The `DocbookGenerator` Class Reference

Declaration

class DocbookGenerator { ... }

Included Headers

Base classes

class	OutputGenerator
	Base class for shared implementation for all output generators. More...

class	OutputGenIntf
	Abstract interface for output generators. More...

Public Constructors Index

	DocbookGenerator ()


	DocbookGenerator (const DocbookGenerator &)


	DocbookGenerator (DocbookGenerator &&)=delete

Public Destructor Index

	~DocbookGenerator ()

Public Operators Index

DocbookGenerator &	operator= (const DocbookGenerator &)


DocbookGenerator &	operator= (DocbookGenerator &&)=delete

Public Member Functions Index

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) override


void	startFile (const QCString &name, const QCString &manName, const QCString &title, int id, int hierarchyLevel) override


void	endFile () override


void	writeSearchInfo () override


void	writeFooter (const QCString &) override


void	startIndexSection (IndexSection) override


void	endIndexSection (IndexSection) override


void	writePageLink (const QCString &, bool) override


void	startProjectNumber () override


void	endProjectNumber () override


void	writeStyleInfo (int) override


void	startTitleHead (const QCString &) override


void	endTitleHead (const QCString &fileName, const QCString &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 QCString &, bool) override


void	startItemList () override


void	endItemList () override


void	startIndexItem (const QCString &, const QCString &) override


void	endIndexItem (const QCString &, const QCString &) override


void	startItemListItem () override


void	endItemListItem () override


void	docify (const QCString &text) override


void	writeChar (char) override


void	writeString (const QCString &) override


void	startParagraph (const QCString &) override


void	endParagraph () override


void	writeObjectLink (const QCString &, const QCString &, const QCString &, const QCString &) 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 QCString &, const QCString &) override


void	startSection (const QCString &, const QCString &, SectionType) override


void	endSection (const QCString &, SectionType) override


void	lineBreak (const QCString &) override


void	addIndexItem (const QCString &, const QCString &) override


void	writeNonBreakableSpace (int) override


void	startDescTable (const QCString &title, const 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 QCString &, const QCString &) override


void	endTextLink () override


void	startPageRef () override


void	endPageRef (const QCString &, const QCString &) override


void	startGroupHeader (const QCString &, int) override


void	endGroupHeader (int) override


void	startMemberSections () override


void	endMemberSections () override


void	startHeaderSection () override


void	endHeaderSection () override


void	startMemberHeader (const QCString &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 QCString &, MemberItemType, const QCString &) override


void	endMemberItem (MemberItemType) override


void	startMemberTemplateParams () override


void	endMemberTemplateParams (const QCString &, const QCString &) override


void	startCompoundTemplateParams () override


void	endCompoundTemplateParams () override


void	startMemberGroupHeader (const QCString &, bool) override


void	endMemberGroupHeader () 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 QCString &, const QCString &, const QCString &, const QCString &, int, int, bool) override


void	endMemberDoc (bool) override


void	startDoxyAnchor (const QCString &fName, const QCString &manName, const QCString &anchor, const QCString &name, const QCString &args) override


void	endDoxyAnchor (const QCString &fileName, const QCString &anchor) override


void	addLabel (const QCString &, const QCString &) override


void	writeLatexSpacing () override


void	writeStartAnnoItem (const QCString &, const QCString &, const QCString &, const QCString &) override


void	startMemberDescription (const QCString &, const QCString &, bool) override


void	endMemberDescription () override


void	startMemberDeclaration () override


void	endMemberDeclaration (const QCString &, const QCString &) override


void	writeInheritedSectionTitle (const QCString &, const QCString &, const QCString &, const QCString &, const QCString &, const QCString &) override


void	startIndent () override


void	endIndent () override


void	writeSynopsis () override


void	startClassDiagram () override


void	endClassDiagram (const ClassDiagram &, const QCString &, const QCString &) 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 QCString &, const QCString &) override


void	writeNavigationPath (const QCString &) override


void	writeLogo () override


void	writeQuickLinks (HighlightedItem, const QCString &, bool) override


void	writeSummaryLink (const QCString &, const QCString &, const QCString &, bool) override


void	writePageOutline () override


void	startContents () override


void	endContents () override


void	startPageDoc (const QCString &) 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 QCString &) 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 QCString &, bool) override


void	startConstraintList (const QCString &) 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 QCString &, 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 QCString &name) override


void	endPlainFile () override

Private Member Functions Index

void	openSection (const QCString &attr=QCString())


void	closeSection ()


void	closeAllSections ()

Private Member Attributes Index

QCString	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


QCString	m_pageLinks


TocState	m_tocState

Public Static Functions Index

static void	init ()

Definition at line 103 of file docbookgen.h.

Public Constructors

DocbookGenerator()

DocbookGenerator::DocbookGenerator ()

Declaration at line 106 of file docbookgen.h, definition at line 319 of file docbookgen.cpp.

319DocbookGenerator::DocbookGenerator()

320 : OutputGenerator(Config_getString(DOCBOOK_OUTPUT))

321 , m_codeList(std::make_unique<OutputCodeList>())

322{

323DB_GEN_C

324 m_codeGen = m_codeList->add<DocbookCodeGenerator>(&m_t);

325}

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

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

DocbookGenerator()

DocbookGenerator::DocbookGenerator (const DocbookGenerator & og)

Declaration at line 107 of file docbookgen.h, definition at line 327 of file docbookgen.cpp.

327DocbookGenerator::DocbookGenerator(const DocbookGenerator &og) : OutputGenerator(og.m_dir), OutputGenIntf()

328{

329 m_codeList = std::make_unique<OutputCodeList>(*og.m_codeList);

330 m_codeGen = m_codeList->get<DocbookCodeGenerator>(OutputType::Docbook);

331 m_codeGen->setTextStream(&m_t);

332 m_denseText = og.m_denseText;

333 m_inGroup = og.m_inGroup;

334 m_levelListItem = og.m_levelListItem;

335 m_inListItem = og.m_inListItem;

336 m_inSimpleSect = og.m_inSimpleSect;

337 m_descTable = og.m_descTable;

338 m_simpleTable = og.m_simpleTable;

339 m_inLevel = og.m_inLevel;

340 m_firstMember = og.m_firstMember;

341 m_openSectionCount = og.m_openSectionCount;

342}

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 OutputGenerator::OutputGenerator.

DocbookGenerator()

DocbookGenerator::DocbookGenerator (DocbookGenerator &&)

delete

Definition at line 109 of file docbookgen.h.

Reference DocbookGenerator.

Public Destructor

~DocbookGenerator()

DocbookGenerator::~DocbookGenerator ()

Definition at line 111 of file docbookgen.h.

Public Operators

operator=()

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

Declaration at line 108 of file docbookgen.h, definition at line 344 of file docbookgen.cpp.

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

345{

346 if (this!=&og)

347 {

348 m_dir = og.m_dir;

349 m_codeList = std::make_unique<OutputCodeList>(*og.m_codeList);

350 m_codeGen = m_codeList->get<DocbookCodeGenerator>(OutputType::Docbook);

351 m_codeGen->setTextStream(&m_t);

352 m_denseText = og.m_denseText;

353 m_inGroup = og.m_inGroup;

354 m_levelListItem = og.m_levelListItem;

355 m_inListItem = og.m_inListItem;

356 m_inSimpleSect = og.m_inSimpleSect;

357 m_descTable = og.m_descTable;

358 m_simpleTable = og.m_simpleTable;

359 m_inLevel = og.m_inLevel;

360 m_firstMember = og.m_firstMember;

361 m_openSectionCount = og.m_openSectionCount;

362 }

363 return *this;

364}

operator=()

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

delete

Definition at line 110 of file docbookgen.h.

Reference DocbookGenerator.

Public Member Functions

addCodeGen()

void DocbookGenerator::addCodeGen (OutputCodeList & list)

virtual

Declaration at line 122 of file docbookgen.h, definition at line 368 of file docbookgen.cpp.

368void DocbookGenerator::addCodeGen(OutputCodeList &list)

369{

370 list.add<DocbookCodeGeneratorDefer>(m_codeGen);

371}

References OutputCodeList::add and m_codeGen.

addIndexItem()

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

virtual

Declaration at line 178 of file docbookgen.h, definition at line 1144 of file docbookgen.cpp.

1144void DocbookGenerator::addIndexItem(const QCString &prim,const QCString &sec)

1145{

1146DB_GEN_C

1147 addIndexTerm(m_t, prim, sec);

1148}

References addIndexTerm, DB_GEN_C and OutputGenerator::m_t.

addLabel()

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

virtual

Declaration at line 235 of file docbookgen.h, definition at line 959 of file docbookgen.cpp.

959void DocbookGenerator::addLabel(const QCString &,const QCString &)

960{

961DB_GEN_C

962}

Reference DB_GEN_C.

cleanup()

void DocbookGenerator::cleanup ()

virtual

Declaration at line 123 of file docbookgen.h, definition at line 384 of file docbookgen.cpp.

384void DocbookGenerator::cleanup()

385{

386 QCString dname = Config_getString(DOCBOOK_OUTPUT);

387 Dir d(dname.str());

388 clearSubDirs(d);

389}

References clearSubDirs, Config_getString and QCString::str.

clone()

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

inline virtual

Definition at line 121 of file docbookgen.h.

121 std::unique_ptr<OutputGenIntf> clone() override { return std::make_unique<DocbookGenerator>(*this); }

docify()

void DocbookGenerator::docify (const QCString & text)

virtual

Declaration at line 153 of file docbookgen.h, definition at line 766 of file docbookgen.cpp.

766void DocbookGenerator::docify(const QCString &str)

767{

768DB_GEN_C

769 m_t << convertToDocBook(str);

770}

