Doxygen
Public 成员函数 | 静态 Public 成员函数 | Private 成员函数 | Private 属性 | 所有成员列表
DocbookGenerator类 参考

#include <docbookgen.h>

+ 类 DocbookGenerator 继承关系图:
+ DocbookGenerator 的协作图:

Public 成员函数

 DocbookGenerator ()
 
 DocbookGenerator (const DocbookGenerator &o)
 
DocbookGenerator & operator= (const DocbookGenerator &o)
 
virtual ~DocbookGenerator ()
 
virtual std::unique_ptr< OutputGenerator > clone () const
 
void cleanup ()
 
OutputType type () const
 
void codify (const QCString &text)
 
void writeCodeLink (CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip)
 
void writeLineNumber (const QCString &ref, const QCString &file, const QCString &anchor, int lineNumber, bool writeLineAnchor)
 
void writeTooltip (const QCString &id, const DocLinkInfo &docInfo, const QCString &decl, const QCString &desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo)
 
void startCodeLine (bool hasLineNumbers)
 
void endCodeLine ()
 
void startFontClass (const QCString &s)
 
void endFontClass ()
 
void writeCodeAnchor (const QCString &anchor)
 
void startCodeFragment (const QCString &style)
 
void endCodeFragment (const QCString &style)
 
void writeDoc (DocNode *, const Definition *ctx, const MemberDef *md, int id)
 
void startFile (const QCString &name, const QCString &manName, const QCString &title, int id)
 
void writeSearchInfo ()
 
void writeFooter (const QCString &)
 
void endFile ()
 
void startIndexSection (IndexSections)
 
void endIndexSection (IndexSections)
 
void writePageLink (const QCString &, bool)
 
void startProjectNumber ()
 
void endProjectNumber ()
 
void writeStyleInfo (int)
 
void startTitleHead (const QCString &)
 
void endTitleHead (const QCString &fileName, const QCString &name)
 
void startIndexListItem ()
 
void endIndexListItem ()
 
void startIndexList ()
 
void endIndexList ()
 
void startIndexKey ()
 
void endIndexKey ()
 
void startIndexValue (bool)
 
void endIndexValue (const QCString &, bool)
 
void startItemList ()
 
void endItemList ()
 
void startIndexItem (const QCString &, const QCString &)
 
void endIndexItem (const QCString &, const QCString &)
 
void startItemListItem ()
 
void endItemListItem ()
 
void docify (const QCString &text)
 
void writeChar (char)
 
void writeString (const QCString &)
 
void startParagraph (const QCString &)
 
void endParagraph ()
 
void writeObjectLink (const QCString &, const QCString &, const QCString &, const QCString &)
 
void startHtmlLink (const QCString &)
 
void endHtmlLink ()
 
void startBold ()
 
void endBold ()
 
void startTypewriter ()
 
void endTypewriter ()
 
void startEmphasis ()
 
void endEmphasis ()
 
void writeRuler ()
 
void startDescription ()
 
void endDescription ()
 
void startDescItem ()
 
void startDescForItem ()
 
void endDescForItem ()
 
void endDescItem ()
 
void startCenter ()
 
void endCenter ()
 
void startSmall ()
 
void endSmall ()
 
void startExamples ()
 
void endExamples ()
 
void startParamList (BaseOutputDocInterface::ParamListTypes, const QCString &)
 
void endParamList ()
 
void startTitle ()
 
void endTitle ()
 
void writeAnchor (const QCString &, const QCString &)
 
void startSection (const QCString &, const QCString &, SectionType)
 
void endSection (const QCString &, SectionType)
 
void lineBreak (const QCString &)
 
void addIndexItem (const QCString &, const QCString &)
 
void writeNonBreakableSpace (int)
 
void startDescTable (const QCString &)
 
void endDescTable ()
 
void startDescTableRow ()
 
void endDescTableRow ()
 
void startDescTableTitle ()
 
void endDescTableTitle ()
 
void startDescTableData ()
 
void endDescTableData ()
 
void startTextLink (const QCString &, const QCString &)
 
void endTextLink ()
 
void startPageRef ()
 
void endPageRef (const QCString &, const QCString &)
 
void startSubsection ()
 
void endSubsection ()
 
void startSubsubsection ()
 
void endSubsubsection ()
 
void startGroupHeader (int)
 
void endGroupHeader (int)
 
void startMemberSections ()
 
void endMemberSections ()
 
void startHeaderSection ()
 
void endHeaderSection ()
 
void startMemberHeader (const QCString &anchor, int typ)
 
void endMemberHeader ()
 
void startMemberSubtitle ()
 
void endMemberSubtitle ()
 
void startMemberDocList ()
 
void endMemberDocList ()
 
void startMemberList ()
 
void endMemberList ()
 
void startInlineHeader ()
 
void endInlineHeader ()
 
void startAnonTypeScope (int)
 
void endAnonTypeScope (int)
 
void startMemberItem (const QCString &, int, const QCString &)
 
void endMemberItem ()
 
void startMemberTemplateParams ()
 
void endMemberTemplateParams (const QCString &, const QCString &)
 
void startCompoundTemplateParams ()
 
void endCompoundTemplateParams ()
 
void startMemberGroupHeader (bool)
 
void endMemberGroupHeader ()
 
void startMemberGroupDocs ()
 
void endMemberGroupDocs ()
 
void startMemberGroup ()
 
void endMemberGroup (bool)
 
void insertMemberAlign (bool)
 
void insertMemberAlignLeft (int, bool)
 
void startMemberDoc (const QCString &, const QCString &, const QCString &, const QCString &, int, int, bool)
 
void endMemberDoc (bool)
 
void startDoxyAnchor (const QCString &fName, const QCString &manName, const QCString &anchor, const QCString &name, const QCString &args)
 
void endDoxyAnchor (const QCString &fileName, const QCString &anchor)
 
void writeLatexSpacing ()
 
void writeStartAnnoItem (const QCString &, const QCString &, const QCString &, const QCString &)
 
void writeEndAnnoItem (const QCString &)
 
void startMemberDescription (const QCString &, const QCString &, bool)
 
void endMemberDescription ()
 
void startMemberDeclaration ()
 
void endMemberDeclaration (const QCString &, const QCString &)
 
void writeInheritedSectionTitle (const QCString &, const QCString &, const QCString &, const QCString &, const QCString &, const QCString &)
 
void startIndent ()
 
void endIndent ()
 
void writeSynopsis ()
 
void startClassDiagram ()
 
void endClassDiagram (const ClassDiagram &, const QCString &, const QCString &)
 
void startDotGraph ()
 
void endDotGraph (DotClassGraph &g)
 
void startInclDepGraph ()
 
void endInclDepGraph (DotInclDepGraph &g)
 
void startGroupCollaboration ()
 
void endGroupCollaboration (DotGroupCollaboration &g)
 
void startCallGraph ()
 
void endCallGraph (DotCallGraph &g)
 
void startDirDepGraph ()
 
void endDirDepGraph (DotDirDeps &g)
 
void writeGraphicalHierarchy (DotGfxHierarchyTable &)
 
void startQuickIndices ()
 
void endQuickIndices ()
 
void writeSplitBar (const QCString &)
 
void writeNavigationPath (const QCString &)
 
void writeLogo ()
 
void writeQuickLinks (bool, HighlightedItem, const QCString &)
 
void writeSummaryLink (const QCString &, const QCString &, const QCString &, bool)
 
void startContents ()
 
void endContents ()
 
void startPageDoc (const QCString &)
 
void endPageDoc ()
 
void startTextBlock (bool)
 
void endTextBlock (bool)
 
void lastIndexPage ()
 
void startMemberDocPrefixItem ()
 
void endMemberDocPrefixItem ()
 
void startMemberDocName (bool)
 
void endMemberDocName ()
 
void startParameterType (bool, const QCString &)
 
void endParameterType ()
 
void startParameterName (bool)
 
void endParameterName (bool, bool, bool)
 
void startParameterList (bool)
 
void endParameterList ()
 
void exceptionEntry (const QCString &, bool)
 
void startConstraintList (const QCString &)
 
void startConstraintParam ()
 
void endConstraintParam ()
 
void startConstraintType ()
 
void endConstraintType ()
 
void startConstraintDocs ()
 
void endConstraintDocs ()
 
void endConstraintList ()
 
void startMemberDocSimple (bool)
 
void endMemberDocSimple (bool)
 
void startInlineMemberType ()
 
void endInlineMemberType ()
 
void startInlineMemberName ()
 
void endInlineMemberName ()
 
void startInlineMemberDoc ()
 
void endInlineMemberDoc ()
 
void startLabels ()
 
void writeLabel (const QCString &, bool)
 
void endLabels ()
 
void setCurrentDoc (const Definition *, const QCString &, bool)
 
void addWord (const QCString &, bool)
 
- Public 成员函数 继承自 OutputGenerator
 OutputGenerator (const QCString &dir)
 
 OutputGenerator (const OutputGenerator &o)
 
OutputGenerator & operator= (const OutputGenerator &o)
 
virtual ~OutputGenerator ()
 
void enable ()
 
void disable ()
 
void enableIf (OutputType o)
 
void disableIf (OutputType o)
 
void disableIfNot (OutputType o)
 
bool isEnabled (OutputType o)
 
OutputGenerator * get (OutputType o)
 
QCString dir () const
 
QCString fileName () const
 
void startPlainFile (const QCString &name)
 
void endPlainFile ()
 
bool isEnabled () const
 
void pushGeneratorState ()
 
void popGeneratorState ()
 
- Public 成员函数 继承自 BaseOutputDocInterface
virtual ~BaseOutputDocInterface ()
 
virtual void parseText (const QCString &)
 
- Public 成员函数 继承自 CodeOutputInterface
virtual ~CodeOutputInterface ()
 
 CodeOutputInterface ()
 
 CodeOutputInterface (const CodeOutputInterface &)=delete
 
CodeOutputInterface & operator= (const CodeOutputInterface &)=delete
 
virtual int id () const
 Identifier for the output file 更多...
 

静态 Public 成员函数

static void init ()
 

Private 成员函数

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

Private 属性

QCString relPath
 
DocbookCodeGenerator m_codeGen
 
bool m_denseText = false
 
bool m_inGroup = false
 
int m_levelListItem = 0
 
bool m_inListItem [20] = { false, }
 
bool m_inSimpleSect [20] = { false, }
 
bool m_descTable = false
 
bool m_simpleTable = false
 
int m_inLevel = -1
 
bool m_firstMember = false
 
int m_openSectionCount = 0
 

额外继承的成员函数

- Public 类型 继承自 OutputGenerator
enum  OutputType {
  Html, Latex, Man, RTF,
  XML, DEF, Perl, Docbook
}
 
- Public 类型 继承自 BaseOutputDocInterface
enum  ParamListTypes { Param, RetVal, Exception }
 
