diff options
author | Alexander Neundorf <neundorf@kde.org> | 2007-09-19 13:05:28 (GMT) |
---|---|---|
committer | Alexander Neundorf <neundorf@kde.org> | 2007-09-19 13:05:28 (GMT) |
commit | c5f249bdbdb894d72db8211021ac2b9ff8b02fa7 (patch) | |
tree | 9378751765b4e994d93ba99cfa7e737a180e6513 /Source/cmDocumentationFormatterHTML.h | |
parent | b4f02ec0bd8e102fb93230ed2ffe15c90bb33a81 (diff) | |
download | CMake-c5f249bdbdb894d72db8211021ac2b9ff8b02fa7.zip CMake-c5f249bdbdb894d72db8211021ac2b9ff8b02fa7.tar.gz CMake-c5f249bdbdb894d72db8211021ac2b9ff8b02fa7.tar.bz2 |
STYLE: move the code for the different formats of the generated help into
their own classes, making cmDocumentation smaller and also making it easier
to eventually add another format
Alex
Diffstat (limited to 'Source/cmDocumentationFormatterHTML.h')
-rw-r--r-- | Source/cmDocumentationFormatterHTML.h | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/Source/cmDocumentationFormatterHTML.h b/Source/cmDocumentationFormatterHTML.h new file mode 100644 index 0000000..e5a4a9a --- /dev/null +++ b/Source/cmDocumentationFormatterHTML.h @@ -0,0 +1,44 @@ +/*========================================================================= + + Program: CMake - Cross-Platform Makefile Generator + Module: $RCSfile$ + Language: C++ + Date: $Date$ + Version: $Revision$ + + Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved. + See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details. + + This software is distributed WITHOUT ANY WARRANTY; without even + the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR + PURPOSE. See the above copyright notices for more information. + +=========================================================================*/ +#ifndef _cmDocumentationFormatterHTML_h +#define _cmDocumentationFormatterHTML_h + +#include "cmStandardIncludes.h" + +#include "cmDocumentationFormatter.h" + +/** Class to print the documentation as HTML. */ +class cmDocumentationFormatterHTML : public cmDocumentationFormatter +{ +public: + cmDocumentationFormatterHTML(); + + virtual cmDocumentationEnums::Form GetForm() const + { return cmDocumentationEnums::HTMLForm;} + + virtual void PrintHeader(const char* name, std::ostream& os); + virtual void PrintFooter(std::ostream& os); + virtual void PrintSection(std::ostream& os, + const cmDocumentationEntry* section, + const char* name); + virtual void PrintPreformatted(std::ostream& os, const char* text); + virtual void PrintParagraph(std::ostream& os, const char* text); +private: + void PrintHTMLEscapes(std::ostream& os, const char* text); +}; + +#endif |