References convertToDocBook, DB_GEN_C and OutputGenerator::m_t.

Referenced by startConstraintList, startExamples and writeChar.

endAnonTypeScope()

void DocbookGenerator::endAnonTypeScope (int)

inline virtual

Definition at line 213 of file docbookgen.h.

213 void endAnonTypeScope(int) override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

endBold()

void DocbookGenerator::endBold ()

virtual

Declaration at line 160 of file docbookgen.h, definition at line 828 of file docbookgen.cpp.

828void DocbookGenerator::endBold()

829{

830DB_GEN_C

831 m_t << "</emphasis>";

832}

References DB_GEN_C and OutputGenerator::m_t.

endCallGraph()

void DocbookGenerator::endCallGraph (DotCallGraph & g)

virtual

Declaration at line 258 of file docbookgen.h, definition at line 1321 of file docbookgen.cpp.

1321void DocbookGenerator::endCallGraph(DotCallGraph &g)

1322{

1323DB_GEN_C

1324 QCString fn = g.writeGraph(m_t,GraphOutputFormat::BITMAP,EmbeddedOutputFormat::DocBook,dir(),fileName(),relPath,FALSE);

1325}

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

endCenter()

void DocbookGenerator::endCenter ()

inline virtual

Definition at line 169 of file docbookgen.h.

169 void endCenter() override {DB_GEN_NEW}

Reference DB_GEN_NEW.

endClassDiagram()

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

virtual

Declaration at line 250 of file docbookgen.h, definition at line 997 of file docbookgen.cpp.

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

998{

999DB_GEN_C

1000 m_t << " <informalfigure>\n";

1001 m_t << " <mediaobject>\n";

1002 m_t << " <imageobject>\n";

1003 m_t << " <imagedata width=\"50%\" align=\"center\" valign=\"middle\" scalefit=\"0\" fileref=\""

1004 << relPath << fileName << ".png\">" << "</imagedata>\n";

1005 m_t << " </imageobject>\n";

1006 d.writeImage(m_t,dir(),relPath,fileName,FALSE);

1007 m_t << " </mediaobject>\n";

1008 m_t << " </informalfigure>\n";

1009 m_t << "</para>\n";

1010}

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

endCompoundTemplateParams()

void DocbookGenerator::endCompoundTemplateParams ()

virtual

Declaration at line 219 of file docbookgen.h, definition at line 1045 of file docbookgen.cpp.

1045void DocbookGenerator::endCompoundTemplateParams()

1046{

1047DB_GEN_C

1048 m_t << "</title></simplesect>\n";

1049}

References DB_GEN_C and OutputGenerator::m_t.

endConstraintDocs()

void DocbookGenerator::endConstraintDocs ()

virtual

Declaration at line 299 of file docbookgen.h, definition at line 1374 of file docbookgen.cpp.

1374void DocbookGenerator::endConstraintDocs()

1375{

1376DB_GEN_C

1377}

Reference DB_GEN_C.

endConstraintList()

void DocbookGenerator::endConstraintList ()

virtual

Declaration at line 300 of file docbookgen.h, definition at line 1378 of file docbookgen.cpp.

1378void DocbookGenerator::endConstraintList()

1379{

1380DB_GEN_C

1381 m_t << "</simplesect>\n";

1382}

References DB_GEN_C and OutputGenerator::m_t.

endConstraintParam()

void DocbookGenerator::endConstraintParam ()

virtual

Declaration at line 295 of file docbookgen.h, definition at line 1356 of file docbookgen.cpp.

1356void DocbookGenerator::endConstraintParam()

1357{

1358DB_GEN_C

1359}

Reference DB_GEN_C.

endConstraintType()

void DocbookGenerator::endConstraintType ()

virtual

Declaration at line 297 of file docbookgen.h, definition at line 1365 of file docbookgen.cpp.

1365void DocbookGenerator::endConstraintType()

1366{

1367DB_GEN_C

1368 m_t << "</emphasis></para>\n";

1369}

References DB_GEN_C and OutputGenerator::m_t.

endContents()

void DocbookGenerator::endContents ()

inline virtual

Definition at line 271 of file docbookgen.h.

271 void endContents() override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

endDescForItem()

void DocbookGenerator::endDescForItem ()

inline virtual

Definition at line 167 of file docbookgen.h.

167 void endDescForItem() override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

endDescTable()

void DocbookGenerator::endDescTable ()

virtual

Declaration at line 182 of file docbookgen.h, definition at line 1236 of file docbookgen.cpp.

1236void DocbookGenerator::endDescTable()

1237{

1238DB_GEN_C

1239 m_t << " </tbody>\n";

1240 m_t << " </tgroup>\n";

1241 m_t << "</informaltable>\n";

1242 m_descTable = FALSE;

1243}

References DB_GEN_C, FALSE, m_descTable and OutputGenerator::m_t.

endDescTableData()

void DocbookGenerator::endDescTableData ()

virtual

Declaration at line 190 of file docbookgen.h, definition at line 1285 of file docbookgen.cpp.

1285void DocbookGenerator::endDescTableData()

1286{

1287DB_GEN_C

1288 m_t << "</entry>";

1289}

References DB_GEN_C and OutputGenerator::m_t.

endDescTableInit()

void DocbookGenerator::endDescTableInit ()

virtual

Declaration at line 188 of file docbookgen.h, definition at line 1274 of file docbookgen.cpp.

1274void DocbookGenerator::endDescTableInit()

1275{

1276DB_GEN_C

1277}

Reference DB_GEN_C.

endDescTableRow()

void DocbookGenerator::endDescTableRow ()

virtual

Declaration at line 184 of file docbookgen.h, definition at line 1252 of file docbookgen.cpp.

1252void DocbookGenerator::endDescTableRow()

1253{

1254DB_GEN_C

1255 m_t << "</row>";

1256}

References DB_GEN_C and OutputGenerator::m_t.

endDescTableTitle()

void DocbookGenerator::endDescTableTitle ()

virtual

Declaration at line 186 of file docbookgen.h, definition at line 1263 of file docbookgen.cpp.

1263void DocbookGenerator::endDescTableTitle()

1264{

1265DB_GEN_C

1266}

Reference DB_GEN_C.

endDirDepGraph()

void DocbookGenerator::endDirDepGraph (DotDirDeps & g)

virtual

Declaration at line 260 of file docbookgen.h, definition at line 1330 of file docbookgen.cpp.

1330void DocbookGenerator::endDirDepGraph(DotDirDeps &g)

1331{

1332DB_GEN_C

1333 QCString fn = g.writeGraph(m_t,GraphOutputFormat::BITMAP,EmbeddedOutputFormat::DocBook,dir(),fileName(),relPath,FALSE);

1334}

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

endDotGraph()

void DocbookGenerator::endDotGraph (DotClassGraph & g)

virtual

Declaration at line 252 of file docbookgen.h, definition at line 1303 of file docbookgen.cpp.

1303void DocbookGenerator::endDotGraph(DotClassGraph &g)

1304{

1305DB_GEN_C

1306 g.writeGraph(m_t,GraphOutputFormat::BITMAP,EmbeddedOutputFormat::DocBook,dir(),fileName(),relPath,TRUE,FALSE);

1307}

References BITMAP, DB_GEN_C, OutputGenerator::dir, DocBook, FALSE, OutputGenerator::fileName, OutputGenerator::m_t, relPath, TRUE and DotClassGraph::writeGraph.

endDoxyAnchor()

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

virtual

Declaration at line 234 of file docbookgen.h, definition at line 955 of file docbookgen.cpp.

955void DocbookGenerator::endDoxyAnchor(const QCString &,const QCString &)

956{

957DB_GEN_C

958}

Reference DB_GEN_C.

endEmphasis()

void DocbookGenerator::endEmphasis ()

inline virtual

Definition at line 164 of file docbookgen.h.

164 void endEmphasis() override {DB_GEN_NEW}

Reference DB_GEN_NEW.

endExamples()

void DocbookGenerator::endExamples ()

virtual

Declaration at line 173 of file docbookgen.h, definition at line 1035 of file docbookgen.cpp.

1035void DocbookGenerator::endExamples()

1036{

1037DB_GEN_C

1038 m_t << "</simplesect>\n";

1039}

References DB_GEN_C and OutputGenerator::m_t.

endFile()

void DocbookGenerator::endFile ()

virtual

Declaration at line 126 of file docbookgen.h, definition at line 423 of file docbookgen.cpp.

423void DocbookGenerator::endFile()

424{

425DB_GEN_C

426 closeAllSections();

427 m_inLevel = -1;

428 m_inGroup = FALSE;

429

430 // Write page links only after all sections have been closed to avoid bugs

431 m_t << m_pageLinks;

432

433 QCString fileType="section";

434 QCString fileName= m_codeGen->sourceFileName();

435 if (fileName == "index.xml")

436 {

437 fileType="book";

438 }

439 else if (fileName == "mainpage.xml")

440 {

441 fileType="chapter";

442 }

443 m_t << "</" << fileType << ">\n";

444 endPlainFile();

445 m_codeGen->setSourceFileName("");

446}

References closeAllSections, DB_GEN_C, endPlainFile, FALSE, OutputGenerator::fileName, m_codeGen, m_inGroup, m_inLevel, m_pageLinks and OutputGenerator::m_t.

endGroupCollaboration()

void DocbookGenerator::endGroupCollaboration (DotGroupCollaboration & g)

virtual

Declaration at line 256 of file docbookgen.h, definition at line 1294 of file docbookgen.cpp.

1294void DocbookGenerator::endGroupCollaboration(DotGroupCollaboration &g)

