/Users/kitware/Dashboards/MyTests/VTK_BLD_Release_docs/Utilities/Doxygen/dox/Wrapping/Tools/vtkWrapText.h File Reference

#include "vtkParse.h"
#include "vtkParseHierarchy.h"

Include dependency graph for vtkWrapText.h:

Go to the source code of this file.

Functions
const char *	vtkWrapText_QuoteString (const char *comment, size_t maxlen)
	vtkWrap provides useful functions for generating wrapping code.
const char *	vtkWrapText_FormatComment (const char *comment, size_t width)
	Format a doxygen comment for plain text, and word-wrap at the specified width.
const char *	vtkWrapText_FormatSignature (const char *signature, size_t width, size_t maxlen)
	Format a method signature by applying word-wrap at the specified width and taking special care not to split any literals or names.
const char *	vtkWrapText_PythonSignature (FunctionInfo *currentFunction)
	Produce a python signature for a method, for use in documentation.

---

Function Documentation

const char* vtkWrapText_QuoteString	(	const char *	comment,
		size_t	maxlen
	)

vtkWrap provides useful functions for generating wrapping code.

Quote a string for inclusion in a C string literal. The "maxlen" should be set to a value between 32 and 2047. Values over 2047 will result in string literals too long for some compilers. If the string is truncated, a "..." will be appended.

const char* vtkWrapText_FormatComment	(	const char *	comment,
		size_t	width
	)

Format a doxygen comment for plain text, and word-wrap at the specified width.

A 70-char width is recommended.

const char* vtkWrapText_FormatSignature	(	const char *	signature,
		size_t	width,
		size_t	maxlen
	)

Format a method signature by applying word-wrap at the specified width and taking special care not to split any literals or names.

A width of 70 chars is recommended.

const char* vtkWrapText_PythonSignature

(

FunctionInfo *

currentFunction

)

Produce a python signature for a method, for use in documentation.