diff options
author | Brad King <brad.king@kitware.com> | 2013-09-16 15:29:06 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2013-10-16 13:22:35 (GMT) |
commit | ec6df3675e78d370dbb924bbddf21d01f3ecb071 (patch) | |
tree | 6478d717ac8cbb6c39b1d681e78a9dc4710860a8 /Source/cmDocumentationFormatter.h | |
parent | 25f2877eef3b876922c0e40053205026c8c00e7d (diff) | |
download | CMake-ec6df3675e78d370dbb924bbddf21d01f3ecb071.zip CMake-ec6df3675e78d370dbb924bbddf21d01f3ecb071.tar.gz CMake-ec6df3675e78d370dbb924bbddf21d01f3ecb071.tar.bz2 |
Teach --help-* options to load documentation from .rst files
Install the Help directory next to Modules to make it available in CMake
distributions. Use cmRST to read Help .rst documents and print them as
help output.
Add options
--help-manual-list
--help-manual
to list available manuals or print one of them. Implement the options
--help-commands
--help-modules
--help-policies
--help-properties
--help-variables
by mapping to the corresponding manual page. Implement the options
--help-command-list
--help-module-list
--help-policy-list
--help-property-list
--help-variable-list
by globbing the available Help .rst documents of the corresponding type
and reading their titles. Implement the options
--help-command
--help-module
--help-policy
--help-property
--help-variable
by globbing the matching Help .rst document(s) and printing them.
Diffstat (limited to 'Source/cmDocumentationFormatter.h')
-rw-r--r-- | Source/cmDocumentationFormatter.h | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/Source/cmDocumentationFormatter.h b/Source/cmDocumentationFormatter.h index 534a4de..0bce50c 100644 --- a/Source/cmDocumentationFormatter.h +++ b/Source/cmDocumentationFormatter.h @@ -25,10 +25,11 @@ class cmDocumentationEnums public: /** Types of help provided. */ enum Type - { None, Usage, Single, SingleModule, SingleProperty, SingleVariable, - List, ModuleList, PropertyList, VariableList, PolicyList, - Properties, Variables, Modules, Commands, - Copyright, Version, Policies, SinglePolicy }; + { + None, Version, Usage, ListManuals, + ListCommands, ListModules, ListProperties, ListVariables, ListPolicies, + OneManual, OneCommand, OneModule, OneProperty, OneVariable, OnePolicy + }; /** Forms of documentation output. */ enum Form { TextForm, HTMLForm, RSTForm, ManForm, UsageForm, DocbookForm }; |