1295{

1296DB_GEN_C

1297 g.writeGraph(m_t,GraphOutputFormat::BITMAP,EmbeddedOutputFormat::DocBook,dir(),fileName(),relPath,FALSE);

1298}

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

endGroupHeader()

void DocbookGenerator::endGroupHeader (int)

virtual

Declaration at line 197 of file docbookgen.h, definition at line 854 of file docbookgen.cpp.

854void DocbookGenerator::endGroupHeader(int)

855{

856DB_GEN_C

857 m_t << "</title>\n";

858}

References DB_GEN_C and OutputGenerator::m_t.

endHeaderSection()

void DocbookGenerator::endHeaderSection ()

inline virtual

Definition at line 201 of file docbookgen.h.

201 void endHeaderSection() override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

endInclDepGraph()

void DocbookGenerator::endInclDepGraph (DotInclDepGraph & g)

virtual

Declaration at line 254 of file docbookgen.h, definition at line 1312 of file docbookgen.cpp.

1312void DocbookGenerator::endInclDepGraph(DotInclDepGraph &g)

1313{

1314DB_GEN_C

1315 QCString fn = g.writeGraph(m_t,GraphOutputFormat::BITMAP,EmbeddedOutputFormat::DocBook,dir(),fileName(),relPath,FALSE);

1316}

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

endIndent()

void DocbookGenerator::endIndent ()

inline virtual

Definition at line 247 of file docbookgen.h.

247 void endIndent() override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

endIndexItem()

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

inline virtual

Definition at line 150 of file docbookgen.h.

150 void endIndexItem(const QCString &,const QCString &) override {DB_GEN_NEW}

Reference DB_GEN_NEW.

endIndexKey()

void DocbookGenerator::endIndexKey ()

inline virtual

Definition at line 143 of file docbookgen.h.

143 void endIndexKey() override {DB_GEN_NEW}

Reference DB_GEN_NEW.

endIndexList()

void DocbookGenerator::endIndexList ()

inline virtual

Definition at line 141 of file docbookgen.h.

141 void endIndexList() override {DB_GEN_NEW}

Reference DB_GEN_NEW.

endIndexListItem()

void DocbookGenerator::endIndexListItem ()

inline virtual

Definition at line 139 of file docbookgen.h.

139 void endIndexListItem() override {DB_GEN_NEW}

Reference DB_GEN_NEW.

endIndexSection()

void DocbookGenerator::endIndexSection (IndexSection is)

virtual

Declaration at line 131 of file docbookgen.h, definition at line 533 of file docbookgen.cpp.

533void DocbookGenerator::endIndexSection(IndexSection is)

534{

535DB_GEN_C2("IndexSection " << is)

536 switch (is)

537 {

538 case IndexSection::isTitlePageStart:

539 break;

540 case IndexSection::isTitlePageAuthor:

541 break;

542 case IndexSection::isMainPage:

543 {

544 if (Doxygen::mainPage)

545 {

546 writePageLink(QCString("mainpage"), TRUE);

547 }

548 }

549 break;

550 case IndexSection::isModuleIndex:

551 //m_t << "</chapter>\n";

552 break;

553 case IndexSection::isTopicIndex:

554 //m_t << "</chapter>\n";

555 break;

556 case IndexSection::isDirIndex:

557 //m_t << "<xi:include href=\"dirs.xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>";

558 //m_t << "</chapter>\n";

559 break;

560 case IndexSection::isNamespaceIndex:

561 //m_t << "<xi:include href=\"namespaces.xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>";

562 //m_t << "</chapter>\n";

563 break;

564 case IndexSection::isConceptIndex:

565 //m_t << "<xi:include href=\"concepts.xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>";

566 //m_t << "</chapter>\n";

567 break;

568 case IndexSection::isClassHierarchyIndex:

569 //m_t << "<xi:include href=\"hierarchy.xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>";

570 //m_t << "</chapter>\n";

571 break;

572 case IndexSection::isCompoundIndex:

573 //m_t << "</chapter>\n";

574 break;

575 case IndexSection::isFileIndex:

576 //m_t << "<xi:include href=\"files.xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>";

577 //m_t << "</chapter>\n";

578 break;

579 case IndexSection::isPageIndex:

580 //m_t << "<xi:include href=\"pages.xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>";

581 //m_t << "</chapter>\n";

582 break;

583 case IndexSection::isTopicDocumentation:

584 {

585 m_t << "</title>\n";

586 for (const auto &gd : *Doxygen::groupLinkedMap)

587 {

588 if (!gd->isReference() && !gd->isASubGroup())

589 {

590 writePageLink(gd->getOutputFileBase(), TRUE);

591 }

592 }

593 }

594 m_t << "</chapter>\n";

595 break;

596 case IndexSection::isModuleDocumentation:

597 {

598 m_t << "</title>\n";

599 for (const auto &mod : ModuleManager::instance().modules())

600 {

601 if (!mod->isReference() && mod->isPrimaryInterface())

602 {

603 writePageLink(mod->getOutputFileBase(), TRUE);

604 }

605 }

606 }

607 m_t << "</chapter>\n";

608 break;

609 break;

610 case IndexSection::isDirDocumentation:

611 {

612 m_t << "</title>\n";

613 for (const auto &dd : *Doxygen::dirLinkedMap)

614 {

615 if (dd->isLinkableInProject())

616 {

617 m_t << "< xi:include href=\"" << dd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>\n";

618 }

619 }

620 }

621 m_t << "</chapter>\n";

622 break;

623 case IndexSection::isNamespaceDocumentation:

624 {

625 m_t << "</title>\n";

626 for (const auto &nd : *Doxygen::namespaceLinkedMap)

627 {

628 if (nd->isLinkableInProject() && !nd->isAlias())

629 {

630 m_t << "<xi:include href=\"" << nd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>\n";

631 }

632 }

633 }

634 m_t << "</chapter>\n";

635 break;

636 case IndexSection::isConceptDocumentation:

637 {

638 m_t << "</title>\n";

639 for (const auto &cd : *Doxygen::conceptLinkedMap)

640 {

641 if (cd->isLinkableInProject() && !cd->isAlias())

642 {

643 m_t << "<xi:include href=\"" << cd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>\n";

644 }

645 }

646 }

647 m_t << "</chapter>\n";

648 break;

649 case IndexSection::isClassDocumentation:

650 {

651 m_t << "</title>\n";

652 for (const auto &cd : *Doxygen::classLinkedMap)

653 {

654 if (cd->isLinkableInProject() &&

655 !cd->isImplicitTemplateInstance() &&

656 !cd->isEmbeddedInOuterScope() &&

657 !cd->isAlias()

658 )

659 {

660 m_t << " <xi:include href=\"" << cd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>\n";

661 }

662 }

663 }

664 m_t << "</chapter>\n";

665 break;

666 case IndexSection::isFileDocumentation:

667 {

668 m_t << "</title>\n";

669 for (const auto &fn : *Doxygen::inputNameLinkedMap)

670 {

671 for (const auto &fd : *fn)

672 {

673 if (fd->isLinkableInProject())

674 {

675 m_t << " <xi:include href=\"" << fd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>\n";

676 }

677 if (fd->generateSourceFile())

678 {

679 m_t << " <xi:include href=\"" << fd->getSourceFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>\n";

680 }

681 }

682 }

683 }

684 m_t << "</chapter>\n";

685 break;

686 case IndexSection::isExampleDocumentation:

687 {

688 m_t << "</title>\n";

689 for (const auto &pd : *Doxygen::exampleLinkedMap)

690 {

691 m_t << " <xi:include href=\"" << pd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>\n";

692 }

693 }

694 m_t << "</chapter>\n";

695 break;

696 case IndexSection::isPageDocumentation:

697 for (const auto &pd : *Doxygen::pageLinkedMap)

698 {

699 if (!pd->getGroupDef() && !pd->isReference() && !pd->hasParentPage()

700 && Doxygen::mainPage.get() != pd.get())

701 {

702 writePageLink(pd->getOutputFileBase(), TRUE);

703 }

704 }

705 break;

706 case IndexSection::isPageDocumentation2:

707 break;

708 case IndexSection::isEndIndex:

709 m_t << "<index/>\n";

710 break;

711 }

712}

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, TRUE and writePageLink.

endIndexValue()

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

inline virtual

Definition at line 145 of file docbookgen.h.

145 void endIndexValue(const QCString &,bool) override {DB_GEN_NEW}

Reference DB_GEN_NEW.

endInlineHeader()

void DocbookGenerator::endInlineHeader ()

inline virtual

Definition at line 211 of file docbookgen.h.

211 void endInlineHeader() override {DB_GEN_NEW}

Reference DB_GEN_NEW.

endInlineMemberDoc()

void DocbookGenerator::endInlineMemberDoc ()

virtual

Declaration at line 309 of file docbookgen.h, definition at line 1215 of file docbookgen.cpp.

1215void DocbookGenerator::endInlineMemberDoc()

1216{

1217DB_GEN_C

1218 m_t << "</entry></row>\n";

1219}

References DB_GEN_C and OutputGenerator::m_t.

endInlineMemberName()

void DocbookGenerator::endInlineMemberName ()

virtual

Declaration at line 307 of file docbookgen.h, definition at line 1203 of file docbookgen.cpp.

1203void DocbookGenerator::endInlineMemberName()

1204{

1205DB_GEN_C

1206 m_t << "</entry>";

1207}

References DB_GEN_C and OutputGenerator::m_t.

endInlineMemberType()

void DocbookGenerator::endInlineMemberType ()

virtual

Declaration at line 305 of file docbookgen.h, definition at line 1191 of file docbookgen.cpp.

1191void DocbookGenerator::endInlineMemberType()

1192{

1193DB_GEN_C

1194 m_t << "</entry>";

1195}

References DB_GEN_C and OutputGenerator::m_t.