enum  SectionTypes { EnumValues, Examples }
 
- Protected 属性 继承自 OutputGenerator
TextStream m_t
 

详细描述

在文件 docbookgen.h 第 93 行定义.

构造及析构函数说明

◆ DocbookGenerator() [1/2]

DocbookGenerator::DocbookGenerator ( )

在文件 docbookgen.cpp 第 286 行定义.

286  : OutputGenerator(Config_getString(DOCBOOK_OUTPUT)), m_codeGen(m_t)
287 {
288 DB_GEN_C
289 }

引用了 DB_GEN_C.

◆ DocbookGenerator() [2/2]

DocbookGenerator::DocbookGenerator ( const DocbookGenerator &  o)

在文件 docbookgen.cpp 第 291 行定义.

291  : OutputGenerator(og), m_codeGen(m_t)
292 {
293 }

◆ ~DocbookGenerator()

DocbookGenerator::~DocbookGenerator ( )
virtual

在文件 docbookgen.cpp 第 306 行定义.

307 {
308 DB_GEN_C
309 }

引用了 DB_GEN_C.

成员函数说明

◆ addIndexItem()

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

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 1013 行定义.

1014 {
1015 DB_GEN_C
1016  addIndexTerm(m_t, prim, sec);
1017 }

引用了 addIndexTerm(), DB_GEN_C , 以及 OutputGenerator::m_t.

◆ addWord()

void DocbookGenerator::addWord ( const QCString &  ,
bool   
)
inlinevirtual

实现了 CodeOutputInterface.

在文件 docbookgen.h 第 340 行定义.

340 {DB_GEN_EMPTY}

引用了 DB_GEN_EMPTY.

◆ cleanup()

void DocbookGenerator::cleanup ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 322 行定义.

323 {
324  QCString dname = Config_getString(DOCBOOK_OUTPUT);
325  Dir d(dname.str());
326  clearSubDirs(d);
327 }

引用了 clearSubDirs(), Config_getString , 以及 QCString::str().

◆ clone()

std::unique_ptr< OutputGenerator > DocbookGenerator::clone ( ) const
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 301 行定义.

302 {
303  return std::make_unique<DocbookGenerator>(*this);
304 }

◆ closeAllSections()

void DocbookGenerator::closeAllSections ( )
private

在文件 docbookgen.cpp 第 1256 行定义.

1257 {
1258  while (m_openSectionCount>0)
1259  {
1260  closeSection();
1261  }
1262 }

引用了 closeSection() , 以及 m_openSectionCount.

被这些函数引用 endFile().

◆ closeSection()

void DocbookGenerator::closeSection ( )
private

在文件 docbookgen.cpp 第 1250 行定义.

1251 {
1252  m_t << "</section>\n";
1253  m_openSectionCount--;
1254 }

引用了 m_openSectionCount , 以及 OutputGenerator::m_t.

被这些函数引用 closeAllSections(), endSection(), startDoxyAnchor(), startGroupHeader() , 以及 writeRuler().

◆ codify()

void DocbookGenerator::codify ( const QCString &  s)
inlinevirtual

Writes an code fragment to the output. This function should keep spaces visible, should break lines at a newline and should convert tabs to the right number of spaces.

实现了 CodeOutputInterface.

在文件 docbookgen.h 第 108 行定义.

109  { m_codeGen.codify(text); }

引用了 DocbookCodeGenerator::codify() , 以及 m_codeGen.

◆ docify()

void DocbookGenerator::docify ( const QCString &  s)
virtual

Writes an ASCII string to the output. Converts characters that have A special meaning, like & in html.

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 674 行定义.

675 {
676 DB_GEN_C
677  m_t << convertToDocBook(str);
678 }

引用了 convertToDocBook(), DB_GEN_C , 以及 OutputGenerator::m_t.

被这些函数引用 startConstraintList(), startExamples(), writeChar() , 以及 writeObjectLink().

◆ endAnonTypeScope()

void DocbookGenerator::endAnonTypeScope ( int  )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 242 行定义.

242 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ endBold()

void DocbookGenerator::endBold ( )
virtual

End a section of text displayed in bold face.

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 728 行定义.

