#include <src/docbookgen.h>

Inheritance diagram for DocbookGenerator:

Collaboration diagram for DocbookGenerator:

Classes
struct	TocState

Public Member Functions
	DocbookGenerator ()
	DocbookGenerator (const DocbookGenerator &)
DocbookGenerator &	operator= (const DocbookGenerator &)
	DocbookGenerator (DocbookGenerator &&)=delete
DocbookGenerator &	operator= (DocbookGenerator &&)=delete
	~DocbookGenerator ()
OutputType	type () const override
std::unique_ptr< OutputGenIntf >	clone () override
void	addCodeGen (OutputCodeList &list) override
void	cleanup () override
void	writeDoc (const IDocNodeAST node, const Definition ctx, const MemberDef *md, int id, int sectionLevel) override
void	startFile (const DString &name, bool isSource, const DString &manName, const DString &title, int id, int hierarchyLevel) override
void	endFile () override
void	writeSearchInfo () override
void	writeFooter (const DString &) override
void	startIndexSection (IndexSection) override
void	endIndexSection (IndexSection) override
void	writePageLink (const DString &, bool) override
void	startProjectNumber () override
void	endProjectNumber () override
void	writeStyleInfo (int) override
void	startTitleHead (const DString &) override
void	endTitleHead (const DString &fileName, const DString &name) override
void	startIndexListItem () override
void	endIndexListItem () override
void	startIndexList () override
void	endIndexList () override
void	startIndexKey () override
void	endIndexKey () override
void	startIndexValue (bool) override
void	endIndexValue (const DString &, bool) override
void	startItemList () override
void	endItemList () override
void	startIndexItem (const DString &, const DString &) override
void	endIndexItem (const DString &, const DString &) override
void	startItemListItem () override
void	endItemListItem () override
void	docify (const DString &text) override
void	writeChar (char) override
void	writeString (const DString &) override
void	startParagraph (const DString &) override
void	endParagraph () override
void	writeObjectLink (const DString &, const DString &, const DString &, const DString &) override
void	startBold () override
void	endBold () override
void	startTypewriter () override
void	endTypewriter () override
void	startEmphasis () override
void	endEmphasis () override
void	writeRuler () override
void	startDescForItem () override
void	endDescForItem () override
void	startCenter () override
void	endCenter () override
void	startSmall () override
void	endSmall () override
void	startExamples () override
void	endExamples () override
void	writeAnchor (const DString &, const DString &) override
void	startSection (const DString &, const DString &, SectionType) override
void	endSection (const DString &, SectionType) override
void	lineBreak (const DString &) override
void	addIndexItem (const DString &, const DString &) override
void	writeNonBreakableSpace (int) override
void	startDescTable (const DString &title, bool hasInits) override
void	endDescTable () override
void	startDescTableRow () override
void	endDescTableRow () override
void	startDescTableTitle () override
void	endDescTableTitle () override
void	startDescTableInit () override
void	endDescTableInit () override
void	startDescTableData () override
void	endDescTableData () override
void	startTextLink (const DString &, const DString &) override
void	endTextLink () override
void	startPageRef () override
void	endPageRef (const DString &, const DString &) override
void	startGroupHeader (const DString &, int) override
void	endGroupHeader (int) override
void	startMemberSections () override
void	endMemberSections () override
void	startHeaderSection () override
void	endHeaderSection () override
void	startMemberHeader (const DString &anchor, int typ) override
void	endMemberHeader () override
void	startMemberSubtitle () override
void	endMemberSubtitle () override
void	startMemberDocList () override
void	endMemberDocList () override
void	startMemberList () override
void	endMemberList () override
void	startInlineHeader () override
void	endInlineHeader () override
void	startAnonTypeScope (int) override
void	endAnonTypeScope (int) override
void	startMemberItem (const DString &, MemberItemType, const DString &) override
void	endMemberItem (MemberItemType) override
void	startMemberTemplateParams () override
void	endMemberTemplateParams (const DString &, const DString &) override
void	startCompoundTemplateParams () override
void	endCompoundTemplateParams () override
void	startMemberGroupHeader (const DString &, bool) override
void	endMemberGroupHeader (bool) override
void	startMemberGroupDocs () override
void	endMemberGroupDocs () override
void	startMemberGroup () override
void	endMemberGroup (bool) override
void	insertMemberAlign (bool) override
void	insertMemberAlignLeft (MemberItemType, bool) override
void	startMemberDoc (const DString &, const DString &, const DString &, const DString &, int, int, bool) override
void	endMemberDoc (bool) override
void	startDoxyAnchor (const DString &fName, const DString &manName, const DString &anchor, const DString &name, const DString &args) override
void	endDoxyAnchor (const DString &fileName, const DString &anchor) override
void	addLabel (const DString &, const DString &) override
void	writeLatexSpacing () override
void	writeStartAnnoItem (const DString &, const DString &, const DString &, const DString &) override
void	startMemberDescription (const DString &, const DString &, bool) override
void	endMemberDescription () override
void	startMemberDeclaration () override
void	endMemberDeclaration (const DString &, const DString &) override
void	writeInheritedSectionTitle (const DString &, const DString &, const DString &, const DString &, const DString &, const DString &) override
void	startIndent () override
void	endIndent () override
void	writeSynopsis () override
void	startClassDiagram () override
void	endClassDiagram (const ClassDiagram &, const DString &, const DString &) override
void	startDotGraph () override
void	endDotGraph (DotClassGraph &g) override
void	startInclDepGraph () override
void	endInclDepGraph (DotInclDepGraph &g) override
void	startGroupCollaboration () override
void	endGroupCollaboration (DotGroupCollaboration &g) override
void	startCallGraph () override
void	endCallGraph (DotCallGraph &g) override
void	startDirDepGraph () override
void	endDirDepGraph (DotDirDeps &g) override
void	writeGraphicalHierarchy (DotGfxHierarchyTable &) override
void	startQuickIndices () override
void	endQuickIndices () override
void	writeSplitBar (const DString &, const DString &) override
void	writeNavigationPath (const DString &) override
void	writeLogo () override
void	writeQuickLinks (HighlightedItem, const DString &, bool) override
void	writeSummaryLink (const DString &, const DString &, const DString &, bool) override
void	writePageOutline () override
void	startContents () override
void	endContents () override
void	startPageDoc (const DString &) override
void	endPageDoc () override
void	startTextBlock (bool) override
void	endTextBlock (bool) override
void	lastIndexPage () override
void	startMemberDocPrefixItem () override
void	endMemberDocPrefixItem () override
void	startMemberDocName (bool) override
void	endMemberDocName () override
void	startParameterType (bool, const DString &) override
void	endParameterType () override
void	startParameterName (bool) override
void	endParameterName () override
void	startParameterExtra () override
void	endParameterExtra (bool, bool, bool) override
void	startParameterDefVal (const char *sep) override
void	endParameterDefVal () override
void	startParameterList (bool) override
void	endParameterList () override
void	exceptionEntry (const DString &, bool) override
void	startConstraintList (const DString &) override
void	startConstraintParam () override
void	endConstraintParam () override
void	startConstraintType () override
void	endConstraintType () override
void	startConstraintDocs () override
void	endConstraintDocs () override
void	endConstraintList () override
void	startMemberDocSimple (bool) override
void	endMemberDocSimple (bool) override
void	startInlineMemberType () override
void	endInlineMemberType () override
void	startInlineMemberName () override
void	endInlineMemberName () override
void	startInlineMemberDoc () override
void	endInlineMemberDoc () override
void	startLabels () override
void	writeLabel (const DString &, bool) override
void	endLabels () override
void	startLocalToc (int level) override
void	endLocalToc () override
void	startTocEntry (const SectionInfo *si) override
void	endTocEntry (const SectionInfo *si) override
void	startPlainFile (const DString &name) override
void	endPlainFile () override
void	startEmbeddedDoc (size_t) override
void	endEmbeddedDoc () override
Public Member Functions inherited from OutputGenerator
	OutputGenerator ()
	OutputGenerator (const DString &dir)
virtual	~OutputGenerator ()=default
DString	dir () const
DString	fileName () const
void	startPlainFile (const DString &name)
void	endPlainFile ()

Static Public Member Functions
static void	init ()
static DString	convertToDocbook (const DString &s, bool retainNewline=false, bool citeEntry=false)

Private Member Functions
void	openSection (const DString &attr=DString())
void	closeSection ()
void	closeAllSections ()

Private Attributes
DString	relPath
std::unique_ptr< OutputCodeList >	m_codeList
DocbookCodeGenerator *	m_codeGen = nullptr
bool	m_denseText = false
bool	m_inGroup = false
int	m_levelListItem = 0
std::array< bool, 20 >	m_inListItem = { false, }
std::array< bool, 20 >	m_inSimpleSect = { false, }
bool	m_descTable = false
bool	m_simpleTable = false
int	m_inLevel = -1
bool	m_firstMember = false
int	m_openSectionCount = 0
DString	m_pageLinks
TocState	m_tocState

Additional Inherited Members
Public Types inherited from OutputGenerator
enum class	ParamListTypes { Param , RetVal , Exception }
enum class	MemberItemType { Normal , AnonymousStart , AnonymousEnd , Templated }
Protected Attributes inherited from OutputGenerator
TextStream	m_t
DString	m_dir

Detailed Description

Definition at line 102 of file docbookgen.h.

Constructor & Destructor Documentation

◆ DocbookGenerator() [1/3]

DocbookGenerator::DocbookGenerator ( )

Definition at line 314 of file docbookgen.cpp.

  : OutputGenerator(Config_getString(DOCBOOK_OUTPUT))
  , m_codeList(std::make_unique<OutputCodeList>())
{
DB_GEN_C
  m_codeGen = m_codeList->add<DocbookCodeGenerator>(&m_t);
}

References Config_getString, DB_GEN_C, m_codeGen, m_codeList, OutputGenerator::m_t, and OutputGenerator::OutputGenerator().

Referenced by DocbookGenerator(), DocbookGenerator(), operator=(), and operator=().

◆ DocbookGenerator() [2/3]

DocbookGenerator::DocbookGenerator ( const DocbookGenerator & og )