endItemList()

void DocbookGenerator::endItemList ()

inline virtual

Definition at line 147 of file docbookgen.h.

147 void endItemList() override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

endItemListItem()

void DocbookGenerator::endItemListItem ()

inline virtual

Definition at line 152 of file docbookgen.h.

152 void endItemListItem() override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

endLabels()

void DocbookGenerator::endLabels ()

virtual

Declaration at line 313 of file docbookgen.h, definition at line 1023 of file docbookgen.cpp.

1023void DocbookGenerator::endLabels()

1024{

1025DB_GEN_C

1026}

Reference DB_GEN_C.

endLocalToc()

void DocbookGenerator::endLocalToc ()

virtual

Declaration at line 316 of file docbookgen.h, definition at line 1424 of file docbookgen.cpp.

1424void DocbookGenerator::endLocalToc()

1425{

1426 if (m_tocState.level > m_tocState.maxLevel) m_tocState.level = m_tocState.maxLevel;

1427 while (m_tocState.level>1 && m_tocState.level <= m_tocState.maxLevel)

1428 {

1429 m_t << "</tocdiv>\n";

1430 m_tocState.level--;

1431 }

1432 m_t << " </toc>\n";

1433}

References OutputGenerator::m_t and m_tocState.

endMemberDeclaration()

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

inline virtual

Definition at line 242 of file docbookgen.h.

242 void endMemberDeclaration(const QCString &,const QCString &) override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

endMemberDescription()

void DocbookGenerator::endMemberDescription ()

inline virtual

Definition at line 240 of file docbookgen.h.

240 void endMemberDescription() override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

endMemberDoc()

void DocbookGenerator::endMemberDoc (bool)

virtual

Declaration at line 230 of file docbookgen.h, definition at line 924 of file docbookgen.cpp.

924void DocbookGenerator::endMemberDoc(bool)

925{

926DB_GEN_C

927 m_t << "</computeroutput></para>";

928}

References DB_GEN_C and OutputGenerator::m_t.

endMemberDocList()

void DocbookGenerator::endMemberDocList ()

virtual

Declaration at line 207 of file docbookgen.h, definition at line 1339 of file docbookgen.cpp.

1339void DocbookGenerator::endMemberDocList()

1340{

1341DB_GEN_C

1342 m_inGroup = TRUE;

1343}

References DB_GEN_C, m_inGroup and TRUE.

endMemberDocName()

void DocbookGenerator::endMemberDocName ()

virtual

Declaration at line 280 of file docbookgen.h, definition at line 968 of file docbookgen.cpp.

968void DocbookGenerator::endMemberDocName()

969{

970DB_GEN_C

971}

Reference DB_GEN_C.

endMemberDocPrefixItem()

void DocbookGenerator::endMemberDocPrefixItem ()

virtual

Declaration at line 278 of file docbookgen.h, definition at line 1063 of file docbookgen.cpp.

1063void DocbookGenerator::endMemberDocPrefixItem()

1064{

1065DB_GEN_C

1066 m_t << "</computeroutput>";

1067}

References DB_GEN_C and OutputGenerator::m_t.

endMemberDocSimple()

void DocbookGenerator::endMemberDocSimple (bool)

virtual

Declaration at line 303 of file docbookgen.h, definition at line 1176 of file docbookgen.cpp.

1176void DocbookGenerator::endMemberDocSimple(bool /* isEnum */)

1177{

1178DB_GEN_C

1179 m_t << " </tbody>\n";

1180 m_t << " </tgroup>\n";

1181 m_t << "</table>\n";

1182 m_simpleTable = false;

1183}

References DB_GEN_C, m_simpleTable and OutputGenerator::m_t.

endMemberGroup()

void DocbookGenerator::endMemberGroup (bool)

virtual

Declaration at line 225 of file docbookgen.h, definition at line 986 of file docbookgen.cpp.

986void DocbookGenerator::endMemberGroup(bool)

987{

988DB_GEN_C

989 m_t << "</simplesect>\n";

990}

References DB_GEN_C and OutputGenerator::m_t.

endMemberGroupDocs()

void DocbookGenerator::endMemberGroupDocs ()

inline virtual

Definition at line 223 of file docbookgen.h.

223 void endMemberGroupDocs() override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

endMemberGroupHeader()

void DocbookGenerator::endMemberGroupHeader ()

virtual

Declaration at line 221 of file docbookgen.h, definition at line 977 of file docbookgen.cpp.

977void DocbookGenerator::endMemberGroupHeader()

978{

979DB_GEN_C

980 m_t << "</title>\n";

981}

References DB_GEN_C and OutputGenerator::m_t.

endMemberHeader()

void DocbookGenerator::endMemberHeader ()

virtual

Declaration at line 203 of file docbookgen.h, definition at line 761 of file docbookgen.cpp.

761void DocbookGenerator::endMemberHeader()

762{

763DB_GEN_C

764 m_t << " </title>\n";

765}

References DB_GEN_C and OutputGenerator::m_t.

endMemberItem()

void DocbookGenerator::endMemberItem (MemberItemType)

virtual

Declaration at line 215 of file docbookgen.h, definition at line 818 of file docbookgen.cpp.

818void DocbookGenerator::endMemberItem(MemberItemType)

819{

820DB_GEN_C

821 m_t << "</para>\n";

822}

References DB_GEN_C and OutputGenerator::m_t.

endMemberList()

void DocbookGenerator::endMemberList ()

virtual

Declaration at line 209 of file docbookgen.h, definition at line 801 of file docbookgen.cpp.

801void DocbookGenerator::endMemberList()

802{

803DB_GEN_C

804 if (m_inListItem[m_levelListItem]) m_t << "</listitem>\n";

805 m_inListItem[m_levelListItem] = FALSE;

806 m_t << " </itemizedlist>\n";

807 m_levelListItem = (m_levelListItem> 0 ? m_levelListItem - 1 : 0);

808 if (m_inSimpleSect[m_levelListItem]) m_t << "</simplesect>\n";

809 m_inSimpleSect[m_levelListItem] = FALSE;

810}

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

endMemberSections()

void DocbookGenerator::endMemberSections ()

inline virtual

Definition at line 199 of file docbookgen.h.

199 void endMemberSections() override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

endMemberSubtitle()

void DocbookGenerator::endMemberSubtitle ()

inline virtual

Definition at line 205 of file docbookgen.h.

205 void endMemberSubtitle() override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

endMemberTemplateParams()

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

virtual

Declaration at line 217 of file docbookgen.h, definition at line 1126 of file docbookgen.cpp.

1126void DocbookGenerator::endMemberTemplateParams(const QCString &,const QCString &)

1127{

1128DB_GEN_C

1129 m_t << "</para>";

1130 m_t << "<para>";

1131}

References DB_GEN_C and OutputGenerator::m_t.

endPageDoc()

void DocbookGenerator::endPageDoc ()

inline virtual

Definition at line 273 of file docbookgen.h.

273 void endPageDoc() override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

endPageRef()

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

inline virtual

Definition at line 194 of file docbookgen.h.

194 void endPageRef(const QCString &,const QCString &) override {DB_GEN_NEW}

Reference DB_GEN_NEW.

endParagraph()

void DocbookGenerator::endParagraph ()

virtual

Declaration at line 157 of file docbookgen.h, definition at line 743 of file docbookgen.cpp.

743void DocbookGenerator::endParagraph()

744{

745DB_GEN_C

746 m_t << "</para>\n";

747}

References DB_GEN_C and OutputGenerator::m_t.

endParameterDefVal()

void DocbookGenerator::endParameterDefVal ()

virtual

Declaration at line 288 of file docbookgen.h, definition at line 1115 of file docbookgen.cpp.

1115void DocbookGenerator::endParameterDefVal()

1116{

1117DB_GEN_C

1118 if (!m_denseText) m_t << "</computeroutput>\n";

1119}

References DB_GEN_C, m_denseText and OutputGenerator::m_t.

endParameterExtra()

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

virtual

Declaration at line 286 of file docbookgen.h, definition at line 1098 of file docbookgen.cpp.

1098void DocbookGenerator::endParameterExtra(bool last,bool /*emptyList*/,bool closeBracket)

1099{

1100DB_GEN_C

1101 if (last && closeBracket)

1102 {

1103 m_t << ")";

1104 }

1105}

References DB_GEN_C and OutputGenerator::m_t.

endParameterList()

void DocbookGenerator::endParameterList ()

virtual

Declaration at line 290 of file docbookgen.h, definition at line 865 of file docbookgen.cpp.

865void DocbookGenerator::endParameterList()

866{

867DB_GEN_C

868}

Reference DB_GEN_C.

endParameterName()

void DocbookGenerator::endParameterName ()

virtual

Declaration at line 284 of file docbookgen.h, definition at line 1088 of file docbookgen.cpp.

1088void DocbookGenerator::endParameterName()

1089{

1090DB_GEN_C

1091}

Reference DB_GEN_C.

endParameterType()

void DocbookGenerator::endParameterType ()

inline virtual

Definition at line 282 of file docbookgen.h.

282 void endParameterType() override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

endPlainFile()

void DocbookGenerator::endPlainFile ()

inline virtual

Definition at line 321 of file docbookgen.h.

321 void endPlainFile() override { OutputGenerator::endPlainFile(); }

Reference OutputGenerator::endPlainFile.

Referenced by endFile.

endProjectNumber()

void DocbookGenerator::endProjectNumber ()

inline virtual

Definition at line 134 of file docbookgen.h.

134 void endProjectNumber() override {DB_GEN_NEW}

Reference DB_GEN_NEW.

endQuickIndices()

void DocbookGenerator::endQuickIndices ()

inline virtual

