summaryrefslogtreecommitdiffstats
path: root/Source/cmDocumentation.h
diff options
context:
space:
mode:
authorAlexander Neundorf <neundorf@kde.org>2007-06-28 19:04:28 (GMT)
committerAlexander Neundorf <neundorf@kde.org>2007-06-28 19:04:28 (GMT)
commit151d55557eb823a4ee6d66bdc0a2ea49868bfc1a (patch)
treefe96c973cfc43dbaec4056a93034c6def1d8077a /Source/cmDocumentation.h
parent95f55515fa6064d862354524d0837a9ba4787f49 (diff)
downloadCMake-151d55557eb823a4ee6d66bdc0a2ea49868bfc1a.zip
CMake-151d55557eb823a4ee6d66bdc0a2ea49868bfc1a.tar.gz
CMake-151d55557eb823a4ee6d66bdc0a2ea49868bfc1a.tar.bz2
ENH: generate separate documentation for the commands, compatiblity
commands, modules and properties as html, text and man pages. The names of the man pages are cmcommands, cmcompat, cmprops and cmmodules, so they are easy to type. Alex
Diffstat (limited to 'Source/cmDocumentation.h')
-rw-r--r--Source/cmDocumentation.h11
1 files changed, 8 insertions, 3 deletions
diff --git a/Source/cmDocumentation.h b/Source/cmDocumentation.h
index b54c904..09da00c 100644
--- a/Source/cmDocumentation.h
+++ b/Source/cmDocumentation.h
@@ -31,7 +31,8 @@ public:
/** Types of help provided. */
enum Type { None, Usage, Single, SingleModule, SingleProperty,
List, ModuleList, PropertyList,
- Full, Copyright, Version };
+ Full, Properties, Modules, Commands, CompatCommands,
+ Copyright, Version };
/**
* Check command line arguments for documentation options. Returns
@@ -205,13 +206,17 @@ private:
bool PrintDocumentationSingleProperty(std::ostream& os);
bool PrintDocumentationUsage(std::ostream& os);
bool PrintDocumentationFull(std::ostream& os);
+ bool PrintDocumentationModules(std::ostream& os);
+ bool PrintDocumentationProperties(std::ostream& os);
+ bool PrintDocumentationCurrentCommands(std::ostream& os);
+ bool PrintDocumentationCompatCommands(std::ostream& os);
void PrintDocumentationCommand(std::ostream& os,
const cmDocumentationEntry* entry);
void CreateUsageDocumentation();
void CreateFullDocumentation();
- void CreateCurrentCommandDocumentation();
- void CreateCompatCommandDocumentation();
+ void CreateCurrentCommandsDocumentation();
+ void CreateCompatCommandsDocumentation();
void CreateModulesDocumentation();
void CreatePropertiesDocumentation();