Definition at line 322 of file docbookgen.cpp.

                                                             : OutputGenerator(og.m_dir), OutputGenIntf()
{
  m_codeList         = std::make_unique<OutputCodeList>(*og.m_codeList);
  m_codeGen          = m_codeList->get<DocbookCodeGenerator>(OutputType::Docbook);
  m_codeGen->setTextStream(&m_t);
  m_denseText        = og.m_denseText;
  m_inGroup          = og.m_inGroup;
  m_levelListItem    = og.m_levelListItem;
  m_inListItem       = og.m_inListItem;
  m_inSimpleSect     = og.m_inSimpleSect;
  m_descTable        = og.m_descTable;
  m_simpleTable      = og.m_simpleTable;
  m_inLevel          = og.m_inLevel;
  m_firstMember      = og.m_firstMember;
  m_openSectionCount = og.m_openSectionCount;
}

References Docbook, DocbookGenerator(), m_codeGen, m_codeList, m_denseText, m_descTable, OutputGenerator::m_dir, m_firstMember, m_inGroup, m_inLevel, m_inListItem, m_inSimpleSect, m_levelListItem, m_openSectionCount, m_simpleTable, OutputGenerator::m_t, OutputGenerator::OutputGenerator(), and DocbookCodeGenerator::setTextStream().

◆ DocbookGenerator() [3/3]

DocbookGenerator::DocbookGenerator ( DocbookGenerator && )

delete

References DocbookGenerator().

◆ ~DocbookGenerator()

DocbookGenerator::~DocbookGenerator ( )

default

Member Function Documentation

◆ addCodeGen()

void DocbookGenerator::addCodeGen ( OutputCodeList & list )

overridevirtual

Implements OutputGenIntf.

Definition at line 363 of file docbookgen.cpp.

{
  list.add<DocbookCodeGeneratorDefer>(m_codeGen);
}

References OutputCodeList::add(), and m_codeGen.

◆ addIndexItem()

void DocbookGenerator::addIndexItem	(	const DString &	prim,
		const DString &	sec )

overridevirtual

Implements OutputGenIntf.

Definition at line 1139 of file docbookgen.cpp.

{
DB_GEN_C
  addIndexTerm(m_t, prim, sec);
}

References addIndexTerm(), DB_GEN_C, and OutputGenerator::m_t.

◆ addLabel()

void DocbookGenerator::addLabel	(	const DString &	,
		const DString &	)

overridevirtual

Implements OutputGenIntf.

Definition at line 954 of file docbookgen.cpp.

{
DB_GEN_C
}

References DB_GEN_C.

◆ cleanup()

void DocbookGenerator::cleanup ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 379 of file docbookgen.cpp.

{
  DString dname = Config_getString(DOCBOOK_OUTPUT);
  Dir d(dname.str());
  clearSubDirs(d);
}

References clearSubDirs(), Config_getString, and DString::str().

◆ clone()

std::unique_ptr< OutputGenIntf > DocbookGenerator::clone ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 120 of file docbookgen.h.

120{ return std::make_unique<DocbookGenerator>(*this); }

◆ closeAllSections()

void DocbookGenerator::closeAllSections ( )

private

Definition at line 1393 of file docbookgen.cpp.

{
  while (m_openSectionCount>0)
  {
    closeSection();
  }
}

References closeSection(), and m_openSectionCount.

Referenced by endFile().

◆ closeSection()

void DocbookGenerator::closeSection ( )

private

Definition at line 1387 of file docbookgen.cpp.

{
   m_t << "</section>\n";
   m_openSectionCount--;
}

References m_openSectionCount, and OutputGenerator::m_t.

Referenced by closeAllSections(), endSection(), startDoxyAnchor(), startGroupHeader(), and writeRuler().

◆ convertToDocbook()

DString DocbookGenerator::convertToDocbook	(	const DString &	s,
		bool	retainNewline = false,
		bool	citeEntry = false )

static

Converts a string to an DocBook-encoded string

Definition at line 1477 of file docbookgen.cpp.

{
  if (s.empty()) return s;
  DString result;
  result.reserve(s.length()+32);
  const char *p = s.data();
  char c = 0;
  while ((c=*p++))
  {
    switch (c)
    {
      case '\n':
        if (retainNewline)
        {
          result+="<literallayout>&#160;&#xa;</literallayout>";
          result+=c;
        }
        break;
      case '<':  result+="&lt;";   break;
      case '>':  result+="&gt;";   break;
      case '&':  // possibility to have a special symbol
        p = HtmlEntityMapper::instance().writeHtmlEntity(
            result,
            p-1,
            [](HtmlEntityMapper::SymType symType) { return HtmlEntityMapper::instance().docbook(symType); },
            "&amp;");
        break;
      case '\'': result+="&apos;"; break;
      case '"':  result+="&quot;"; break;
      case  1: case  2: case  3: case  4: case  5: case  6: case 7:  case  8:
      case 11: case 12: case 14: case 15: case 16: case 17: case 18:
      case 19: case 20: case 21: case 22: case 23: case 24: case 25: case 26:
      case 27: case 28: case 29: case 30: case 31:
        result+="&#x24";
        result+=hex[static_cast<uint8_t>(c)>>4];
        result+=hex[static_cast<uint8_t>(c)&0xF];
        result+=';';
        break;
      default:
        result+=c;
        break;
    }
  }
  return result;
}

References DString::data(), HtmlEntityMapper::docbook(), DString::empty(), hex, HtmlEntityMapper::instance(), DString::length(), DString::reserve(), and HtmlEntityMapper::writeHtmlEntity().

Referenced by addIndexTerm(), docify(), DocbookDocVisitor::filter(), objectLinkToString(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), startDescTable(), startIndexSection(), startMemberDoc(), startMemberDocSimple(), startTocEntry(), DocbookDocVisitor::visitPreStart(), writeDocbookString(), and writeInheritedSectionTitle().

◆ docify()

void DocbookGenerator::docify ( const DString & text )

overridevirtual

Implements OutputGenIntf.

Definition at line 761 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << convertToDocbook(str);
}

References convertToDocbook(), DB_GEN_C, and OutputGenerator::m_t.

Referenced by startConstraintList(), startExamples(), and writeChar().

◆ endAnonTypeScope()

void DocbookGenerator::endAnonTypeScope ( int )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 212 of file docbookgen.h.

212{DB_GEN_EMPTY}

DB_GEN_EMPTY

#define DB_GEN_EMPTY

Definition docbookgen.h:25

References DB_GEN_EMPTY.

◆ endBold()

void DocbookGenerator::endBold ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 823 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "</emphasis>";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ endCallGraph()

void DocbookGenerator::endCallGraph ( DotCallGraph & g )

overridevirtual

Implements OutputGenIntf.

Definition at line 1316 of file docbookgen.cpp.

{
DB_GEN_C
  DString fn = g.writeGraph(m_t,GraphOutputFormat::BITMAP,EmbeddedOutputFormat::DocBook,dir(),fileName(),relPath,false);
}

References BITMAP, DB_GEN_C, OutputGenerator::dir(), DocBook, OutputGenerator::fileName(), OutputGenerator::m_t, relPath, and DotCallGraph::writeGraph().

◆ endCenter()

void DocbookGenerator::endCenter ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 168 of file docbookgen.h.

168{DB_GEN_NEW}

DB_GEN_NEW

#define DB_GEN_NEW

Definition docbookgen.h:41

References DB_GEN_NEW.

◆ endClassDiagram()

void DocbookGenerator::endClassDiagram	(	const ClassDiagram &	d,
		const DString &	fileName,
		const DString &	)

overridevirtual

Implements OutputGenIntf.

Definition at line 992 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "    <informalfigure>\n";
  m_t << "        <mediaobject>\n";
  m_t << "            <imageobject>\n";
  m_t << "                <imagedata width=\"50%\" align=\"center\" valign=\"middle\" scalefit=\"0\" fileref=\""
                         << relPath << fileName << ".png\">" << "</imagedata>\n";
  m_t << "            </imageobject>\n";
  d.writeImage(m_t,dir(),relPath,fileName,false,false);
  m_t << "        </mediaobject>\n";
  m_t << "    </informalfigure>\n";
  m_t << "</para>\n";
}

References DB_GEN_C, OutputGenerator::dir(), OutputGenerator::fileName(), OutputGenerator::m_t, relPath, and ClassDiagram::writeImage().

◆ endCompoundTemplateParams()

void DocbookGenerator::endCompoundTemplateParams ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1040 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "</title></simplesect>\n";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ endConstraintDocs()

void DocbookGenerator::endConstraintDocs ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1369 of file docbookgen.cpp.

{
DB_GEN_C
}

References DB_GEN_C.

◆ endConstraintList()

void DocbookGenerator::endConstraintList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1373 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "</simplesect>\n";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ endConstraintParam()

void DocbookGenerator::endConstraintParam ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1351 of file docbookgen.cpp.

{
DB_GEN_C
}

References DB_GEN_C.

◆ endConstraintType()

void DocbookGenerator::endConstraintType ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1360 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "</emphasis></para>\n";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ endContents()

void DocbookGenerator::endContents ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 270 of file docbookgen.h.