Definition at line 263 of file docbookgen.h.

263 void endQuickIndices() override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

endSection()

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

virtual

Declaration at line 176 of file docbookgen.h, definition at line 1138 of file docbookgen.cpp.

1138void DocbookGenerator::endSection(const QCString &,SectionType)

1139{

1140DB_GEN_C

1141 m_t << "</title>";

1142 closeSection();

1143}

References closeSection, DB_GEN_C and OutputGenerator::m_t.

endSmall()

void DocbookGenerator::endSmall ()

inline virtual

Definition at line 171 of file docbookgen.h.

171 void endSmall() override {DB_GEN_NEW}

Reference DB_GEN_NEW.

endTextBlock()

void DocbookGenerator::endTextBlock (bool)

virtual

Declaration at line 275 of file docbookgen.h, definition at line 898 of file docbookgen.cpp.

898void DocbookGenerator::endTextBlock(bool)

899{

900DB_GEN_C

901 if (m_denseText)

902 {

903 m_denseText = FALSE;

904 m_t << "</programlisting>";

905 }

906}

References DB_GEN_C, FALSE, m_denseText and OutputGenerator::m_t.

endTextLink()

void DocbookGenerator::endTextLink ()

inline virtual

Definition at line 192 of file docbookgen.h.

192 void endTextLink() override {DB_GEN_NEW}

Reference DB_GEN_NEW.

endTitleHead()

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

virtual

Declaration at line 137 of file docbookgen.h, definition at line 934 of file docbookgen.cpp.

934void DocbookGenerator::endTitleHead(const QCString &,const QCString &name)

935{

936DB_GEN_C

937 m_t << "</title>\n";

938 if (!name.isEmpty()) addIndexTerm(m_t, name);

939}

References addIndexTerm, DB_GEN_C, QCString::isEmpty and OutputGenerator::m_t.

endTocEntry()

void DocbookGenerator::endTocEntry (const SectionInfo * si)

virtual

Declaration at line 318 of file docbookgen.h, definition at line 1465 of file docbookgen.cpp.

1465void DocbookGenerator::endTocEntry(const SectionInfo *si)

1466{

1467 SectionType type = si->type();

1468 int nextLevel = type.level();

1469 if (type.isSection() && nextLevel <= m_tocState.maxLevel)

1470 {

1471 m_t << "</tocentry>\n";

1472 m_tocState.inLi[nextLevel]=true;

1473 m_tocState.level = nextLevel;

1474 }

1475}

References OutputGenerator::m_t, m_tocState, type and SectionInfo::type.

endTypewriter()

void DocbookGenerator::endTypewriter ()

virtual

Declaration at line 162 of file docbookgen.h, definition at line 884 of file docbookgen.cpp.

884void DocbookGenerator::endTypewriter()

885{

886DB_GEN_C

887 if (!m_denseText) m_t << "</computeroutput>\n";

888}

References DB_GEN_C, m_denseText and OutputGenerator::m_t.

exceptionEntry()

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

virtual

Declaration at line 291 of file docbookgen.h, definition at line 1068 of file docbookgen.cpp.

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

1069{

1070DB_GEN_C

1071 if (!prefix.isEmpty())

1072 {

1073 m_t << " " << prefix << "(";

1074 }

1075 else if (closeBracket)

1076 {

1077 m_t << ")";

1078 }

1079 m_t << " ";

1080}

References DB_GEN_C, OutputGenerator::m_t and prefix.

insertMemberAlign()

void DocbookGenerator::insertMemberAlign (bool)

inline virtual

Definition at line 226 of file docbookgen.h.

226 void insertMemberAlign(bool) override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

insertMemberAlignLeft()

void DocbookGenerator::insertMemberAlignLeft (MemberItemType, bool)

inline virtual

Definition at line 227 of file docbookgen.h.

227 void insertMemberAlignLeft(MemberItemType,bool) override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

lastIndexPage()

void DocbookGenerator::lastIndexPage ()

inline virtual

Definition at line 276 of file docbookgen.h.

276 void lastIndexPage() override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

lineBreak()

void DocbookGenerator::lineBreak (const QCString &)

virtual

Declaration at line 177 of file docbookgen.h, definition at line 874 of file docbookgen.cpp.

874void DocbookGenerator::lineBreak(const QCString &)

875{

876DB_GEN_C

877 m_t << "<?linebreak?>";

878}

References DB_GEN_C and OutputGenerator::m_t.

startAnonTypeScope()

void DocbookGenerator::startAnonTypeScope (int)

inline virtual

Definition at line 212 of file docbookgen.h.

212 void startAnonTypeScope(int) override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

startBold()

void DocbookGenerator::startBold ()

virtual

Declaration at line 159 of file docbookgen.h, definition at line 823 of file docbookgen.cpp.

823void DocbookGenerator::startBold()

824{

825DB_GEN_C

826 m_t << "<emphasis role=\"strong\">";

827}

References DB_GEN_C and OutputGenerator::m_t.

startCallGraph()

void DocbookGenerator::startCallGraph ()

virtual

Declaration at line 257 of file docbookgen.h, definition at line 1317 of file docbookgen.cpp.

1317void DocbookGenerator::startCallGraph()

1318{

1319DB_GEN_C

1320}

Reference DB_GEN_C.

startCenter()

void DocbookGenerator::startCenter ()

inline virtual

Definition at line 168 of file docbookgen.h.

168 void startCenter() override {DB_GEN_NEW}

Reference DB_GEN_NEW.

startClassDiagram()

void DocbookGenerator::startClassDiagram ()

virtual

Declaration at line 249 of file docbookgen.h, definition at line 991 of file docbookgen.cpp.

991void DocbookGenerator::startClassDiagram()

992{

993DB_GEN_C

994 m_t << "<para>";

995}

References DB_GEN_C and OutputGenerator::m_t.

startCompoundTemplateParams()

void DocbookGenerator::startCompoundTemplateParams ()

virtual

Declaration at line 218 of file docbookgen.h, definition at line 1040 of file docbookgen.cpp.

1040void DocbookGenerator::startCompoundTemplateParams()

1041{

1042DB_GEN_C

1043 m_t << "<simplesect><title>";

1044}

References DB_GEN_C and OutputGenerator::m_t.

startConstraintDocs()

void DocbookGenerator::startConstraintDocs ()

virtual

Declaration at line 298 of file docbookgen.h, definition at line 1370 of file docbookgen.cpp.

1370void DocbookGenerator::startConstraintDocs()

1371{

1372DB_GEN_C

1373}

Reference DB_GEN_C.

startConstraintList()

void DocbookGenerator::startConstraintList (const QCString & header)

virtual

Declaration at line 293 of file docbookgen.h, definition at line 1344 of file docbookgen.cpp.

1344void DocbookGenerator::startConstraintList(const QCString &header)

1345{

1346DB_GEN_C

1347 m_t << "<simplesect><title>";

1348 docify(header);

1349 m_t << "</title>\n";

1350}

References DB_GEN_C, docify and OutputGenerator::m_t.

startConstraintParam()

void DocbookGenerator::startConstraintParam ()

virtual

Declaration at line 294 of file docbookgen.h, definition at line 1351 of file docbookgen.cpp.

1351void DocbookGenerator::startConstraintParam()

1352{

1353DB_GEN_C

1354 m_t << "<para><emphasis role=\"strong\">";

1355}

References DB_GEN_C and OutputGenerator::m_t.

startConstraintType()

void DocbookGenerator::startConstraintType ()

virtual

Declaration at line 296 of file docbookgen.h, definition at line 1360 of file docbookgen.cpp.

1360void DocbookGenerator::startConstraintType()

1361{

1362DB_GEN_C

1363 m_t << ":";

1364}

References DB_GEN_C and OutputGenerator::m_t.

startContents()

void DocbookGenerator::startContents ()

inline virtual

Definition at line 270 of file docbookgen.h.

270 void startContents() override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

startDescForItem()

void DocbookGenerator::startDescForItem ()

inline virtual

Definition at line 166 of file docbookgen.h.

166 void startDescForItem() override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

startDescTable()

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

virtual

Declaration at line 181 of file docbookgen.h, definition at line 1221 of file docbookgen.cpp.

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

1222{

1223DB_GEN_C

1224 int ncols = (hasInits?3:2);

1225 m_t << "<informaltable frame=\"all\">\n";

1226 if (!title.isEmpty()) m_t << "<title>" << convertToDocBook(title) << "</title>\n";

1227 m_t << " <tgroup cols=\"" << ncols << "\" align=\"left\" colsep=\"1\" rowsep=\"1\">\n";

1228 int i = 1;

1229 m_t << " <colspec colname='c" << i++ << "'/>\n";

1230 if (hasInits) m_t << " <colspec colname='c" << i++ << "' align='right'/>\n";

1231 m_t << " <colspec colname='c" << i++ << "'/>\n";

1232 m_t << "<tbody>\n";

1233 m_descTable = TRUE;

1234}

References convertToDocBook, DB_GEN_C, QCString::isEmpty, m_descTable, OutputGenerator::m_t and TRUE.

startDescTableData()

void DocbookGenerator::startDescTableData ()

virtual

Declaration at line 189 of file docbookgen.h, definition at line 1279 of file docbookgen.cpp.

1279void DocbookGenerator::startDescTableData()

1280{

1281DB_GEN_C

1282 m_t << "</entry><entry>";

1283}

References DB_GEN_C and OutputGenerator::m_t.

startDescTableInit()

void DocbookGenerator::startDescTableInit ()

virtual

Declaration at line 187 of file docbookgen.h, definition at line 1268 of file docbookgen.cpp.

1268void DocbookGenerator::startDescTableInit()

1269{

1270DB_GEN_C

1271 m_t << "</entry><entry>";

1272}

