summaryrefslogtreecommitdiffstats
path: root/Source/cmDocumentationFormatterText.h
diff options
context:
space:
mode:
Diffstat (limited to 'Source/cmDocumentationFormatterText.h')
-rw-r--r--Source/cmDocumentationFormatterText.h45
1 files changed, 45 insertions, 0 deletions
diff --git a/Source/cmDocumentationFormatterText.h b/Source/cmDocumentationFormatterText.h
new file mode 100644
index 0000000..f7db277
--- /dev/null
+++ b/Source/cmDocumentationFormatterText.h
@@ -0,0 +1,45 @@
+/*=========================================================================
+
+ 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 _cmDocumentationFormatterText_h
+#define _cmDocumentationFormatterText_h
+
+#include "cmStandardIncludes.h"
+
+#include "cmDocumentationFormatter.h"
+
+/** Class to print the documentation as plain text. */
+class cmDocumentationFormatterText : public cmDocumentationFormatter
+{
+public:
+ cmDocumentationFormatterText();
+
+ virtual cmDocumentationEnums::Form GetForm() const
+ { return cmDocumentationEnums::TextForm;}
+
+ 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);
+ void PrintColumn(std::ostream& os, const char* text);
+ void SetIndent(const char* indent);
+protected:
+ int TextWidth;
+ const char* TextIndent;
+};
+
+#endif