729 {
730 DB_GEN_C
731  m_t << "</emphasis>";
732 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ endCallGraph()

void DocbookGenerator::endCallGraph ( DotCallGraph &  g)
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1179 行定义.

1180 {
1181 DB_GEN_C
1182  QCString fn = g.writeGraph(m_t,GOF_BITMAP,EOF_DocBook,dir(),fileName(),relPath,FALSE);
1183 }

引用了 DB_GEN_C, OutputGenerator::dir(), EOF_DocBook, FALSE, OutputGenerator::fileName(), GOF_BITMAP, OutputGenerator::m_t, relPath , 以及 DotCallGraph::writeGraph().

◆ endCenter()

void DocbookGenerator::endCenter ( )
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 192 行定义.

192 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ endClassDiagram()

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

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 893 行定义.

894 {
895 DB_GEN_C
896  m_t << " <informalfigure>\n";
897  m_t << " <mediaobject>\n";
898  m_t << " <imageobject>\n";
899  m_t << " <imagedata width=\"50%\" align=\"center\" valign=\"middle\" scalefit=\"0\" fileref=\""
900  << relPath << fileName << ".png\">" << "</imagedata>\n";
901  m_t << " </imageobject>\n";
902  d.writeImage(m_t,dir(),relPath,fileName,FALSE);
903  m_t << " </mediaobject>\n";
904  m_t << " </informalfigure>\n";
905  m_t << "</para>\n";
906 }

引用了 DB_GEN_C, OutputGenerator::dir(), FALSE, OutputGenerator::fileName(), OutputGenerator::m_t, relPath , 以及 ClassDiagram::writeImage().

◆ endCodeFragment()

void DocbookGenerator::endCodeFragment ( const QCString &  style)
inlinevirtual

Ends a block of code

实现了 CodeOutputInterface.

在文件 docbookgen.h 第 133 行定义.

134  { m_codeGen.endCodeFragment(style); }

引用了 DocbookCodeGenerator::endCodeFragment() , 以及 m_codeGen.

◆ endCodeLine()

void DocbookGenerator::endCodeLine ( )
inlinevirtual

Ends a line of code started with startCodeLine()

实现了 CodeOutputInterface.

在文件 docbookgen.h 第 123 行定义.

124  { m_codeGen.endCodeLine(); }

引用了 DocbookCodeGenerator::endCodeLine() , 以及 m_codeGen.

◆ endCompoundTemplateParams()

void DocbookGenerator::endCompoundTemplateParams ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 248 行定义.

248 { endSubsubsection(); }

引用了 endSubsubsection().

◆ endConstraintDocs()

void DocbookGenerator::endConstraintDocs ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1232 行定义.

1233 {
1234 DB_GEN_C
1235 }

引用了 DB_GEN_C.

◆ endConstraintList()

void DocbookGenerator::endConstraintList ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1236 行定义.

1237 {
1238 DB_GEN_C
1239  m_t << "</simplesect>\n";
1240 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ endConstraintParam()

void DocbookGenerator::endConstraintParam ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1214 行定义.

1215 {
1216 DB_GEN_C
1217 }

引用了 DB_GEN_C.

◆ endConstraintType()

void DocbookGenerator::endConstraintType ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1223 行定义.

1224 {
1225 DB_GEN_C
1226  m_t << "</emphasis></para>\n";
1227 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ endContents()

void DocbookGenerator::endContents ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 299 行定义.

299 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ endDescForItem()

void DocbookGenerator::endDescForItem ( )
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 189 行定义.

189 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ endDescItem()

void DocbookGenerator::endDescItem ( )
inlinevirtual

Ends an item of a description list and starts the description itself: e.g. </dt> in HTML.

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 190 行定义.

190 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ endDescription()

void DocbookGenerator::endDescription ( )
inlinevirtual

Ends a description list: e.g. </dl> in HTML

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 186 行定义.

186 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ endDescTable()

void DocbookGenerator::endDescTable ( )
virtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 1105 行定义.

1106 {
1107 DB_GEN_C
1108  m_t << " </tbody>\n";
1109  m_t << " </tgroup>\n";
1110  m_t << "</informaltable>\n";
1111  m_descTable = FALSE;
1112 }

引用了 DB_GEN_C, FALSE, m_descTable , 以及 OutputGenerator::m_t.

◆ endDescTableData()

void DocbookGenerator::endDescTableData ( )
virtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 1143 行定义.

1144 {
1145 DB_GEN_C
1146  m_t << "</entry>";
1147 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ endDescTableRow()

void DocbookGenerator::endDescTableRow ( )
virtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 1121 行定义.

1122 {
1123 DB_GEN_C
1124  m_t << "</row>";
1125 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ endDescTableTitle()

void DocbookGenerator::endDescTableTitle ( )
virtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 1132 行定义.

1133 {
1134 DB_GEN_C
1135 }

引用了 DB_GEN_C.

◆ endDirDepGraph()

void DocbookGenerator::endDirDepGraph ( DotDirDeps &  g)
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1188 行定义.

1189 {
1190 DB_GEN_C
1191  QCString fn = g.writeGraph(m_t,GOF_BITMAP,EOF_DocBook,dir(),fileName(),relPath,FALSE);
1192 }

引用了 DB_GEN_C, OutputGenerator::dir(), EOF_DocBook, FALSE, OutputGenerator::fileName(), GOF_BITMAP, OutputGenerator::m_t, relPath , 以及 DotDirDeps::writeGraph().

◆ endDotGraph()

void DocbookGenerator::endDotGraph ( DotClassGraph &  g)
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1161 行定义.

1162 {
1163 DB_GEN_C
1164  g.writeGraph(m_t,GOF_BITMAP,EOF_DocBook,dir(),fileName(),relPath,TRUE,FALSE);
1165 }

引用了 DB_GEN_C, OutputGenerator::dir(), EOF_DocBook, FALSE, OutputGenerator::fileName(), GOF_BITMAP, OutputGenerator::m_t, relPath, TRUE , 以及 DotClassGraph::writeGraph().

◆ endDoxyAnchor()

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

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 855 行定义.

856 {
857 DB_GEN_C
858 }

引用了 DB_GEN_C.

◆ endEmphasis()

void DocbookGenerator::endEmphasis ( )
inlinevirtual

Ends a section of text displayed in italic.

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 183 行定义.

183 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ endExamples()

void DocbookGenerator::endExamples ( )
virtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 931 行定义.

932 {
933 DB_GEN_C
934  m_t << "</simplesect>\n";
935 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ endFile()

void DocbookGenerator::endFile ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 360 行定义.

361 {
362 DB_GEN_C
363  closeAllSections();
364  m_inLevel = -1;
365  m_inGroup = FALSE;
366 
367  QCString fileType="section";
368  QCString fileName= m_codeGen.sourceFileName();
369  if (fileName == "index.xml")
370  {
371  fileType="book";
372  }
373  else if (fileName == "mainpage.xml")
374  {
375  fileType="chapter";
376  }
377  m_t << "</" << fileType << ">\n";
378  endPlainFile();
379  m_codeGen.setSourceFileName("");
380 }

引用了 closeAllSections(), DB_GEN_C, OutputGenerator::endPlainFile(), FALSE, OutputGenerator::fileName(), m_codeGen, m_inGroup, m_inLevel, OutputGenerator::m_t, DocbookCodeGenerator::setSourceFileName() , 以及 DocbookCodeGenerator::sourceFileName().

◆ endFontClass()

void DocbookGenerator::endFontClass ( )
inlinevirtual

Ends a block started with startFontClass()

实现了 CodeOutputInterface.

在文件 docbookgen.h 第 127 行定义.

128  { m_codeGen.endFontClass(); }

引用了 DocbookCodeGenerator::endFontClass() , 以及 m_codeGen.

◆ endGroupCollaboration()

void DocbookGenerator::endGroupCollaboration ( DotGroupCollaboration &  g)
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1152 行定义.

1153 {
1154 DB_GEN_C
1155  g.writeGraph(m_t,GOF_BITMAP,EOF_DocBook,dir(),fileName(),relPath,FALSE);
1156 }

引用了 DB_GEN_C, OutputGenerator::dir(), EOF_DocBook, FALSE, OutputGenerator::fileName(), GOF_BITMAP, OutputGenerator::m_t, relPath , 以及 DotGroupCollaboration::writeGraph().

◆ endGroupHeader()

void DocbookGenerator::endGroupHeader ( int  )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 754 行定义.

755 {
756 DB_GEN_C
757  m_t << "</title>\n";
758 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ endHeaderSection()

void DocbookGenerator::endHeaderSection ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 230 行定义.

230 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ endHtmlLink()

void DocbookGenerator::endHtmlLink ( )
inlinevirtual

Ends a link started by startHtmlLink().

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 177 行定义.

177 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ endInclDepGraph()

void DocbookGenerator::endInclDepGraph ( DotInclDepGraph &  g)
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1170 行定义.

1171 {
1172 DB_GEN_C
1173  QCString fn = g.writeGraph(m_t,GOF_BITMAP,EOF_DocBook,dir(),fileName(),relPath,FALSE);
1174 }

引用了 DB_GEN_C, OutputGenerator::dir(), EOF_DocBook, FALSE, OutputGenerator::fileName(), GOF_BITMAP, OutputGenerator::m_t, relPath , 以及 DotInclDepGraph::writeGraph().

◆ endIndent()

void DocbookGenerator::endIndent ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 276 行定义.

276 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ endIndexItem()

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

实现了 OutputGenerator.

在文件 docbookgen.h 第 167 行定义.

167 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ endIndexKey()

void DocbookGenerator::endIndexKey ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 160 行定义.

160 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ endIndexList()

void DocbookGenerator::endIndexList ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 158 行定义.

158 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ endIndexListItem()

void DocbookGenerator::endIndexListItem ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 156 行定义.

156 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ endIndexSection()

void DocbookGenerator::endIndexSection ( IndexSections  is)
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 462 行定义.

463 {
464 DB_GEN_C2("IndexSections " << is)
465  switch (is)
466  {
467  case isTitlePageStart:
468  break;
469  case isTitlePageAuthor:
470  break;
471  case isMainPage:
472  m_t << "</title>\n";
473  m_t << " <xi:include href=\"mainpage.xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>\n";
474  m_t << "</chapter>\n";
475  break;
476  case isModuleIndex:
477  //m_t << "</chapter>\n";
478  break;
479  case isDirIndex:
480  //m_t << "<xi:include href=\"dirs.xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>";
481  //m_t << "</chapter>\n";
482  break;
483  case isNamespaceIndex:
484  //m_t << "<xi:include href=\"namespaces.xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>";
485  //m_t << "</chapter>\n";
486  break;
487  case isConceptIndex:
488  //m_t << "<xi:include href=\"concepts.xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>";
489  //m_t << "</chapter>\n";
490  break;
491  case isClassHierarchyIndex:
492  //m_t << "<xi:include href=\"hierarchy.xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>";
493  //m_t << "</chapter>\n";
494  break;
495  case isCompoundIndex:
496  //m_t << "</chapter>\n";
497  break;
498  case isFileIndex:
499  //m_t << "<xi:include href=\"files.xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>";
500  //m_t << "</chapter>\n";
501  break;
502  case isPageIndex:
503  //m_t << "<xi:include href=\"pages.xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>";
504  //m_t << "</chapter>\n";
505  break;
506  case isModuleDocumentation:
507  {
508  m_t << "</title>\n";
509  for (const auto &gd : *Doxygen::groupLinkedMap)
510  {
511  if (!gd->isReference())
512  {
513  m_t << " <xi:include href=\"" << gd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>\n";
514  }
515  }
516  }
517  m_t << "</chapter>\n";
518  break;
519  case isDirDocumentation:
520  {
521  m_t << "</title>\n";
522  for (const auto &dd : *Doxygen::dirLinkedMap)
523  {
524  if (dd->isLinkableInProject())
525  {
526  m_t << "< xi:include href=\"" << dd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>\n";
527  }
528  }
529  }
530  m_t << "</chapter>\n";
531  break;
532  case isNamespaceDocumentation:
533  {
534  m_t << "</title>\n";
535  for (const auto &nd : *Doxygen::namespaceLinkedMap)
536  {
537  if (nd->isLinkableInProject() && !nd->isAlias())
538  {
539  m_t << "<xi:include href=\"" << nd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>\n";
540  }
541  }
542  }
543  m_t << "</chapter>\n";
544  break;
545  case isConceptDocumentation:
546  {
547  m_t << "</title>\n";
548  for (const auto &cd : *Doxygen::conceptLinkedMap)
549  {
550  if (cd->isLinkableInProject() && !cd->isAlias())
551  {
552  m_t << "<xi:include href=\"" << cd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>\n";
553  }
554  }
555  }
556  m_t << "</chapter>\n";
557  break;
558  case isClassDocumentation:
559  {
560  m_t << "</title>\n";
561  for (const auto &cd : *Doxygen::classLinkedMap)
562  {
563  if (cd->isLinkableInProject() &&
564  cd->templateMaster()==0 &&
565  !cd->isEmbeddedInOuterScope() &&
566  !cd->isAlias()
567  )
568  {
569  m_t << " <xi:include href=\"" << cd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>\n";
570  }
571  }
572  }
573  m_t << "</chapter>\n";
574  break;
575  case isFileDocumentation:
576  {
577  m_t << "</title>\n";
578  for (const auto &fn : *Doxygen::inputNameLinkedMap)
579  {
580  for (const auto &fd : *fn)
581  {
582  if (fd->isLinkableInProject())
583  {
584  m_t << " <xi:include href=\"" << fd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>\n";
585  }
586  if (fd->generateSourceFile())
587  {
588  m_t << " <xi:include href=\"" << fd->getSourceFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>\n";
589  }
590  }
591  }
592  }
593  m_t << "</chapter>\n";
594  break;
595  case isExampleDocumentation:
596  {
597  m_t << "</title>\n";
598  for (const auto &pd : *Doxygen::exampleLinkedMap)
599  {
600  m_t << " <xi:include href=\"" << pd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>\n";
601  }
602  }
603  m_t << "</chapter>\n";
604  break;
605  case isPageDocumentation:
606  break;
607  case isPageDocumentation2:
608  break;
609  case isEndIndex:
610  m_t << "<index/>\n";
611  break;
612  }
613 }

引用了 Doxygen::classLinkedMap, Doxygen::conceptLinkedMap, DB_GEN_C2, Doxygen::dirLinkedMap, Doxygen::exampleLinkedMap, Doxygen::groupLinkedMap, Doxygen::inputNameLinkedMap, isClassDocumentation, isClassHierarchyIndex, isCompoundIndex, isConceptDocumentation, isConceptIndex, isDirDocumentation, isDirIndex, isEndIndex, isExampleDocumentation, isFileDocumentation, isFileIndex, isMainPage, isModuleDocumentation, isModuleIndex, isNamespaceDocumentation, isNamespaceIndex, isPageDocumentation, isPageDocumentation2, isPageIndex, isTitlePageAuthor, isTitlePageStart, OutputGenerator::m_t , 以及 Doxygen::namespaceLinkedMap.

◆ endIndexValue()

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

实现了 OutputGenerator.

在文件 docbookgen.h 第 162 行定义.

162 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ endInlineHeader()

void DocbookGenerator::endInlineHeader ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 240 行定义.

240 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ endInlineMemberDoc()

void DocbookGenerator::endInlineMemberDoc ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1084 行定义.

1085 {
1086 DB_GEN_C
1087  m_t << "</entry></row>\n";
1088 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ endInlineMemberName()

void DocbookGenerator::endInlineMemberName ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1072 行定义.

1073 {
1074 DB_GEN_C
1075  m_t << "</entry>";
1076 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ endInlineMemberType()

void DocbookGenerator::endInlineMemberType ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1060 行定义.

1061 {
1062 DB_GEN_C
1063  m_t << "</entry>";
1064 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ endItemList()

void DocbookGenerator::endItemList ( )
inlinevirtual

Ends a bullet list: e.g. </ul> in html

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 164 行定义.

164 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ endItemListItem()

void DocbookGenerator::endItemListItem ( )
inlinevirtual

Writes a list item for a bullet or enumerated list: e.g. </li> in html

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 169 行定义.

169 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ endLabels()

void DocbookGenerator::endLabels ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 919 行定义.

920 {
921 DB_GEN_C
922 }

引用了 DB_GEN_C.

◆ endMemberDeclaration()

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

实现了 OutputGenerator.

在文件 docbookgen.h 第 271 行定义.

271 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ endMemberDescription()

void DocbookGenerator::endMemberDescription ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 269 行定义.

269 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ endMemberDoc()

void DocbookGenerator::endMemberDoc ( bool  )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 824 行定义.

825 {
826 DB_GEN_C
827  m_t << "</computeroutput></para>";
828 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ endMemberDocList()

void DocbookGenerator::endMemberDocList ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1197 行定义.

1198 {
1199 DB_GEN_C
1200  m_inGroup = TRUE;
1201 }

引用了 DB_GEN_C, m_inGroup , 以及 TRUE.

◆ endMemberDocName()

void DocbookGenerator::endMemberDocName ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 864 行定义.

865 {
866 DB_GEN_C
867 }

引用了 DB_GEN_C.

◆ endMemberDocPrefixItem()

void DocbookGenerator::endMemberDocPrefixItem ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 959 行定义.

960 {
961 DB_GEN_C
962  m_t << "</computeroutput>";
963 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ endMemberDocSimple()

void DocbookGenerator::endMemberDocSimple ( bool  isEnum)
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1045 行定义.

1046 {
1047 DB_GEN_C
1048  m_t << " </tbody>\n";
1049  m_t << " </tgroup>\n";
1050  m_t << "</table>\n";
1051  m_simpleTable = false;
1052 }

引用了 DB_GEN_C, m_simpleTable , 以及 OutputGenerator::m_t.

◆ endMemberGroup()

void DocbookGenerator::endMemberGroup ( bool  )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 882 行定义.

883 {
884 DB_GEN_C
885  m_t << "</simplesect>\n";
886 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ endMemberGroupDocs()

void DocbookGenerator::endMemberGroupDocs ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 252 行定义.

252 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ endMemberGroupHeader()

void DocbookGenerator::endMemberGroupHeader ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 873 行定义.

874 {
875 DB_GEN_C
876  m_t << "</title>\n";
877 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ endMemberHeader()

void DocbookGenerator::endMemberHeader ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 669 行定义.

670 {
671 DB_GEN_C
672  m_t << " </title>\n";
673 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ endMemberItem()

void DocbookGenerator::endMemberItem ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 718 行定义.

719 {
720 DB_GEN_C
721  m_t << "</para>\n";
722 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ endMemberList()

void DocbookGenerator::endMemberList ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 701 行定义.

702 {
703 DB_GEN_C
704  if (m_inListItem[m_levelListItem]) m_t << "</listitem>\n";
705  m_inListItem[m_levelListItem] = FALSE;
706  m_t << " </itemizedlist>\n";
707  m_levelListItem = (m_levelListItem> 0 ? m_levelListItem - 1 : 0);
708  if (m_inSimpleSect[m_levelListItem]) m_t << "</simplesect>\n";
709  m_inSimpleSect[m_levelListItem] = FALSE;
710 }

引用了 DB_GEN_C, FALSE, m_inListItem, m_inSimpleSect, m_levelListItem , 以及 OutputGenerator::m_t.

◆ endMemberSections()

void DocbookGenerator::endMemberSections ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 228 行定义.

228 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ endMemberSubtitle()

void DocbookGenerator::endMemberSubtitle ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 234 行定义.

234 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ endMemberTemplateParams()

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

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 995 行定义.

996 {
997 DB_GEN_C
998  m_t << "</para>";
999  m_t << "<para>";
1000 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ endPageDoc()

void DocbookGenerator::endPageDoc ( )
inlinevirtual

重载 OutputGenerator .

在文件 docbookgen.h 第 301 行定义.

301 {DB_GEN_EMPTY}

引用了 DB_GEN_EMPTY.

◆ endPageRef()

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

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 218 行定义.

218 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ endParagraph()

void DocbookGenerator::endParagraph ( )
virtual

Ends a paragraph

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 651 行定义.

652 {
653 DB_GEN_C
654  m_t << "</para>\n";
655 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ endParameterList()

void DocbookGenerator::endParameterList ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 765 行定义.

766 {
767 DB_GEN_C
768 }

引用了 DB_GEN_C.

◆ endParameterName()

void DocbookGenerator::endParameterName ( bool  last,
bool  ,
bool  closeBracket 
)
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 982 行定义.

983 {
984 DB_GEN_C
985  if (last)
986  {
987  if (closeBracket) m_t << ")";
988  }
989 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ endParameterType()

void DocbookGenerator::endParameterType ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 310 行定义.

310 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ endParamList()

void DocbookGenerator::endParamList ( )
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 198 行定义.

198 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ endProjectNumber()

void DocbookGenerator::endProjectNumber ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 151 行定义.

151 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ endQuickIndices()

void DocbookGenerator::endQuickIndices ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 292 行定义.

292 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ endSection()

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

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 1007 行定义.

1008 {
1009 DB_GEN_C
1010  m_t << "</title>";
1011  closeSection();
1012 }

引用了 closeSection(), DB_GEN_C , 以及 OutputGenerator::m_t.

◆ endSmall()

void DocbookGenerator::endSmall ( )
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 194 行定义.

194 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ endSubsection()

void DocbookGenerator::endSubsection ( )
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 220 行定义.

220 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ endSubsubsection()

void DocbookGenerator::endSubsubsection ( )
virtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 941 行定义.

942 {
943 DB_GEN_C
944  m_t << "</title></simplesect>\n";
945 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

被这些函数引用 endCompoundTemplateParams().

◆ endTextBlock()

void DocbookGenerator::endTextBlock ( bool  )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 798 行定义.

799 {
800 DB_GEN_C
801  if (m_denseText)
802  {
803  m_denseText = FALSE;
804  m_t << "</programlisting>";
805  }
806 }

引用了 DB_GEN_C, FALSE, m_denseText , 以及 OutputGenerator::m_t.

◆ endTextLink()

void DocbookGenerator::endTextLink ( )
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 216 行定义.

216 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ endTitle()

void DocbookGenerator::endTitle ( )
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 200 行定义.

200 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ endTitleHead()

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

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 834 行定义.

835 {
836 DB_GEN_C
837  m_t << "</title>\n";
838  if (!name.isEmpty()) addIndexTerm(m_t, name);
839 }

引用了 addIndexTerm(), DB_GEN_C, QCString::isEmpty() , 以及 OutputGenerator::m_t.

◆ endTypewriter()

void DocbookGenerator::endTypewriter ( )
virtual

End a section of text displayed in typewriter style.

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 784 行定义.

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

引用了 DB_GEN_C, m_denseText , 以及 OutputGenerator::m_t.

◆ exceptionEntry()

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

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 964 行定义.

965 {
966 DB_GEN_C
967  if (!prefix.isEmpty())
968  {
969  m_t << " " << prefix << "(";
970  }
971  else if (closeBracket)
972  {
973  m_t << ")";
974  }
975  m_t << " ";
976 }

引用了 DB_GEN_C, QCString::isEmpty() , 以及 OutputGenerator::m_t.

◆ init()

void DocbookGenerator::init ( )
static

在文件 docbookgen.cpp 第 311 行定义.

312 {
313  QCString dir=Config_getString(DOCBOOK_OUTPUT);
314  Dir d(dir.str());
315  if (!d.exists() && !d.mkdir(dir.str()))
316  {
317  term("Could not create output directory %s\n",qPrint(dir));
318  }
319 
320  createSubDirs(d);
321 }

引用了 Config_getString, createSubDirs(), OutputGenerator::dir(), Dir::exists(), Dir::mkdir(), qPrint(), QCString::str() , 以及 term().

被这些函数引用 generateOutput().

◆ insertMemberAlign()

void DocbookGenerator::insertMemberAlign ( bool  )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 255 行定义.

255 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ insertMemberAlignLeft()

void DocbookGenerator::insertMemberAlignLeft ( int  ,
bool   
)
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 256 行定义.

256 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ lastIndexPage()

void DocbookGenerator::lastIndexPage ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 304 行定义.

304 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ lineBreak()

void DocbookGenerator::lineBreak ( const QCString &  )
virtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 774 行定义.

775 {
776 DB_GEN_C
777  m_t << "\n";
778 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ openSection()

void DocbookGenerator::openSection ( const QCString &  attr = QCString())
private

在文件 docbookgen.cpp 第 1242 行定义.

1243 {
1244  m_t << "<section";
1245  if (!attr.isEmpty()) m_t << " " << attr;
1246  m_t << ">\n";
1247  m_openSectionCount++;
1248 }

引用了 QCString::isEmpty(), m_openSectionCount , 以及 OutputGenerator::m_t.

被这些函数引用 startGroupHeader(), startMemberDoc() , 以及 startSection().

◆ operator=()

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

在文件 docbookgen.cpp 第 295 行定义.

296 {
297  OutputGenerator::operator=(og);
298  return *this;
299 }

引用了 OutputGenerator::operator=().

◆ setCurrentDoc()

void DocbookGenerator::setCurrentDoc ( const Definition *  ,
const QCString &  ,
bool   
)
inlinevirtual

实现了 CodeOutputInterface.

在文件 docbookgen.h 第 339 行定义.

339 {DB_GEN_EMPTY}

引用了 DB_GEN_EMPTY.

◆ startAnonTypeScope()

void DocbookGenerator::startAnonTypeScope ( int  )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 241 行定义.

241 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ startBold()

void DocbookGenerator::startBold ( )
virtual

Changes the text font to bold face. The bold section ends with endBold()

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 723 行定义.

724 {
725 DB_GEN_C
726  m_t << "<emphasis role=\"strong\">";
727 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ startCallGraph()

void DocbookGenerator::startCallGraph ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1175 行定义.

1176 {
1177 DB_GEN_C
1178 }

引用了 DB_GEN_C.

◆ startCenter()

void DocbookGenerator::startCenter ( )
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 191 行定义.

191 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ startClassDiagram()

void DocbookGenerator::startClassDiagram ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 887 行定义.

888 {
889 DB_GEN_C
890  m_t << "<para>";
891 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ startCodeFragment()

void DocbookGenerator::startCodeFragment ( const QCString &  style)
inlinevirtual

Starts a source code fragment. The fragment will be fed to the code parser (see code.h) for syntax highlighting and cross-referencing. The fragment ends by a call to endCodeFragment()

参数
styleThe kind of code fragment.

实现了 CodeOutputInterface.

在文件 docbookgen.h 第 131 行定义.

132  { m_codeGen.startCodeFragment(style); }

引用了 m_codeGen , 以及 DocbookCodeGenerator::startCodeFragment().

◆ startCodeLine()

void DocbookGenerator::startCodeLine ( bool  hasLineNumbers)
inlinevirtual

实现了 CodeOutputInterface.

在文件 docbookgen.h 第 121 行定义.

122  { m_codeGen.startCodeLine(hasLineNumbers); }

引用了 m_codeGen , 以及 DocbookCodeGenerator::startCodeLine().

◆ startCompoundTemplateParams()

void DocbookGenerator::startCompoundTemplateParams ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 247 行定义.

247 { startSubsubsection(); }

引用了 startSubsubsection().

◆ startConstraintDocs()

void DocbookGenerator::startConstraintDocs ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1228 行定义.

1229 {
1230 DB_GEN_C
1231 }

引用了 DB_GEN_C.

◆ startConstraintList()

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

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1202 行定义.

1203 {
1204 DB_GEN_C
1205  m_t << "<simplesect><title>";
1206  docify(header);
1207  m_t << "</title>\n";
1208 }

引用了 DB_GEN_C, docify() , 以及 OutputGenerator::m_t.

◆ startConstraintParam()

void DocbookGenerator::startConstraintParam ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1209 行定义.

1210 {
1211 DB_GEN_C
1212  m_t << "<para><emphasis role=\"strong\">";
1213 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ startConstraintType()

void DocbookGenerator::startConstraintType ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1218 行定义.

1219 {
1220 DB_GEN_C
1221  m_t << ":";
1222 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ startContents()

void DocbookGenerator::startContents ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 298 行定义.

298 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ startDescForItem()

void DocbookGenerator::startDescForItem ( )
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 188 行定义.

188 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ startDescItem()

void DocbookGenerator::startDescItem ( )
inlinevirtual

Starts an item of a description list: e.g. <dt> in HTML.

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 187 行定义.

187 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ startDescription()

void DocbookGenerator::startDescription ( )
inlinevirtual

Starts a description list: e.g. <dl> in HTML Items are surrounded by startDescItem() and endDescItem()

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 185 行定义.

185 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ startDescTable()

void DocbookGenerator::startDescTable ( const QCString &  title)
virtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 1090 行定义.

1091 {
1092 DB_GEN_C
1093  int ncols = 2;
1094  m_t << "<informaltable frame=\"all\">\n";
1095  if (!title.isEmpty()) m_t << "<title>" << convertToDocBook(title) << "</title>\n";
1096  m_t << " <tgroup cols=\"" << ncols << "\" align=\"left\" colsep=\"1\" rowsep=\"1\">\n";
1097  for (int i = 0; i < ncols; i++)
1098  {
1099  m_t << " <colspec colname='c" << i+1 << "'/>\n";
1100  }
1101  m_t << "<tbody>\n";
1102  m_descTable = TRUE;
1103 }

引用了 convertToDocBook(), DB_GEN_C, QCString::isEmpty(), m_descTable, OutputGenerator::m_t , 以及 TRUE.

◆ startDescTableData()

void DocbookGenerator::startDescTableData ( )
virtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 1137 行定义.

1138 {
1139 DB_GEN_C
1140  m_t << "</entry><entry>";
1141 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ startDescTableRow()

void DocbookGenerator::startDescTableRow ( )
virtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 1114 行定义.

1115 {
1116 DB_GEN_C
1117  m_t << "<row>";
1118  m_t << "<entry>";
1119 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ startDescTableTitle()

void DocbookGenerator::startDescTableTitle ( )
virtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 1127 行定义.

1128 {
1129 DB_GEN_C
1130 }

引用了 DB_GEN_C.

◆ startDirDepGraph()

void DocbookGenerator::startDirDepGraph ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1184 行定义.

1185 {
1186 DB_GEN_C
1187 }

引用了 DB_GEN_C.

◆ startDotGraph()

void DocbookGenerator::startDotGraph ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1157 行定义.

1158 {
1159 DB_GEN_C
1160 }

引用了 DB_GEN_C.

◆ startDoxyAnchor()

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

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 840 行定义.

843 {
844 DB_GEN_C
845  if (!m_inListItem[m_levelListItem] && !m_descTable && !m_simpleTable)
846  {
847  if (!m_firstMember) closeSection();
848  m_firstMember = FALSE;
849  }
850  if (!anchor.isEmpty())
851  {
852  m_t << "<anchor xml:id=\"_" << stripPath(fName) << "_1" << anchor << "\"/>";
853  }
854 }

引用了 closeSection(), DB_GEN_C, FALSE, QCString::isEmpty(), m_descTable, m_firstMember, m_inListItem, m_levelListItem, m_simpleTable, OutputGenerator::m_t , 以及 stripPath().

◆ startEmphasis()

void DocbookGenerator::startEmphasis ( )
inlinevirtual

Changes the text font to italic. The italic section ends with endEmphasis()

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 182 行定义.

182 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ startExamples()

void DocbookGenerator::startExamples ( )
virtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 923 行定义.

924 {
925 DB_GEN_C
926  m_t << "<simplesect><title>";
927  docify(theTranslator->trExamples());
928  m_t << "</title>";
929 }

引用了 DB_GEN_C, docify(), OutputGenerator::m_t, theTranslator , 以及 Translator::trExamples().

◆ startFile()

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

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 330 行定义.

331 {
332 DB_GEN_C
333  QCString fileName=name;
334  QCString pageName;
335  QCString fileType="section";
336  if (fileName == "refman")
337  {
338  fileName="index";
339  fileType="book";
340  }
341  else if (fileName == "index")
342  {
343  fileName="mainpage";
344  fileType="chapter";
345  }
346  pageName = fileName;
347  relPath = relativePathToRoot(fileName);
348  if (fileName.right(4)!=".xml") fileName+=".xml";
349  startPlainFile(fileName);
350  m_codeGen.setRelativePath(relPath);
351  m_codeGen.setSourceFileName(stripPath(fileName));
352 
353  m_t << "<?xml version='1.0' encoding='UTF-8' standalone='no'?>\n";;
354  m_t << "<" << fileType << " xmlns=\"http://docbook.org/ns/docbook\" version=\"5.0\" xmlns:xlink=\"http://www.w3.org/1999/xlink\"";
355  if (!pageName.isEmpty()) m_t << " xml:id=\"_" << stripPath(pageName) << "\"";
356  m_t << " xml:lang=\"" << theTranslator->trISOLang() << "\"";
357  m_t << ">\n";
358 }

引用了 DB_GEN_C, OutputGenerator::fileName(), QCString::isEmpty(), m_codeGen, OutputGenerator::m_t, relativePathToRoot(), relPath, QCString::right(), DocbookCodeGenerator::setRelativePath(), DocbookCodeGenerator::setSourceFileName(), OutputGenerator::startPlainFile(), stripPath(), theTranslator , 以及 Translator::trISOLang().

◆ startFontClass()

void DocbookGenerator::startFontClass ( const QCString &  clsName)
inlinevirtual

Starts a block with a certain meaning. Used for syntax highlighting, which elements of the same type are rendered using the same 'font class'.

参数
clsNameThe category name.

实现了 CodeOutputInterface.

在文件 docbookgen.h 第 125 行定义.

126  { m_codeGen.startFontClass(s); }

引用了 m_codeGen , 以及 DocbookCodeGenerator::startFontClass().

◆ startGroupCollaboration()

void DocbookGenerator::startGroupCollaboration ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1148 行定义.

1149 {
1150 DB_GEN_C
1151 }

引用了 DB_GEN_C.

◆ startGroupHeader()

void DocbookGenerator::startGroupHeader ( int  extraIndentLevel)
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 733 行定义.

734 {
735 DB_GEN_C2("m_inLevel " << m_inLevel)
736 DB_GEN_C2("extraIndentLevel " << extraIndentLevel)
737  m_firstMember = TRUE;
738  if (m_inSimpleSect[m_levelListItem]) m_t << "</simplesect>\n";
739  m_inSimpleSect[m_levelListItem] = FALSE;
740  if (m_inLevel != -1) m_inGroup = TRUE;
741  if (m_inLevel == extraIndentLevel) closeSection();
742  m_inLevel = extraIndentLevel;
743  openSection();
744  m_t << "<title>";
745 }

引用了 closeSection(), DB_GEN_C2, FALSE, m_firstMember, m_inGroup, m_inLevel, m_inSimpleSect, m_levelListItem, OutputGenerator::m_t, openSection() , 以及 TRUE.

◆ startHeaderSection()

void DocbookGenerator::startHeaderSection ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 229 行定义.

229 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ startHtmlLink()

void DocbookGenerator::startHtmlLink ( const QCString &  url)
inlinevirtual

Starts a (link to an) URL found in the documentation.

参数
urlThe URL to link to.

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 176 行定义.

176 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ startInclDepGraph()

void DocbookGenerator::startInclDepGraph ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1166 行定义.

1167 {
1168 DB_GEN_C
1169 }

引用了 DB_GEN_C.

◆ startIndent()

void DocbookGenerator::startIndent ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 275 行定义.

275 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ startIndexItem()

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

实现了 OutputGenerator.

在文件 docbookgen.h 第 166 行定义.

166 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ startIndexKey()

void DocbookGenerator::startIndexKey ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 159 行定义.

159 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ startIndexList()

void DocbookGenerator::startIndexList ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 157 行定义.

157 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ startIndexListItem()

void DocbookGenerator::startIndexListItem ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 155 行定义.

155 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ startIndexSection()

void DocbookGenerator::startIndexSection ( IndexSections  is)
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 382 行定义.

383 {
384 DB_GEN_C2("IndexSections " << is)
385  switch (is)
386  {
387  case isTitlePageStart:
388  {
389  QCString dbk_projectName = Config_getString(PROJECT_NAME);
390  m_t << " <info>\n";
391  m_t << " <title>" << convertToDocBook(dbk_projectName) << "</title>\n";
392  m_t << " </info>\n";
393  }
394  break;
395  case isTitlePageAuthor:
396  break;
397  case isMainPage:
398  m_t << "<chapter>\n";
399  m_t << " <title>";
400  break;
401  case isModuleIndex:
402  //Module Index}\n"
403  break;
404  case isDirIndex:
405  //Directory Index}\n"
406  break;
407  case isNamespaceIndex:
408  //Namespace Index}\n"
409  break;
410  case isConceptIndex:
411  //Concept Index}\n"
412  break;
413  case isClassHierarchyIndex:
414  //Hierarchical Index}\n"
415  break;
416  case isCompoundIndex:
417  //m_t << "{"; //Class Index}\n"
418  break;
419  case isFileIndex:
420  //Annotated File Index}\n"
421  break;
422  case isPageIndex:
423  //Annotated Page Index}\n"
424  break;
425  case isModuleDocumentation:
426  m_t << "<chapter>\n";
427  m_t << " <title>";
428  break;
429  case isDirDocumentation:
430  m_t << "<chapter>\n";
431  m_t << " <title>";
432  break;
433  case isNamespaceDocumentation:
434  m_t << "<chapter>\n";
435  m_t << " <title>";
436  break;
437  case isConceptDocumentation:
438  m_t << "<chapter>\n";
439  m_t << " <title>";
440  break;
441  case isClassDocumentation:
442  m_t << "<chapter>\n";
443  m_t << " <title>";
444  break;
445  case isFileDocumentation:
446  m_t << "<chapter>\n";
447  m_t << " <title>";
448  break;
449  case isExampleDocumentation:
450  m_t << "<chapter>\n";
451  m_t << " <title>";
452  break;
453  case isPageDocumentation:
454  break;
455  case isPageDocumentation2:
456  break;
457  case isEndIndex:
458  break;
459  }
460 }

引用了 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 , 以及 OutputGenerator::m_t.

◆ startIndexValue()

void DocbookGenerator::startIndexValue ( bool  )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 161 行定义.

161 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ startInlineHeader()

void DocbookGenerator::startInlineHeader ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 239 行定义.

239 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ startInlineMemberDoc()

void DocbookGenerator::startInlineMemberDoc ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1078 行定义.

1079 {
1080 DB_GEN_C
1081  m_t << "<entry>";
1082 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ startInlineMemberName()

void DocbookGenerator::startInlineMemberName ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1066 行定义.

1067 {
1068 DB_GEN_C
1069  m_t << "<entry>";
1070 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ startInlineMemberType()

void DocbookGenerator::startInlineMemberType ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1054 行定义.

1055 {
1056 DB_GEN_C
1057  m_t << "<row><entry>";
1058 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ startItemList()

void DocbookGenerator::startItemList ( )
inlinevirtual

Start of a bullet list: e.g. <ul> in html. startItemListItem() is Used for the bullet items.

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 163 行定义.

163 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ startItemListItem()

void DocbookGenerator::startItemListItem ( )
inlinevirtual

Writes a list item for a bullet or enumerated list: e.g. <li> in html

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 168 行定义.

168 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ startLabels()

void DocbookGenerator::startLabels ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 907 行定义.

908 {
909 DB_GEN_C
910 }

引用了 DB_GEN_C.

◆ startMemberDeclaration()

void DocbookGenerator::startMemberDeclaration ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 270 行定义.

270 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ startMemberDescription()

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

实现了 OutputGenerator.

在文件 docbookgen.h 第 268 行定义.

268 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ startMemberDoc()

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

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 807 行定义.

809 {
810 DB_GEN_C2("m_inLevel " << m_inLevel)
811  openSection();
812  m_t << " <title>" << convertToDocBook(title);
813  if (memTotal>1)
814  {
815  m_t << "<computeroutput>[" << memCount << "/" << memTotal << "]</computeroutput>";
816  }
817  m_t << "</title>\n";
818  if (!memname.isEmpty() && memname[0]!='@')
819  {
820  addIndexTerm(m_t,memname,clname);
821  addIndexTerm(m_t,clname,memname);
822  }
823 }

引用了 addIndexTerm(), convertToDocBook(), DB_GEN_C2, QCString::isEmpty(), m_inLevel, OutputGenerator::m_t , 以及 openSection().

◆ startMemberDocList()

void DocbookGenerator::startMemberDocList ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1193 行定义.

1194 {
1195 DB_GEN_C
1196 }

引用了 DB_GEN_C.

◆ startMemberDocName()

void DocbookGenerator::startMemberDocName ( bool  )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 859 行定义.

860 {
861 DB_GEN_C
862  m_t << "<para><computeroutput>";
863 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ startMemberDocPrefixItem()

void DocbookGenerator::startMemberDocPrefixItem ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 954 行定义.

955 {
956 DB_GEN_C
957  m_t << "<computeroutput>";
958 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ startMemberDocSimple()

void DocbookGenerator::startMemberDocSimple ( bool  isEnum)
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 1019 行定义.

1020 {
1021 DB_GEN_C
1022  int ncols;
1023  QCString title;
1024  if (isEnum)
1025  {
1026  ncols = 2;
1027  title = theTranslator->trEnumerationValues();
1028  }
1029  else
1030  {
1031  ncols = 3;
1032  title = theTranslator->trCompoundMembers();
1033  }
1034  m_t << "<table frame=\"all\">\n";
1035  if (!title.isEmpty()) m_t << "<title>" << convertToDocBook(title) << "</title>\n";
1036  m_t << " <tgroup cols=\"" << ncols << "\" align=\"left\" colsep=\"1\" rowsep=\"1\">\n";
1037  for (int i = 0; i < ncols; i++)
1038  {
1039  m_t << " <colspec colname='c" << i+1 << "'/>\n";
1040  }
1041  m_t << "<tbody>\n";
1042  m_simpleTable = true;
1043 }

引用了 convertToDocBook(), DB_GEN_C, QCString::isEmpty(), m_simpleTable, OutputGenerator::m_t, theTranslator, Translator::trCompoundMembers() , 以及 Translator::trEnumerationValues().

◆ startMemberGroup()

void DocbookGenerator::startMemberGroup ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 878 行定义.

879 {
880 DB_GEN_C
881 }

引用了 DB_GEN_C.

◆ startMemberGroupDocs()

void DocbookGenerator::startMemberGroupDocs ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 251 行定义.

251 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ startMemberGroupHeader()

void DocbookGenerator::startMemberGroupHeader ( bool  )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 868 行定义.

869 {
870 DB_GEN_C
871  m_t << "<simplesect><title>";
872 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ startMemberHeader()

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

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 661 行定义.

662 {
663 DB_GEN_C
664  m_t << "<simplesect>\n";
665  m_inSimpleSect[m_levelListItem] = TRUE;
666  m_t << " <title>";
667 }

引用了 DB_GEN_C, m_inSimpleSect, m_levelListItem, OutputGenerator::m_t , 以及 TRUE.

◆ startMemberItem()

void DocbookGenerator::startMemberItem ( const QCString &  ,
int  ,
const QCString &   
)
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 711 行定义.

712 {
713 DB_GEN_C
714  if (m_inListItem[m_levelListItem]) m_t << "</listitem>\n";
715  m_t << " <listitem><para>";
716  m_inListItem[m_levelListItem] = TRUE;
717 }

引用了 DB_GEN_C, m_inListItem, m_levelListItem, OutputGenerator::m_t , 以及 TRUE.

◆ startMemberList()

void DocbookGenerator::startMemberList ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 695 行定义.

696 {
697 DB_GEN_C
698  m_t << " <itemizedlist>\n";
699  m_levelListItem++;
700 }

引用了 DB_GEN_C, m_levelListItem , 以及 OutputGenerator::m_t.

◆ startMemberSections()

void DocbookGenerator::startMemberSections ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 227 行定义.

227 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ startMemberSubtitle()

void DocbookGenerator::startMemberSubtitle ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 233 行定义.

233 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ startMemberTemplateParams()

void DocbookGenerator::startMemberTemplateParams ( )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 990 行定义.

991 {
992 DB_GEN_C
993 }

引用了 DB_GEN_C.

◆ startPageDoc()

void DocbookGenerator::startPageDoc ( const QCString &  )
inlinevirtual

重载 OutputGenerator .

在文件 docbookgen.h 第 300 行定义.

300 {DB_GEN_EMPTY}

引用了 DB_GEN_EMPTY.

◆ startPageRef()

void DocbookGenerator::startPageRef ( )
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 217 行定义.

217 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ startParagraph()

void DocbookGenerator::startParagraph ( const QCString &  classDef)
virtual

Starts a new paragraph

Starts a new paragraph

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 645 行定义.

646 {
647 DB_GEN_C
648  m_t << "<para>\n";
649 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ startParameterList()

void DocbookGenerator::startParameterList ( bool  openBracket)
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 760 行定义.

761 {
762 DB_GEN_C
763  if (openBracket) m_t << "(";
764 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ startParameterName()

void DocbookGenerator::startParameterName ( bool  )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 977 行定义.

978 {
979 DB_GEN_C
980  m_t << " ";
981 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ startParameterType()

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

实现了 OutputGenerator.

在文件 docbookgen.h 第 309 行定义.

309 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ startParamList()

void DocbookGenerator::startParamList ( BaseOutputDocInterface::ParamListTypes  ,
const QCString &   
)
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 197 行定义.

197 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ startProjectNumber()

void DocbookGenerator::startProjectNumber ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 150 行定义.

150 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ startQuickIndices()

void DocbookGenerator::startQuickIndices ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 291 行定义.

291 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ startSection()

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

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 1001 行定义.

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

引用了 DB_GEN_C, OutputGenerator::m_t, openSection() , 以及 stripPath().

◆ startSmall()

void DocbookGenerator::startSmall ( )
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 193 行定义.

193 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ startSubsection()

void DocbookGenerator::startSubsection ( )
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 219 行定义.

219 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ startSubsubsection()

void DocbookGenerator::startSubsubsection ( )
virtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 936 行定义.

937 {
938 DB_GEN_C
939  m_t << "<simplesect><title>";
940 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

被这些函数引用 startCompoundTemplateParams().

◆ startTextBlock()

void DocbookGenerator::startTextBlock ( bool  dense)
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 789 行定义.

790 {
791 DB_GEN_C
792  if (dense)
793  {
794  m_denseText = TRUE;
795  m_t << "<programlisting linenumbering=\"unnumbered\">";
796  }
797 }

引用了 DB_GEN_C, m_denseText, OutputGenerator::m_t , 以及 TRUE.

◆ startTextLink()

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

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 215 行定义.

215 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ startTitle()

void DocbookGenerator::startTitle ( )
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 199 行定义.

199 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ startTitleHead()

void DocbookGenerator::startTitleHead ( const QCString &  )
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 829 行定义.

830 {
831 DB_GEN_C
832  m_t << "<title>";
833 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ startTypewriter()

void DocbookGenerator::startTypewriter ( )
virtual

Changes the text font to fixed size. The section ends with endTypewriter()

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 779 行定义.

780 {
781 DB_GEN_C
782  if (!m_denseText) m_t << "<computeroutput>";
783 }

引用了 DB_GEN_C, m_denseText , 以及 OutputGenerator::m_t.

◆ type()

OutputType DocbookGenerator::type ( ) const
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 105 行定义.

105 { return Docbook; }

引用了 OutputGenerator::Docbook.

被这些函数引用 writeCodeLink().

◆ writeAnchor()

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

实现了 BaseOutputDocInterface.

在文件 docbookgen.h 第 201 行定义.

201 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ writeChar()

void DocbookGenerator::writeChar ( char  c)
virtual

Writes a single ASCII character to the output. Converts characters that have a special meaning.

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 946 行定义.

947 {
948 DB_GEN_C
949  char cs[2];
950  cs[0]=c;
951  cs[1]=0;
952  docify(cs);
953 }

引用了 DB_GEN_C , 以及 docify().

◆ writeCodeAnchor()

void DocbookGenerator::writeCodeAnchor ( const QCString &  name)
inlinevirtual

Write an anchor to a source listing.

参数
nameThe name of the anchor.

实现了 CodeOutputInterface.

在文件 docbookgen.h 第 129 行定义.

130  { m_codeGen.writeCodeAnchor(anchor); }

引用了 m_codeGen , 以及 DocbookCodeGenerator::writeCodeAnchor().

◆ writeCodeLink()

void DocbookGenerator::writeCodeLink ( CodeSymbolType  type,
const QCString &  ref,
const QCString &  file,
const QCString &  anchor,
const QCString &  name,
const QCString &  tooltip 
)
inlinevirtual

Writes a link to an object in a code fragment.

参数
typeThe type of symbol, used for semantic syntax highlighting, may be Default is no info is available.
refIf this is non-zero, the object is to be found in an external documentation file.
fileThe file in which the object is located.
anchorThe anchor uniquely identifying the object within the file.
nameThe text to display as a placeholder for the link.
tooltipThe tooltip to display when the mouse is on the link.

实现了 CodeOutputInterface.

在文件 docbookgen.h 第 110 行定义.

114  { m_codeGen.writeCodeLink(type,ref,file,anchor,name,tooltip); }

引用了 m_codeGen, type() , 以及 DocbookCodeGenerator::writeCodeLink().

◆ writeDoc()

void DocbookGenerator::writeDoc ( DocNode *  n,
const Definition *  ctx,
const MemberDef *  md,
int  id 
)
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 636 行定义.

637 {
638 DB_GEN_C
639  DocbookDocVisitor *visitor =
640  new DocbookDocVisitor(m_t,*this,ctx?ctx->getDefFileExtension():QCString());
641  n->accept(visitor);
642  delete visitor;
643 }

引用了 DocNode::accept(), DB_GEN_C, Definition::getDefFileExtension() , 以及 OutputGenerator::m_t.

◆ writeEndAnnoItem()

void DocbookGenerator::writeEndAnnoItem ( const QCString &  )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 267 行定义.

267 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ writeFooter()

void DocbookGenerator::writeFooter ( const QCString &  )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 145 行定义.

145 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ writeGraphicalHierarchy()

void DocbookGenerator::writeGraphicalHierarchy ( DotGfxHierarchyTable &  )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 290 行定义.

290 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ writeInheritedSectionTitle()

void DocbookGenerator::writeInheritedSectionTitle ( const QCString &  ,
const QCString &  ,
const QCString &  ,
const QCString &  ,
const QCString &  ,
const QCString &   
)
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 272 行定义.

274  {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ writeLabel()

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

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 912 行定义.

913 {
914 DB_GEN_C
915  m_t << "<computeroutput>[" << l << "]</computeroutput>";
916  if (!isLast) m_t << ", ";
917 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ writeLatexSpacing()

void DocbookGenerator::writeLatexSpacing ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 264 行定义.

264 {DB_GEN_EMPTY}

引用了 DB_GEN_EMPTY.

◆ writeLineNumber()

void DocbookGenerator::writeLineNumber ( const QCString &  ref,
const QCString &  file,
const QCString &  anchor,
int  lineNumber,
bool  writeLineAnchor 
)
inlinevirtual

Writes the line number of a source listing

参数
refExternal reference (when imported from a tag file)
fileThe file part of the URL pointing to the docs.
anchorThe anchor part of the URL pointing to the docs.
lineNumberThe line number to write
writeLineAnchorIndicates if an anchor for the line number needs to be written

实现了 CodeOutputInterface.

在文件 docbookgen.h 第 115 行定义.

116  { m_codeGen.writeLineNumber(ref,file,anchor,lineNumber,writeLineAnchor); }

引用了 m_codeGen , 以及 DocbookCodeGenerator::writeLineNumber().

◆ writeLogo()

void DocbookGenerator::writeLogo ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 295 行定义.

295 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ writeNavigationPath()

void DocbookGenerator::writeNavigationPath ( const QCString &  )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 294 行定义.

294 {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ writeNonBreakableSpace()

void DocbookGenerator::writeNonBreakableSpace ( int  n)
virtual

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 769 行定义.

770 {
771 DB_GEN_C
772  for (int i=0;i<n;i++) m_t << " ";
773 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ writeObjectLink()

void DocbookGenerator::writeObjectLink ( const QCString &  ref,
const QCString &  file,
const QCString &  anchor,
const QCString &  name 
)
virtual

Writes a link to an object in the documentation.

参数
refIf this is non-zero, the object is to be found in an external documentation file.
fileThe file in which the object is located.
anchorThe anchor uniquely identifying the object within the file.
nameThe text to display as a placeholder for the link.

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 679 行定义.

681 {
682 DB_GEN_C
683  if (!anchor.isEmpty())
684  {
685  if (!f.isEmpty()) m_t << "<link linkend=\"_" << stripPath(f) << "_1" << anchor << "\">";
686  else m_t << "<link linkend=\"_" << anchor << "\">";
687  }
688  else
689  {
690  m_t << "<link linkend=\"_" << stripPath(f) << "\">";
691  }
692  docify(text);
693  m_t << "</link>";
694 }

引用了 DB_GEN_C, docify(), QCString::isEmpty(), OutputGenerator::m_t , 以及 stripPath().

◆ writePageLink()

void DocbookGenerator::writePageLink ( const QCString &  name,
bool   
)
virtual

实现了 OutputGenerator.

在文件 docbookgen.cpp 第 614 行定义.

615 {
616 DB_GEN_C
617  for (const auto &pd : *Doxygen::pageLinkedMap)
618  {
619  if (!pd->getGroupDef() && !pd->isReference() && pd->name() == stripPath(name))
620  {
621  m_t << "<chapter>\n";
622  if (pd->hasTitle())
623  {
624  m_t << " <title>" << convertToDocBook(pd->title()) << "</title>\n";
625  }
626  else
627  {
628  m_t << " <title>" << convertToDocBook(pd->name()) << "</title>\n";
629  }
630  m_t << " <xi:include href=\"" << pd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>\n";
631  m_t << "</chapter>\n";
632  }
633  }
634 }

引用了 convertToDocBook(), DB_GEN_C, OutputGenerator::m_t, Doxygen::pageLinkedMap , 以及 stripPath().

◆ writeQuickLinks()

void DocbookGenerator::writeQuickLinks ( bool  ,
HighlightedItem  ,
const QCString &   
)
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 296 行定义.

296 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ writeRuler()

void DocbookGenerator::writeRuler ( )
virtual

Writes a horizontal ruler to the output

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 746 行定义.

747 {
748 DB_GEN_C2("m_inLevel " << m_inLevel)
749 DB_GEN_C2("m_inGroup " << m_inGroup)
750  if (m_inGroup) closeSection();
751  m_inGroup = FALSE;
752 }

引用了 closeSection(), DB_GEN_C2, FALSE, m_inGroup , 以及 m_inLevel.

◆ writeSearchInfo()

void DocbookGenerator::writeSearchInfo ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 144 行定义.

144 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ writeSplitBar()

void DocbookGenerator::writeSplitBar ( const QCString &  )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 293 行定义.

293 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ writeStartAnnoItem()

void DocbookGenerator::writeStartAnnoItem ( const QCString &  ,
const QCString &  ,
const QCString &  ,
const QCString &   
)
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 265 行定义.

266  {DB_GEN_NEW};

引用了 DB_GEN_NEW.

◆ writeString()

void DocbookGenerator::writeString ( const QCString &  text)
virtual

Writes an ASCII string to the output, without converting special characters.

实现了 BaseOutputDocInterface.

在文件 docbookgen.cpp 第 656 行定义.

657 {
658 DB_GEN_C
659  m_t << text;
660 }

引用了 DB_GEN_C , 以及 OutputGenerator::m_t.

◆ writeStyleInfo()

void DocbookGenerator::writeStyleInfo ( int  )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 152 行定义.

152 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ writeSummaryLink()

void DocbookGenerator::writeSummaryLink ( const QCString &  ,
const QCString &  ,
const QCString &  ,
bool   
)
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 297 行定义.

297 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ writeSynopsis()

void DocbookGenerator::writeSynopsis ( )
inlinevirtual

实现了 OutputGenerator.

在文件 docbookgen.h 第 277 行定义.

277 {DB_GEN_EMPTY};

引用了 DB_GEN_EMPTY.

◆ writeTooltip()

void DocbookGenerator::writeTooltip ( const QCString &  id,
const DocLinkInfo &  docInfo,
const QCString &  decl,
const QCString &  desc,
const SourceLinkInfo &  defInfo,
const SourceLinkInfo &  declInfo 
)
inlinevirtual

Writes a tool tip definition

参数
idunique identifier for the tooltip
docInfoInfo about the symbol's documentation.
declfull declaration of the symbol (for functions)
descbrief description for the symbol
defInfoInfo about the symbol's definition in the source code
declInfoInfo about the symbol's declaration in the source code

实现了 CodeOutputInterface.

在文件 docbookgen.h 第 117 行定义.

120  { m_codeGen.writeTooltip(id,docInfo,decl,desc,defInfo,declInfo); }

引用了 m_codeGen , 以及 DocbookCodeGenerator::writeTooltip().

类成员变量说明

◆ m_codeGen

DocbookCodeGenerator DocbookGenerator::m_codeGen
private

在文件 docbookgen.h 第 348 行定义.

被这些函数引用 codify(), endCodeFragment(), endCodeLine(), endFile(), endFontClass(), startCodeFragment(), startCodeLine(), startFile(), startFontClass(), writeCodeAnchor(), writeCodeLink(), writeLineNumber() , 以及 writeTooltip().

◆ m_denseText

bool DocbookGenerator::m_denseText = false
private

在文件 docbookgen.h 第 349 行定义.

被这些函数引用 endTextBlock(), endTypewriter(), startTextBlock() , 以及 startTypewriter().

◆ m_descTable

bool DocbookGenerator::m_descTable = false
private

在文件 docbookgen.h 第 354 行定义.

被这些函数引用 endDescTable(), startDescTable() , 以及 startDoxyAnchor().

◆ m_firstMember

bool DocbookGenerator::m_firstMember = false
private

在文件 docbookgen.h 第 357 行定义.

被这些函数引用 startDoxyAnchor() , 以及 startGroupHeader().

◆ m_inGroup

bool DocbookGenerator::m_inGroup = false
private

在文件 docbookgen.h 第 350 行定义.

被这些函数引用 endFile(), endMemberDocList(), startGroupHeader() , 以及 writeRuler().

◆ m_inLevel

int DocbookGenerator::m_inLevel = -1
private

在文件 docbookgen.h 第 356 行定义.

被这些函数引用 endFile(), startGroupHeader(), startMemberDoc() , 以及 writeRuler().

◆ m_inListItem

bool DocbookGenerator::m_inListItem[20] = { false, }
private

在文件 docbookgen.h 第 352 行定义.

被这些函数引用 endMemberList(), startDoxyAnchor() , 以及 startMemberItem().

◆ m_inSimpleSect

bool DocbookGenerator::m_inSimpleSect[20] = { false, }
private

在文件 docbookgen.h 第 353 行定义.

被这些函数引用 endMemberList(), startGroupHeader() , 以及 startMemberHeader().

◆ m_levelListItem

int DocbookGenerator::m_levelListItem = 0
private

在文件 docbookgen.h 第 351 行定义.

被这些函数引用 endMemberList(), startDoxyAnchor(), startGroupHeader(), startMemberHeader(), startMemberItem() , 以及 startMemberList().

◆ m_openSectionCount

int DocbookGenerator::m_openSectionCount = 0
private

在文件 docbookgen.h 第 358 行定义.

被这些函数引用 closeAllSections(), closeSection() , 以及 openSection().

◆ m_simpleTable

bool DocbookGenerator::m_simpleTable = false
private

在文件 docbookgen.h 第 355 行定义.

被这些函数引用 endMemberDocSimple(), startDoxyAnchor() , 以及 startMemberDocSimple().

◆ relPath

QCString DocbookGenerator::relPath
private

在文件 docbookgen.h 第 347 行定义.

被这些函数引用 endCallGraph(), endClassDiagram(), endDirDepGraph(), endDotGraph(), endGroupCollaboration(), endInclDepGraph() , 以及 startFile().

该类的文档由以下文件生成:
Definition::getDefFileExtension
virtual QCString getDefFileExtension() const =0
OutputGenerator::fileName
QCString fileName() const
Definition: outputgen.cpp:85
isExampleDocumentation
@ isExampleDocumentation
Definition: index.h:134
DocbookGenerator::m_simpleTable
bool m_simpleTable
Definition: docbookgen.h:355
isDirDocumentation
@ isDirDocumentation
Definition: index.h:129
Translator::trCompoundMembers
virtual QCString trCompoundMembers()=0
DocbookGenerator::openSection
void openSection(const QCString &attr=QCString())
Definition: docbookgen.cpp:1242
DocbookGenerator::m_codeGen
DocbookCodeGenerator m_codeGen
Definition: docbookgen.h:348
isNamespaceIndex
@ isNamespaceIndex
Definition: index.h:122
DocbookCodeGenerator::startCodeFragment
void startCodeFragment(const QCString &style)
Definition: docbookgen.cpp:269
relativePathToRoot
QCString relativePathToRoot(const QCString &name)
Definition: util.cpp:3656
Dir
Class representing a directory in the file system
Definition: dir.h:68
isFileIndex
@ isFileIndex
Definition: index.h:126
isCompoundIndex
@ isCompoundIndex
Definition: index.h:125
ClassDiagram::writeImage
void writeImage(TextStream &t, const QCString &path, const QCString &relPath, const QCString &file, bool generateMap=true) const
Definition: diagram.cpp:1342
DocbookGenerator::m_levelListItem
int m_levelListItem
Definition: docbookgen.h:351
Doxygen::conceptLinkedMap
static ConceptLinkedMap * conceptLinkedMap
Definition: doxygen.h:80
DocbookCodeGenerator::writeLineNumber
void writeLineNumber(const QCString &extRef, const QCString &compId, const QCString &anchorId, int l, bool writeLineAnchor)
Definition: docbookgen.cpp:225
isTitlePageStart
@ isTitlePageStart
Definition: index.h:117
QCString::isEmpty
bool isEmpty() const
Returns TRUE iff the string is empty
Definition: qcstring.h:144
isPageIndex
@ isPageIndex
Definition: index.h:127
Doxygen::pageLinkedMap
static PageLinkedMap * pageLinkedMap
Definition: doxygen.h:82
addIndexTerm
static void addIndexTerm(TextStream &t, QCString prim, QCString sec="")
Definition: docbookgen.cpp:122
DotGroupCollaboration::writeGraph
QCString writeGraph(TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool writeImageMap=TRUE, int graphId=-1)
Definition: dotgroupcollaboration.cpp:242
QCString::str
std::string str() const
Definition: qcstring.h:442
DotClassGraph::writeGraph
QCString writeGraph(TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool TBRank=TRUE, bool imageMap=TRUE, int graphId=-1)
Definition: dotclassgraph.cpp:447
isClassDocumentation
@ isClassDocumentation
Definition: index.h:131
isModuleDocumentation
@ isModuleDocumentation
Definition: index.h:128
isConceptIndex
@ isConceptIndex
Definition: index.h:123
Translator::trEnumerationValues
virtual QCString trEnumerationValues()=0
Doxygen::dirLinkedMap
static DirLinkedMap * dirLinkedMap
Definition: doxygen.h:109
DotDirDeps::writeGraph
QCString writeGraph(TextStream &out, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool writeImageMap=TRUE, int graphId=-1, bool linkRelations=TRUE)
Definition: dotdirdeps.cpp:432
DocbookDocVisitor
Concrete visitor implementation for Docbook output.
Definition: docbookvisitor.h:31
Doxygen::inputNameLinkedMap
static FileNameLinkedMap * inputNameLinkedMap
Definition: doxygen.h:88
Translator::trISOLang
virtual QCString trISOLang()=0
OutputGenerator::m_t
TextStream m_t
Definition: outputgen.h:511
DotInclDepGraph::writeGraph
QCString writeGraph(TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool writeImageMap=TRUE, int graphId=-1)
Definition: dotincldepgraph.cpp:184
isNamespaceDocumentation
@ isNamespaceDocumentation
Definition: index.h:130
isDirIndex
@ isDirIndex
Definition: index.h:121
DocbookCodeGenerator::writeCodeLink
void writeCodeLink(CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip)
Definition: docbookgen.cpp:158
isEndIndex
@ isEndIndex
Definition: index.h:137
EOF_DocBook
@ EOF_DocBook
Definition: dotgraph.h:28
DocbookGenerator::endSubsubsection
void endSubsubsection()
Definition: docbookgen.cpp:941
DocbookCodeGenerator::startFontClass
void startFontClass(const QCString &colorClass)
Definition: docbookgen.cpp:206
theTranslator
Translator * theTranslator
Definition: language.cpp:156
DocbookGenerator::m_denseText
bool m_denseText
Definition: docbookgen.h:349
Doxygen::groupLinkedMap
static GroupLinkedMap * groupLinkedMap
Definition: doxygen.h:96
DocbookCodeGenerator::sourceFileName
QCString sourceFileName()
Definition: docbookgen.h:42
stripPath
QCString stripPath(const QCString &s)
Definition: util.cpp:5318
OutputGenerator::dir
QCString dir() const
Definition: outputgen.cpp:80
DocbookGenerator::closeSection
void closeSection()
Definition: docbookgen.cpp:1250
TRUE
#define TRUE
Definition: qcstring.h:36
DocbookCodeGenerator::writeTooltip
void writeTooltip(const QCString &, const DocLinkInfo &, const QCString &, const QCString &, const SourceLinkInfo &, const SourceLinkInfo &)
Definition: docbookgen.cpp:182
DocbookCodeGenerator::setRelativePath
void setRelativePath(const QCString &path)
Definition: docbookgen.h:40
DocbookGenerator::closeAllSections
void closeAllSections()
Definition: docbookgen.cpp:1256
isModuleIndex
@ isModuleIndex
Definition: index.h:120
DocbookCodeGenerator::writeCodeAnchor
void writeCodeAnchor(const QCString &)
Definition: docbookgen.cpp:220
DocbookCodeGenerator::codify
void codify(const QCString &text)
Definition: docbookgen.cpp:152
isClassHierarchyIndex
@ isClassHierarchyIndex
Definition: index.h:124
OutputGenerator::Docbook
@ Docbook
Definition: outputgen.h:333
DocbookGenerator::m_inListItem
bool m_inListItem[20]
Definition: docbookgen.h:352
clearSubDirs
void clearSubDirs(const Dir &d)
Definition: util.cpp:3704
DB_GEN_EMPTY
#define DB_GEN_EMPTY
Definition: docbookgen.h:74
DocbookCodeGenerator::startCodeLine
void startCodeLine(bool)
Definition: docbookgen.cpp:189
isTitlePageAuthor
@ isTitlePageAuthor
Definition: index.h:118
GOF_BITMAP
@ GOF_BITMAP
Definition: dotgraph.h:27
DB_GEN_C2
#define DB_GEN_C2(y)
Definition: docbookgen.cpp:69
isFileDocumentation
@ isFileDocumentation
Definition: index.h:133
DB_GEN_C
#define DB_GEN_C
Definition: docbookgen.cpp:67
DocbookGenerator::m_inLevel
int m_inLevel
Definition: docbookgen.h:356
DB_GEN_NEW
#define DB_GEN_NEW
Definition: docbookgen.h:90
DocbookGenerator::m_descTable
bool m_descTable
Definition: docbookgen.h:354
DotCallGraph::writeGraph
QCString writeGraph(TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool writeImageMap=TRUE, int graphId=-1)
Definition: dotcallgraph.cpp:183
DocbookGenerator::startSubsubsection
void startSubsubsection()
Definition: docbookgen.cpp:936
term
void term(const char *fmt,...)
Definition: message.cpp:220
DocbookGenerator::m_inSimpleSect
bool m_inSimpleSect[20]
Definition: docbookgen.h:353
isPageDocumentation
@ isPageDocumentation
Definition: index.h:135
isPageDocumentation2
@ isPageDocumentation2
Definition: index.h:136
qPrint
const char * qPrint(const char *s)
Definition: qcstring.h:589
Config_getString
#define Config_getString(name)
Definition: config.h:32
DocbookCodeGenerator::setSourceFileName
void setSourceFileName(const QCString &sourceFileName)
Definition: docbookgen.h:41
isMainPage
@ isMainPage
Definition: index.h:119
convertToDocBook
QCString convertToDocBook(const QCString &s)
Definition: util.cpp:3999
Doxygen::namespaceLinkedMap
static NamespaceLinkedMap * namespaceLinkedMap
Definition: doxygen.h:97
DocbookGenerator::m_inGroup
bool m_inGroup
Definition: docbookgen.h:350
DocbookGenerator::relPath
QCString relPath
Definition: docbookgen.h:347
DocNode::accept
virtual void accept(DocVisitor *v)=0
OutputGenerator::operator=
OutputGenerator & operator=(const OutputGenerator &o)
Definition: outputgen.cpp:48
DocbookCodeGenerator::endCodeFragment
void endCodeFragment(const QCString &style)
Definition: docbookgen.cpp:275
OutputGenerator::endPlainFile
void endPlainFile()
Definition: outputgen.cpp:72
DocbookCodeGenerator::endFontClass
void endFontClass()
Definition: docbookgen.cpp:213
Translator::trExamples
virtual QCString trExamples()=0
DocbookGenerator::docify
void docify(const QCString &text)
Definition: docbookgen.cpp:674
Doxygen::classLinkedMap
static ClassLinkedMap * classLinkedMap
Definition: doxygen.h:78
DocbookCodeGenerator::endCodeLine
void endCodeLine()
Definition: docbookgen.cpp:196
createSubDirs
void createSubDirs(const Dir &d)
Definition: util.cpp:3677
OutputGenerator::OutputGenerator
OutputGenerator(const QCString &dir)
Definition: outputgen.cpp:27
QCString::right
QCString right(size_t len) const
Definition: qcstring.h:217
OutputGenerator::startPlainFile
void startPlainFile(const QCString &name)
Definition: outputgen.cpp:60
DocbookGenerator::m_firstMember
bool m_firstMember
Definition: docbookgen.h:357
FALSE
#define FALSE
Definition: qcstring.h:33
Doxygen::exampleLinkedMap
static PageLinkedMap * exampleLinkedMap
Definition: doxygen.h:81
DocbookGenerator::type
OutputType type() const
Definition: docbookgen.h:105
isConceptDocumentation
@ isConceptDocumentation
Definition: index.h:132
DocbookGenerator::m_openSectionCount
int m_openSectionCount
Definition: docbookgen.h:358
QCString
This is an alternative implementation of QCString.
Definition: qcstring.h:108