summaryrefslogtreecommitdiffstats
path: root/Source/cmDocumentation.h
diff options
context:
space:
mode:
authorBill Hoffman <bill.hoffman@kitware.com>2005-12-14 18:51:08 (GMT)
committerBill Hoffman <bill.hoffman@kitware.com>2005-12-14 18:51:08 (GMT)
commitb7fa820118d6989ca4d77dbfcc972c2e903bfe2a (patch)
treea5605c468a458597fff5f17485fad8cd85856e1b /Source/cmDocumentation.h
parent805d365d479a916acf2c5638809fb046fc28dc97 (diff)
downloadCMake-b7fa820118d6989ca4d77dbfcc972c2e903bfe2a.zip
CMake-b7fa820118d6989ca4d77dbfcc972c2e903bfe2a.tar.gz
CMake-b7fa820118d6989ca4d77dbfcc972c2e903bfe2a.tar.bz2
ENH: add documentation support for modules
Diffstat (limited to 'Source/cmDocumentation.h')
-rw-r--r--Source/cmDocumentation.h11
1 files changed, 10 insertions, 1 deletions
diff --git a/Source/cmDocumentation.h b/Source/cmDocumentation.h
index d0db3a1..735d09c 100644
--- a/Source/cmDocumentation.h
+++ b/Source/cmDocumentation.h
@@ -25,10 +25,12 @@ class cmDocumentation
public:
cmDocumentation();
+ ~cmDocumentation();
// High-level interface for standard documents:
/** Types of help provided. */
- enum Type { None, Usage, Single, List, Full, HTML, Man, Copyright, Version };
+ enum Type { None, Usage, Single, SingleModule, List, ModuleList,
+ Full, HTML, Man, Copyright, Version };
/**
* Check command line arguments for documentation options. Returns
@@ -121,10 +123,14 @@ private:
void PrintColumn(std::ostream& os, const char* text);
void PrintHTMLEscapes(std::ostream& os, const char* text);
+ bool CreateSingleModule(const char* fname, const char* moduleName);
+ bool CreateModulesSection();
bool PrintCopyright(std::ostream& os);
bool PrintVersion(std::ostream& os);
bool PrintDocumentationList(std::ostream& os);
+ bool PrintModuleList(std::ostream& os);
bool PrintDocumentationSingle(std::ostream& os);
+ bool PrintDocumentationSingleModule(std::ostream& os);
bool PrintDocumentationUsage(std::ostream& os);
bool PrintDocumentationFull(std::ostream& os);
bool PrintDocumentationHTML(std::ostream& os);
@@ -149,11 +155,14 @@ private:
std::vector<cmDocumentationEntry> DescriptionSection;
std::vector<cmDocumentationEntry> OptionsSection;
std::vector<cmDocumentationEntry> CommandsSection;
+ std::vector<cmDocumentationEntry> ModulesSection;
std::vector<cmDocumentationEntry> GeneratorsSection;
std::vector<cmDocumentationEntry> SeeAlsoSection;
std::string SeeAlsoString;
std::string SingleCommand;
+ std::string SingleModuleName;
+ std::vector< char* > ModuleStrings;
std::vector< const char* > Names;
std::vector< const cmDocumentationEntry* > Sections;
Form CurrentForm;