summaryrefslogtreecommitdiffstats
path: root/Source/cmDocumentationFormatterUsage.h
diff options
context:
space:
mode:
authorAlexander Neundorf <neundorf@kde.org>2007-09-19 13:05:28 (GMT)
committerAlexander Neundorf <neundorf@kde.org>2007-09-19 13:05:28 (GMT)
commitc5f249bdbdb894d72db8211021ac2b9ff8b02fa7 (patch)
tree9378751765b4e994d93ba99cfa7e737a180e6513 /Source/cmDocumentationFormatterUsage.h
parentb4f02ec0bd8e102fb93230ed2ffe15c90bb33a81 (diff)
downloadCMake-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/cmDocumentationFormatterUsage.h')
-rw-r--r--Source/cmDocumentationFormatterUsage.h36
1 files changed, 36 insertions, 0 deletions
diff --git a/Source/cmDocumentationFormatterUsage.h b/Source/cmDocumentationFormatterUsage.h
new file mode 100644
index 0000000..620e3b9
--- /dev/null
+++ b/Source/cmDocumentationFormatterUsage.h
@@ -0,0 +1,36 @@
+/*=========================================================================
+
+ 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 _cmDocumentationFormatterUsage_h
+#define _cmDocumentationFormatterUsage_h
+
+#include "cmDocumentationFormatterText.h"
+
+/** Class to print the documentation as usage on the command line. */
+class cmDocumentationFormatterUsage : public cmDocumentationFormatterText
+{
+public:
+ cmDocumentationFormatterUsage();
+
+ virtual cmDocumentationEnums::Form GetForm() const
+ { return cmDocumentationEnums::UsageForm;}
+
+ virtual void PrintSection(std::ostream& os,
+ const cmDocumentationEntry* section,
+ const char* name);
+};
+
+#endif