VTK
vtkWrapText.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkWrapText.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 
20 #ifndef vtkWrapText_h
21 #define vtkWrapText_h
22 
23 #include "vtkParse.h"
24 #include "vtkParseHierarchy.h"
25 
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29 
36 const char *vtkWrapText_QuoteString(const char *comment, size_t maxlen);
37 
42 const char *vtkWrapText_FormatComment(const char *comment, size_t width);
43 
49 const char *vtkWrapText_FormatSignature(
50  const char *signature, size_t width, size_t maxlen);
51 
55 const char *vtkWrapText_PythonSignature(FunctionInfo *currentFunction);
56 
57 
64 void vtkWrapText_PythonName(const char *name, char *pname);
65 
66 #ifdef __cplusplus
67 }
68 #endif
69 
70 #endif
const char * vtkWrapText_PythonSignature(FunctionInfo *currentFunction)
Produce a python signature for a method, for use in documentation.
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...
FunctionInfo is for functions and methods.
Definition: vtkParseData.h:121
void vtkWrapText_PythonName(const char *name, char *pname)
Convert a C++ identifier into an identifier that can be used from Python.