Source/cmDocumentationFormatterMan.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmDocumentationFormatterMan.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008-10-10 15:23:35 $
   7   Version:   $Revision: 1.3 $
   8
   9   Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  10   See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
  11
  12      This software is distributed WITHOUT ANY WARRANTY; without even
  13      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14      PURPOSE.  See the above copyright notices for more information.
  15
  16 =========================================================================*/
  17 #ifndef _cmDocumentationFormatterMan_h
  18 #define _cmDocumentationFormatterMan_h
  19
  20 #include "cmStandardIncludes.h"
  21
  22 #include "cmDocumentationFormatter.h"
  23
  24 /** Class to print the documentation as man page.  */
  25 class cmDocumentationFormatterMan : public cmDocumentationFormatter
  26 {
  27 public:
  28   cmDocumentationFormatterMan();
  29
  30   virtual cmDocumentationEnums::Form GetForm() const
  31                                       { return cmDocumentationEnums::ManForm;}
  32
  33   virtual void PrintHeader(const char* docname, const char* appname,
  34                            std::ostream& os);
  35   virtual void PrintSection(std::ostream& os,
  36                     const cmDocumentationSection& section,
  37                     const char* name);
  38   virtual void PrintPreformatted(std::ostream& os, const char* text);
  39   virtual void PrintParagraph(std::ostream& os, const char* text);
  40
  41 private:
  42   void EscapeText(std::string& man_text);
  43 };
  44
  45 #endif