summaryrefslogtreecommitdiffstats
path: root/Source/cmDocumentation.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2004-04-14 18:25:43 (GMT)
committerBrad King <brad.king@kitware.com>2004-04-14 18:25:43 (GMT)
commit0c92cfb8c456ff097186a59fcec257aae98d319e (patch)
tree7eb51dc19094adccd1f281b99cc0918f931ad535 /Source/cmDocumentation.h
parent8020279dd602626ae8edeaa3553d2cd391818e0f (diff)
downloadCMake-0c92cfb8c456ff097186a59fcec257aae98d319e.zip
CMake-0c92cfb8c456ff097186a59fcec257aae98d319e.tar.gz
CMake-0c92cfb8c456ff097186a59fcec257aae98d319e.tar.bz2
ENH: Renamed --help-list-commands to --help-command-list and split --help [command] into separate --help and --help-command cmd options.
Diffstat (limited to 'Source/cmDocumentation.h')
-rw-r--r--Source/cmDocumentation.h23
1 files changed, 13 insertions, 10 deletions
diff --git a/Source/cmDocumentation.h b/Source/cmDocumentation.h
index 79023bc..d0db3a1 100644
--- a/Source/cmDocumentation.h
+++ b/Source/cmDocumentation.h
@@ -28,7 +28,7 @@ public:
// High-level interface for standard documents:
/** Types of help provided. */
- enum Type { None, Usage, List, Full, HTML, Man, Copyright, Version };
+ enum Type { None, Usage, Single, List, Full, HTML, Man, Copyright, Version };
/**
* Check command line arguments for documentation options. Returns
@@ -47,7 +47,7 @@ public:
bool PrintRequestedDocumentation(std::ostream& os);
/** Print help of the given type. */
- void PrintDocumentation(Type ht, std::ostream& os);
+ bool PrintDocumentation(Type ht, std::ostream& os);
/** Set the program name for standard document generation. */
void SetName(const char* name);
@@ -121,13 +121,14 @@ private:
void PrintColumn(std::ostream& os, const char* text);
void PrintHTMLEscapes(std::ostream& os, const char* text);
- void PrintCopyright(std::ostream& os);
- void PrintVersion(std::ostream& os);
- void PrintDocumentationUsage(std::ostream& os);
- void PrintDocumentationList(std::ostream& os);
- void PrintDocumentationFull(std::ostream& os);
- void PrintDocumentationHTML(std::ostream& os);
- void PrintDocumentationMan(std::ostream& os);
+ bool PrintCopyright(std::ostream& os);
+ bool PrintVersion(std::ostream& os);
+ bool PrintDocumentationList(std::ostream& os);
+ bool PrintDocumentationSingle(std::ostream& os);
+ bool PrintDocumentationUsage(std::ostream& os);
+ bool PrintDocumentationFull(std::ostream& os);
+ bool PrintDocumentationHTML(std::ostream& os);
+ bool PrintDocumentationMan(std::ostream& os);
void PrintDocumentationCommand(std::ostream& os,
cmDocumentationEntry* entry);
@@ -140,6 +141,7 @@ private:
const cmDocumentationEntry* footer,
std::vector<cmDocumentationEntry>&);
const char* GetNameString();
+ bool IsOption(const char* arg);
std::string NameString;
std::vector<cmDocumentationEntry> NameSection;
@@ -150,7 +152,8 @@ private:
std::vector<cmDocumentationEntry> GeneratorsSection;
std::vector<cmDocumentationEntry> SeeAlsoSection;
std::string SeeAlsoString;
-
+ std::string SingleCommand;
+
std::vector< const char* > Names;
std::vector< const cmDocumentationEntry* > Sections;
Form CurrentForm;