summaryrefslogtreecommitdiffstats
path: root/Source/cmDocumentationFormatterHTML.cxx
diff options
context:
space:
mode:
authorAlexander Neundorf <neundorf@kde.org>2008-07-21 21:52:59 (GMT)
committerAlexander Neundorf <neundorf@kde.org>2008-07-21 21:52:59 (GMT)
commit4175b514fc65cd452fbf1f62bd5c0c494568e9fd (patch)
tree6e726407fc166a557beb0726a315ccedf0d066cb /Source/cmDocumentationFormatterHTML.cxx
parent76878d928e66a1ce850beba7d9d114f46ee1d549 (diff)
downloadCMake-4175b514fc65cd452fbf1f62bd5c0c494568e9fd.zip
CMake-4175b514fc65cd452fbf1f62bd5c0c494568e9fd.tar.gz
CMake-4175b514fc65cd452fbf1f62bd5c0c494568e9fd.tar.bz2
ENH: handle HTML documentation for single items better: no warning about
ComputeSectionLinkPrefix, don't create an index for only one item Alex
Diffstat (limited to 'Source/cmDocumentationFormatterHTML.cxx')
-rw-r--r--Source/cmDocumentationFormatterHTML.cxx45
1 files changed, 30 insertions, 15 deletions
diff --git a/Source/cmDocumentationFormatterHTML.cxx b/Source/cmDocumentationFormatterHTML.cxx
index a40ce99..0f7cc70 100644
--- a/Source/cmDocumentationFormatterHTML.cxx
+++ b/Source/cmDocumentationFormatterHTML.cxx
@@ -117,30 +117,37 @@ void cmDocumentationFormatterHTML
const cmDocumentationSection &section,
const char* name)
{
- if(name)
- {
- os << "<h2><a name=\"section_" << name << "\"/>" << name << "</h2>\n";
- }
-
std::string prefix = this->ComputeSectionLinkPrefix(name);
const std::vector<cmDocumentationEntry> &entries =
section.GetEntries();
- os << "<ul>\n";
- for(std::vector<cmDocumentationEntry>::const_iterator op
- = entries.begin(); op != entries.end(); ++ op )
+ // skip the index if the help for only a single item (--help-command,
+ // --help-policy, --help-property, --help-module) is printed
+ bool isSingleItemHelp = ((name!=0) && (strcmp(name, "SingleItem")==0));
+
+ if (!isSingleItemHelp)
{
- if(op->Name.size())
+ if (name)
{
- os << " <li><a href=\"#" << prefix << ":";
- cmDocumentationPrintHTMLId(os, op->Name.c_str());
- os << "\"><b><code>";
- this->PrintHTMLEscapes(os, op->Name.c_str());
- os << "</code></b></a></li>";
+ os << "<h2><a name=\"section_" << name << "\"/>" << name << "</h2>\n";
}
+
+ os << "<ul>\n";
+ for(std::vector<cmDocumentationEntry>::const_iterator op
+ = entries.begin(); op != entries.end(); ++ op )
+ {
+ if(op->Name.size())
+ {
+ os << " <li><a href=\"#" << prefix << ":";
+ cmDocumentationPrintHTMLId(os, op->Name.c_str());
+ os << "\"><b><code>";
+ this->PrintHTMLEscapes(os, op->Name.c_str());
+ os << "</code></b></a></li>";
+ }
+ }
+ os << "</ul>\n" ;
}
- os << "</ul>\n" ;
for(std::vector<cmDocumentationEntry>::const_iterator op = entries.begin();
op != entries.end();)
@@ -240,6 +247,14 @@ void cmDocumentationFormatterHTML
::PrintIndex(std::ostream& os,
std::vector<const cmDocumentationSection *>& sections)
{
+ // skip the index if only the help for a single item is printed
+ if ((sections.size() == 1)
+ && (sections[0]->GetName(this->GetForm()) != 0 )
+ && (std::string(sections[0]->GetName(this->GetForm())) == "SingleItem"))
+ {
+ return;
+ }
+
os << "<h2><a name=\"section_Index\"/>Master Index</h2>\n";
os << "<ul>\n";
for(unsigned int i=0; i < sections.size(); ++i)