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/cmDocumentationFormatter.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/cmDocumentationFormatter.h')
| -rw-r--r-- | Source/cmDocumentationFormatter.h | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Source/cmDocumentationFormatter.h b/Source/cmDocumentationFormatter.h index 29eb2d0..1cb3d19 100644 --- a/Source/cmDocumentationFormatter.h +++ b/Source/cmDocumentationFormatter.h @@ -52,7 +52,9 @@ public: virtual cmDocumentationEnums::Form GetForm() const = 0; - virtual void PrintHeader(const char* /*name*/, std::ostream& /*os*/) {} + virtual void PrintHeader(const char* /*docname*/, + const char* /*appname*/, + std::ostream& /*os*/) {} virtual void PrintFooter(std::ostream& /*os*/) {} virtual void PrintSection(std::ostream& os, const cmDocumentationSection& section, |