diff options
author | Brad King <brad.king@kitware.com> | 2013-10-16 13:28:12 (GMT) |
---|---|---|
committer | CMake Topic Stage <kwrobot@kitware.com> | 2013-10-16 13:28:12 (GMT) |
commit | c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740 (patch) | |
tree | 96102c69673467ce7b922697cd5f378511249201 /Source/cmDocumentationFormatterMan.h | |
parent | 5029da5eac08171653a92b961c341f7ffcca3640 (diff) | |
parent | 7038a93a7eafa83d506dd73bed171dc72dfbd9a5 (diff) | |
download | CMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.zip CMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.tar.gz CMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.tar.bz2 |
Merge topic 'doc-reStructuredText'
7038a93 Modules/readme.txt: Update steps to add module documentation
a77e308 CPack: Replace #<type> markup with reStructuredText equivalent
e7ca48f Help: Factor out cmake-generator-expressions manual page
97e8650 Help: Factor out COMPILE_DEFINITIONS disclaimer duplication
8982161 Help: Factor out find_* command duplication
30b2186 Help: Factor out *_OUTPUT_(NAME|DIRECTORY).rst duplication
bfe07aa Build Help documentation during CMake build using Sphinx
53ded59 Drop unused builtin documentation APIs
0c39a75 Drop the 'Full' field from cmDocumentationEntry
e33d8d2 Drop builtin command documentation
399e9c4 Drop builtin property documentation
6035c04 get_property: Drop test for builtin property documentation
80a3273 Drop all documentation formatters except Usage
b336a1eb Teach COMPATIBLE_INTERFACE_* checks to use Help .rst documents
ec6df36 Teach --help-* options to load documentation from .rst files
25f2877 Add class cmRST to do basic reStructuredText processing
...
Diffstat (limited to 'Source/cmDocumentationFormatterMan.h')
-rw-r--r-- | Source/cmDocumentationFormatterMan.h | 43 |
1 files changed, 0 insertions, 43 deletions
diff --git a/Source/cmDocumentationFormatterMan.h b/Source/cmDocumentationFormatterMan.h deleted file mode 100644 index b3d069c..0000000 --- a/Source/cmDocumentationFormatterMan.h +++ /dev/null @@ -1,43 +0,0 @@ -/*============================================================================ - 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 _cmDocumentationFormatterMan_h -#define _cmDocumentationFormatterMan_h - -#include "cmStandardIncludes.h" - -#include "cmDocumentationFormatter.h" - -/** Class to print the documentation as man page. */ -class cmDocumentationFormatterMan : public cmDocumentationFormatter -{ -public: - cmDocumentationFormatterMan(); - - void SetManSection(int manSection); - - virtual cmDocumentationEnums::Form GetForm() const - { return cmDocumentationEnums::ManForm;} - - virtual void PrintHeader(const char* docname, const char* appname, - std::ostream& os); - virtual void PrintSection(std::ostream& os, - const cmDocumentationSection& section, - const char* name); - virtual void PrintPreformatted(std::ostream& os, const char* text); - virtual void PrintParagraph(std::ostream& os, const char* text); - -private: - void EscapeText(std::string& man_text); - int ManSection; -}; - -#endif |