summaryrefslogtreecommitdiffstats
path: root/Source/cmDocumentation.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2003-07-11 03:15:45 (GMT)
committerBrad King <brad.king@kitware.com>2003-07-11 03:15:45 (GMT)
commit7c2b4e3a029ffe1205553fb80883434677167b2c (patch)
tree662fdbc709b4c19f872567e6c8e1a97c744a3e72 /Source/cmDocumentation.h
parentc08062795747714b6db50a4261543ff4035dc843 (diff)
downloadCMake-7c2b4e3a029ffe1205553fb80883434677167b2c.zip
CMake-7c2b4e3a029ffe1205553fb80883434677167b2c.tar.gz
CMake-7c2b4e3a029ffe1205553fb80883434677167b2c.tar.bz2
ENH: Added SEE ALSO section to generated man page. Minor formatting improvements for generated text-only documentation.
Diffstat (limited to 'Source/cmDocumentation.h')
-rw-r--r--Source/cmDocumentation.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/Source/cmDocumentation.h b/Source/cmDocumentation.h
index 598b1d3..ddfbb44 100644
--- a/Source/cmDocumentation.h
+++ b/Source/cmDocumentation.h
@@ -67,6 +67,9 @@ public:
/** Set the generator descriptions for standard document generation. */
void SetGeneratorsSection(const cmDocumentationEntry*);
+ /** Set the see-also list of references to the other tools. */
+ void SetSeeAlsoList(const cmDocumentationEntry*);
+
// Low-level interface for custom documents:
/** Forms of documentation output. */
@@ -136,6 +139,8 @@ private:
std::vector<cmDocumentationEntry> OptionsSection;
std::vector<cmDocumentationEntry> CommandsSection;
std::vector<cmDocumentationEntry> GeneratorsSection;
+ std::vector<cmDocumentationEntry> SeeAlsoSection;
+ std::string SeeAlsoString;
std::vector< const char* > Names;
std::vector< const cmDocumentationEntry* > Sections;