diff options
| author | Brad King <brad.king@kitware.com> | 2008-05-05 16:02:36 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2008-05-05 16:02:36 (GMT) |
| commit | 199e85910f9ce308c4c53ffcb0f934706f16c5cd (patch) | |
| tree | 290fef0ea4992a634e2bd602a5cd73c08c072755 /Source/cmDocumentationFormatter.h | |
| parent | 1b23b65ed5ff1ea22e912ad25ba94b53e4e91828 (diff) | |
| download | CMake-199e85910f9ce308c4c53ffcb0f934706f16c5cd.zip CMake-199e85910f9ce308c4c53ffcb0f934706f16c5cd.tar.gz CMake-199e85910f9ce308c4c53ffcb0f934706f16c5cd.tar.bz2 | |
ENH: Fix generated documentation internal links.
- Previously all links started in 'command_' which led to conflicts
and was confusing for non-command items.
- Use a per-section name that is meaningful to humans.
- Fix link id names to be valid HTML.
Diffstat (limited to 'Source/cmDocumentationFormatter.h')
| -rw-r--r-- | Source/cmDocumentationFormatter.h | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/Source/cmDocumentationFormatter.h b/Source/cmDocumentationFormatter.h index 33f95f2..29eb2d0 100644 --- a/Source/cmDocumentationFormatter.h +++ b/Source/cmDocumentationFormatter.h @@ -62,6 +62,9 @@ public: virtual void PrintIndex(std::ostream& , std::vector<const cmDocumentationSection *>&) {} + + /** Compute a prefix for links into a section (#<prefix>_SOMETHING). */ + std::string ComputeSectionLinkPrefix(std::string const& name); }; #endif |