References DB_GEN_C and OutputGenerator::m_t.

startDescTableRow()

void DocbookGenerator::startDescTableRow ()

virtual

Declaration at line 183 of file docbookgen.h, definition at line 1245 of file docbookgen.cpp.

1245void DocbookGenerator::startDescTableRow()

1246{

1247DB_GEN_C

1248 m_t << "<row>";

1249 m_t << "<entry>";

1250}

References DB_GEN_C and OutputGenerator::m_t.

startDescTableTitle()

void DocbookGenerator::startDescTableTitle ()

virtual

Declaration at line 185 of file docbookgen.h, definition at line 1258 of file docbookgen.cpp.

1258void DocbookGenerator::startDescTableTitle()

1259{

1260DB_GEN_C

1261}

Reference DB_GEN_C.

startDirDepGraph()

void DocbookGenerator::startDirDepGraph ()

virtual

Declaration at line 259 of file docbookgen.h, definition at line 1326 of file docbookgen.cpp.

1326void DocbookGenerator::startDirDepGraph()

1327{

1328DB_GEN_C

1329}

Reference DB_GEN_C.

startDotGraph()

void DocbookGenerator::startDotGraph ()

virtual

Declaration at line 251 of file docbookgen.h, definition at line 1299 of file docbookgen.cpp.

1299void DocbookGenerator::startDotGraph()

1300{

1301DB_GEN_C

1302}

Reference DB_GEN_C.

startDoxyAnchor()

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

virtual

Declaration at line 231 of file docbookgen.h, definition at line 940 of file docbookgen.cpp.

940void DocbookGenerator::startDoxyAnchor(const QCString &fName,const QCString &,

941 const QCString &anchor,const QCString &,

942 const QCString &)

943{

944DB_GEN_C

945 if (!m_inListItem[m_levelListItem] && !m_descTable && !m_simpleTable)

946 {

947 if (!m_firstMember) closeSection();

948 m_firstMember = FALSE;

949 }

950 if (!anchor.isEmpty())

951 {

952 m_t << "<anchor xml:id=\"_" << stripPath(fName) << "_1" << anchor << "\"/>";

953 }

954}

References closeSection, DB_GEN_C, FALSE, QCString::isEmpty, m_descTable, m_firstMember, m_inListItem, m_levelListItem, m_simpleTable, OutputGenerator::m_t and stripPath.

startEmphasis()

void DocbookGenerator::startEmphasis ()

inline virtual

Definition at line 163 of file docbookgen.h.

163 void startEmphasis() override {DB_GEN_NEW}

Reference DB_GEN_NEW.

startExamples()

void DocbookGenerator::startExamples ()

virtual

Declaration at line 172 of file docbookgen.h, definition at line 1027 of file docbookgen.cpp.

1027void DocbookGenerator::startExamples()

1028{

1029DB_GEN_C

1030 m_t << "<simplesect><title>";

1031 docify(theTranslator->trExamples());

1032 m_t << "</title>";

1033}

References DB_GEN_C, docify, OutputGenerator::m_t and theTranslator.

startFile()

void DocbookGenerator::startFile (const QCString & name, const QCString & manName, const QCString & title, int id, int hierarchyLevel)

virtual

Declaration at line 125 of file docbookgen.h, definition at line 392 of file docbookgen.cpp.

392void DocbookGenerator::startFile(const QCString &name,const QCString &,const QCString &,int,int)

393{

394DB_GEN_C

395 QCString fileName=name;

396 QCString pageName;

397 QCString fileType="section";

398 if (fileName == "refman")

399 {

400 fileName="index";

401 fileType="book";

402 }

403 else if (fileName == "index")

404 {

405 fileName="mainpage";

406 fileType="chapter";

407 }

408 pageName = fileName;

409 relPath = relativePathToRoot(fileName);

410 if (!fileName.endsWith(".xml")) fileName+=".xml";

411 startPlainFile(fileName);

412 m_codeGen->setRelativePath(relPath);

413 m_codeGen->setSourceFileName(stripPath(fileName));

414 m_pageLinks = QCString();

415

416 m_t << "<?xml version='1.0' encoding='UTF-8' standalone='no'?>\n";

417 m_t << "<" << fileType << " xmlns=\"http://docbook.org/ns/docbook\" version=\"5.0\" xmlns:xlink=\"http://www.w3.org/1999/xlink\"";

418 if (!pageName.isEmpty()) m_t << " xml:id=\"_" << stripPath(pageName) << "\"";

419 m_t << " xml:lang=\"" << theTranslator->trISOLang() << "\"";

420 m_t << ">\n";

421}

References DB_GEN_C, OutputGenerator::fileName, QCString::isEmpty, m_codeGen, m_pageLinks, OutputGenerator::m_t, relativePathToRoot, relPath, startPlainFile, stripPath and theTranslator.

startGroupCollaboration()

void DocbookGenerator::startGroupCollaboration ()

virtual

Declaration at line 255 of file docbookgen.h, definition at line 1290 of file docbookgen.cpp.

1290void DocbookGenerator::startGroupCollaboration()

1291{

1292DB_GEN_C

1293}

Reference DB_GEN_C.

startGroupHeader()

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

virtual

Declaration at line 196 of file docbookgen.h, definition at line 833 of file docbookgen.cpp.

833void DocbookGenerator::startGroupHeader(const QCString &,int extraIndentLevel)

834{

835DB_GEN_C2("m_inLevel " << m_inLevel)

836DB_GEN_C2("extraIndentLevel " << extraIndentLevel)

837 m_firstMember = TRUE;

838 if (m_inSimpleSect[m_levelListItem]) m_t << "</simplesect>\n";

839 m_inSimpleSect[m_levelListItem] = FALSE;

840 if (m_inLevel != -1) m_inGroup = TRUE;

841 if (m_inLevel == extraIndentLevel) closeSection();

842 m_inLevel = extraIndentLevel;

843 openSection();

844 m_t << "<title>";

845}

References closeSection, DB_GEN_C2, FALSE, m_firstMember, m_inGroup, m_inLevel, m_inSimpleSect, m_levelListItem, OutputGenerator::m_t, openSection and TRUE.

startHeaderSection()

void DocbookGenerator::startHeaderSection ()

inline virtual

Definition at line 200 of file docbookgen.h.

200 void startHeaderSection() override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

startInclDepGraph()

void DocbookGenerator::startInclDepGraph ()

virtual

Declaration at line 253 of file docbookgen.h, definition at line 1308 of file docbookgen.cpp.

1308void DocbookGenerator::startInclDepGraph()

1309{

1310DB_GEN_C

1311}

Reference DB_GEN_C.

startIndent()

void DocbookGenerator::startIndent ()

inline virtual

Definition at line 246 of file docbookgen.h.

246 void startIndent() override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

startIndexItem()

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

inline virtual

Definition at line 149 of file docbookgen.h.

149 void startIndexItem(const QCString &,const QCString &) override {DB_GEN_NEW}

Reference DB_GEN_NEW.

startIndexKey()

void DocbookGenerator::startIndexKey ()

inline virtual

Definition at line 142 of file docbookgen.h.

142 void startIndexKey() override {DB_GEN_NEW}

Reference DB_GEN_NEW.

startIndexList()

void DocbookGenerator::startIndexList ()

inline virtual

Definition at line 140 of file docbookgen.h.

140 void startIndexList() override {DB_GEN_NEW}

Reference DB_GEN_NEW.

startIndexListItem()

void DocbookGenerator::startIndexListItem ()

inline virtual

Definition at line 138 of file docbookgen.h.

138 void startIndexListItem() override {DB_GEN_NEW}

Reference DB_GEN_NEW.

startIndexSection()

void DocbookGenerator::startIndexSection (IndexSection is)

virtual

Declaration at line 130 of file docbookgen.h, definition at line 448 of file docbookgen.cpp.

448void DocbookGenerator::startIndexSection(IndexSection is)

449{

450DB_GEN_C2("IndexSection " << is)

451 switch (is)

452 {

453 case IndexSection::isTitlePageStart:

454 {

455 QCString dbk_projectName = Config_getString(PROJECT_NAME);

456 m_t << " <info>\n";

457 m_t << " <title>" << convertToDocBook(dbk_projectName) << "</title>\n";

458 m_t << " </info>\n";

459 }

460 break;

461 case IndexSection::isTitlePageAuthor:

462 break;

463 case IndexSection::isMainPage:

464 break;

465 case IndexSection::isModuleIndex:

466 //Module Index\n"

467 break;

468 case IndexSection::isTopicIndex:

469 //Module Index\n"

470 break;

471 case IndexSection::isDirIndex:

472 //Directory Index\n"

473 break;

474 case IndexSection::isNamespaceIndex:

475 //Namespace Index\n"

476 break;

477 case IndexSection::isConceptIndex:

478 //Concept Index\n"

479 break;

480 case IndexSection::isClassHierarchyIndex:

481 //Hierarchical Index\n"

482 break;

483 case IndexSection::isCompoundIndex:

484 //m_t << "{"; //Class Index}\n"

485 break;

486 case IndexSection::isFileIndex:

487 //Annotated File Index\n"

488 break;

489 case IndexSection::isPageIndex:

490 //Annotated Page Index\n"

491 break;

492 case IndexSection::isModuleDocumentation:

493 m_t << "<chapter>\n";

494 m_t << " <title>";

495 break;

496 case IndexSection::isTopicDocumentation:

497 m_t << "<chapter>\n";

498 m_t << " <title>";

499 break;

500 case IndexSection::isDirDocumentation:

501 m_t << "<chapter>\n";

502 m_t << " <title>";

503 break;

504 case IndexSection::isNamespaceDocumentation:

505 m_t << "<chapter>\n";

506 m_t << " <title>";

507 break;

508 case IndexSection::isConceptDocumentation:

509 m_t << "<chapter>\n";

510 m_t << " <title>";

511 break;

512 case IndexSection::isClassDocumentation:

513 m_t << "<chapter>\n";

514 m_t << " <title>";

515 break;

516 case IndexSection::isFileDocumentation:

517 m_t << "<chapter>\n";

518 m_t << " <title>";

519 break;

520 case IndexSection::isExampleDocumentation:

521 m_t << "<chapter>\n";

522 m_t << " <title>";

523 break;

524 case IndexSection::isPageDocumentation:

525 break;

526 case IndexSection::isPageDocumentation2:

527 break;

528 case IndexSection::isEndIndex:

529 break;

530 }

531}

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)

