src/VTKWrapping/ParaView/vtkWrapText.h

   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
  16 /**
  17  * vtkWrap provides useful functions for generating wrapping code.
  18 */
  19
  20 #ifndef VTK_WRAP_TEXT_H
  21 #define VTK_WRAP_TEXT_H
  22
  23 #include "vtkParse.h"
  24 #include "vtkParseHierarchy.h"
  25
  26 #ifdef __cplusplus
  27 extern "C" {
  28 #endif
  29
  30 /**
  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.
  35  */
  36 const char *vtkWrapText_QuoteString(const char *comment, size_t maxlen);
  37
  38 /**
  39  * Format a doxygen comment for plain text, and word-wrap at
  40  * the specified width.  A 70-char width is recommended.
  41  */
  42 const char *vtkWrapText_FormatComment(const char *comment, size_t width);
  43
  44 /**
  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.
  48  */
  49 const char *vtkWrapText_FormatSignature(
  50   const char *signature, size_t width, size_t maxlen);
  51
  52 /**
  53  * Produce a python signature for a method, for use in documentation.
  54  */
  55 const char *vtkWrapText_PythonSignature(FunctionInfo *currentFunction);
  56
  57 #ifdef __cplusplus
  58 }
  59 #endif
  60
  61 #endif