Source/cmDocumentationFormatterDocbook.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmDocumentationFormatterDocbook.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008-10-10 15:23:35 $
   7   Version:   $Revision: 1.2 $
   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 _cmDocumentationFormatterDocbook_h
  18 #define _cmDocumentationFormatterDocbook_h
  19
  20 #include "cmStandardIncludes.h"
  21
  22 #include "cmDocumentationFormatter.h"
  23
  24 /** Class to print the documentation as Docbook.
  25  http://www.oasis-open.org/docbook/xml/4.2/   */
  26 class cmDocumentationFormatterDocbook : public cmDocumentationFormatter
  27 {
  28 public:
  29   cmDocumentationFormatterDocbook();
  30
  31   virtual cmDocumentationEnums::Form GetForm() const
  32                                   { return cmDocumentationEnums::DocbookForm;}
  33
  34   virtual void PrintHeader(const char* docname, const char* appname,
  35                            std::ostream& os);
  36   virtual void PrintFooter(std::ostream& os);
  37   virtual void PrintSection(std::ostream& os,
  38                             const cmDocumentationSection& section,
  39                             const char* name);
  40   virtual void PrintPreformatted(std::ostream& os, const char* text);
  41   virtual void PrintParagraph(std::ostream& os, const char* text);
  42 private:
  43   std::set<std::string> EmittedLinkIds;
  44 };
  45
  46 #endif