1 /*=========================================================================
3 Program: Visualization Toolkit
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
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.
14 =========================================================================*/
17 * vtkWrap provides useful functions for generating wrapping code.
20 #ifndef VTK_WRAP_TEXT_H
21 #define VTK_WRAP_TEXT_H
24 #include "vtkParseHierarchy.h"
31 * Quote a string for inclusion in a C string literal. The "maxlen"
32 * should be set to a value between 32 and 2047. Values over 2047
33 * will result in string literals too long for some compilers. If
34 * the string is truncated, a "..." will be appended.
36 const char *vtkWrapText_QuoteString(const char *comment, size_t maxlen);
39 * Format a doxygen comment for plain text, and word-wrap at
40 * the specified width. A 70-char width is recommended.
42 const char *vtkWrapText_FormatComment(const char *comment, size_t width);
45 * Format a method signature by applying word-wrap at the specified
46 * width and taking special care not to split any literals or names.
47 * A width of 70 chars is recommended.
49 const char *vtkWrapText_FormatSignature(
50 const char *signature, size_t width, size_t maxlen);
53 * Produce a python signature for a method, for use in documentation.
55 const char *vtkWrapText_PythonSignature(FunctionInfo *currentFunction);