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/cmDocumentationFormatterDocbook.cxx | |
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/cmDocumentationFormatterDocbook.cxx')
-rw-r--r-- | Source/cmDocumentationFormatterDocbook.cxx | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/Source/cmDocumentationFormatterDocbook.cxx b/Source/cmDocumentationFormatterDocbook.cxx index a3f4a7a..a34689b 100644 --- a/Source/cmDocumentationFormatterDocbook.cxx +++ b/Source/cmDocumentationFormatterDocbook.cxx @@ -229,8 +229,9 @@ void cmDocumentationFormatterDocbook::PrintParagraph(std::ostream& os, } //---------------------------------------------------------------------------- -void cmDocumentationFormatterDocbook::PrintHeader(const char* name, - std::ostream& os) +void cmDocumentationFormatterDocbook::PrintHeader(const char* docname, + const char* appname, + std::ostream& os) { // this one is used to ensure that we don't create multiple link targets // with the same name. We can clear it here since we are at the @@ -244,7 +245,7 @@ void cmDocumentationFormatterDocbook::PrintHeader(const char* name, "<!ENTITY % English \"INCLUDE\"> ]>\n" "<article>\n" "<articleinfo>\n" - "<title>" << name << "</title>\n" + "<title>" << docname << " - " << appname << "</title>\n" "</articleinfo>\n"; } |