270{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ endDescForItem()

void DocbookGenerator::endDescForItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 166 of file docbookgen.h.

166{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ endDescTable()

void DocbookGenerator::endDescTable ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1231 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "    </tbody>\n";
  m_t << "    </tgroup>\n";
  m_t << "</informaltable>\n";
  m_descTable = false;
}

References DB_GEN_C, m_descTable, and OutputGenerator::m_t.

◆ endDescTableData()

void DocbookGenerator::endDescTableData ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1280 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "</entry>";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ endDescTableInit()

void DocbookGenerator::endDescTableInit ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1269 of file docbookgen.cpp.

{
DB_GEN_C
}

References DB_GEN_C.

◆ endDescTableRow()

void DocbookGenerator::endDescTableRow ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1247 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "</row>";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ endDescTableTitle()

void DocbookGenerator::endDescTableTitle ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1258 of file docbookgen.cpp.

{
DB_GEN_C
}

References DB_GEN_C.

◆ endDirDepGraph()

void DocbookGenerator::endDirDepGraph ( DotDirDeps & g )

overridevirtual

Implements OutputGenIntf.

Definition at line 1325 of file docbookgen.cpp.

{
DB_GEN_C
  DString fn = g.writeGraph(m_t,GraphOutputFormat::BITMAP,EmbeddedOutputFormat::DocBook,dir(),fileName(),relPath,false);
}

References BITMAP, DB_GEN_C, OutputGenerator::dir(), DocBook, OutputGenerator::fileName(), OutputGenerator::m_t, relPath, and DotDirDeps::writeGraph().

◆ endDotGraph()

void DocbookGenerator::endDotGraph ( DotClassGraph & g )

overridevirtual

Implements OutputGenIntf.

Definition at line 1298 of file docbookgen.cpp.

{
DB_GEN_C
  g.writeGraph(m_t,GraphOutputFormat::BITMAP,EmbeddedOutputFormat::DocBook,dir(),fileName(),relPath,true,false);
}

References BITMAP, DB_GEN_C, OutputGenerator::dir(), DocBook, OutputGenerator::fileName(), OutputGenerator::m_t, relPath, and DotClassGraph::writeGraph().

◆ endDoxyAnchor()

void DocbookGenerator::endDoxyAnchor	(	const DString &	fileName,
		const DString &	anchor )

overridevirtual

Implements OutputGenIntf.

Definition at line 950 of file docbookgen.cpp.

{
DB_GEN_C
}

References DB_GEN_C.

◆ endEmbeddedDoc()

void DocbookGenerator::endEmbeddedDoc ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 323 of file docbookgen.h.

323{}

◆ endEmphasis()

void DocbookGenerator::endEmphasis ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 163 of file docbookgen.h.

163{DB_GEN_NEW}

References DB_GEN_NEW.

◆ endExamples()

void DocbookGenerator::endExamples ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1030 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "</simplesect>\n";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ endFile()

void DocbookGenerator::endFile ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 418 of file docbookgen.cpp.

{
DB_GEN_C
  closeAllSections();
  m_inLevel = -1;
  m_inGroup = false;
 
  // Write page links only after all sections have been closed to avoid bugs
  m_t << m_pageLinks;
 
  DString fileType="section";
  DString fileName= m_codeGen->sourceFileName();
  if (fileName == "index.xml")
  {
    fileType="book";
  }
  else if (fileName == "mainpage.xml")
  {
    fileType="chapter";
  }
  m_t << "</" << fileType << ">\n";
  endPlainFile();
  m_codeGen->setSourceFileName("");
}

References closeAllSections(), DB_GEN_C, endPlainFile(), OutputGenerator::fileName(), m_codeGen, m_inGroup, m_inLevel, m_pageLinks, OutputGenerator::m_t, DocbookCodeGenerator::setSourceFileName(), and DocbookCodeGenerator::sourceFileName().

◆ endGroupCollaboration()

void DocbookGenerator::endGroupCollaboration ( DotGroupCollaboration & g )

overridevirtual

Implements OutputGenIntf.

Definition at line 1289 of file docbookgen.cpp.

{
DB_GEN_C
  g.writeGraph(m_t,GraphOutputFormat::BITMAP,EmbeddedOutputFormat::DocBook,dir(),fileName(),relPath,false);
}

References BITMAP, DB_GEN_C, OutputGenerator::dir(), DocBook, OutputGenerator::fileName(), OutputGenerator::m_t, relPath, and DotGroupCollaboration::writeGraph().

◆ endGroupHeader()

void DocbookGenerator::endGroupHeader ( int )

overridevirtual

Implements OutputGenIntf.

Definition at line 849 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "</title>\n";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ endHeaderSection()

void DocbookGenerator::endHeaderSection ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 200 of file docbookgen.h.

200{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ endInclDepGraph()

void DocbookGenerator::endInclDepGraph ( DotInclDepGraph & g )

overridevirtual

Implements OutputGenIntf.

Definition at line 1307 of file docbookgen.cpp.

{
DB_GEN_C
  DString fn = g.writeGraph(m_t,GraphOutputFormat::BITMAP,EmbeddedOutputFormat::DocBook,dir(),fileName(),relPath,false);
}

References BITMAP, DB_GEN_C, OutputGenerator::dir(), DocBook, OutputGenerator::fileName(), OutputGenerator::m_t, relPath, and DotInclDepGraph::writeGraph().

◆ endIndent()

void DocbookGenerator::endIndent ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 246 of file docbookgen.h.

246{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ endIndexItem()

void DocbookGenerator::endIndexItem	(	const DString &	,
		const DString &	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 149 of file docbookgen.h.

149{DB_GEN_NEW}

References DB_GEN_NEW.

◆ endIndexKey()

void DocbookGenerator::endIndexKey ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 142 of file docbookgen.h.

142{DB_GEN_NEW}

References DB_GEN_NEW.

◆ endIndexList()

void DocbookGenerator::endIndexList ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 140 of file docbookgen.h.

140{DB_GEN_NEW}

References DB_GEN_NEW.

◆ endIndexListItem()

void DocbookGenerator::endIndexListItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 138 of file docbookgen.h.

138{DB_GEN_NEW}

References DB_GEN_NEW.

◆ endIndexSection()

void DocbookGenerator::endIndexSection ( IndexSection is )

overridevirtual

Implements OutputGenIntf.

Definition at line 528 of file docbookgen.cpp.

{
DB_GEN_C2("IndexSection " << is)
  switch (is)
  {
    case IndexSection::isTitlePageStart:
      break;
    case IndexSection::isTitlePageAuthor:
      break;
    case IndexSection::isMainPage:
      {
        if (Doxygen::mainPage)
        {
          writePageLink(DString("mainpage"), true);
        }
      }
      break;
    case IndexSection::isModuleIndex:
      //m_t << "</chapter>\n";
      break;
    case IndexSection::isTopicIndex:
      //m_t << "</chapter>\n";
      break;
    case IndexSection::isDirIndex:
      //m_t << "<xi:include href=\"dirs.xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>";
      //m_t << "</chapter>\n";
      break;
    case IndexSection::isNamespaceIndex:
      //m_t << "<xi:include href=\"namespaces.xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>";
      //m_t << "</chapter>\n";
      break;
    case IndexSection::isConceptIndex:
      //m_t << "<xi:include href=\"concepts.xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>";
      //m_t << "</chapter>\n";
      break;
    case IndexSection::isClassHierarchyIndex:
      //m_t << "<xi:include href=\"hierarchy.xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>";
      //m_t << "</chapter>\n";
      break;
    case IndexSection::isCompoundIndex:
      //m_t << "</chapter>\n";
      break;
    case IndexSection::isFileIndex:
      //m_t << "<xi:include href=\"files.xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>";
      //m_t << "</chapter>\n";
      break;
    case IndexSection::isPageIndex:
      //m_t << "<xi:include href=\"pages.xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>";
      //m_t << "</chapter>\n";
      break;
    case IndexSection::isTopicDocumentation:
      {
        m_t << "</title>\n";
        for (const auto &gd : *Doxygen::groupLinkedMap)
        {
          if (!gd->isReference() && !gd->isASubGroup())
          {
            writePageLink(gd->getOutputFileBase(), true);
          }
        }
      }
      m_t << "</chapter>\n";
      break;
    case IndexSection::isModuleDocumentation:
      {
        m_t << "</title>\n";
        for (const auto &mod : ModuleManager::instance().modules())
        {
          if (!mod->isReference() && mod->isPrimaryInterface())
          {
            writePageLink(mod->getOutputFileBase(), true);
          }
        }
      }
      m_t << "</chapter>\n";
      break;
      break;
    case IndexSection::isDirDocumentation:
      {
        m_t << "</title>\n";
        for (const auto &dd : *Doxygen::dirLinkedMap)
        {
          if (dd->isLinkableInProject())
          {
            m_t << "    <xi:include href=\"" << dd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>\n";
          }
        }
      }
      m_t << "</chapter>\n";
      break;
    case IndexSection::isNamespaceDocumentation:
      {
        m_t << "</title>\n";
        for (const auto &nd : *Doxygen::namespaceLinkedMap)
        {
          if (nd->isLinkableInProject() && !nd->isAlias())
          {
            m_t << "    <xi:include href=\"" << nd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>\n";
          }
        }
      }
      m_t << "</chapter>\n";
      break;
    case IndexSection::isConceptDocumentation:
      {
        m_t << "</title>\n";
        for (const auto &cd : *Doxygen::conceptLinkedMap)
        {
          if (cd->isLinkableInProject() && !cd->isAlias())
          {
            m_t << "    <xi:include href=\"" << cd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>\n";
          }
        }
      }
      m_t << "</chapter>\n";
      break;
    case IndexSection::isClassDocumentation:
      {
        m_t << "</title>\n";
        for (const auto &cd : *Doxygen::classLinkedMap)
        {
          if (cd->isLinkableInProject() &&
             !cd->isImplicitTemplateInstance() &&
             !cd->isEmbeddedInOuterScope() &&
             !cd->isAlias()
             )
          {
            m_t << "    <xi:include href=\"" << cd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>\n";
          }
        }
      }
      m_t << "</chapter>\n";
      break;
    case IndexSection::isFileDocumentation:
      {
        m_t << "</title>\n";
        for (const auto &fn : *Doxygen::inputNameLinkedMap)
        {
          for (const auto &fd : *fn)
          {
            if (fd->isLinkableInProject())
            {
              m_t << "    <xi:include href=\"" << fd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>\n";
            }
            if (fd->generateSourceFile())
            {
              m_t << "    <xi:include href=\"" << fd->getSourceFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>\n";
            }
          }
        }
      }
      m_t << "</chapter>\n";
      break;
    case IndexSection::isExampleDocumentation:
      {
        m_t << "</title>\n";
        for (const auto &pd : *Doxygen::exampleLinkedMap)
        {
          m_t << "    <xi:include href=\"" << pd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>\n";
        }
      }
      m_t << "</chapter>\n";
      break;
    case IndexSection::isPageDocumentation:
        for (const auto &pd : *Doxygen::pageLinkedMap)
        {
          if (!pd->getGroupDef() && !pd->isReference() && !pd->hasParentPage()
            && Doxygen::mainPage.get() != pd.get())
          {
            writePageLink(pd->getOutputFileBase(), true);
          }
        }
      break;
    case IndexSection::isPageDocumentation2:
      break;
    case IndexSection::isEndIndex:
      m_t << "<index/>\n";
      break;
  }
}

References Doxygen::classLinkedMap, Doxygen::conceptLinkedMap, DB_GEN_C2, Doxygen::dirLinkedMap, Doxygen::exampleLinkedMap, Doxygen::groupLinkedMap, Doxygen::inputNameLinkedMap, ModuleManager::instance(), isClassDocumentation, isClassHierarchyIndex, isCompoundIndex, isConceptDocumentation, isConceptIndex, isDirDocumentation, isDirIndex, isEndIndex, isExampleDocumentation, isFileDocumentation, isFileIndex, isMainPage, isModuleDocumentation, isModuleIndex, isNamespaceDocumentation, isNamespaceIndex, isPageDocumentation, isPageDocumentation2, isPageIndex, isTitlePageAuthor, isTitlePageStart, isTopicDocumentation, isTopicIndex, OutputGenerator::m_t, Doxygen::mainPage, Doxygen::namespaceLinkedMap, Doxygen::pageLinkedMap, and writePageLink().

◆ endIndexValue()

void DocbookGenerator::endIndexValue	(	const DString &	,
		bool	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 144 of file docbookgen.h.

144{DB_GEN_NEW}

References DB_GEN_NEW.

◆ endInlineHeader()

void DocbookGenerator::endInlineHeader ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 210 of file docbookgen.h.

210{DB_GEN_NEW}

References DB_GEN_NEW.

◆ endInlineMemberDoc()

void DocbookGenerator::endInlineMemberDoc ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1210 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "</entry></row>\n";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ endInlineMemberName()

void DocbookGenerator::endInlineMemberName ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1198 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "</entry>";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ endInlineMemberType()

void DocbookGenerator::endInlineMemberType ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1186 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "</entry>";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ endItemList()

void DocbookGenerator::endItemList ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 146 of file docbookgen.h.

146{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ endItemListItem()

void DocbookGenerator::endItemListItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 151 of file docbookgen.h.

151{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ endLabels()

void DocbookGenerator::endLabels ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1018 of file docbookgen.cpp.

{
DB_GEN_C
}

References DB_GEN_C.

◆ endLocalToc()

void DocbookGenerator::endLocalToc ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1419 of file docbookgen.cpp.

{
  if (m_tocState.level > m_tocState.maxLevel) m_tocState.level = m_tocState.maxLevel;
  while (m_tocState.level>1 && m_tocState.level <= m_tocState.maxLevel)
  {
    m_t << "</tocdiv>\n";
    m_tocState.level--;
  }
  m_t << "    </toc>\n";
}

References DocbookGenerator::TocState::level, OutputGenerator::m_t, m_tocState, and DocbookGenerator::TocState::maxLevel.

◆ endMemberDeclaration()

void DocbookGenerator::endMemberDeclaration	(	const DString &	,
		const DString &	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 241 of file docbookgen.h.

241{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ endMemberDescription()

void DocbookGenerator::endMemberDescription ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 239 of file docbookgen.h.

239{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ endMemberDoc()

void DocbookGenerator::endMemberDoc ( bool )

overridevirtual

Implements OutputGenIntf.

Definition at line 919 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "</computeroutput></para>";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ endMemberDocList()

void DocbookGenerator::endMemberDocList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1334 of file docbookgen.cpp.

{
DB_GEN_C
  m_inGroup = true;
}

References DB_GEN_C, and m_inGroup.

◆ endMemberDocName()

void DocbookGenerator::endMemberDocName ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 963 of file docbookgen.cpp.

{
DB_GEN_C
}

References DB_GEN_C.

◆ endMemberDocPrefixItem()

void DocbookGenerator::endMemberDocPrefixItem ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1058 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "</computeroutput>";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ endMemberDocSimple()

void DocbookGenerator::endMemberDocSimple ( bool )

overridevirtual

Implements OutputGenIntf.

Definition at line 1171 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "    </tbody>\n";
  m_t << "    </tgroup>\n";
  m_t << "</table>\n";
  m_simpleTable = false;
}

References DB_GEN_C, m_simpleTable, and OutputGenerator::m_t.

◆ endMemberGroup()

void DocbookGenerator::endMemberGroup ( bool )

overridevirtual

Implements OutputGenIntf.

Definition at line 981 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "</simplesect>\n";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ endMemberGroupDocs()

void DocbookGenerator::endMemberGroupDocs ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 222 of file docbookgen.h.

222{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ endMemberGroupHeader()

void DocbookGenerator::endMemberGroupHeader ( bool )

overridevirtual

Implements OutputGenIntf.

Definition at line 972 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "</title>\n";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ endMemberHeader()

void DocbookGenerator::endMemberHeader ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 756 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "    </title>\n";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ endMemberItem()

void DocbookGenerator::endMemberItem ( MemberItemType )

overridevirtual

Implements OutputGenIntf.

Definition at line 813 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "</para>\n";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ endMemberList()

void DocbookGenerator::endMemberList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 796 of file docbookgen.cpp.

{
DB_GEN_C
  if (m_inListItem[m_levelListItem]) m_t << "</listitem>\n";
  m_inListItem[m_levelListItem] = false;
  m_t << "        </itemizedlist>\n";
  m_levelListItem = (m_levelListItem> 0 ?  m_levelListItem - 1 : 0);
  if (m_inSimpleSect[m_levelListItem]) m_t << "</simplesect>\n";
  m_inSimpleSect[m_levelListItem] = false;
}

References DB_GEN_C, m_inListItem, m_inSimpleSect, m_levelListItem, and OutputGenerator::m_t.

◆ endMemberSections()

void DocbookGenerator::endMemberSections ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 198 of file docbookgen.h.

198{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ endMemberSubtitle()

void DocbookGenerator::endMemberSubtitle ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 204 of file docbookgen.h.

204{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ endMemberTemplateParams()

void DocbookGenerator::endMemberTemplateParams	(	const DString &	,
		const DString &	)

overridevirtual

Implements OutputGenIntf.

Definition at line 1121 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "</para>";
  m_t << "<para>";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ endPageDoc()

void DocbookGenerator::endPageDoc ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 272 of file docbookgen.h.

272{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ endPageRef()

void DocbookGenerator::endPageRef	(	const DString &	,
		const DString &	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 193 of file docbookgen.h.

193{DB_GEN_NEW}

References DB_GEN_NEW.

◆ endParagraph()

void DocbookGenerator::endParagraph ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 738 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "</para>\n";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ endParameterDefVal()

void DocbookGenerator::endParameterDefVal ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1110 of file docbookgen.cpp.

{
DB_GEN_C
  if (!m_denseText) m_t << "</computeroutput>\n";
}

References DB_GEN_C, m_denseText, and OutputGenerator::m_t.

◆ endParameterExtra()

void DocbookGenerator::endParameterExtra	(	bool	last,
		bool	,
		bool	closeBracket )

overridevirtual

Implements OutputGenIntf.

Definition at line 1093 of file docbookgen.cpp.

{
DB_GEN_C
  if (last && closeBracket)
  {
    m_t << ")";
  }
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ endParameterList()

void DocbookGenerator::endParameterList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 860 of file docbookgen.cpp.

{
DB_GEN_C
}

References DB_GEN_C.

◆ endParameterName()

void DocbookGenerator::endParameterName ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1083 of file docbookgen.cpp.

{
DB_GEN_C
}

References DB_GEN_C.

◆ endParameterType()

void DocbookGenerator::endParameterType ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 281 of file docbookgen.h.

281{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ endPlainFile()

void DocbookGenerator::endPlainFile ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 320 of file docbookgen.h.

320{ OutputGenerator::endPlainFile(); }

OutputGenerator::endPlainFile

void endPlainFile()

Definition outputgen.cpp:40

References OutputGenerator::endPlainFile().

Referenced by endFile().

◆ endProjectNumber()

void DocbookGenerator::endProjectNumber ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 133 of file docbookgen.h.

133{DB_GEN_NEW}

References DB_GEN_NEW.

◆ endQuickIndices()

void DocbookGenerator::endQuickIndices ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 262 of file docbookgen.h.

262{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ endSection()

void DocbookGenerator::endSection	(	const DString &	,
		SectionType	)

overridevirtual

Implements OutputGenIntf.

Definition at line 1133 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "</title>";
  closeSection();
}

References closeSection(), DB_GEN_C, and OutputGenerator::m_t.

◆ endSmall()

void DocbookGenerator::endSmall ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 170 of file docbookgen.h.

170{DB_GEN_NEW}

References DB_GEN_NEW.

◆ endTextBlock()

void DocbookGenerator::endTextBlock ( bool )

overridevirtual

Implements OutputGenIntf.

Definition at line 893 of file docbookgen.cpp.

{
DB_GEN_C
  if (m_denseText)
  {
    m_denseText = false;
    m_t << "</programlisting>";
  }
}

References DB_GEN_C, m_denseText, and OutputGenerator::m_t.

◆ endTextLink()

void DocbookGenerator::endTextLink ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 191 of file docbookgen.h.

191{DB_GEN_NEW}

References DB_GEN_NEW.

◆ endTitleHead()

void DocbookGenerator::endTitleHead	(	const DString &	fileName,
		const DString &	name )

overridevirtual

Implements OutputGenIntf.

Definition at line 929 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "</title>\n";
  if (!name.empty()) addIndexTerm(m_t, name);
}

References addIndexTerm(), DB_GEN_C, DString::empty(), and OutputGenerator::m_t.

◆ endTocEntry()

void DocbookGenerator::endTocEntry ( const SectionInfo * si )

overridevirtual

Implements OutputGenIntf.

Definition at line 1460 of file docbookgen.cpp.

{
  SectionType type = si->type();
  int nextLevel = type.level();
  if (type.isSection() && nextLevel <= m_tocState.maxLevel)
  {
    m_t << "</tocentry>\n";
    m_tocState.inLi[nextLevel]=true;
    m_tocState.level = nextLevel;
  }
}

References DocbookGenerator::TocState::inLi, SectionType::isSection(), DocbookGenerator::TocState::level, SectionType::level(), OutputGenerator::m_t, m_tocState, DocbookGenerator::TocState::maxLevel, type(), and SectionInfo::type().

◆ endTypewriter()

void DocbookGenerator::endTypewriter ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 879 of file docbookgen.cpp.

{
DB_GEN_C
  if (!m_denseText) m_t << "</computeroutput>\n";
}

References DB_GEN_C, m_denseText, and OutputGenerator::m_t.

◆ exceptionEntry()

void DocbookGenerator::exceptionEntry	(	const DString &	prefix,
		bool	closeBracket )

overridevirtual

Implements OutputGenIntf.

Definition at line 1063 of file docbookgen.cpp.

{
DB_GEN_C
  if (!prefix.empty())
  {
    m_t << " " << prefix << "(";
  }
  else if (closeBracket)
  {
    m_t << ")";
  }
  m_t << " ";
}

References DB_GEN_C, OutputGenerator::m_t, and prefix.

◆ init()

void DocbookGenerator::init ( )

static

Definition at line 368 of file docbookgen.cpp.

{
  DString dir=Config_getString(DOCBOOK_OUTPUT);
  Dir d(dir.str());
  if (!d.exists() && !d.mkdir(dir.str()))
  {
    term("Could not create output directory {}\n",dir);
  }
 
  createSubDirs(d);
}

References Config_getString, createSubDirs(), OutputGenerator::dir(), Dir::exists(), Dir::mkdir(), DString::str(), and term.

Referenced by generateOutput().

◆ insertMemberAlign()

void DocbookGenerator::insertMemberAlign ( bool )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 225 of file docbookgen.h.

225{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ insertMemberAlignLeft()

void DocbookGenerator::insertMemberAlignLeft	(	MemberItemType	,
		bool	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 226 of file docbookgen.h.

226{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ lastIndexPage()

void DocbookGenerator::lastIndexPage ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 275 of file docbookgen.h.

275{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ lineBreak()

void DocbookGenerator::lineBreak ( const DString & )

overridevirtual

Implements OutputGenIntf.

Definition at line 869 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "<?linebreak?>";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ openSection()

void DocbookGenerator::openSection ( const DString & attr = DString() )

private

Definition at line 1379 of file docbookgen.cpp.

{
   m_t << "<section";
   if (!attr.empty()) m_t << " " << attr;
   m_t << ">\n";
   m_openSectionCount++;
}

References DString::empty(), m_openSectionCount, and OutputGenerator::m_t.

Referenced by startGroupHeader(), startMemberDoc(), and startSection().

◆ operator=() [1/2]

DocbookGenerator & DocbookGenerator::operator= ( const DocbookGenerator & og )

Definition at line 339 of file docbookgen.cpp.

{
  if (this!=&og)
  {
    m_dir              = og.m_dir;
    m_codeList         = std::make_unique<OutputCodeList>(*og.m_codeList);
    m_codeGen          = m_codeList->get<DocbookCodeGenerator>(OutputType::Docbook);
    m_codeGen->setTextStream(&m_t);
    m_denseText        = og.m_denseText;
    m_inGroup          = og.m_inGroup;
    m_levelListItem    = og.m_levelListItem;
    m_inListItem       = og.m_inListItem;
    m_inSimpleSect     = og.m_inSimpleSect;
    m_descTable        = og.m_descTable;
    m_simpleTable      = og.m_simpleTable;
    m_inLevel          = og.m_inLevel;
    m_firstMember      = og.m_firstMember;
    m_openSectionCount = og.m_openSectionCount;
  }
  return *this;
}

References Docbook, DocbookGenerator(), m_codeGen, m_codeList, m_denseText, m_descTable, OutputGenerator::m_dir, m_firstMember, m_inGroup, m_inLevel, m_inListItem, m_inSimpleSect, m_levelListItem, m_openSectionCount, m_simpleTable, OutputGenerator::m_t, and DocbookCodeGenerator::setTextStream().

◆ operator=() [2/2]

DocbookGenerator & DocbookGenerator::operator= ( DocbookGenerator && )

delete

References DocbookGenerator().

◆ startAnonTypeScope()

void DocbookGenerator::startAnonTypeScope ( int )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 211 of file docbookgen.h.

211{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ startBold()

void DocbookGenerator::startBold ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 818 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "<emphasis role=\"strong\">";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ startCallGraph()

void DocbookGenerator::startCallGraph ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1312 of file docbookgen.cpp.

{
DB_GEN_C
}

References DB_GEN_C.

◆ startCenter()

void DocbookGenerator::startCenter ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 167 of file docbookgen.h.

167{DB_GEN_NEW}

References DB_GEN_NEW.

◆ startClassDiagram()

void DocbookGenerator::startClassDiagram ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 986 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "<para>";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ startCompoundTemplateParams()

void DocbookGenerator::startCompoundTemplateParams ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1035 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "<simplesect><title>";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ startConstraintDocs()

void DocbookGenerator::startConstraintDocs ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1365 of file docbookgen.cpp.

{
DB_GEN_C
}

References DB_GEN_C.

◆ startConstraintList()

void DocbookGenerator::startConstraintList ( const DString & header )

overridevirtual

Implements OutputGenIntf.

Definition at line 1339 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "<simplesect><title>";
  docify(header);
  m_t << "</title>\n";
}

References DB_GEN_C, docify(), and OutputGenerator::m_t.

◆ startConstraintParam()

void DocbookGenerator::startConstraintParam ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1346 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "<para><emphasis role=\"strong\">";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ startConstraintType()

void DocbookGenerator::startConstraintType ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1355 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << ":";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ startContents()

void DocbookGenerator::startContents ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 269 of file docbookgen.h.

269{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ startDescForItem()

void DocbookGenerator::startDescForItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 165 of file docbookgen.h.

165{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ startDescTable()

void DocbookGenerator::startDescTable	(	const DString &	title,
		bool	hasInits )

overridevirtual

Implements OutputGenIntf.

Definition at line 1216 of file docbookgen.cpp.

{
DB_GEN_C
  int ncols = (hasInits?3:2);
  m_t << "<informaltable frame=\"all\">\n";
  if (!title.empty()) m_t << "<title>" << convertToDocbook(title) << "</title>\n";
  m_t << "    <tgroup cols=\"" << ncols << "\" align=\"left\" colsep=\"1\" rowsep=\"1\">\n";
  int i = 1;
  m_t << "      <colspec colname='c" << i++ << "'/>\n";
  if (hasInits) m_t << "      <colspec colname='c" << i++ << "' align='right'/>\n";
  m_t << "      <colspec colname='c" << i++ << "'/>\n";
  m_t << "<tbody>\n";
  m_descTable = true;
}

References convertToDocbook(), DB_GEN_C, DString::empty(), m_descTable, and OutputGenerator::m_t.

◆ startDescTableData()

void DocbookGenerator::startDescTableData ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1274 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "</entry><entry>";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ startDescTableInit()

void DocbookGenerator::startDescTableInit ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1263 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "</entry><entry>";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ startDescTableRow()

void DocbookGenerator::startDescTableRow ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1240 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "<row>";
  m_t << "<entry>";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ startDescTableTitle()

void DocbookGenerator::startDescTableTitle ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1253 of file docbookgen.cpp.

{
DB_GEN_C
}

References DB_GEN_C.

◆ startDirDepGraph()

void DocbookGenerator::startDirDepGraph ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1321 of file docbookgen.cpp.

{
DB_GEN_C
}

References DB_GEN_C.

◆ startDotGraph()

void DocbookGenerator::startDotGraph ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1294 of file docbookgen.cpp.

{
DB_GEN_C
}

References DB_GEN_C.

◆ startDoxyAnchor()

void DocbookGenerator::startDoxyAnchor	(	const DString &	fName,
		const DString &	manName,
		const DString &	anchor,
		const DString &	name,
		const DString &	args )

overridevirtual

Implements OutputGenIntf.

Definition at line 935 of file docbookgen.cpp.

{
DB_GEN_C
  if (!m_inListItem[m_levelListItem] && !m_descTable && !m_simpleTable)
  {
    if (!m_firstMember) closeSection();
    m_firstMember = false;
  }
  if (!anchor.empty())
  {
    m_t << "<anchor xml:id=\"_" << stripPath(fName) << "_1" << anchor << "\"/>";
  }
}

References closeSection(), DB_GEN_C, DString::empty(), m_descTable, m_firstMember, m_inListItem, m_levelListItem, m_simpleTable, OutputGenerator::m_t, and stripPath().

◆ startEmbeddedDoc()

void DocbookGenerator::startEmbeddedDoc ( size_t )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 322 of file docbookgen.h.

322{}

◆ startEmphasis()

void DocbookGenerator::startEmphasis ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 162 of file docbookgen.h.

162{DB_GEN_NEW}

References DB_GEN_NEW.

◆ startExamples()

void DocbookGenerator::startExamples ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1022 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "<simplesect><title>";
  docify(theTranslator->trExamples());
  m_t << "</title>";
}

References DB_GEN_C, docify(), OutputGenerator::m_t, theTranslator, and Translator::trExamples().

◆ startFile()

void DocbookGenerator::startFile	(	const DString &	name,
		bool	isSource,
		const DString &	manName,
		const DString &	title,
		int	id,
		int	hierarchyLevel )

overridevirtual

Implements OutputGenIntf.

Definition at line 387 of file docbookgen.cpp.

{
DB_GEN_C
  DString fileName=name;
  DString pageName;
  DString fileType="section";
  if (fileName == "refman")
  {
    fileName="index";
    fileType="book";
  }
  else if (fileName == "index")
  {
    fileName="mainpage";
    fileType="chapter";
  }
  pageName = fileName;
  relPath = relativePathToRoot(fileName);
  if (!fileName.endsWith(".xml")) fileName+=".xml";
  startPlainFile(fileName);
  m_codeGen->setRelativePath(relPath);
  m_codeGen->setSourceFileName(stripPath(fileName));
  m_pageLinks = DString();
 
  m_t << "<?xml version='1.0' encoding='UTF-8' standalone='no'?>\n";
  m_t << "<" << fileType << " xmlns=\"http://docbook.org/ns/docbook\" version=\"5.0\" xmlns:xlink=\"http://www.w3.org/1999/xlink\"";
  if (!pageName.empty()) m_t << " xml:id=\"_" <<  stripPath(pageName) << "\"";
  m_t << " xml:lang=\"" << theTranslator->trISOLang() << "\"";
  m_t << ">\n";
}

References DB_GEN_C, DString::empty(), OutputGenerator::fileName(), m_codeGen, m_pageLinks, OutputGenerator::m_t, relativePathToRoot(), relPath, DocbookCodeGenerator::setRelativePath(), DocbookCodeGenerator::setSourceFileName(), startPlainFile(), stripPath(), theTranslator, and Translator::trISOLang().

◆ startGroupCollaboration()

void DocbookGenerator::startGroupCollaboration ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1285 of file docbookgen.cpp.

{
DB_GEN_C
}

References DB_GEN_C.

◆ startGroupHeader()

void DocbookGenerator::startGroupHeader	(	const DString &	,
		int	extraIndentLevel )

overridevirtual

Implements OutputGenIntf.

Definition at line 828 of file docbookgen.cpp.

{
DB_GEN_C2("m_inLevel " << m_inLevel)
DB_GEN_C2("extraIndentLevel " << extraIndentLevel)
  m_firstMember = true;
  if (m_inSimpleSect[m_levelListItem]) m_t << "</simplesect>\n";
  m_inSimpleSect[m_levelListItem] = false;
  if (m_inLevel != -1) m_inGroup = true;
  if (m_inLevel == extraIndentLevel) closeSection();
  m_inLevel = extraIndentLevel;
  openSection();
  m_t << "<title>";
}

References closeSection(), DB_GEN_C2, m_firstMember, m_inGroup, m_inLevel, m_inSimpleSect, m_levelListItem, OutputGenerator::m_t, and openSection().

◆ startHeaderSection()

void DocbookGenerator::startHeaderSection ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 199 of file docbookgen.h.

199{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ startInclDepGraph()

void DocbookGenerator::startInclDepGraph ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1303 of file docbookgen.cpp.

{
DB_GEN_C
}

References DB_GEN_C.

◆ startIndent()

void DocbookGenerator::startIndent ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 245 of file docbookgen.h.

245{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ startIndexItem()

void DocbookGenerator::startIndexItem	(	const DString &	,
		const DString &	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 148 of file docbookgen.h.

148{DB_GEN_NEW}

References DB_GEN_NEW.

◆ startIndexKey()

void DocbookGenerator::startIndexKey ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 141 of file docbookgen.h.

141{DB_GEN_NEW}

References DB_GEN_NEW.

◆ startIndexList()

void DocbookGenerator::startIndexList ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 139 of file docbookgen.h.

139{DB_GEN_NEW}

References DB_GEN_NEW.

◆ startIndexListItem()

void DocbookGenerator::startIndexListItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 137 of file docbookgen.h.

137{DB_GEN_NEW}

References DB_GEN_NEW.

◆ startIndexSection()

void DocbookGenerator::startIndexSection ( IndexSection is )

overridevirtual

Implements OutputGenIntf.

Definition at line 443 of file docbookgen.cpp.

{
DB_GEN_C2("IndexSection " << is)
  switch (is)
  {
    case IndexSection::isTitlePageStart:
      {
        DString dbk_projectName = Config_getString(PROJECT_NAME);
        m_t << "    <info>\n";
        m_t << "    <title>" << convertToDocbook(dbk_projectName) << "</title>\n";
        m_t << "    </info>\n";
      }
      break;
    case IndexSection::isTitlePageAuthor:
      break;
    case IndexSection::isMainPage:
      break;
    case IndexSection::isModuleIndex:
      //Module Index\n"
      break;
    case IndexSection::isTopicIndex:
      //Module Index\n"
      break;
    case IndexSection::isDirIndex:
      //Directory Index\n"
      break;
    case IndexSection::isNamespaceIndex:
      //Namespace Index\n"
      break;
    case IndexSection::isConceptIndex:
      //Concept Index\n"
      break;
    case IndexSection::isClassHierarchyIndex:
      //Hierarchical Index\n"
      break;
    case IndexSection::isCompoundIndex:
      //m_t << "{"; //Class Index}\n"
      break;
    case IndexSection::isFileIndex:
      //Annotated File Index\n"
      break;
    case IndexSection::isPageIndex:
      //Annotated Page Index\n"
      break;
    case IndexSection::isModuleDocumentation:
      m_t << "<chapter>\n";
      m_t << "    <title>";
      break;
    case IndexSection::isTopicDocumentation:
      m_t << "<chapter>\n";
      m_t << "    <title>";
      break;
    case IndexSection::isDirDocumentation:
      m_t << "<chapter>\n";
      m_t << "    <title>";
      break;
    case IndexSection::isNamespaceDocumentation:
      m_t << "<chapter>\n";
      m_t << "    <title>";
      break;
    case IndexSection::isConceptDocumentation:
      m_t << "<chapter>\n";
      m_t << "    <title>";
      break;
    case IndexSection::isClassDocumentation:
      m_t << "<chapter>\n";
      m_t << "    <title>";
      break;
    case IndexSection::isFileDocumentation:
      m_t << "<chapter>\n";
      m_t << "    <title>";
      break;
    case IndexSection::isExampleDocumentation:
      m_t << "<chapter>\n";
      m_t << "    <title>";
      break;
    case IndexSection::isPageDocumentation:
      break;
    case IndexSection::isPageDocumentation2:
      break;
    case IndexSection::isEndIndex:
      break;
  }
}

References Config_getString, convertToDocbook(), DB_GEN_C2, isClassDocumentation, isClassHierarchyIndex, isCompoundIndex, isConceptDocumentation, isConceptIndex, isDirDocumentation, isDirIndex, isEndIndex, isExampleDocumentation, isFileDocumentation, isFileIndex, isMainPage, isModuleDocumentation, isModuleIndex, isNamespaceDocumentation, isNamespaceIndex, isPageDocumentation, isPageDocumentation2, isPageIndex, isTitlePageAuthor, isTitlePageStart, isTopicDocumentation, isTopicIndex, and OutputGenerator::m_t.

◆ startIndexValue()

void DocbookGenerator::startIndexValue ( bool )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 143 of file docbookgen.h.

143{DB_GEN_NEW}

References DB_GEN_NEW.

◆ startInlineHeader()

void DocbookGenerator::startInlineHeader ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 209 of file docbookgen.h.

209{DB_GEN_NEW}

References DB_GEN_NEW.

◆ startInlineMemberDoc()

void DocbookGenerator::startInlineMemberDoc ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1204 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "<entry>";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ startInlineMemberName()

void DocbookGenerator::startInlineMemberName ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1192 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "<entry>";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ startInlineMemberType()

void DocbookGenerator::startInlineMemberType ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1180 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "<row><entry>";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ startItemList()

void DocbookGenerator::startItemList ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 145 of file docbookgen.h.

145{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ startItemListItem()

void DocbookGenerator::startItemListItem ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 150 of file docbookgen.h.

150{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ startLabels()

void DocbookGenerator::startLabels ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1006 of file docbookgen.cpp.

{
DB_GEN_C
}

References DB_GEN_C.

◆ startLocalToc()

void DocbookGenerator::startLocalToc ( int level )

overridevirtual

Implements OutputGenIntf.

Definition at line 1410 of file docbookgen.cpp.

{
  m_tocState.level=1;
  m_tocState.maxLevel=level;
  m_tocState.inLi = BoolVector(level+1,false);
  m_t << "    <toc>\n";
  m_t << "    <title>" << theTranslator->trRTFTableOfContents() << "</title>\n";
}

References DocbookGenerator::TocState::inLi, DocbookGenerator::TocState::level, OutputGenerator::m_t, m_tocState, DocbookGenerator::TocState::maxLevel, theTranslator, and Translator::trRTFTableOfContents().

◆ startMemberDeclaration()

void DocbookGenerator::startMemberDeclaration ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 240 of file docbookgen.h.

240{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ startMemberDescription()

void DocbookGenerator::startMemberDescription	(	const DString &	,
		const DString &	,
		bool	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 238 of file docbookgen.h.

238{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ startMemberDoc()

void DocbookGenerator::startMemberDoc	(	const DString &	clname,
		const DString &	memname,
		const DString &	,
		const DString &	title,
		int	memCount,
		int	memTotal,
		bool	)

overridevirtual

Implements OutputGenIntf.

Definition at line 902 of file docbookgen.cpp.

{
DB_GEN_C2("m_inLevel " << m_inLevel)
  openSection();
  m_t << "    <title>" << convertToDocbook(title);
  if (memTotal>1)
  {
    m_t << "<computeroutput>[" << memCount << "/" << memTotal << "]</computeroutput>";
  }
  m_t << "</title>\n";
  if (!memname.empty() && memname[0]!='@')
  {
    addIndexTerm(m_t,memname,clname);
    addIndexTerm(m_t,clname,memname);
  }
}

References addIndexTerm(), convertToDocbook(), DB_GEN_C2, DString::empty(), m_inLevel, OutputGenerator::m_t, and openSection().

◆ startMemberDocList()

void DocbookGenerator::startMemberDocList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1330 of file docbookgen.cpp.

{
DB_GEN_C
}

References DB_GEN_C.

◆ startMemberDocName()

void DocbookGenerator::startMemberDocName ( bool )

overridevirtual

Implements OutputGenIntf.

Definition at line 958 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "<para><computeroutput>";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ startMemberDocPrefixItem()

void DocbookGenerator::startMemberDocPrefixItem ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1053 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "<computeroutput>";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ startMemberDocSimple()

void DocbookGenerator::startMemberDocSimple ( bool isEnum )

overridevirtual

Implements OutputGenIntf.

Definition at line 1145 of file docbookgen.cpp.

{
DB_GEN_C
  int ncols=0;
  DString title;
  if (isEnum)
  {
    ncols = 2;
    title = theTranslator->trEnumerationValues();
  }
  else
  {
    ncols = 3;
    title = theTranslator->trCompoundMembers();
  }
  m_t << "<table frame=\"all\">\n";
  if (!title.empty()) m_t << "<title>" << convertToDocbook(title) << "</title>\n";
  m_t << "    <tgroup cols=\"" << ncols << "\" align=\"left\" colsep=\"1\" rowsep=\"1\">\n";
  for (int i = 0; i < ncols; i++)
  {
    m_t << "      <colspec colname='c" << i+1 << "'/>\n";
  }
  m_t << "<tbody>\n";
  m_simpleTable = true;
}

References convertToDocbook(), DB_GEN_C, DString::empty(), m_simpleTable, OutputGenerator::m_t, theTranslator, Translator::trCompoundMembers(), and Translator::trEnumerationValues().

◆ startMemberGroup()

void DocbookGenerator::startMemberGroup ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 977 of file docbookgen.cpp.

{
DB_GEN_C
}

References DB_GEN_C.

◆ startMemberGroupDocs()

void DocbookGenerator::startMemberGroupDocs ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 221 of file docbookgen.h.

221{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ startMemberGroupHeader()

void DocbookGenerator::startMemberGroupHeader	(	const DString &	,
		bool	)

overridevirtual

Implements OutputGenIntf.

Definition at line 967 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "<simplesect><title>";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ startMemberHeader()

void DocbookGenerator::startMemberHeader	(	const DString &	anchor,
		int	typ )

overridevirtual

Implements OutputGenIntf.

Definition at line 748 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "<simplesect>\n";
  m_inSimpleSect[m_levelListItem] = true;
  m_t << "    <title>";
}

References DB_GEN_C, m_inSimpleSect, m_levelListItem, and OutputGenerator::m_t.

◆ startMemberItem()

void DocbookGenerator::startMemberItem	(	const DString &	,
		MemberItemType	,
		const DString &	)

overridevirtual

Implements OutputGenIntf.

Definition at line 806 of file docbookgen.cpp.

{
DB_GEN_C
  if (m_inListItem[m_levelListItem]) m_t << "</listitem>\n";
  m_t << "            <listitem><para>";
  m_inListItem[m_levelListItem] = true;
}

References DB_GEN_C, m_inListItem, m_levelListItem, and OutputGenerator::m_t.

◆ startMemberList()

void DocbookGenerator::startMemberList ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 790 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "        <itemizedlist>\n";
  m_levelListItem++;
}

References DB_GEN_C, m_levelListItem, and OutputGenerator::m_t.

◆ startMemberSections()

void DocbookGenerator::startMemberSections ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 197 of file docbookgen.h.

197{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ startMemberSubtitle()

void DocbookGenerator::startMemberSubtitle ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 203 of file docbookgen.h.

203{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ startMemberTemplateParams()

void DocbookGenerator::startMemberTemplateParams ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1116 of file docbookgen.cpp.

{
DB_GEN_C
}

References DB_GEN_C.

◆ startPageDoc()

void DocbookGenerator::startPageDoc ( const DString & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 271 of file docbookgen.h.

271{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ startPageRef()

void DocbookGenerator::startPageRef ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 192 of file docbookgen.h.

192{DB_GEN_NEW}

References DB_GEN_NEW.

◆ startParagraph()

void DocbookGenerator::startParagraph ( const DString & )

overridevirtual

Implements OutputGenIntf.

Definition at line 732 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "<para>\n";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ startParameterDefVal()

void DocbookGenerator::startParameterDefVal ( const char * sep )

overridevirtual

Implements OutputGenIntf.

Definition at line 1103 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << sep;
  if (!m_denseText) m_t << "<computeroutput>";
}

References DB_GEN_C, m_denseText, and OutputGenerator::m_t.

◆ startParameterExtra()

void DocbookGenerator::startParameterExtra ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 1088 of file docbookgen.cpp.

{
DB_GEN_C
}

References DB_GEN_C.

◆ startParameterList()

void DocbookGenerator::startParameterList ( bool openBracket )

overridevirtual

Implements OutputGenIntf.

Definition at line 855 of file docbookgen.cpp.

{
DB_GEN_C
  if (openBracket) m_t << "(";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ startParameterName()

void DocbookGenerator::startParameterName ( bool )

overridevirtual

Implements OutputGenIntf.

Definition at line 1077 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << " ";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ startParameterType()

void DocbookGenerator::startParameterType	(	bool	,
		const DString &	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 280 of file docbookgen.h.

280{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ startPlainFile()

void DocbookGenerator::startPlainFile ( const DString & name )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 319 of file docbookgen.h.

319{ OutputGenerator::startPlainFile(name); }

OutputGenerator::startPlainFile

void startPlainFile(const DString &name)

Definition outputgen.cpp:28

References OutputGenerator::startPlainFile().

Referenced by startFile().

◆ startProjectNumber()

void DocbookGenerator::startProjectNumber ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 132 of file docbookgen.h.

132{DB_GEN_NEW}

References DB_GEN_NEW.

◆ startQuickIndices()

void DocbookGenerator::startQuickIndices ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 261 of file docbookgen.h.

261{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ startSection()

void DocbookGenerator::startSection	(	const DString &	lab,
		const DString &	,
		SectionType	)

overridevirtual

Implements OutputGenIntf.

Definition at line 1127 of file docbookgen.cpp.

{
DB_GEN_C
  openSection("xml:id=\"_" + stripPath(lab) + "\"");
  m_t << "<title>";
}

References DB_GEN_C, OutputGenerator::m_t, openSection(), and stripPath().

◆ startSmall()

void DocbookGenerator::startSmall ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 169 of file docbookgen.h.

169{DB_GEN_NEW}

References DB_GEN_NEW.

◆ startTextBlock()

void DocbookGenerator::startTextBlock ( bool dense )

overridevirtual

Implements OutputGenIntf.

Definition at line 884 of file docbookgen.cpp.

{
DB_GEN_C
  if (dense)
  {
    m_denseText = true;
    m_t << "<programlisting linenumbering=\"unnumbered\">";
  }
}

References DB_GEN_C, m_denseText, and OutputGenerator::m_t.

◆ startTextLink()

void DocbookGenerator::startTextLink	(	const DString &	,
		const DString &	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 190 of file docbookgen.h.

190{DB_GEN_NEW}

References DB_GEN_NEW.

◆ startTitleHead()

void DocbookGenerator::startTitleHead ( const DString & )

overridevirtual

Implements OutputGenIntf.

Definition at line 924 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "<title>";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ startTocEntry()

void DocbookGenerator::startTocEntry ( const SectionInfo * si )

overridevirtual

Implements OutputGenIntf.

Definition at line 1430 of file docbookgen.cpp.

{
  SectionType type = si->type();
  if (type.isSection())
  {
    //printf("  level=%d title=%s\n",level,qPrint(si->title));
    int nextLevel = type.level();
    if (nextLevel>m_tocState.level)
    {
      for (int l=m_tocState.level;l<nextLevel;l++)
      {
        if (l < m_tocState.maxLevel) m_t << "    <tocdiv>\n";
      }
    }
    else if (nextLevel<m_tocState.level)
    {
      for (int l=m_tocState.level;l>nextLevel;l--)
      {
        m_tocState.inLi[l]=false;
        if (l <= m_tocState.maxLevel) m_t << "    </tocdiv>\n";
      }
    }
    if (nextLevel <= m_tocState.maxLevel)
    {
      DString label = convertToDocbook(si->label());
      m_t << "      <tocentry>";
    }
  }
}

References convertToDocbook(), DocbookGenerator::TocState::inLi, SectionType::isSection(), SectionInfo::label(), DocbookGenerator::TocState::level, SectionType::level(), OutputGenerator::m_t, m_tocState, DocbookGenerator::TocState::maxLevel, type(), and SectionInfo::type().

◆ startTypewriter()

void DocbookGenerator::startTypewriter ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 874 of file docbookgen.cpp.

{
DB_GEN_C
  if (!m_denseText) m_t << "<computeroutput>";
}

References DB_GEN_C, m_denseText, and OutputGenerator::m_t.

◆ type()

OutputType DocbookGenerator::type ( ) const

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 119 of file docbookgen.h.

119{ return OutputType::Docbook; }

References Docbook.

Referenced by endTocEntry(), and startTocEntry().

◆ writeAnchor()

void DocbookGenerator::writeAnchor	(	const DString &	,
		const DString &	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 173 of file docbookgen.h.

173{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ writeChar()

void DocbookGenerator::writeChar ( char c )

overridevirtual

Implements OutputGenIntf.

Definition at line 1045 of file docbookgen.cpp.

{
DB_GEN_C
  char cs[2];
  cs[0]=c;
  cs[1]=0;
  docify(cs);
}

References DB_GEN_C, and docify().

◆ writeDoc()

void DocbookGenerator::writeDoc	(	const IDocNodeAST *	node,
		const Definition *	ctx,
		const MemberDef *	md,
		int	id,
		int	sectionLevel )

overridevirtual

Implements OutputGenIntf.

Definition at line 721 of file docbookgen.cpp.

{
DB_GEN_C
  auto astImpl = dynamic_cast<const DocNodeAST*>(ast);
  if (astImpl && sectionLevel<=m_tocState.maxLevel)
  {
    DocbookDocVisitor visitor(m_t,*m_codeList,ctx?ctx->getDefFileExtension():DString());
    std::visit(visitor,astImpl->root);
  }
}

References DB_GEN_C, Definition::getDefFileExtension(), m_codeList, OutputGenerator::m_t, m_tocState, and DocbookGenerator::TocState::maxLevel.

◆ writeFooter()

void DocbookGenerator::writeFooter ( const DString & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 128 of file docbookgen.h.

128{DB_GEN_NEW}

References DB_GEN_NEW.

◆ writeGraphicalHierarchy()

void DocbookGenerator::writeGraphicalHierarchy ( DotGfxHierarchyTable & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 260 of file docbookgen.h.

260{DB_GEN_NEW}

References DB_GEN_NEW.

◆ writeInheritedSectionTitle()

void DocbookGenerator::writeInheritedSectionTitle	(	const DString &	,
		const DString &	ref,
		const DString &	file,
		const DString &	anchor,
		const DString &	title,
		const DString &	name )

overridevirtual

Implements OutputGenIntf.

Definition at line 1401 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << theTranslator->trInheritedFrom(convertToDocbook(title), objectLinkToString(ref, file, anchor, name));
}

References convertToDocbook(), DB_GEN_C, OutputGenerator::m_t, objectLinkToString(), theTranslator, and Translator::trInheritedFrom().

◆ writeLabel()

void DocbookGenerator::writeLabel	(	const DString &	l,
		bool	isLast )

overridevirtual

Implements OutputGenIntf.

Definition at line 1011 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << "<computeroutput>[" << l << "]</computeroutput>";
  if (!isLast) m_t << ", ";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ writeLatexSpacing()

void DocbookGenerator::writeLatexSpacing ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 235 of file docbookgen.h.

235{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ writeLogo()

void DocbookGenerator::writeLogo ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 265 of file docbookgen.h.

265{DB_GEN_NEW}

References DB_GEN_NEW.

◆ writeNavigationPath()

void DocbookGenerator::writeNavigationPath ( const DString & )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 264 of file docbookgen.h.

264{DB_GEN_NEW}

References DB_GEN_NEW.

◆ writeNonBreakableSpace()

void DocbookGenerator::writeNonBreakableSpace ( int n )

overridevirtual

Implements OutputGenIntf.

Definition at line 864 of file docbookgen.cpp.

{
DB_GEN_C
  for (int i=0;i<n;i++) m_t << "&#160;";
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ writeObjectLink()

void DocbookGenerator::writeObjectLink	(	const DString &	ref,
		const DString &	f,
		const DString &	anchor,
		const DString &	text )

overridevirtual

Implements OutputGenIntf.

Definition at line 784 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << objectLinkToString(ref,f,anchor,text);
}

References DB_GEN_C, OutputGenerator::m_t, and objectLinkToString().

◆ writePageLink()

void DocbookGenerator::writePageLink	(	const DString &	name,
		bool	first )

overridevirtual

Implements OutputGenIntf.

Definition at line 708 of file docbookgen.cpp.

{
DB_GEN_C
  DString link;
  link.sprintf("    <xi:include href=\"%s.xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>\n",
               name.data());
  if (first)
    m_t << link;
  else
    // Buffer page links and write them after all sections are closed
    m_pageLinks += link;
}

References DString::data(), DB_GEN_C, m_pageLinks, OutputGenerator::m_t, and DString::sprintf().

Referenced by endIndexSection().

◆ writePageOutline()

void DocbookGenerator::writePageOutline ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 268 of file docbookgen.h.

268{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ writeQuickLinks()

void DocbookGenerator::writeQuickLinks	(	HighlightedItem	,
		const DString &	,
		bool	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 266 of file docbookgen.h.

266{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ writeRuler()

void DocbookGenerator::writeRuler ( )

overridevirtual

Implements OutputGenIntf.

Definition at line 841 of file docbookgen.cpp.

{
DB_GEN_C2("m_inLevel " << m_inLevel)
DB_GEN_C2("m_inGroup " << m_inGroup)
  if (m_inGroup) closeSection();
  m_inGroup = false;
}

References closeSection(), DB_GEN_C2, m_inGroup, and m_inLevel.

◆ writeSearchInfo()

void DocbookGenerator::writeSearchInfo ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 127 of file docbookgen.h.

127{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ writeSplitBar()

void DocbookGenerator::writeSplitBar	(	const DString &	,
		const DString &	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 263 of file docbookgen.h.

263{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ writeStartAnnoItem()

void DocbookGenerator::writeStartAnnoItem	(	const DString &	,
		const DString &	,
		const DString &	,
		const DString &	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 236 of file docbookgen.h.

237 {DB_GEN_NEW}

References DB_GEN_NEW.

◆ writeString()

void DocbookGenerator::writeString ( const DString & text )

overridevirtual

Implements OutputGenIntf.

Definition at line 743 of file docbookgen.cpp.

{
DB_GEN_C
  m_t << text;
}

References DB_GEN_C, and OutputGenerator::m_t.

◆ writeStyleInfo()

void DocbookGenerator::writeStyleInfo ( int )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 134 of file docbookgen.h.

134{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ writeSummaryLink()

void DocbookGenerator::writeSummaryLink	(	const DString &	,
		const DString &	,
		const DString &	,
		bool	)

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 267 of file docbookgen.h.

267{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

◆ writeSynopsis()

void DocbookGenerator::writeSynopsis ( )

inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 247 of file docbookgen.h.

247{DB_GEN_EMPTY}

References DB_GEN_EMPTY.

Member Data Documentation

◆ m_codeGen

DocbookCodeGenerator* DocbookGenerator::m_codeGen = nullptr

private

Definition at line 333 of file docbookgen.h.

Referenced by addCodeGen(), DocbookGenerator(), DocbookGenerator(), endFile(), operator=(), and startFile().

◆ m_codeList

std::unique_ptr<OutputCodeList> DocbookGenerator::m_codeList

private

Definition at line 332 of file docbookgen.h.

Referenced by DocbookGenerator(), DocbookGenerator(), operator=(), and writeDoc().

◆ m_denseText

bool DocbookGenerator::m_denseText = false

private

Definition at line 334 of file docbookgen.h.

Referenced by DocbookGenerator(), endParameterDefVal(), endTextBlock(), endTypewriter(), operator=(), startParameterDefVal(), startTextBlock(), and startTypewriter().

◆ m_descTable

bool DocbookGenerator::m_descTable = false

private

Definition at line 339 of file docbookgen.h.

Referenced by DocbookGenerator(), endDescTable(), operator=(), startDescTable(), and startDoxyAnchor().

◆ m_firstMember

bool DocbookGenerator::m_firstMember = false

private

Definition at line 342 of file docbookgen.h.

Referenced by DocbookGenerator(), operator=(), startDoxyAnchor(), and startGroupHeader().

◆ m_inGroup

bool DocbookGenerator::m_inGroup = false

private

Definition at line 335 of file docbookgen.h.

Referenced by DocbookGenerator(), endFile(), endMemberDocList(), operator=(), startGroupHeader(), and writeRuler().

◆ m_inLevel

int DocbookGenerator::m_inLevel = -1

private

Definition at line 341 of file docbookgen.h.

Referenced by DocbookGenerator(), endFile(), operator=(), startGroupHeader(), startMemberDoc(), and writeRuler().

◆ m_inListItem

std::array<bool,20> DocbookGenerator::m_inListItem = { false, }

private

Definition at line 337 of file docbookgen.h.

Referenced by DocbookGenerator(), endMemberList(), operator=(), startDoxyAnchor(), and startMemberItem().

◆ m_inSimpleSect

std::array<bool,20> DocbookGenerator::m_inSimpleSect = { false, }

private

Definition at line 338 of file docbookgen.h.

Referenced by DocbookGenerator(), endMemberList(), operator=(), startGroupHeader(), and startMemberHeader().

◆ m_levelListItem

int DocbookGenerator::m_levelListItem = 0

private

Definition at line 336 of file docbookgen.h.

Referenced by DocbookGenerator(), endMemberList(), operator=(), startDoxyAnchor(), startGroupHeader(), startMemberHeader(), startMemberItem(), and startMemberList().

◆ m_openSectionCount

int DocbookGenerator::m_openSectionCount = 0

private

Definition at line 343 of file docbookgen.h.

Referenced by closeAllSections(), closeSection(), DocbookGenerator(), openSection(), and operator=().

◆ m_pageLinks

DString DocbookGenerator::m_pageLinks

private

Definition at line 344 of file docbookgen.h.

Referenced by endFile(), startFile(), and writePageLink().

◆ m_simpleTable

bool DocbookGenerator::m_simpleTable = false

private

Definition at line 340 of file docbookgen.h.

Referenced by DocbookGenerator(), endMemberDocSimple(), operator=(), startDoxyAnchor(), and startMemberDocSimple().

◆ m_tocState

TocState DocbookGenerator::m_tocState

private

Definition at line 352 of file docbookgen.h.

Referenced by endLocalToc(), endTocEntry(), startLocalToc(), startTocEntry(), and writeDoc().

◆ relPath

DString DocbookGenerator::relPath

private

Definition at line 331 of file docbookgen.h.

Referenced by endCallGraph(), endClassDiagram(), endDirDepGraph(), endDotGraph(), endGroupCollaboration(), endInclDepGraph(), and startFile().

The documentation for this class was generated from the following files:

src/docbookgen.h
src/docbookgen.cpp

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DocbookGenerator() [1/3]

◆ DocbookGenerator() [2/3]

◆ DocbookGenerator() [3/3]

◆ ~DocbookGenerator()

Member Function Documentation

◆ addCodeGen()

◆ addIndexItem()

◆ addLabel()

◆ cleanup()

◆ clone()

◆ closeAllSections()

◆ closeSection()

◆ convertToDocbook()

◆ docify()

◆ endAnonTypeScope()

◆ endBold()

◆ endCallGraph()

◆ endCenter()

◆ endClassDiagram()

◆ endCompoundTemplateParams()

◆ endConstraintDocs()

◆ endConstraintList()

◆ endConstraintParam()

◆ endConstraintType()

◆ endContents()

◆ endDescForItem()

◆ endDescTable()

◆ endDescTableData()

◆ endDescTableInit()

◆ endDescTableRow()

◆ endDescTableTitle()

◆ endDirDepGraph()

◆ endDotGraph()

◆ endDoxyAnchor()

◆ endEmbeddedDoc()

◆ endEmphasis()

◆ endExamples()

◆ endFile()

◆ endGroupCollaboration()

◆ endGroupHeader()

◆ endHeaderSection()

◆ endInclDepGraph()

◆ endIndent()

◆ endIndexItem()

◆ endIndexKey()

◆ endIndexList()

◆ endIndexListItem()

◆ endIndexSection()

◆ endIndexValue()

◆ endInlineHeader()

◆ endInlineMemberDoc()

◆ endInlineMemberName()

◆ endInlineMemberType()

◆ endItemList()

◆ endItemListItem()

◆ endLabels()

◆ endLocalToc()

◆ endMemberDeclaration()

◆ endMemberDescription()

◆ endMemberDoc()

◆ endMemberDocList()

◆ endMemberDocName()

◆ endMemberDocPrefixItem()

◆ endMemberDocSimple()

◆ endMemberGroup()

◆ endMemberGroupDocs()

◆ endMemberGroupHeader()

◆ endMemberHeader()

◆ endMemberItem()

◆ endMemberList()

◆ endMemberSections()

◆ endMemberSubtitle()