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. More...
const char *	vtkWrapText_FormatComment (const char *comment, size_t width)
	Format a doxygen comment for plain text, and word-wrap at the specified width. More...
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. More...
const char *	vtkWrapText_PythonSignature (FunctionInfo *currentFunction)
	Produce a python signature for a method, for use in documentation. More...
void	vtkWrapText_PythonName (const char *name, char *pname)
	Convert a C++ identifier into an identifier that can be used from Python. More...

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.

void vtkWrapText_PythonName	(	const char *	name,
		char *	pname
	)

Convert a C++ identifier into an identifier that can be used from Python.

The "::" namespace separators are converted to ".", and template args are mangled and prefix with "T" according to the ia64 ABI. The output parameter "pname" must be large enough to accept the result. If it is as long as the input name, that is sufficient.