inline virtual

Definition at line 144 of file docbookgen.h.

144 void startIndexValue(bool) override {DB_GEN_NEW}

Reference DB_GEN_NEW.

startInlineHeader()

void DocbookGenerator::startInlineHeader ()

inline virtual

Definition at line 210 of file docbookgen.h.

210 void startInlineHeader() override {DB_GEN_NEW}

Reference DB_GEN_NEW.

startInlineMemberDoc()

void DocbookGenerator::startInlineMemberDoc ()

virtual

Declaration at line 308 of file docbookgen.h, definition at line 1209 of file docbookgen.cpp.

1209void DocbookGenerator::startInlineMemberDoc()

1210{

1211DB_GEN_C

1212 m_t << "<entry>";

1213}

References DB_GEN_C and OutputGenerator::m_t.

startInlineMemberName()

void DocbookGenerator::startInlineMemberName ()

virtual

Declaration at line 306 of file docbookgen.h, definition at line 1197 of file docbookgen.cpp.

1197void DocbookGenerator::startInlineMemberName()

1198{

1199DB_GEN_C

1200 m_t << "<entry>";

1201}

References DB_GEN_C and OutputGenerator::m_t.

startInlineMemberType()

void DocbookGenerator::startInlineMemberType ()

virtual

Declaration at line 304 of file docbookgen.h, definition at line 1185 of file docbookgen.cpp.

1185void DocbookGenerator::startInlineMemberType()

1186{

1187DB_GEN_C

1188 m_t << "<row><entry>";

1189}

References DB_GEN_C and OutputGenerator::m_t.

startItemList()

void DocbookGenerator::startItemList ()

inline virtual

Definition at line 146 of file docbookgen.h.

146 void startItemList() override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

startItemListItem()

void DocbookGenerator::startItemListItem ()

inline virtual

Definition at line 151 of file docbookgen.h.

151 void startItemListItem() override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

startLabels()

void DocbookGenerator::startLabels ()

virtual

Declaration at line 311 of file docbookgen.h, definition at line 1011 of file docbookgen.cpp.

1011void DocbookGenerator::startLabels()

1012{

1013DB_GEN_C

1014}

Reference DB_GEN_C.

startLocalToc()

void DocbookGenerator::startLocalToc (int level)

virtual

Declaration at line 315 of file docbookgen.h, definition at line 1415 of file docbookgen.cpp.

1415void DocbookGenerator::startLocalToc(int level)

1416{

1417 m_tocState.level=1;

1418 m_tocState.maxLevel=level;

1419 m_tocState.inLi = BoolVector(level+1,false);

1420 m_t << " <toc>\n";

1421 m_t << " <title>" << theTranslator->trRTFTableOfContents() << "</title>\n";

1422}

References OutputGenerator::m_t, m_tocState and theTranslator.

startMemberDeclaration()

void DocbookGenerator::startMemberDeclaration ()

inline virtual

Definition at line 241 of file docbookgen.h.

241 void startMemberDeclaration() override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

startMemberDescription()

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

inline virtual

Definition at line 239 of file docbookgen.h.

239 void startMemberDescription(const QCString &,const QCString &,bool) override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

startMemberDoc()

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

virtual

Declaration at line 228 of file docbookgen.h, definition at line 907 of file docbookgen.cpp.

907void DocbookGenerator::startMemberDoc(const QCString &clname, const QCString &memname, const QCString &, const QCString &title,

908 int memCount, int memTotal, bool)

909{

910DB_GEN_C2("m_inLevel " << m_inLevel)

911 openSection();

912 m_t << " <title>" << convertToDocBook(title);

913 if (memTotal>1)

914 {

915 m_t << "<computeroutput>[" << memCount << "/" << memTotal << "]</computeroutput>";

916 }

917 m_t << "</title>\n";

918 if (!memname.isEmpty() && memname[0]!='@')

919 {

920 addIndexTerm(m_t,memname,clname);

921 addIndexTerm(m_t,clname,memname);

922 }

923}

References addIndexTerm, convertToDocBook, DB_GEN_C2, QCString::isEmpty, m_inLevel, OutputGenerator::m_t and openSection.

startMemberDocList()

void DocbookGenerator::startMemberDocList ()

virtual

Declaration at line 206 of file docbookgen.h, definition at line 1335 of file docbookgen.cpp.

1335void DocbookGenerator::startMemberDocList()

1336{

1337DB_GEN_C

1338}

Reference DB_GEN_C.

startMemberDocName()

void DocbookGenerator::startMemberDocName (bool)

virtual

Declaration at line 279 of file docbookgen.h, definition at line 963 of file docbookgen.cpp.

963void DocbookGenerator::startMemberDocName(bool)

964{

965DB_GEN_C

966 m_t << "<para><computeroutput>";

967}

References DB_GEN_C and OutputGenerator::m_t.

startMemberDocPrefixItem()

void DocbookGenerator::startMemberDocPrefixItem ()

virtual

Declaration at line 277 of file docbookgen.h, definition at line 1058 of file docbookgen.cpp.

1058void DocbookGenerator::startMemberDocPrefixItem()

1059{

1060DB_GEN_C

1061 m_t << "<computeroutput>";

1062}

References DB_GEN_C and OutputGenerator::m_t.

startMemberDocSimple()

void DocbookGenerator::startMemberDocSimple (bool isEnum)

virtual

Declaration at line 302 of file docbookgen.h, definition at line 1150 of file docbookgen.cpp.

1150void DocbookGenerator::startMemberDocSimple(bool isEnum)

1151{

1152DB_GEN_C

1153 int ncols=0;

1154 QCString title;

1155 if (isEnum)

1156 {

1157 ncols = 2;

1158 title = theTranslator->trEnumerationValues();

1159 }

1160 else

1161 {

1162 ncols = 3;

1163 title = theTranslator->trCompoundMembers();

1164 }

1165 m_t << "<table frame=\"all\">\n";

1166 if (!title.isEmpty()) m_t << "<title>" << convertToDocBook(title) << "</title>\n";

1167 m_t << " <tgroup cols=\"" << ncols << "\" align=\"left\" colsep=\"1\" rowsep=\"1\">\n";

1168 for (int i = 0; i < ncols; i++)

1169 {

1170 m_t << " <colspec colname='c" << i+1 << "'/>\n";

1171 }

1172 m_t << "<tbody>\n";

1173 m_simpleTable = true;

1174}

References convertToDocBook, DB_GEN_C, QCString::isEmpty, m_simpleTable, OutputGenerator::m_t and theTranslator.

startMemberGroup()

void DocbookGenerator::startMemberGroup ()

virtual

Declaration at line 224 of file docbookgen.h, definition at line 982 of file docbookgen.cpp.

982void DocbookGenerator::startMemberGroup()

983{

984DB_GEN_C

985}

Reference DB_GEN_C.

startMemberGroupDocs()

void DocbookGenerator::startMemberGroupDocs ()

inline virtual

Definition at line 222 of file docbookgen.h.

222 void startMemberGroupDocs() override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

startMemberGroupHeader()

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

virtual

Declaration at line 220 of file docbookgen.h, definition at line 972 of file docbookgen.cpp.

972void DocbookGenerator::startMemberGroupHeader(const QCString &,bool)

973{

974DB_GEN_C

975 m_t << "<simplesect><title>";

976}

References DB_GEN_C and OutputGenerator::m_t.

startMemberHeader()

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

virtual

Declaration at line 202 of file docbookgen.h, definition at line 753 of file docbookgen.cpp.

753void DocbookGenerator::startMemberHeader(const QCString &,int)

754{

755DB_GEN_C

756 m_t << "<simplesect>\n";

757 m_inSimpleSect[m_levelListItem] = TRUE;

758 m_t << " <title>";

759}

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

startMemberItem()

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

virtual

Declaration at line 214 of file docbookgen.h, definition at line 811 of file docbookgen.cpp.

811void DocbookGenerator::startMemberItem(const QCString &,MemberItemType,const QCString &)

812{

813DB_GEN_C

814 if (m_inListItem[m_levelListItem]) m_t << "</listitem>\n";

815 m_t << " <listitem><para>";

816 m_inListItem[m_levelListItem] = TRUE;

817}

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

startMemberList()

void DocbookGenerator::startMemberList ()

virtual

Declaration at line 208 of file docbookgen.h, definition at line 795 of file docbookgen.cpp.

795void DocbookGenerator::startMemberList()

796{

797DB_GEN_C

798 m_t << " <itemizedlist>\n";

799 m_levelListItem++;

800}

References DB_GEN_C, m_levelListItem and OutputGenerator::m_t.

startMemberSections()

void DocbookGenerator::startMemberSections ()

inline virtual

Definition at line 198 of file docbookgen.h.

198 void startMemberSections() override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

startMemberSubtitle()

void DocbookGenerator::startMemberSubtitle ()

inline virtual

Definition at line 204 of file docbookgen.h.

204 void startMemberSubtitle() override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

startMemberTemplateParams()

