diff options
author | Ken Martin <ken.martin@kitware.com> | 2006-12-07 14:45:32 (GMT) |
---|---|---|
committer | Ken Martin <ken.martin@kitware.com> | 2006-12-07 14:45:32 (GMT) |
commit | 27379d7b081be852c2b290a98db548cffffbff04 (patch) | |
tree | fcc9e19282bdfb71bf4bf9b1f8fcea1401c2fbd5 /Source/cmDocumentation.h | |
parent | 833548f53a2ed799bb0df23fd7d973c30b423d1b (diff) | |
download | CMake-27379d7b081be852c2b290a98db548cffffbff04.zip CMake-27379d7b081be852c2b290a98db548cffffbff04.tar.gz CMake-27379d7b081be852c2b290a98db548cffffbff04.tar.bz2 |
ENH: make properties a bit more formal with documentation and chaining
Diffstat (limited to 'Source/cmDocumentation.h')
-rw-r--r-- | Source/cmDocumentation.h | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/Source/cmDocumentation.h b/Source/cmDocumentation.h index 6ce777e..53ced44 100644 --- a/Source/cmDocumentation.h +++ b/Source/cmDocumentation.h @@ -29,7 +29,8 @@ public: // High-level interface for standard documents: /** Types of help provided. */ - enum Type { None, Usage, Single, SingleModule, List, ModuleList, + enum Type { None, Usage, Single, SingleModule, SingleProperty, + List, ModuleList, PropertyList, Full, HTML, Man, Copyright, Version }; /** @@ -70,6 +71,9 @@ public: /** Set the listfile commands for standard document generation. */ void SetCommandsSection(const cmDocumentationEntry*); + /** Set the properties for standard document generation. */ + void SetPropertiesSection(const cmDocumentationEntry*); + /** Set the generator descriptions for standard document generation. */ void SetGeneratorsSection(const cmDocumentationEntry*); @@ -132,8 +136,10 @@ private: bool PrintVersion(std::ostream& os); bool PrintDocumentationList(std::ostream& os); bool PrintModuleList(std::ostream& os); + bool PrintPropertyList(std::ostream& os); bool PrintDocumentationSingle(std::ostream& os); bool PrintDocumentationSingleModule(std::ostream& os); + bool PrintDocumentationSingleProperty(std::ostream& os); bool PrintDocumentationUsage(std::ostream& os); bool PrintDocumentationFull(std::ostream& os); bool PrintDocumentationHTML(std::ostream& os); @@ -159,11 +165,13 @@ private: std::vector<cmDocumentationEntry> OptionsSection; std::vector<cmDocumentationEntry> CommandsSection; std::vector<cmDocumentationEntry> ModulesSection; + std::vector<cmDocumentationEntry> PropertiesSection; std::vector<cmDocumentationEntry> GeneratorsSection; std::vector<cmDocumentationEntry> SeeAlsoSection; std::string SeeAlsoString; std::string SingleCommand; std::string SingleModuleName; + std::string SinglePropertyName; std::string CMakeRoot; std::vector< char* > ModuleStrings; std::vector< const char* > Names; |