summaryrefslogtreecommitdiff
path: root/Source/cmDocumentationFormatterUsage.h
diff options
context:
space:
mode:
Diffstat (limited to 'Source/cmDocumentationFormatterUsage.h')
-rw-r--r--Source/cmDocumentationFormatterUsage.h31
1 files changed, 31 insertions, 0 deletions
diff --git a/Source/cmDocumentationFormatterUsage.h b/Source/cmDocumentationFormatterUsage.h
new file mode 100644
index 000000000..3ed3442cb
--- /dev/null
+++ b/Source/cmDocumentationFormatterUsage.h
@@ -0,0 +1,31 @@
+/*============================================================================
+ CMake - Cross Platform Makefile Generator
+ Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
+
+ Distributed under the OSI-approved BSD License (the "License");
+ see accompanying file Copyright.txt for details.
+
+ This software is distributed WITHOUT ANY WARRANTY; without even the
+ implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ See the License 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 cmDocumentationSection& section,
+ const char* name);
+};
+
+#endif