CMakeLua/Source/cmDocumentationFormatterDocbook.h

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