diff options
author | Brad King <brad.king@kitware.com> | 2008-10-10 15:23:35 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2008-10-10 15:23:35 (GMT) |
commit | 5a82a0b1084096b9ba0a769d3319ba804d20d227 (patch) | |
tree | 74ccb137de52bcd7d8c0199044e04ee901878157 /Source/cmDocumentationFormatterMan.h | |
parent | 657627c231caac9fe816f24ec2e98b895d13292a (diff) | |
download | CMake-5a82a0b1084096b9ba0a769d3319ba804d20d227.zip CMake-5a82a0b1084096b9ba0a769d3319ba804d20d227.tar.gz CMake-5a82a0b1084096b9ba0a769d3319ba804d20d227.tar.bz2 |
ENH: Improve generated documentation formatting
Applying patch provided in issue #7797.
Fixes to man-pages:
- Character '-' must be espaced as '\-'
- Surround preformatted text with '.nf' and '.fi' to adjust filling
- Give every page a NAME section for indexing by mandb
- Pass the man page filename without extension to .TH in its header
Also added a title to the HTML header.
Diffstat (limited to 'Source/cmDocumentationFormatterMan.h')
-rw-r--r-- | Source/cmDocumentationFormatterMan.h | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/Source/cmDocumentationFormatterMan.h b/Source/cmDocumentationFormatterMan.h index c0b9968..f1d0d0d 100644 --- a/Source/cmDocumentationFormatterMan.h +++ b/Source/cmDocumentationFormatterMan.h @@ -30,12 +30,16 @@ public: virtual cmDocumentationEnums::Form GetForm() const { return cmDocumentationEnums::ManForm;} - virtual void PrintHeader(const char* name, std::ostream& os); + virtual void PrintHeader(const char* docname, const char* appname, + std::ostream& os); virtual void PrintSection(std::ostream& os, const cmDocumentationSection& section, const char* name); virtual void PrintPreformatted(std::ostream& os, const char* text); virtual void PrintParagraph(std::ostream& os, const char* text); + +private: + void EscapeText(std::string& man_text); }; #endif |