kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

docbook: Add support for <abstract> at section level 1 

If a section has subsections (ie. subelemens with a title), all elements
before the first title are written inside an <abstract>.  Also wrap
<programlisting> in <para>, to allow preformatted output in abstracts.
This commit is contained in:
Daniel Pfeifer 2012-09-07 10:55:58 +02:00 committed by Brad King
parent 67e7d49cb8
commit 3a9e373a69
1 changed files with 24 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
Source/cmDocumentationFormatterDocbook.cxx
View File

@ -115,11 +115,28 @@ void cmDocumentationFormatterDocbook
std::string prefix = this->ComputeSectionLinkPrefix(name); std::string prefix = this->ComputeSectionLinkPrefix(name);
const std::vector<cmDocumentationEntry> &entries = section.GetEntries(); const std::vector<cmDocumentationEntry> &entries = section.GetEntries();
bool hasSubSections = false;
for(std::vector<cmDocumentationEntry>::const_iterator op = entries.begin(); for(std::vector<cmDocumentationEntry>::const_iterator op = entries.begin();
op != entries.end(); ++op) op != entries.end(); ++op)
{ {
if(op->Name.size()) if(op->Name.size())
{ {
hasSubSections = true;
break;
}
}
bool inAbstract = false;
for(std::vector<cmDocumentationEntry>::const_iterator op = entries.begin();
op != entries.end(); ++op)
{
if(op->Name.size())
{
if(inAbstract)
{
os << "</abstract>\n";
inAbstract = false;
}
os << "<sect2 id=\""; os << "<sect2 id=\"";
this->PrintId(os, prefix.c_str(), op->Name); this->PrintId(os, prefix.c_str(), op->Name);
os << "\">\n<title>"; os << "\">\n<title>";
@ -140,6 +157,11 @@ void cmDocumentationFormatterDocbook
} }
else else
{ {
if(hasSubSections && op == entries.begin())
{
os << "<abstract>\n";
inAbstract = true;
}
this->PrintFormatted(os, op->Brief.c_str()); this->PrintFormatted(os, op->Brief.c_str());
} }
} }
@ -157,9 +179,9 @@ void cmDocumentationFormatterDocbook
void cmDocumentationFormatterDocbook void cmDocumentationFormatterDocbook
::PrintPreformatted(std::ostream& os, const char* text) ::PrintPreformatted(std::ostream& os, const char* text)
{ {
os << "<programlisting>"; os << "<para>\n<programlisting>";
cmDocumentationPrintDocbookEscapes(os, text); cmDocumentationPrintDocbookEscapes(os, text);
os << "</programlisting>\n"; os << "</programlisting>\n</para>\n";
} }
void cmDocumentationFormatterDocbook void cmDocumentationFormatterDocbook