void DocbookGenerator::startMemberTemplateParams ()

virtual

Declaration at line 216 of file docbookgen.h, definition at line 1121 of file docbookgen.cpp.

1121void DocbookGenerator::startMemberTemplateParams()

1122{

1123DB_GEN_C

1124}

Reference DB_GEN_C.

startPageDoc()

void DocbookGenerator::startPageDoc (const QCString &)

inline virtual

Definition at line 272 of file docbookgen.h.

272 void startPageDoc(const QCString &) override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

startPageRef()

void DocbookGenerator::startPageRef ()

inline virtual

Definition at line 193 of file docbookgen.h.

193 void startPageRef() override {DB_GEN_NEW}

Reference DB_GEN_NEW.

startParagraph()

void DocbookGenerator::startParagraph (const QCString &)

virtual

Declaration at line 156 of file docbookgen.h, definition at line 737 of file docbookgen.cpp.

737void DocbookGenerator::startParagraph(const QCString &)

738{

739DB_GEN_C

740 m_t << "<para>\n";

741}

References DB_GEN_C and OutputGenerator::m_t.

startParameterDefVal()

void DocbookGenerator::startParameterDefVal (const char * sep)

virtual

Declaration at line 287 of file docbookgen.h, definition at line 1108 of file docbookgen.cpp.

1108void DocbookGenerator::startParameterDefVal(const char *sep)

1109{

1110DB_GEN_C

1111 m_t << sep;

1112 if (!m_denseText) m_t << "<computeroutput>";

1113}

References DB_GEN_C, m_denseText and OutputGenerator::m_t.

startParameterExtra()

void DocbookGenerator::startParameterExtra ()

virtual

Declaration at line 285 of file docbookgen.h, definition at line 1093 of file docbookgen.cpp.

1093void DocbookGenerator::startParameterExtra()

1094{

1095DB_GEN_C

1096}

Reference DB_GEN_C.

startParameterList()

void DocbookGenerator::startParameterList (bool openBracket)

virtual

Declaration at line 289 of file docbookgen.h, definition at line 860 of file docbookgen.cpp.

860void DocbookGenerator::startParameterList(bool openBracket)

861{

862DB_GEN_C

863 if (openBracket) m_t << "(";

864}

References DB_GEN_C and OutputGenerator::m_t.

startParameterName()

void DocbookGenerator::startParameterName (bool)

virtual

Declaration at line 283 of file docbookgen.h, definition at line 1082 of file docbookgen.cpp.

1082void DocbookGenerator::startParameterName(bool)

1083{

1084DB_GEN_C

1085 m_t << " ";

1086}

References DB_GEN_C and OutputGenerator::m_t.

startParameterType()

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

inline virtual

Definition at line 281 of file docbookgen.h.

281 void startParameterType(bool,const QCString &) override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

startPlainFile()

void DocbookGenerator::startPlainFile (const QCString & name)

inline virtual

Definition at line 320 of file docbookgen.h.

320 void startPlainFile(const QCString &name) override { OutputGenerator::startPlainFile(name); }

Reference OutputGenerator::startPlainFile.

Referenced by startFile.

startProjectNumber()

void DocbookGenerator::startProjectNumber ()

inline virtual

Definition at line 133 of file docbookgen.h.

133 void startProjectNumber() override {DB_GEN_NEW}

Reference DB_GEN_NEW.

startQuickIndices()

void DocbookGenerator::startQuickIndices ()

inline virtual

Definition at line 262 of file docbookgen.h.

262 void startQuickIndices() override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

startSection()

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

virtual

Declaration at line 175 of file docbookgen.h, definition at line 1132 of file docbookgen.cpp.

1132void DocbookGenerator::startSection(const QCString &lab,const QCString &,SectionType)

1133{

1134DB_GEN_C

1135 openSection("xml:id=\"_" + stripPath(lab) + "\"");

1136 m_t << "<title>";

1137}

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

startSmall()

void DocbookGenerator::startSmall ()

inline virtual

Definition at line 170 of file docbookgen.h.

170 void startSmall() override {DB_GEN_NEW}

Reference DB_GEN_NEW.

startTextBlock()

void DocbookGenerator::startTextBlock (bool dense)

virtual

Declaration at line 274 of file docbookgen.h, definition at line 889 of file docbookgen.cpp.

889void DocbookGenerator::startTextBlock(bool dense)

890{

891DB_GEN_C

892 if (dense)

893 {

894 m_denseText = TRUE;

895 m_t << "<programlisting linenumbering=\"unnumbered\">";

896 }

897}

References DB_GEN_C, m_denseText, OutputGenerator::m_t and TRUE.

startTextLink()

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

inline virtual

Definition at line 191 of file docbookgen.h.

191 void startTextLink(const QCString &,const QCString &) override {DB_GEN_NEW}

Reference DB_GEN_NEW.

startTitleHead()

void DocbookGenerator::startTitleHead (const QCString &)

virtual

Declaration at line 136 of file docbookgen.h, definition at line 929 of file docbookgen.cpp.

929void DocbookGenerator::startTitleHead(const QCString &)

930{

931DB_GEN_C

932 m_t << "<title>";

933}

References DB_GEN_C and OutputGenerator::m_t.

startTocEntry()

void DocbookGenerator::startTocEntry (const SectionInfo * si)

virtual

Declaration at line 317 of file docbookgen.h, definition at line 1435 of file docbookgen.cpp.

1435void DocbookGenerator::startTocEntry(const SectionInfo *si)

1436{

1437 SectionType type = si->type();

1438 if (type.isSection())

1439 {

1440 //printf(" level=%d title=%s\n",level,qPrint(si->title));

1441 int nextLevel = type.level();

1442 if (nextLevel>m_tocState.level)

1443 {

1444 for (int l=m_tocState.level;l<nextLevel;l++)

1445 {

1446 if (l < m_tocState.maxLevel) m_t << " <tocdiv>\n";

1447 }

1448 }

1449 else if (nextLevel<m_tocState.level)

1450 {

1451 for (int l=m_tocState.level;l>nextLevel;l--)

1452 {

1453 m_tocState.inLi[l]=false;

1454 if (l <= m_tocState.maxLevel) m_t << " </tocdiv>\n";

1455 }

1456 }

1457 if (nextLevel <= m_tocState.maxLevel)

1458 {

1459 QCString label = convertToDocBook(si->label());

1460 m_t << " <tocentry>";

1461 }

1462 }

1463}

References convertToDocBook, SectionInfo::label, OutputGenerator::m_t, m_tocState, type and SectionInfo::type.

startTypewriter()

void DocbookGenerator::startTypewriter ()

virtual

Declaration at line 161 of file docbookgen.h, definition at line 879 of file docbookgen.cpp.

879void DocbookGenerator::startTypewriter()

880{

881DB_GEN_C

882 if (!m_denseText) m_t << "<computeroutput>";

883}

References DB_GEN_C, m_denseText and OutputGenerator::m_t.

type()

OutputType DocbookGenerator::type ()

inline virtual

Definition at line 120 of file docbookgen.h.

120 OutputType type() const override { return OutputType::Docbook; }

Reference Docbook.

Referenced by endTocEntry and startTocEntry.

writeAnchor()

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

inline virtual

Definition at line 174 of file docbookgen.h.

174 void writeAnchor(const QCString &,const QCString &) override {DB_GEN_EMPTY}

Reference DB_GEN_EMPTY.

writeChar()

void DocbookGenerator::writeChar (char c)

virtual

Declaration at line 154 of file docbookgen.h, definition at line 1050 of file docbookgen.cpp.

1050void DocbookGenerator::writeChar(char c)

1051{

1052DB_GEN_C

1053 char cs[2];

1054 cs[0]=c;

1055 cs[1]=0;

1056 docify(cs);

1057}

References DB_GEN_C and docify.

writeDoc()

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

virtual

Declaration at line 124 of file docbookgen.h, definition at line 726 of file docbookgen.cpp.

726void DocbookGenerator::writeDoc(const IDocNodeAST *ast,const Definition *ctx,const MemberDef *,int)

727{

728DB_GEN_C

729 auto astImpl = dynamic_cast<const DocNodeAST*>(ast);

730 if (astImpl)

731 {

732 DocbookDocVisitor visitor(m_t,*m_codeList,ctx?ctx->getDefFileExtension():QCString());

733 std::visit(visitor,astImpl->root);

734 }

735}

References DB_GEN_C, Definition::getDefFileExtension, m_codeList and OutputGenerator::m_t.

writeFooter()

void DocbookGenerator::writeFooter (const QCString &)

inline virtual

Definition at line 129 of file docbookgen.h.

129 void writeFooter(const QCString &) override {DB_GEN_NEW}

Reference DB_GEN_NEW.

writeGraphicalHierarchy()

void DocbookGenerator::writeGraphicalHierarchy (DotGfxHierarchyTable &)

inline virtual

Definition at line 261 of file docbookgen.h.

261 void writeGraphicalHierarchy(DotGfxHierarchyTable &) override {DB_GEN_NEW}

Reference DB_GEN_NEW.

writeInheritedSectionTitle()

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

virtual

Declaration at line 243 of file docbookgen.h, definition at line 1406 of file docbookgen.cpp.

1406void DocbookGenerator::writeInheritedSectionTitle(

1407 const QCString &/*id*/,const QCString &ref,

1408 const QCString &file, const QCString &anchor,

1409 const QCString &title, const QCString &name)

1410{

1411DB_GEN_C

1412 m_t << theTranslator->trInheritedFrom(convertToDocBook(title), objectLinkToString(ref, file, anchor, name));

1413}

References convertToDocBook, DB_GEN_C, OutputGenerator::m_t, objectLinkToString and theTranslator.