Doxygen
HtmlGenerator类 参考

Generator for HTML output 更多...

#include <htmlgen.h>

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

Public 成员函数

 HtmlGenerator ()
 
HtmlGeneratoroperator= (const HtmlGenerator &g)
 
 HtmlGenerator (const HtmlGenerator &g)
 
virtual ~HtmlGenerator ()
 
virtual std::unique_ptr< OutputGeneratorclone () const
 
virtual OutputType type () const
 
void cleanup ()
 
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 setCurrentDoc (const Definition *context, const QCString &anchor, bool isSourceFile)
 
void addWord (const QCString &word, bool hiPriority)
 
void writeDoc (DocNode *, const Definition *, const MemberDef *, int id)
 
void startFile (const QCString &name, const QCString &manName, const QCString &title, int id)
 
void writeFooter (const QCString &navPath)
 
void endFile ()
 
void clearBuffer ()
 
void writeSearchInfo ()
 
void startIndexSection (IndexSections)
 
void endIndexSection (IndexSections)
 
void writePageLink (const QCString &, bool)
 
void startProjectNumber ()
 
void endProjectNumber ()
 
void writeStyleInfo (int part)
 
void startTitleHead (const QCString &)
 
void endTitleHead (const QCString &, const QCString &)
 
void startTitle ()
 
void endTitle ()
 
void startParagraph (const QCString &classDef)
 
void endParagraph ()
 
void writeString (const QCString &text)
 
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 &ref, const QCString &file)
 
void endIndexItem (const QCString &ref, const QCString &file)
 
void docify (const QCString &text)
 
void writeObjectLink (const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name)
 
void startTextLink (const QCString &file, const QCString &anchor)
 
void endTextLink ()
 
void startHtmlLink (const QCString &url)
 
void endHtmlLink ()
 
void startTypewriter ()
 
void endTypewriter ()
 
void startGroupHeader (int)
 
void endGroupHeader (int)
 
void startItemListItem ()
 
void endItemListItem ()
 
void startMemberSections ()
 
void endMemberSections ()
 
void startHeaderSection ()
 
void endHeaderSection ()
 
void startMemberHeader (const QCString &, int)
 
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 &anchor, int, const QCString &inheritId)
 
void endMemberItem ()
 
void startMemberTemplateParams ()
 
void endMemberTemplateParams (const QCString &anchor, const QCString &inheritId)
 
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 startMemberDescription (const QCString &anchor, const QCString &inheritId, bool typ)
 
void endMemberDescription ()
 
void startMemberDeclaration ()
 
void endMemberDeclaration (const QCString &anchor, const QCString &inheritId)
 
void writeInheritedSectionTitle (const QCString &id, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &title, const QCString &name)
 
void writeRuler ()
 
void writeAnchor (const QCString &, const QCString &name)
 
void startEmphasis ()
 
void endEmphasis ()
 
void startBold ()
 
void endBold ()
 
void startDescription ()
 
void endDescription ()
 
void startDescItem ()
 
void endDescItem ()
 
void startDescForItem ()
 
void endDescForItem ()
 
void lineBreak (const QCString &style)
 
void writeChar (char c)
 
void startMemberDoc (const QCString &clName, const QCString &memName, const QCString &anchor, const QCString &title, int memCount, int memTotal, bool showInline)
 
void endMemberDoc (bool)
 
void startDoxyAnchor (const QCString &fName, const QCString &manName, const QCString &anchor, const QCString &name, const QCString &args)
 
void endDoxyAnchor (const QCString &fName, const QCString &anchor)
 
void writeLatexSpacing ()
 
void writeStartAnnoItem (const QCString &type, const QCString &file, const QCString &path, const QCString &name)
 
void writeEndAnnoItem (const QCString &)
 
void startSubsection ()
 
void endSubsection ()
 
void startSubsubsection ()
 
void endSubsubsection ()
 
void startCenter ()
 
void endCenter ()
 
void startSmall ()
 
void endSmall ()
 
void startExamples ()
 
void endExamples ()
 
void startParamList (ParamListTypes, const QCString &)
 
void endParamList ()
 
void startSection (const QCString &, const QCString &, SectionType)
 
void endSection (const QCString &, SectionType)
 
void addIndexItem (const QCString &, const QCString &)
 
void startIndent ()
 
void endIndent ()
 
void writeSynopsis ()
 
void startClassDiagram ()
 
void endClassDiagram (const ClassDiagram &, const QCString &, const QCString &)
 
void startPageRef ()
 
void endPageRef (const QCString &, const QCString &)
 
void startQuickIndices ()
 
void endQuickIndices ()
 
void writeSplitBar (const QCString &name)
 
void writeNavigationPath (const QCString &s)
 
void writeLogo ()
 
void writeQuickLinks (bool compact, HighlightedItem hli, const QCString &file)
 
void writeSummaryLink (const QCString &file, const QCString &anchor, const QCString &title, bool first)
 
void startContents ()
 
void endContents ()
 
void startPageDoc (const QCString &pageTitle)
 
void endPageDoc ()
 
void writeNonBreakableSpace (int)
 
void startDescTable (const QCString &title)
 
void endDescTable ()
 
void startDescTableRow ()
 
void endDescTableRow ()
 
void startDescTableTitle ()
 
void endDescTableTitle ()
 
void startDescTableData ()
 
void endDescTableData ()
 
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 &g)
 
void startTextBlock (bool)
 
void endTextBlock (bool)
 
void lastIndexPage ()
 
void startMemberDocPrefixItem ()
 
void endMemberDocPrefixItem ()
 
void startMemberDocName (bool)
 
void endMemberDocName ()
 
void startParameterType (bool first, const QCString &key)
 
void endParameterType ()
 
void startParameterName (bool)
 
void endParameterName (bool last, bool emptyList, bool closeBracket)
 
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 &l, bool isLast)
 
void endLabels ()
 
- Public 成员函数 继承自 OutputGenerator
 OutputGenerator (const QCString &dir)
 
 OutputGenerator (const OutputGenerator &o)
 
OutputGeneratoroperator= (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)
 
OutputGeneratorget (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
 
CodeOutputInterfaceoperator= (const CodeOutputInterface &)=delete
 
virtual int id () const
 Identifier for the output file 更多...
 

静态 Public 成员函数

static void init ()
 
static void writeStyleSheetFile (TextStream &t)
 
static void writeHeaderFile (TextStream &t, const QCString &cssname)
 
static void writeFooterFile (TextStream &t)
 
static void writeTabData ()
 Additional initialization after indices have been created 更多...
 
static void writeSearchInfo (TextStream &t, const QCString &relPath)
 
static void writeSearchData (const QCString &dir)
 
static void writeSearchPage ()
 
static void writeExternalSearchPage ()
 
static QCString writeLogoAsString (const QCString &path)
 
static QCString writeSplitBarAsString (const QCString &name, const QCString &relpath)
 
static QCString getMathJaxMacros ()
 

Private 成员函数

void docify (const QCString &text, bool inHtmlComment)
 

静态 Private 成员函数

static void writePageFooter (TextStream &t, const QCString &, const QCString &, const QCString &)
 

Private 属性

QCString m_lastTitle
 
QCString m_lastFile
 
QCString m_relPath
 
int m_sectionCount = 0
 
bool m_emptySection = false
 
HtmlCodeGenerator m_codeGen
 

额外继承的成员函数

- 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
 

详细描述

Generator for HTML output

在文件 htmlgen.h66 行定义.

构造及析构函数说明

◆ HtmlGenerator() [1/2]

HtmlGenerator::HtmlGenerator ( )

在文件 htmlgen.cpp905 行定义.

906 {
907 }

◆ HtmlGenerator() [2/2]

HtmlGenerator::HtmlGenerator ( const HtmlGenerator g)

在文件 htmlgen.cpp909 行定义.

910 {
911 }

◆ ~HtmlGenerator()

HtmlGenerator::~HtmlGenerator ( )
virtual

在文件 htmlgen.cpp924 行定义.

925 {
926  //printf("HtmlGenerator::~HtmlGenerator()\n");
927 }

成员函数说明

◆ addIndexItem()

void HtmlGenerator::addIndexItem ( const QCString ,
const QCString  
)
virtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.cpp2153 行定义.

2154 {
2155 }

◆ addWord()

void HtmlGenerator::addWord ( const QCString word,
bool  hiPriority 
)
virtual

实现了 CodeOutputInterface.

在文件 htmlgen.cpp3068 行定义.

3069 {
3071  {
3072  Doxygen::searchIndex->addWord(word,hiPriority);
3073  }
3074 }

引用了 SearchIndexIntf::addWord() , 以及 Doxygen::searchIndex.

◆ cleanup()

void HtmlGenerator::cleanup ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1005 行定义.

1006 {
1007  QCString dname = Config_getString(HTML_OUTPUT);
1008  Dir d(dname.str());
1009  clearSubDirs(d);
1010 }

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

◆ clearBuffer()

void HtmlGenerator::clearBuffer ( )

◆ clone()

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

实现了 OutputGenerator.

在文件 htmlgen.cpp919 行定义.

920 {
921  return std::make_unique<HtmlGenerator>(*this);
922 }

◆ codify()

void HtmlGenerator::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.

在文件 htmlgen.h91 行定义.

92  { m_codeGen.codify(text); }

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

◆ docify() [1/2]

void HtmlGenerator::docify ( const QCString s)
virtual

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

实现了 BaseOutputDocInterface.

在文件 htmlgen.cpp1499 行定义.

1500 {
1501  docify(str,FALSE);
1502 }

引用了 FALSE.

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

◆ docify() [2/2]

void HtmlGenerator::docify ( const QCString text,
bool  inHtmlComment 
)
private

在文件 htmlgen.cpp1504 行定义.

1505 {
1506  if (!str.isEmpty())
1507  {
1508  const char *p=str.data();
1509  char c;
1510  while (*p)
1511  {
1512  c=*p++;
1513  switch(c)
1514  {
1515  case '<': m_t << "&lt;"; break;
1516  case '>': m_t << "&gt;"; break;
1517  case '&': m_t << "&amp;"; break;
1518  case '"': m_t << "&quot;"; break;
1519  case '-': if (inHtmlComment) m_t << "&#45;"; else m_t << "-"; break;
1520  case '\\':
1521  if (*p=='<')
1522  { m_t << "&lt;"; p++; }
1523  else if (*p=='>')
1524  { m_t << "&gt;"; p++; }
1525  else if (*p=='(')
1526  { m_t << "\\&zwj;("; p++; }
1527  else if (*p==')')
1528  { m_t << "\\&zwj;)"; p++; }
1529  else
1530  m_t << "\\";
1531  break;
1532  default: m_t << c;
1533  }
1534  }
1535  }
1536 }

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

◆ endAnonTypeScope()

void HtmlGenerator::endAnonTypeScope ( int  )
inlinevirtual

实现了 OutputGenerator.

在文件 htmlgen.h187 行定义.

187 {}

◆ endBold()

void HtmlGenerator::endBold ( )
inlinevirtual

End a section of text displayed in bold face.

实现了 BaseOutputDocInterface.

在文件 htmlgen.h218 行定义.

218 { m_t << "</b>"; }

引用了 OutputGenerator::m_t.

◆ endCallGraph()

◆ endCenter()

void HtmlGenerator::endCenter ( )
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.h244 行定义.

244 { m_t << "</center>\n"; }

引用了 OutputGenerator::m_t.

◆ endClassDiagram()

void HtmlGenerator::endClassDiagram ( const ClassDiagram d,
const QCString fileName,
const QCString name 
)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1625 行定义.

1627 {
1632  TextStream tt;
1633  d.writeImage(tt,dir(),m_relPath,fileName);
1634  if (!tt.empty())
1635  {
1636  m_t << " <div class=\"center\">\n";
1637  m_t << " <img src=\"";
1638  m_t << m_relPath << fileName << ".png\" usemap=\"#" << convertToId(name);
1639  m_t << "_map\" alt=\"\"/>\n";
1640  m_t << " <map id=\"" << convertToId(name);
1641  m_t << "_map\" name=\"" << convertToId(name);
1642  m_t << "_map\">\n";
1643  m_t << tt.str();
1644  m_t << " </map>\n";
1645  m_t << "</div>";
1646  }
1647  else
1648  {
1649  m_t << " <div class=\"center\">\n";
1650  m_t << " <img src=\"";
1651  m_t << m_relPath << fileName << ".png\" alt=\"\"/>\n";
1652  m_t << " </div>";
1653  }
1655  m_sectionCount++;
1656 }

引用了 convertToId(), OutputGenerator::dir(), TextStream::empty(), endSectionContent(), endSectionHeader(), endSectionSummary(), OutputGenerator::fileName(), m_relPath, m_sectionCount, OutputGenerator::m_t, startSectionContent(), startSectionSummary(), TextStream::str() , 以及 ClassDiagram::writeImage().

◆ endCodeFragment()

void HtmlGenerator::endCodeFragment ( const QCString style)
inlinevirtual

Ends a block of code

实现了 CodeOutputInterface.

在文件 htmlgen.h116 行定义.

117  { m_codeGen.endCodeFragment(style); }

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

◆ endCodeLine()

void HtmlGenerator::endCodeLine ( )
inlinevirtual

Ends a line of code started with startCodeLine()

实现了 CodeOutputInterface.

在文件 htmlgen.h106 行定义.

107  { m_codeGen.endCodeLine(); }

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

◆ endCompoundTemplateParams()

void HtmlGenerator::endCompoundTemplateParams ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1715 行定义.

1716 {
1717  m_t << "</div>";
1718 }

引用了 OutputGenerator::m_t.

◆ endConstraintDocs()

void HtmlGenerator::endConstraintDocs ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2863 行定义.

2864 {
2865  m_t << "</td></tr>\n";
2866 }

引用了 OutputGenerator::m_t.

◆ endConstraintList()

void HtmlGenerator::endConstraintList ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2868 行定义.

2869 {
2870  m_t << "</table>\n";
2871  m_t << "</dd>\n";
2872  m_t << "</dl>\n";
2873  m_t << "</div>\n";
2874 }

引用了 OutputGenerator::m_t.

◆ endConstraintParam()

void HtmlGenerator::endConstraintParam ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2843 行定义.

2844 {
2845  m_t << "</em></td>";
2846 }

引用了 OutputGenerator::m_t.

◆ endConstraintType()

void HtmlGenerator::endConstraintType ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2853 行定义.

2854 {
2855  m_t << "</em></td>";
2856 }

引用了 OutputGenerator::m_t.

◆ endContents()

void HtmlGenerator::endContents ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2613 行定义.

2614 {
2615  m_t << "</div><!-- contents -->\n";
2616 }

引用了 OutputGenerator::m_t.

◆ endDescForItem()

void HtmlGenerator::endDescForItem ( )
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.h224 行定义.

224 { m_t << "</dd>\n"; }

引用了 OutputGenerator::m_t.

◆ endDescItem()

void HtmlGenerator::endDescItem ( )
inlinevirtual

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

实现了 BaseOutputDocInterface.

在文件 htmlgen.h222 行定义.

222 { m_t << "</dt>"; }

引用了 OutputGenerator::m_t.

◆ endDescription()

void HtmlGenerator::endDescription ( )
inlinevirtual

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

实现了 BaseOutputDocInterface.

在文件 htmlgen.h220 行定义.

220 { m_t << "\n</dl>\n\n"; }

引用了 OutputGenerator::m_t.

◆ endDescTable()

void HtmlGenerator::endDescTable ( )
virtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.cpp2171 行定义.

2172 {
2173  m_t << "</table>\n";
2174 }

引用了 OutputGenerator::m_t.

◆ endDescTableData()

void HtmlGenerator::endDescTableData ( )
virtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.cpp2201 行定义.

2202 {
2203  m_t << "</td>";
2204 }

引用了 OutputGenerator::m_t.

◆ endDescTableRow()

void HtmlGenerator::endDescTableRow ( )
virtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.cpp2181 行定义.

2182 {
2183  m_t << "</tr>\n";
2184 }

引用了 OutputGenerator::m_t.

◆ endDescTableTitle()

void HtmlGenerator::endDescTableTitle ( )
virtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.cpp2191 行定义.

2192 {
2193  m_t << "&#160;</td>";
2194 }

引用了 OutputGenerator::m_t.

◆ endDirDepGraph()

◆ endDotGraph()

void HtmlGenerator::endDotGraph ( DotClassGraph g)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2012 行定义.

2013 {
2014  bool generateLegend = Config_getBool(GENERATE_LEGEND);
2015  bool umlLook = Config_getBool(UML_LOOK);
2020 
2022  if (generateLegend && !umlLook)
2023  {
2024  m_t << "<center><span class=\"legend\">[";
2026  m_t << theTranslator->trLegend();
2027  endHtmlLink();
2028  m_t << "]</span></center>";
2029  }
2030 
2032  m_sectionCount++;
2033 }

引用了 Config_getBool, OutputGenerator::dir(), endHtmlLink(), endSectionContent(), endSectionHeader(), endSectionSummary(), EOF_Html, OutputGenerator::fileName(), GOF_BITMAP, Doxygen::htmlFileExtension, m_relPath, m_sectionCount, OutputGenerator::m_t, startHtmlLink(), startSectionContent(), startSectionSummary(), theTranslator, Translator::trLegend(), TRUE , 以及 DotClassGraph::writeGraph().

◆ endDoxyAnchor()

void HtmlGenerator::endDoxyAnchor ( const QCString fName,
const QCString anchor 
)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1306 行定义.

1307 {
1308 }

◆ endEmphasis()

void HtmlGenerator::endEmphasis ( )
inlinevirtual

Ends a section of text displayed in italic.

实现了 BaseOutputDocInterface.

在文件 htmlgen.h216 行定义.

216 { m_t << "</em>"; }

引用了 OutputGenerator::m_t.

◆ endExamples()

void HtmlGenerator::endExamples ( )
virtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.cpp2213 行定义.

2214 {
2215  m_t << "</dl>\n";
2216 }

引用了 OutputGenerator::m_t.

◆ endFile()

void HtmlGenerator::endFile ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1225 行定义.

1226 {
1227  endPlainFile();
1228 }

引用了 OutputGenerator::endPlainFile().

◆ endFontClass()

void HtmlGenerator::endFontClass ( )
inlinevirtual

Ends a block started with startFontClass()

实现了 CodeOutputInterface.

在文件 htmlgen.h110 行定义.

111  { m_codeGen.endFontClass(); }

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

◆ endGroupCollaboration()

◆ endGroupHeader()

void HtmlGenerator::endGroupHeader ( int  extraIndentLevel)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1456 行定义.

1457 {
1458  if (extraIndentLevel==2)
1459  {
1460  m_t << "</h4>\n";
1461  }
1462  else if (extraIndentLevel==1)
1463  {
1464  m_t << "</h3>\n";
1465  }
1466  else
1467  {
1468  m_t << "</h2>\n";
1469  }
1470 }

引用了 OutputGenerator::m_t.

◆ endHeaderSection()

void HtmlGenerator::endHeaderSection ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2905 行定义.

2906 {
2907  m_t << "</div><!--header-->\n";
2908 }

引用了 OutputGenerator::m_t.

◆ endHtmlLink()

void HtmlGenerator::endHtmlLink ( )
virtual

Ends a link started by startHtmlLink().

实现了 BaseOutputDocInterface.

在文件 htmlgen.cpp1435 行定义.

1436 {
1437  m_t << "</a>";
1438 }

引用了 OutputGenerator::m_t.

被这些函数引用 endDotGraph().

◆ endInclDepGraph()

◆ endIndent()

void HtmlGenerator::endIndent ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2147 行定义.

2148 {
2149  DBG_HTML(m_t << "<!-- endIndent -->\n";)
2150  m_t << "\n</div>\n" << "</div>\n";
2151 }

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

◆ endIndexItem()

void HtmlGenerator::endIndexItem ( const QCString ref,
const QCString file 
)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1368 行定义.

1369 {
1370  //printf("HtmlGenerator::endIndexItem(%s,%s,%s)\n",ref,f,name);
1371  if (!ref.isEmpty() || !f.isEmpty())
1372  {
1373  m_t << "</a>";
1374  }
1375  else
1376  {
1377  m_t << "</b>";
1378  }
1379 }

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

◆ endIndexKey()

void HtmlGenerator::endIndexKey ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1835 行定义.

1836 {
1837  m_t << "</td>";
1838 }

引用了 OutputGenerator::m_t.

◆ endIndexList()

void HtmlGenerator::endIndexList ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1824 行定义.

1825 {
1826  m_t << "</table>\n";
1827 }

引用了 OutputGenerator::m_t.

◆ endIndexListItem()

void HtmlGenerator::endIndexListItem ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1338 行定义.

1339 {
1340  m_t << "</li>\n";
1341 }

引用了 OutputGenerator::m_t.

◆ endIndexSection()

void HtmlGenerator::endIndexSection ( IndexSections  )
inlinevirtual

实现了 OutputGenerator.

在文件 htmlgen.h131 行定义.

131 {}

◆ endIndexValue()

void HtmlGenerator::endIndexValue ( const QCString ,
bool   
)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1846 行定义.

1847 {
1848  m_t << "</td></tr>\n";
1849 }

引用了 OutputGenerator::m_t.

◆ endInlineHeader()

void HtmlGenerator::endInlineHeader ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2920 行定义.

2921 {
2922  m_t << "</h3></td></tr>\n";
2923 }

引用了 OutputGenerator::m_t.

◆ endInlineMemberDoc()

void HtmlGenerator::endInlineMemberDoc ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2970 行定义.

2971 {
2972  DBG_HTML(m_t << "<!-- endInlineMemberDoc -->\n";)
2973  m_t << "</td></tr>\n";
2974 }

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

◆ endInlineMemberName()

void HtmlGenerator::endInlineMemberName ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2958 行定义.

2959 {
2960  DBG_HTML(m_t << "<!-- endInlineMemberName -->\n";)
2961  m_t << "</td>\n";
2962 }

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

◆ endInlineMemberType()

void HtmlGenerator::endInlineMemberType ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2946 行定义.

2947 {
2948  DBG_HTML(m_t << "<!-- endInlineMemberType -->\n";)
2949  m_t << "</td>\n";
2950 }

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

◆ endItemList()

void HtmlGenerator::endItemList ( )
inlinevirtual

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

实现了 BaseOutputDocInterface.

在文件 htmlgen.h153 行定义.

153 { m_t << "</ul>\n"; }

引用了 OutputGenerator::m_t.

◆ endItemListItem()

void HtmlGenerator::endItemListItem ( )
inlinevirtual

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

实现了 BaseOutputDocInterface.

在文件 htmlgen.h170 行定义.

170 { m_t << "</li>\n"; }

引用了 OutputGenerator::m_t.

◆ endLabels()

void HtmlGenerator::endLabels ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2990 行定义.

2991 {
2992  DBG_HTML(m_t << "<!-- endLabels -->\n";)
2993  m_t << "</span>";
2994 }

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

◆ endMemberDeclaration()

void HtmlGenerator::endMemberDeclaration ( const QCString anchor,
const QCString inheritId 
)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp3050 行定义.

3051 {
3052  m_t << "<tr class=\"separator:" << anchor;
3053  if (!inheritId.isEmpty())
3054  {
3055  m_t << " inherit " << inheritId;
3056  }
3057  m_t << "\"><td class=\"memSeparator\" colspan=\"2\">&#160;</td></tr>\n";
3058 }

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

◆ endMemberDescription()

void HtmlGenerator::endMemberDescription ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1758 行定义.

1759 {
1760  DBG_HTML(m_t << "<!-- endMemberDescription -->\n")
1761  m_t << "<br /></td></tr>\n";
1762 }

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

◆ endMemberDoc()

void HtmlGenerator::endMemberDoc ( bool  hasArgs)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1996 行定义.

1997 {
1998  DBG_HTML(m_t << "<!-- endMemberDoc -->\n";)
1999  if (!hasArgs)
2000  {
2001  m_t << " </tr>\n";
2002  }
2003  m_t << " </table>\n";
2004  // m_t << "</div>\n";
2005 }

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

◆ endMemberDocList()

void HtmlGenerator::endMemberDocList ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1856 行定义.

1857 {
1858  DBG_HTML(m_t << "<!-- endMemberDocList -->\n";)
1859 }

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

◆ endMemberDocName()

void HtmlGenerator::endMemberDocName ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1900 行定义.

1901 {
1902  DBG_HTML(m_t << "<!-- endMemberDocName -->\n";)
1903  m_t << "</td>\n";
1904 }

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

◆ endMemberDocPrefixItem()

void HtmlGenerator::endMemberDocPrefixItem ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1884 行定义.

1885 {
1886  DBG_HTML(m_t << "<!-- endMemberDocPrefixItem -->\n";)
1887  m_t << "</div>\n";
1888 }

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

◆ endMemberDocSimple()

void HtmlGenerator::endMemberDocSimple ( bool  )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2934 行定义.

2935 {
2936  DBG_HTML(m_t << "<!-- endMemberDocSimple -->\n";)
2937  m_t << "</table>\n";
2938 }

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

◆ endMemberGroup()

void HtmlGenerator::endMemberGroup ( bool  )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2136 行定义.

2137 {
2138 }

◆ endMemberGroupDocs()

void HtmlGenerator::endMemberGroupDocs ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2127 行定义.

2128 {
2129  m_t << "</div></td></tr>\n";
2130 }

引用了 OutputGenerator::m_t.

◆ endMemberGroupHeader()

void HtmlGenerator::endMemberGroupHeader ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2117 行定义.

2118 {
2119  m_t << "</div></td></tr>\n";
2120 }

引用了 OutputGenerator::m_t.

◆ endMemberHeader()

void HtmlGenerator::endMemberHeader ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1801 行定义.

1802 {
1803  DBG_HTML(m_t << "<!-- endMemberHeader -->\n")
1804  m_t << "</h2></td></tr>\n";
1805 }

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

◆ endMemberItem()

void HtmlGenerator::endMemberItem ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1690 行定义.

1691 {
1692  m_t << "</td></tr>\n";
1693 }

引用了 OutputGenerator::m_t.

◆ endMemberList()

void HtmlGenerator::endMemberList ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1664 行定义.

1665 {
1666  DBG_HTML(m_t << "<!-- endMemberList -->\n")
1667 }

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

◆ endMemberSections()

void HtmlGenerator::endMemberSections ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1772 行定义.

1773 {
1774  DBG_HTML(m_t << "<!-- endMemberSections -->\n")
1775  if (!m_emptySection)
1776  {
1777  m_t << "</table>\n";
1778  }
1779 }

引用了 DBG_HTML, m_emptySection , 以及 OutputGenerator::m_t.

◆ endMemberSubtitle()

void HtmlGenerator::endMemberSubtitle ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1813 行定义.

1814 {
1815  DBG_HTML(m_t << "<!-- endMemberSubtitle -->\n")
1816  m_t << "</td></tr>\n";
1817 }

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

◆ endMemberTemplateParams()

void HtmlGenerator::endMemberTemplateParams ( const QCString anchor,
const QCString inheritId 
)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1699 行定义.

1700 {
1701  m_t << "</td></tr>\n";
1702  m_t << "<tr class=\"memitem:" << anchor;
1703  if (!inheritId.isEmpty())
1704  {
1705  m_t << " inherit " << inheritId;
1706  }
1707  m_t << "\"><td class=\"memTemplItemLeft\" align=\"right\" valign=\"top\">";
1708 }

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

◆ endPageDoc()

void HtmlGenerator::endPageDoc ( )
virtual

重载 OutputGenerator .

在文件 htmlgen.cpp2623 行定义.

2624 {
2625  m_t << "</div><!-- PageDoc -->\n";
2626 }

引用了 OutputGenerator::m_t.

◆ endPageRef()

void HtmlGenerator::endPageRef ( const QCString ,
const QCString  
)
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.h260 行定义.

260 {}

◆ endParagraph()

void HtmlGenerator::endParagraph ( )
virtual

Ends a paragraph

实现了 BaseOutputDocInterface.

在文件 htmlgen.cpp1323 行定义.

1324 {
1325  m_t << "</p>\n";
1326 }

引用了 OutputGenerator::m_t.

◆ endParameterList()

void HtmlGenerator::endParameterList ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1973 行定义.

1974 {
1975  DBG_HTML(m_t << "<!-- endParameterList -->\n";)
1976  m_t << "</td>\n";
1977  m_t << " </tr>\n";
1978 }

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

◆ endParameterName()

void HtmlGenerator::endParameterName ( bool  last,
bool  emptyList,
bool  closeBracket 
)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1943 行定义.

1944 {
1945  DBG_HTML(m_t << "<!-- endParameterName -->\n";)
1946  if (last)
1947  {
1948  if (emptyList)
1949  {
1950  if (closeBracket) m_t << "</td><td>)";
1951  m_t << "</td>\n";
1952  m_t << " <td>";
1953  }
1954  else
1955  {
1956  m_t << "&#160;</td>\n";
1957  m_t << " </tr>\n";
1958  m_t << " <tr>\n";
1959  m_t << " <td></td>\n";
1960  m_t << " <td>";
1961  if (closeBracket) m_t << ")";
1962  m_t << "</td>\n";
1963  m_t << " <td></td><td>";
1964  }
1965  }
1966  else
1967  {
1968  m_t << "</td>\n";
1969  m_t << " </tr>\n";
1970  }
1971 }

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

◆ endParameterType()

void HtmlGenerator::endParameterType ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1931 行定义.

1932 {
1933  DBG_HTML(m_t << "<!-- endParameterType -->\n";)
1934  m_t << "&#160;</td>\n";
1935 }

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

◆ endParamList()

void HtmlGenerator::endParamList ( )
virtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.cpp2226 行定义.

2227 {
2228  m_t << "</dl>";
2229 }

引用了 OutputGenerator::m_t.

◆ endProjectNumber()

void HtmlGenerator::endProjectNumber ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1235 行定义.

1236 {
1237  m_t << "</h3>";
1238 }

引用了 OutputGenerator::m_t.

◆ endQuickIndices()

void HtmlGenerator::endQuickIndices ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2558 行定义.

2559 {
2560  m_t << "</div><!-- top -->\n";
2561 }

引用了 OutputGenerator::m_t.

◆ endSection()

void HtmlGenerator::endSection ( const QCString ,
SectionType  type 
)
virtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.cpp1486 行定义.

1487 {
1488  switch(type)
1489  {
1490  case SectionType::Page: m_t << "</h1>"; break;
1491  case SectionType::Section: m_t << "</h2>"; break;
1492  case SectionType::Subsection: m_t << "</h3>"; break;
1493  case SectionType::Subsubsection: m_t << "</h4>"; break;
1494  case SectionType::Paragraph: m_t << "</h5>"; break;
1495  default: ASSERT(0); break;
1496  }
1497 }

引用了 ASSERT, OutputGenerator::m_t, Page, Paragraph, Section, Subsection, Subsubsection , 以及 type().

◆ endSmall()

void HtmlGenerator::endSmall ( )
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.h246 行定义.

246 { m_t << "</small>\n"; }

引用了 OutputGenerator::m_t.

◆ endSubsection()

void HtmlGenerator::endSubsection ( )
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.h240 行定义.

240 { m_t << "</h2>\n"; }

引用了 OutputGenerator::m_t.

◆ endSubsubsection()

void HtmlGenerator::endSubsubsection ( )
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.h242 行定义.

242 { m_t << "</h3>\n"; }

引用了 OutputGenerator::m_t.

◆ endTextBlock()

void HtmlGenerator::endTextBlock ( bool  )
inlinevirtual

实现了 OutputGenerator.

在文件 htmlgen.h297 行定义.

298  { m_t << "</div>"; }

引用了 OutputGenerator::m_t.

◆ endTextLink()

void HtmlGenerator::endTextLink ( )
virtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.cpp1420 行定义.

1421 {
1422  m_t << "</a>";
1423 }

引用了 OutputGenerator::m_t.

◆ endTitle()

void HtmlGenerator::endTitle ( )
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.h139 行定义.

139 { m_t << "</div>"; }

引用了 OutputGenerator::m_t.

被这些函数引用 endTitleHead().

◆ endTitleHead()

void HtmlGenerator::endTitleHead ( const QCString ,
const QCString  
)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2899 行定义.

2900 {
2901  endTitle();
2902  m_t << "</div>\n";
2903 }

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

◆ endTypewriter()

void HtmlGenerator::endTypewriter ( )
inlinevirtual

End a section of text displayed in typewriter style.

实现了 BaseOutputDocInterface.

在文件 htmlgen.h166 行定义.

166 { m_t << "</code>"; }

引用了 OutputGenerator::m_t.

◆ exceptionEntry()

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

实现了 OutputGenerator.

在文件 htmlgen.cpp1980 行定义.

1981 {
1982  DBG_HTML(m_t << "<!-- exceptionEntry -->\n";)
1983  m_t << "</td>\n";
1984  m_t << " </tr>\n";
1985  m_t << " <tr>\n";
1986  m_t << " <td align=\"right\">";
1987  // colspan 2 so it gets both parameter type and parameter name columns
1988  if (!prefix.isEmpty())
1989  m_t << prefix << "</td><td>(</td><td colspan=\"2\">";
1990  else if (closeBracket)
1991  m_t << "</td><td>)</td><td></td><td>";
1992  else
1993  m_t << "</td><td></td><td colspan=\"2\">";
1994 }

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

◆ getMathJaxMacros()

QCString HtmlGenerator::getMathJaxMacros ( )
static

在文件 htmlgen.cpp3076 行定义.

3077 {
3078  return getConvertLatexMacro();
3079 }

引用了 getConvertLatexMacro().

被这些函数引用 DoxygenContext::Private::createMathJaxMacros().

◆ init()

void HtmlGenerator::init ( )
static

在文件 htmlgen.cpp930 行定义.

931 {
932  QCString dname = Config_getString(HTML_OUTPUT);
933  Dir d(dname.str());
934  if (!d.exists() && !d.mkdir(dname.str()))
935  {
936  term("Could not create output directory %s\n",qPrint(dname));
937  }
938  //writeLogo(dname);
939  if (!Config_getString(HTML_HEADER).isEmpty())
940  {
941  g_header=fileToString(Config_getString(HTML_HEADER));
942  //printf("g_header='%s'\n",qPrint(g_header));
943  }
944  else
945  {
946  g_header = ResourceMgr::instance().getAsString("header.html");
947  }
948 
949  if (!Config_getString(HTML_FOOTER).isEmpty())
950  {
951  g_footer=fileToString(Config_getString(HTML_FOOTER));
952  //printf("g_footer='%s'\n",qPrint(g_footer));
953  }
954  else
955  {
956  g_footer = ResourceMgr::instance().getAsString("footer.html");
957  }
958 
959  if (Config_getBool(USE_MATHJAX))
960  {
961  if (!Config_getString(MATHJAX_CODEFILE).isEmpty())
962  {
963  g_mathjax_code=fileToString(Config_getString(MATHJAX_CODEFILE));
964  //printf("g_mathjax_code='%s'\n",qPrint(g_mathjax_code));
965  }
967  //printf("converted g_latex_macro='%s'\n",qPrint(g_latex_macro));
968  }
969  createSubDirs(d);
970 
972  if (Config_getBool(HTML_DYNAMIC_MENUS))
973  {
974  mgr.copyResourceAs("tabs.css",dname,"tabs.css");
975  }
976  else // stylesheet for the 'old' static tabs
977  {
978  mgr.copyResourceAs("fixed_tabs.css",dname,"tabs.css");
979  }
980  mgr.copyResource("jquery.js",dname);
981  if (Config_getBool(INTERACTIVE_SVG))
982  {
983  mgr.copyResource("svgpan.js",dname);
984  }
985 
986  if (!Config_getBool(DISABLE_INDEX) && Config_getBool(HTML_DYNAMIC_MENUS))
987  {
988  mgr.copyResource("menu.js",dname);
989  }
990 
991  {
992  std::ofstream f(dname.str()+"/dynsections.js",std::ofstream::out | std::ofstream::binary);
993  if (f.is_open())
994  {
995  TextStream t(&f);
996  t << mgr.getAsString("dynsections.js");
997  if (Config_getBool(SOURCE_BROWSER) && Config_getBool(SOURCE_TOOLTIPS))
998  {
999  t << mgr.getAsString("dynsections_tooltips.js");
1000  }
1001  }
1002  }
1003 }

引用了 Config_getBool, Config_getString, ResourceMgr::copyResource(), ResourceMgr::copyResourceAs(), createSubDirs(), Dir::exists(), fileToString(), g_footer, g_header, g_latex_macro, g_mathjax_code, ResourceMgr::getAsString(), getConvertLatexMacro(), ResourceMgr::instance(), Dir::mkdir(), qPrint(), QCString::str() , 以及 term().

被这些函数引用 generateOutput().

◆ insertMemberAlign()

void HtmlGenerator::insertMemberAlign ( bool  templ)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1720 行定义.

1721 {
1722  DBG_HTML(m_t << "<!-- insertMemberAlign -->\n")
1723  QCString className = templ ? "memTemplItemRight" : "memItemRight";
1724  m_t << "&#160;</td><td class=\"" << className << "\" valign=\"bottom\">";
1725 }

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

◆ insertMemberAlignLeft()

void HtmlGenerator::insertMemberAlignLeft ( int  annoType,
bool  initTag 
)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1727 行定义.

1728 {
1729  if (!initTag) m_t << "&#160;</td>";
1730  switch(annoType)
1731  {
1732  case 0: m_t << "<td class=\"memItemLeft\" align=\"right\" valign=\"top\">"; break;
1733  case 1: m_t << "<td class=\"memItemLeft\" >"; break;
1734  case 2: m_t << "<td class=\"memItemLeft\" valign=\"top\">"; break;
1735  default: m_t << "<td class=\"memTemplParams\" colspan=\"2\">"; break;
1736  }
1737 }

引用了 OutputGenerator::m_t.

被这些函数引用 startMemberItem().

◆ lastIndexPage()

void HtmlGenerator::lastIndexPage ( )
inlinevirtual

实现了 OutputGenerator.

在文件 htmlgen.h299 行定义.

299 {}

◆ lineBreak()

void HtmlGenerator::lineBreak ( const QCString style)
virtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.cpp2876 行定义.

2877 {
2878  if (!style.isEmpty())
2879  {
2880  m_t << "<br class=\"" << style << "\" />\n";
2881  }
2882  else
2883  {
2884  m_t << "<br />\n";
2885  }
2886 }

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

◆ operator=()

HtmlGenerator & HtmlGenerator::operator= ( const HtmlGenerator g)

在文件 htmlgen.cpp913 行定义.

914 {
916  return *this;
917 }

引用了 OutputGenerator::operator=().

◆ setCurrentDoc()

void HtmlGenerator::setCurrentDoc ( const Definition context,
const QCString anchor,
bool  isSourceFile 
)
virtual

实现了 CodeOutputInterface.

在文件 htmlgen.cpp3060 行定义.

3061 {
3063  {
3064  Doxygen::searchIndex->setCurrentDoc(context,anchor,isSourceFile);
3065  }
3066 }

引用了 Doxygen::searchIndex , 以及 SearchIndexIntf::setCurrentDoc().

◆ startAnonTypeScope()

void HtmlGenerator::startAnonTypeScope ( int  )
inlinevirtual

实现了 OutputGenerator.

在文件 htmlgen.h186 行定义.

186 {}

◆ startBold()

void HtmlGenerator::startBold ( )
inlinevirtual

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

实现了 BaseOutputDocInterface.

在文件 htmlgen.h217 行定义.

217 { m_t << "<b>"; }

引用了 OutputGenerator::m_t.

◆ startCallGraph()

void HtmlGenerator::startCallGraph ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2071 行定义.

2072 {
2074 }

引用了 m_relPath, m_sectionCount, OutputGenerator::m_t , 以及 startSectionHeader().

◆ startCenter()

void HtmlGenerator::startCenter ( )
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.h243 行定义.

243 { m_t << "<center>\n"; }

引用了 OutputGenerator::m_t.

◆ startClassDiagram()

void HtmlGenerator::startClassDiagram ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1620 行定义.

1621 {
1623 }

引用了 m_relPath, m_sectionCount, OutputGenerator::m_t , 以及 startSectionHeader().

◆ startCodeFragment()

void HtmlGenerator::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.

在文件 htmlgen.h114 行定义.

115  { m_codeGen.startCodeFragment(style); }

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

◆ startCodeLine()

void HtmlGenerator::startCodeLine ( bool  hasLineNumbers)
inlinevirtual

实现了 CodeOutputInterface.

在文件 htmlgen.h104 行定义.

105  { m_codeGen.startCodeLine(hasLineNumbers); }

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

◆ startCompoundTemplateParams()

void HtmlGenerator::startCompoundTemplateParams ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1710 行定义.

1711 {
1712  m_t << "<div class=\"compoundTemplParams\">";
1713 }

引用了 OutputGenerator::m_t.

◆ startConstraintDocs()

void HtmlGenerator::startConstraintDocs ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2858 行定义.

2859 {
2860  m_t << "<td>&#160;";
2861 }

引用了 OutputGenerator::m_t.

◆ startConstraintList()

void HtmlGenerator::startConstraintList ( const QCString header)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2831 行定义.

2832 {
2833  m_t << "<div class=\"typeconstraint\">\n";
2834  m_t << "<dl><dt><b>" << header << "</b></dt><dd>\n";
2835  m_t << "<table border=\"0\" cellspacing=\"2\" cellpadding=\"0\">\n";
2836 }

引用了 OutputGenerator::m_t.

◆ startConstraintParam()

void HtmlGenerator::startConstraintParam ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2838 行定义.

2839 {
2840  m_t << "<tr><td valign=\"top\"><em>";
2841 }

引用了 OutputGenerator::m_t.

◆ startConstraintType()

void HtmlGenerator::startConstraintType ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2848 行定义.

2849 {
2850  m_t << "<td>&#160;:</td><td valign=\"top\"><em>";
2851 }

引用了 OutputGenerator::m_t.

◆ startContents()

void HtmlGenerator::startContents ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2608 行定义.

2609 {
2610  m_t << "<div class=\"contents\">\n";
2611 }

引用了 OutputGenerator::m_t.

◆ startDescForItem()

void HtmlGenerator::startDescForItem ( )
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.h223 行定义.

223 { m_t << "<dd>"; }

引用了 OutputGenerator::m_t.

◆ startDescItem()

void HtmlGenerator::startDescItem ( )
inlinevirtual

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

实现了 BaseOutputDocInterface.

在文件 htmlgen.h221 行定义.

221 { m_t << "<dt>"; }

引用了 OutputGenerator::m_t.

◆ startDescription()

void HtmlGenerator::startDescription ( )
inlinevirtual

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

实现了 BaseOutputDocInterface.

在文件 htmlgen.h219 行定义.

219 { m_t << "\n<dl>\n"; }

引用了 OutputGenerator::m_t.

◆ startDescTable()

void HtmlGenerator::startDescTable ( const QCString title)
virtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.cpp2166 行定义.

2167 {
2168  m_t << "<table class=\"fieldtable\">\n"
2169  << "<tr><th colspan=\"2\">" << title << "</th></tr>";
2170 }

引用了 OutputGenerator::m_t.

◆ startDescTableData()

void HtmlGenerator::startDescTableData ( )
virtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.cpp2196 行定义.

2197 {
2198  m_t << "<td class=\"fielddoc\">";
2199 }

引用了 OutputGenerator::m_t.

◆ startDescTableRow()

void HtmlGenerator::startDescTableRow ( )
virtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.cpp2176 行定义.

2177 {
2178  m_t << "<tr>";
2179 }

引用了 OutputGenerator::m_t.

◆ startDescTableTitle()

void HtmlGenerator::startDescTableTitle ( )
virtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.cpp2186 行定义.

2187 {
2188  m_t << "<td class=\"fieldname\">";
2189 }

引用了 OutputGenerator::m_t.

◆ startDirDepGraph()

void HtmlGenerator::startDirDepGraph ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2089 行定义.

2090 {
2092 }

引用了 m_relPath, m_sectionCount, OutputGenerator::m_t , 以及 startSectionHeader().

◆ startDotGraph()

void HtmlGenerator::startDotGraph ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2007 行定义.

2008 {
2010 }

引用了 m_relPath, m_sectionCount, OutputGenerator::m_t , 以及 startSectionHeader().

◆ startDoxyAnchor()

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

实现了 OutputGenerator.

在文件 htmlgen.cpp1299 行定义.

1302 {
1303  m_t << "<a id=\"" << anchor << "\" name=\"" << anchor << "\"></a>";
1304 }

引用了 OutputGenerator::m_t.

◆ startEmphasis()

void HtmlGenerator::startEmphasis ( )
inlinevirtual

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

实现了 BaseOutputDocInterface.

在文件 htmlgen.h215 行定义.

215 { m_t << "<em>"; }

引用了 OutputGenerator::m_t.

◆ startExamples()

void HtmlGenerator::startExamples ( )
virtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.cpp2206 行定义.

2207 {
2208  m_t << "<dl class=\"section examples\"><dt>";
2210  m_t << "</dt>";
2211 }

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

◆ startFile()

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

实现了 OutputGenerator.

在文件 htmlgen.cpp1120 行定义.

1122 {
1123  //printf("HtmlGenerator::startFile(%s)\n",qPrint(name));
1124  m_relPath = relativePathToRoot(name);
1126  m_lastTitle=title;
1127 
1129  m_codeGen.setId(id);
1131  {
1132  std::lock_guard<std::mutex> lock(g_indexLock);
1134  }
1135 
1136  m_lastFile = fileName;
1138 
1139  m_t << "<!-- " << theTranslator->trGeneratedBy() << " Doxygen "
1140  << getDoxygenVersion() << " -->\n";
1141  //bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
1142  bool searchEngine = Config_getBool(SEARCHENGINE);
1143  if (searchEngine /*&& !generateTreeView*/)
1144  {
1145  m_t << "<script type=\"text/javascript\">\n";
1146  m_t << "/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */\n";
1147  m_t << "var searchBox = new SearchBox(\"searchBox\", \""
1148  << m_relPath<< "search\",'" << theTranslator->trSearch() << "','" << Doxygen::htmlFileExtension << "');\n";
1149  m_t << "/* @license-end */\n";
1150  m_t << "</script>\n";
1151  }
1152  //generateDynamicSections(t,relPath);
1153  m_sectionCount=0;
1154 }

引用了 addHtmlExtensionIfMissing(), IndexList::addIndexFile(), Config_getBool, convertToHtml(), OutputGenerator::fileName(), filterTitle(), g_header, g_indexLock, Doxygen::htmlFileExtension, Doxygen::indexList, m_codeGen, m_lastFile, m_lastTitle, m_relPath, m_sectionCount, OutputGenerator::m_t, relativePathToRoot(), HtmlCodeGenerator::setId(), HtmlCodeGenerator::setRelativePath(), OutputGenerator::startPlainFile(), substituteHtmlKeywords(), theTranslator, Translator::trGeneratedBy() , 以及 Translator::trSearch().

◆ startFontClass()

void HtmlGenerator::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.

在文件 htmlgen.h108 行定义.

109  { m_codeGen.startFontClass(s); }

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

◆ startGroupCollaboration()

void HtmlGenerator::startGroupCollaboration ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2053 行定义.

2054 {
2056 }

引用了 m_relPath, m_sectionCount, OutputGenerator::m_t , 以及 startSectionHeader().

◆ startGroupHeader()

void HtmlGenerator::startGroupHeader ( int  extraIndentLevel)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1440 行定义.

1441 {
1442  if (extraIndentLevel==2)
1443  {
1444  m_t << "<h4 class=\"groupheader\">";
1445  }
1446  else if (extraIndentLevel==1)
1447  {
1448  m_t << "<h3 class=\"groupheader\">";
1449  }
1450  else // extraIndentLevel==0
1451  {
1452  m_t << "<h2 class=\"groupheader\">";
1453  }
1454 }

引用了 OutputGenerator::m_t.

◆ startHeaderSection()

void HtmlGenerator::startHeaderSection ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2888 行定义.

2889 {
2890  m_t << "<div class=\"header\">\n";
2891 }

引用了 OutputGenerator::m_t.

◆ startHtmlLink()

void HtmlGenerator::startHtmlLink ( const QCString url)
virtual

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

参数
urlThe URL to link to.

实现了 BaseOutputDocInterface.

在文件 htmlgen.cpp1425 行定义.

1426 {
1427  bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
1428  m_t << "<a ";
1429  if (generateTreeView) m_t << "target=\"top\" ";
1430  m_t << "href=\"";
1431  if (!url.isEmpty()) m_t << url;
1432  m_t << "\">";
1433 }

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

被这些函数引用 endDotGraph().

◆ startInclDepGraph()

void HtmlGenerator::startInclDepGraph ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2035 行定义.

2036 {
2038 }

引用了 m_relPath, m_sectionCount, OutputGenerator::m_t , 以及 startSectionHeader().

◆ startIndent()

void HtmlGenerator::startIndent ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2140 行定义.

2141 {
2142  DBG_HTML(m_t << "<!-- startIndent -->\n";)
2143 
2144  m_t << "<div class=\"memdoc\">\n";
2145 }

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

◆ startIndexItem()

void HtmlGenerator::startIndexItem ( const QCString ref,
const QCString file 
)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1343 行定义.

1344 {
1345  //printf("HtmlGenerator::startIndexItem(%s,%s)\n",ref,f);
1346  if (!ref.isEmpty() || !f.isEmpty())
1347  {
1348  if (!ref.isEmpty())
1349  {
1350  m_t << "<a class=\"elRef\" ";
1351  m_t << externalLinkTarget();
1352  }
1353  else
1354  {
1355  m_t << "<a class=\"el\" ";
1356  }
1357  m_t << "href=\"";
1358  m_t << externalRef(m_relPath,ref,TRUE);
1359  if (!f.isEmpty()) m_t << addHtmlExtensionIfMissing(f);
1360  m_t << "\">";
1361  }
1362  else
1363  {
1364  m_t << "<b>";
1365  }
1366 }

引用了 addHtmlExtensionIfMissing(), externalLinkTarget(), externalRef(), QCString::isEmpty(), m_relPath, OutputGenerator::m_t , 以及 TRUE.

◆ startIndexKey()

void HtmlGenerator::startIndexKey ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1829 行定义.

1830 {
1831  // inserted 'class = ...', 02 jan 2002, jh
1832  m_t << " <tr><td class=\"indexkey\">";
1833 }

引用了 OutputGenerator::m_t.

◆ startIndexList()

void HtmlGenerator::startIndexList ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1819 行定义.

1820 {
1821  m_t << "<table>\n";
1822 }

引用了 OutputGenerator::m_t.

◆ startIndexListItem()

void HtmlGenerator::startIndexListItem ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1333 行定义.

1334 {
1335  m_t << "<li>";
1336 }

引用了 OutputGenerator::m_t.

◆ startIndexSection()

void HtmlGenerator::startIndexSection ( IndexSections  )
inlinevirtual

实现了 OutputGenerator.

在文件 htmlgen.h130 行定义.

130 {}

◆ startIndexValue()

void HtmlGenerator::startIndexValue ( bool  )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1840 行定义.

1841 {
1842  // inserted 'class = ...', 02 jan 2002, jh
1843  m_t << "<td class=\"indexvalue\">";
1844 }

引用了 OutputGenerator::m_t.

◆ startInlineHeader()

void HtmlGenerator::startInlineHeader ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2910 行定义.

2911 {
2912  if (m_emptySection)
2913  {
2914  m_t << "<table class=\"memberdecls\">\n";
2916  }
2917  m_t << "<tr><td colspan=\"2\"><h3>";
2918 }

引用了 FALSE, m_emptySection , 以及 OutputGenerator::m_t.

◆ startInlineMemberDoc()

void HtmlGenerator::startInlineMemberDoc ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2964 行定义.

2965 {
2966  DBG_HTML(m_t << "<!-- startInlineMemberDoc -->\n";)
2967  m_t << "<td class=\"fielddoc\">\n";
2968 }

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

◆ startInlineMemberName()

void HtmlGenerator::startInlineMemberName ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2952 行定义.

2953 {
2954  DBG_HTML(m_t << "<!-- startInlineMemberName -->\n";)
2955  m_t << "<td class=\"fieldname\">\n";
2956 }

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

◆ startInlineMemberType()

void HtmlGenerator::startInlineMemberType ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2940 行定义.

2941 {
2942  DBG_HTML(m_t << "<!-- startInlineMemberType -->\n";)
2943  m_t << "<tr><td class=\"fieldtype\">\n";
2944 }

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

◆ startItemList()

void HtmlGenerator::startItemList ( )
inlinevirtual

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

实现了 BaseOutputDocInterface.

在文件 htmlgen.h152 行定义.

152 { m_t << "<ul>\n"; }

引用了 OutputGenerator::m_t.

◆ startItemListItem()

void HtmlGenerator::startItemListItem ( )
inlinevirtual

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

实现了 BaseOutputDocInterface.

在文件 htmlgen.h169 行定义.

169 { m_t << "<li>"; }

引用了 OutputGenerator::m_t.

◆ startLabels()

void HtmlGenerator::startLabels ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2976 行定义.

2977 {
2978  DBG_HTML(m_t << "<!-- startLabels -->\n";)
2979  m_t << "<span class=\"mlabels\">";
2980 }

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

◆ startMemberDeclaration()

void HtmlGenerator::startMemberDeclaration ( )
inlinevirtual

实现了 OutputGenerator.

在文件 htmlgen.h206 行定义.

206 {}

◆ startMemberDescription()

void HtmlGenerator::startMemberDescription ( const QCString anchor,
const QCString inheritId,
bool  typ 
)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1739 行定义.

1740 {
1741  DBG_HTML(m_t << "<!-- startMemberDescription -->\n")
1742  if (m_emptySection)
1743  {
1744  m_t << "<table class=\"memberdecls\">\n";
1746  }
1747  m_t << "<tr class=\"memdesc:" << anchor;
1748  if (!inheritId.isEmpty())
1749  {
1750  m_t << " inherit " << inheritId;
1751  }
1752  m_t << "\">";
1753  m_t << "<td class=\"mdescLeft\">&#160;</td>";
1754  if (typ) m_t << "<td class=\"mdescLeft\">&#160;</td>";
1755  m_t << "<td class=\"mdescRight\">";;
1756 }

引用了 DBG_HTML, FALSE, QCString::isEmpty(), m_emptySection , 以及 OutputGenerator::m_t.

◆ startMemberDoc()

void HtmlGenerator::startMemberDoc ( const QCString clName,
const QCString memName,
const QCString anchor,
const QCString title,
int  memCount,
int  memTotal,
bool  showInline 
)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1861 行定义.

1864 {
1865  DBG_HTML(m_t << "<!-- startMemberDoc -->\n";)
1866  m_t << "\n<h2 class=\"memtitle\">"
1867  << "<span class=\"permalink\"><a href=\"#" << anchor << "\">&#9670;&nbsp;</a></span>";
1868  docify(title);
1869  if (memTotal>1)
1870  {
1871  m_t << " <span class=\"overload\">[" << memCount << "/" << memTotal <<"]</span>";
1872  }
1873  m_t << "</h2>\n";
1874  m_t << "\n<div class=\"memitem\">\n";
1875  m_t << "<div class=\"memproto\">\n";
1876 }

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

◆ startMemberDocList()

void HtmlGenerator::startMemberDocList ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1851 行定义.

1852 {
1853  DBG_HTML(m_t << "<!-- startMemberDocList -->\n";)
1854 }

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

◆ startMemberDocName()

void HtmlGenerator::startMemberDocName ( bool  )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1890 行定义.

1891 {
1892  DBG_HTML(m_t << "<!-- startMemberDocName -->\n";)
1893 
1894  m_t << " <table class=\"memname\">\n";
1895 
1896  m_t << " <tr>\n";
1897  m_t << " <td class=\"memname\">";
1898 }

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

◆ startMemberDocPrefixItem()

void HtmlGenerator::startMemberDocPrefixItem ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1878 行定义.

1879 {
1880  DBG_HTML(m_t << "<!-- startMemberDocPrefixItem -->\n";)
1881  m_t << "<div class=\"memtemplate\">\n";
1882 }

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

◆ startMemberDocSimple()

void HtmlGenerator::startMemberDocSimple ( bool  isEnum)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2925 行定义.

2926 {
2927  DBG_HTML(m_t << "<!-- startMemberDocSimple -->\n";)
2928  m_t << "<table class=\"fieldtable\">\n";
2929  m_t << "<tr><th colspan=\"" << (isEnum?"2":"3") << "\">";
2930  m_t << (isEnum? theTranslator->trEnumerationValues() :
2931  theTranslator->trCompoundMembers()) << "</th></tr>\n";
2932 }

引用了 DBG_HTML, OutputGenerator::m_t, theTranslator, Translator::trCompoundMembers() , 以及 Translator::trEnumerationValues().

◆ startMemberGroup()

void HtmlGenerator::startMemberGroup ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2132 行定义.

2133 {
2134 }

◆ startMemberGroupDocs()

void HtmlGenerator::startMemberGroupDocs ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2122 行定义.

2123 {
2124  m_t << "<tr><td colspan=\"2\"><div class=\"groupText\">";
2125 }

引用了 OutputGenerator::m_t.

◆ startMemberGroupHeader()

void HtmlGenerator::startMemberGroupHeader ( bool  )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2112 行定义.

2113 {
2114  m_t << "<tr><td colspan=\"2\"><div class=\"groupHeader\">";
2115 }

引用了 OutputGenerator::m_t.

◆ startMemberHeader()

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

实现了 OutputGenerator.

在文件 htmlgen.cpp1781 行定义.

1782 {
1783  DBG_HTML(m_t << "<!-- startMemberHeader -->\n")
1784  if (!m_emptySection)
1785  {
1786  m_t << "</table>";
1788  }
1789  if (m_emptySection)
1790  {
1791  m_t << "<table class=\"memberdecls\">\n";
1793  }
1794  m_t << "<tr class=\"heading\"><td colspan=\"" << typ << "\"><h2 class=\"groupheader\">";
1795  if (!anchor.isEmpty())
1796  {
1797  m_t << "<a id=\"" << anchor << "\" name=\"" << anchor << "\"></a>\n";
1798  }
1799 }

引用了 DBG_HTML, FALSE, QCString::isEmpty(), m_emptySection, OutputGenerator::m_t , 以及 TRUE.

◆ startMemberItem()

void HtmlGenerator::startMemberItem ( const QCString anchor,
int  annoType,
const QCString inheritId 
)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1673 行定义.

1674 {
1675  DBG_HTML(m_t << "<!-- startMemberItem() -->\n")
1676  if (m_emptySection)
1677  {
1678  m_t << "<table class=\"memberdecls\">\n";
1680  }
1681  m_t << "<tr class=\"memitem:" << anchor;
1682  if (!inheritId.isEmpty())
1683  {
1684  m_t << " inherit " << inheritId;
1685  }
1686  m_t << "\">";
1687  insertMemberAlignLeft(annoType, true);
1688 }

引用了 DBG_HTML, FALSE, insertMemberAlignLeft(), QCString::isEmpty(), m_emptySection , 以及 OutputGenerator::m_t.

◆ startMemberList()

void HtmlGenerator::startMemberList ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1659 行定义.

1660 {
1661  DBG_HTML(m_t << "<!-- startMemberList -->\n")
1662 }

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

◆ startMemberSections()

void HtmlGenerator::startMemberSections ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1764 行定义.

1765 {
1766  DBG_HTML(m_t << "<!-- startMemberSections -->\n")
1767  m_emptySection=TRUE; // we postpone writing <table> until we actually
1768  // write a row to prevent empty tables, which
1769  // are not valid XHTML!
1770 }

引用了 DBG_HTML, m_emptySection, OutputGenerator::m_t , 以及 TRUE.

◆ startMemberSubtitle()

void HtmlGenerator::startMemberSubtitle ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1807 行定义.

1808 {
1809  DBG_HTML(m_t << "<!-- startMemberSubtitle -->\n")
1810  m_t << "<tr><td class=\"ititle\" colspan=\"2\">";
1811 }

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

◆ startMemberTemplateParams()

void HtmlGenerator::startMemberTemplateParams ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1695 行定义.

1696 {
1697 }

◆ startPageDoc()

void HtmlGenerator::startPageDoc ( const QCString pageTitle)
virtual

重载 OutputGenerator .

在文件 htmlgen.cpp2618 行定义.

2619 {
2620  m_t << "<div>";
2621 }

引用了 OutputGenerator::m_t.

◆ startPageRef()

void HtmlGenerator::startPageRef ( )
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.h259 行定义.

259 {}

◆ startParagraph()

void HtmlGenerator::startParagraph ( const QCString classDef)
virtual

Starts a new paragraph

Starts a new paragraph

实现了 BaseOutputDocInterface.

在文件 htmlgen.cpp1315 行定义.

1316 {
1317  if (!classDef.isEmpty())
1318  m_t << "\n<p class=\"" << classDef << "\">";
1319  else
1320  m_t << "\n<p>";
1321 }

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

◆ startParameterList()

void HtmlGenerator::startParameterList ( bool  openBracket)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1906 行定义.

1907 {
1908  DBG_HTML(m_t << "<!-- startParameterList -->\n";)
1909  m_t << " <td>";
1910  if (openBracket) m_t << "(";
1911  m_t << "</td>\n";
1912 }

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

◆ startParameterName()

void HtmlGenerator::startParameterName ( bool  )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1937 行定义.

1938 {
1939  DBG_HTML(m_t << "<!-- startParameterName -->\n";)
1940  m_t << " <td class=\"paramname\">";
1941 }

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

◆ startParameterType()

void HtmlGenerator::startParameterType ( bool  first,
const QCString key 
)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1914 行定义.

1915 {
1916  if (first)
1917  {
1918  DBG_HTML(m_t << "<!-- startFirstParameterType -->\n";)
1919  m_t << " <td class=\"paramtype\">";
1920  }
1921  else
1922  {
1923  DBG_HTML(m_t << "<!-- startParameterType -->\n";)
1924  m_t << " <tr>\n";
1925  m_t << " <td class=\"paramkey\">" << key << "</td>\n";
1926  m_t << " <td></td>\n";
1927  m_t << " <td class=\"paramtype\">";
1928  }
1929 }

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

◆ startParamList()

void HtmlGenerator::startParamList ( ParamListTypes  ,
const QCString title 
)
virtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.cpp2218 行定义.

2220 {
2221  m_t << "<dl><dt><b>";
2222  docify(title);
2223  m_t << "</b></dt>";
2224 }

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

◆ startProjectNumber()

void HtmlGenerator::startProjectNumber ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1230 行定义.

1231 {
1232  m_t << "<h3 class=\"version\">";
1233 }

引用了 OutputGenerator::m_t.

◆ startQuickIndices()

void HtmlGenerator::startQuickIndices ( )
inlinevirtual

实现了 OutputGenerator.

在文件 htmlgen.h261 行定义.

261 {}

◆ startSection()

void HtmlGenerator::startSection ( const QCString lab,
const QCString ,
SectionType  type 
)
virtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.cpp1472 行定义.

1473 {
1474  switch(type)
1475  {
1476  case SectionType::Page: m_t << "\n\n<h1>"; break;
1477  case SectionType::Section: m_t << "\n\n<h2>"; break;
1478  case SectionType::Subsection: m_t << "\n\n<h3>"; break;
1479  case SectionType::Subsubsection: m_t << "\n\n<h4>"; break;
1480  case SectionType::Paragraph: m_t << "\n\n<h5>"; break;
1481  default: ASSERT(0); break;
1482  }
1483  m_t << "<a id=\"" << lab << "\" name=\"" << lab << "\"></a>";
1484 }

引用了 ASSERT, OutputGenerator::m_t, Page, Paragraph, Section, Subsection, Subsubsection , 以及 type().

◆ startSmall()

void HtmlGenerator::startSmall ( )
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.h245 行定义.

245 { m_t << "<small>\n"; }

引用了 OutputGenerator::m_t.

◆ startSubsection()

void HtmlGenerator::startSubsection ( )
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.h239 行定义.

239 { m_t << "<h2>"; }

引用了 OutputGenerator::m_t.

◆ startSubsubsection()

void HtmlGenerator::startSubsubsection ( )
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.h241 行定义.

241 { m_t << "<h3>"; }

引用了 OutputGenerator::m_t.

◆ startTextBlock()

void HtmlGenerator::startTextBlock ( bool  )
inlinevirtual

实现了 OutputGenerator.

在文件 htmlgen.h295 行定义.

296  { m_t << "<div class=\"textblock\">"; }

引用了 OutputGenerator::m_t.

◆ startTextLink()

void HtmlGenerator::startTextLink ( const QCString file,
const QCString anchor 
)
virtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.cpp1412 行定义.

1413 {
1414  m_t << "<a href=\"";
1415  if (!f.isEmpty()) m_t << m_relPath << addHtmlExtensionIfMissing(f);
1416  if (!anchor.isEmpty()) m_t << "#" << anchor;
1417  m_t << "\">";
1418 }

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

◆ startTitle()

void HtmlGenerator::startTitle ( )
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.h138 行定义.

138 { m_t << "<div class=\"title\">"; }

引用了 OutputGenerator::m_t.

被这些函数引用 startTitleHead().

◆ startTitleHead()

void HtmlGenerator::startTitleHead ( const QCString )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2893 行定义.

2894 {
2895  m_t << " <div class=\"headertitle\">";
2896  startTitle();
2897 }

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

◆ startTypewriter()

void HtmlGenerator::startTypewriter ( )
inlinevirtual

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

实现了 BaseOutputDocInterface.

在文件 htmlgen.h165 行定义.

165 { m_t << "<code>"; }

引用了 OutputGenerator::m_t.

◆ type()

virtual OutputType HtmlGenerator::type ( ) const
inlinevirtual

实现了 OutputGenerator.

在文件 htmlgen.h75 行定义.

75 { return Html; }

引用了 OutputGenerator::Html.

被这些函数引用 endSection(), startSection() , 以及 writeCodeLink().

◆ writeAnchor()

void HtmlGenerator::writeAnchor ( const QCString ,
const QCString name 
)
inlinevirtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.h213 行定义.

214  { m_t << "<a name=\"" << name <<"\" id=\"" << name << "\"></a>"; }

引用了 OutputGenerator::m_t.

◆ writeChar()

void HtmlGenerator::writeChar ( char  c)
virtual

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

实现了 BaseOutputDocInterface.

在文件 htmlgen.cpp1538 行定义.

1539 {
1540  char cs[2];
1541  cs[0]=c;
1542  cs[1]=0;
1543  docify(cs);
1544 }

引用了 docify().

◆ writeCodeAnchor()

void HtmlGenerator::writeCodeAnchor ( const QCString name)
inlinevirtual

Write an anchor to a source listing.

参数
nameThe name of the anchor.

实现了 CodeOutputInterface.

在文件 htmlgen.h112 行定义.

113  { m_codeGen.writeCodeAnchor(anchor); }

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

◆ writeCodeLink()

void HtmlGenerator::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.

在文件 htmlgen.h93 行定义.

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

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

◆ writeDoc()

void HtmlGenerator::writeDoc ( DocNode n,
const Definition ctx,
const MemberDef ,
int  id 
)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2231 行定义.

2232 {
2233  m_codeGen.setId(id);
2234  HtmlDocVisitor *visitor = new HtmlDocVisitor(m_t,m_codeGen,ctx);
2235  n->accept(visitor);
2236  delete visitor;
2237 }

引用了 DocNode::accept(), m_codeGen, OutputGenerator::m_t , 以及 HtmlCodeGenerator::setId().

◆ writeEndAnnoItem()

void HtmlGenerator::writeEndAnnoItem ( const QCString )
inlinevirtual

实现了 OutputGenerator.

在文件 htmlgen.h238 行定义.

238 { m_t << "\n"; }

引用了 OutputGenerator::m_t.

◆ writeExternalSearchPage()

void HtmlGenerator::writeExternalSearchPage ( )
static

在文件 htmlgen.cpp2725 行定义.

2726 {
2727  bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
2728  QCString dname = Config_getString(HTML_OUTPUT);
2729  QCString fileName = dname+"/search"+Doxygen::htmlFileExtension;
2730  std::ofstream f(fileName.str(),std::ofstream::out | std::ofstream::binary);
2731  if (f.is_open())
2732  {
2733  TextStream t(&f);
2734  t << substituteHtmlKeywords(g_header,"Search","");
2735 
2736  t << "<!-- " << theTranslator->trGeneratedBy() << " Doxygen "
2737  << getDoxygenVersion() << " -->\n";
2738  t << "<script type=\"text/javascript\">\n";
2739  t << "/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */\n";
2740  t << "var searchBox = new SearchBox(\"searchBox\", \""
2741  << "search\",'" << theTranslator->trSearch() << "','" << Doxygen::htmlFileExtension << "');\n";
2742  t << "/* @license-end */\n";
2743  t << "</script>\n";
2744  if (!Config_getBool(DISABLE_INDEX))
2745  {
2747  t << " <input type=\"text\" id=\"MSearchField\" name=\"query\" value=\"\" size=\"20\" accesskey=\"S\" onfocus=\"searchBox.OnSearchFieldFocus(true)\" onblur=\"searchBox.OnSearchFieldFocus(false)\"/>\n";
2748  t << " </form>\n";
2749  t << " </div><div class=\"right\"></div>\n";
2750  t << " </div>\n";
2751  t << " </li>\n";
2752  t << " </ul>\n";
2753  t << " </div>\n";
2754  t << "</div>\n";
2755  }
2756  else
2757  {
2758  t << "</div>\n";
2759  }
2760  t << writeSplitBarAsString("search","");
2761  t << "<div class=\"header\">\n";
2762  t << " <div class=\"headertitle\">\n";
2763  t << " <div class=\"title\">" << theTranslator->trSearchResultsTitle() << "</div>\n";
2764  t << " </div>\n";
2765  t << "</div>\n";
2766  t << "<div class=\"contents\">\n";
2767 
2768  t << "<div id=\"searchresults\"></div>\n";
2769  t << "</div>\n";
2770 
2771  if (generateTreeView)
2772  {
2773  t << "</div><!-- doc-content -->\n";
2774  }
2775 
2776  writePageFooter(t,"Search","","");
2777 
2778  }
2779  f.close();
2780 
2781  QCString scriptName = dname+"/search/search.js";
2782  f.open(scriptName.str(),std::ofstream::out | std::ofstream::binary);
2783  if (f.is_open())
2784  {
2785  TextStream t(&f);
2786  t << "var searchResultsText=["
2787  << "\"" << theTranslator->trSearchResults(0) << "\","
2788  << "\"" << theTranslator->trSearchResults(1) << "\","
2789  << "\"" << theTranslator->trSearchResults(2) << "\"];\n";
2790  t << "var serverUrl=\"" << Config_getString(SEARCHENGINE_URL) << "\";\n";
2791  t << "var tagMap = {\n";
2792  bool first=TRUE;
2793  // add search mappings
2794  const StringVector &extraSearchMappings = Config_getList(EXTRA_SEARCH_MAPPINGS);
2795  for (const auto &ml : extraSearchMappings)
2796  {
2797  QCString mapLine = ml.c_str();
2798  int eqPos = mapLine.find('=');
2799  if (eqPos!=-1) // tag command contains a destination
2800  {
2801  QCString tagName = mapLine.left(eqPos).stripWhiteSpace();
2802  QCString destName = mapLine.right(mapLine.length()-eqPos-1).stripWhiteSpace();
2803  if (!tagName.isEmpty())
2804  {
2805  if (!first) t << ",\n";
2806  t << " \"" << tagName << "\": \"" << destName << "\"";
2807  first=FALSE;
2808  }
2809  }
2810  }
2811  if (!first) t << "\n";
2812  t << "};\n\n";
2813  t << ResourceMgr::instance().getAsString("extsearch.js");
2814  t << "\n";
2815  t << "$(document).ready(function() {\n";
2816  t << " var query = trim(getURLParameter('query'));\n";
2817  t << " if (query) {\n";
2818  t << " searchFor(query,0,20);\n";
2819  t << " } else {\n";
2820  t << " var results = $('#results');\n";
2821  t << " results.html('<p>" << theTranslator->trSearchResults(0) << "</p>');\n";
2822  t << " }\n";
2823  t << "});\n";
2824  }
2825  else
2826  {
2827  err("Failed to open file '%s' for writing...\n",qPrint(scriptName));
2828  }
2829 }

引用了 Config_getBool, Config_getList, Config_getString, err(), FALSE, OutputGenerator::fileName(), QCString::find(), g_header, ResourceMgr::getAsString(), HLI_Search, Doxygen::htmlFileExtension, ResourceMgr::instance(), QCString::isEmpty(), QCString::left(), QCString::length(), qPrint(), QCString::right(), QCString::str(), QCString::stripWhiteSpace(), substituteHtmlKeywords(), theTranslator, Translator::trGeneratedBy(), Translator::trSearch(), Translator::trSearchResults(), Translator::trSearchResultsTitle(), TRUE, writeDefaultQuickLinks(), writePageFooter() , 以及 writeSplitBarAsString().

被这些函数引用 generateOutput().

◆ writeFooter()

void HtmlGenerator::writeFooter ( const QCString navPath)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1220 行定义.

1221 {
1223 }

引用了 m_lastTitle, m_relPath, OutputGenerator::m_t , 以及 writePageFooter().

◆ writeFooterFile()

void HtmlGenerator::writeFooterFile ( TextStream t)
static

在文件 htmlgen.cpp1112 行定义.

1113 {
1114  t << "<!-- HTML footer for doxygen " << getDoxygenVersion() << "-->\n";
1115  t << ResourceMgr::instance().getAsString("footer.html");
1116 }

引用了 ResourceMgr::getAsString() , 以及 ResourceMgr::instance().

被这些函数引用 readConfiguration().

◆ writeGraphicalHierarchy()

void HtmlGenerator::writeGraphicalHierarchy ( DotGfxHierarchyTable g)
virtual

◆ writeHeaderFile()

void HtmlGenerator::writeHeaderFile ( TextStream t,
const QCString cssname 
)
static

在文件 htmlgen.cpp1106 行定义.

1107 {
1108  t << "<!-- HTML header for doxygen " << getDoxygenVersion() << "-->\n";
1109  t << ResourceMgr::instance().getAsString("header.html");
1110 }

引用了 ResourceMgr::getAsString() , 以及 ResourceMgr::instance().

被这些函数引用 readConfiguration().

◆ writeInheritedSectionTitle()

void HtmlGenerator::writeInheritedSectionTitle ( const QCString id,
const QCString ref,
const QCString file,
const QCString anchor,
const QCString title,
const QCString name 
)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2996 行定义.

3000 {
3001  DBG_HTML(m_t << "<!-- writeInheritedSectionTitle -->\n";)
3002  QCString a = anchor;
3003  if (!a.isEmpty()) a.prepend("#");
3004  QCString classLink = QCString("<a class=\"el\" ");
3005  if (!ref.isEmpty())
3006  {
3007  classLink+= externalLinkTarget();
3008  classLink += " href=\"";
3009  classLink+= externalRef(m_relPath,ref,TRUE);
3010  }
3011  else
3012  {
3013  classLink += "href=\"";
3014  classLink+=m_relPath;
3015  }
3016  classLink=classLink+addHtmlExtensionIfMissing(file)+a;
3017  classLink+=QCString("\">")+convertToHtml(name,FALSE)+"</a>";
3018  m_t << "<tr class=\"inherit_header " << id << "\">"
3019  << "<td colspan=\"2\" onclick=\"javascript:toggleInherit('" << id << "')\">"
3020  << "<img src=\"" << m_relPath << "closed.png\" alt=\"-\"/>&#160;"
3021  << theTranslator->trInheritedFrom(convertToHtml(title,FALSE),classLink)
3022  << "</td></tr>\n";
3023 }

引用了 addHtmlExtensionIfMissing(), convertToHtml(), DBG_HTML, externalLinkTarget(), externalRef(), FALSE, QCString::isEmpty(), m_relPath, OutputGenerator::m_t, QCString::prepend(), theTranslator, Translator::trInheritedFrom() , 以及 TRUE.

◆ writeLabel()

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

实现了 OutputGenerator.

在文件 htmlgen.cpp2982 行定义.

2983 {
2984  DBG_HTML(m_t << "<!-- writeLabel(" << l << ") -->\n";)
2985  //m_t << "<tt>[" << l << "]</tt>";
2986  //if (!isLast) m_t << ", ";
2987  m_t << "<span class=\"mlabel\">" << l << "</span>";
2988 }

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

◆ writeLatexSpacing()

void HtmlGenerator::writeLatexSpacing ( )
inlinevirtual

实现了 OutputGenerator.

在文件 htmlgen.h235 行定义.

235 {}

◆ writeLineNumber()

void HtmlGenerator::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.

在文件 htmlgen.h98 行定义.

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

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

◆ writeLogo()

void HtmlGenerator::writeLogo ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1209 行定义.

1210 {
1212 }

引用了 m_relPath, OutputGenerator::m_t , 以及 writeLogoAsString().

◆ writeLogoAsString()

QCString HtmlGenerator::writeLogoAsString ( const QCString path)
static

在文件 htmlgen.cpp1185 行定义.

1186 {
1187  bool timeStamp = Config_getBool(HTML_TIMESTAMP);
1188  QCString result;
1189  if (timeStamp)
1190  {
1191  result += theTranslator->trGeneratedAt(
1192  dateToString(TRUE),
1193  Config_getString(PROJECT_NAME)
1194  );
1195  }
1196  else
1197  {
1198  result += theTranslator->trGeneratedBy();
1199  }
1200  result += "&#160;\n<a href=\"https://www.doxygen.org/index.html\">\n"
1201  "<img class=\"footer\" src=\"";
1202  result += path;
1203  result += "doxygen.svg\" width=\"104\" height=\"31\" alt=\"doxygen\"/></a> ";
1204  result += getDoxygenVersion();
1205  result += " ";
1206  return result;
1207 }

引用了 Config_getBool, Config_getString, dateToString(), theTranslator, Translator::trGeneratedAt(), Translator::trGeneratedBy() , 以及 TRUE.

被这些函数引用 writeLogo() , 以及 writeSearchPage().

◆ writeNavigationPath()

void HtmlGenerator::writeNavigationPath ( const QCString s)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2603 行定义.

2604 {
2605  m_t << substitute(s,"$relpath^",m_relPath);
2606 }

引用了 m_relPath, OutputGenerator::m_t , 以及 substitute().

◆ writeNonBreakableSpace()

void HtmlGenerator::writeNonBreakableSpace ( int  n)
virtual

实现了 BaseOutputDocInterface.

在文件 htmlgen.cpp2157 行定义.

2158 {
2159  int i;
2160  for (i=0;i<n;i++)
2161  {
2162  m_t << "&#160;";
2163  }
2164 }

引用了 OutputGenerator::m_t.

◆ writeObjectLink()

void HtmlGenerator::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.

在文件 htmlgen.cpp1391 行定义.

1393 {
1394  if (!ref.isEmpty())
1395  {
1396  m_t << "<a class=\"elRef\" ";
1397  m_t << externalLinkTarget();
1398  }
1399  else
1400  {
1401  m_t << "<a class=\"el\" ";
1402  }
1403  m_t << "href=\"";
1404  m_t << externalRef(m_relPath,ref,TRUE);
1405  if (!f.isEmpty()) m_t << addHtmlExtensionIfMissing(f);
1406  if (!anchor.isEmpty()) m_t << "#" << anchor;
1407  m_t << "\">";
1408  docify(name);
1409  m_t << "</a>";
1410 }

引用了 addHtmlExtensionIfMissing(), docify(), externalLinkTarget(), externalRef(), QCString::isEmpty(), m_relPath, OutputGenerator::m_t , 以及 TRUE.

◆ writePageFooter()

void HtmlGenerator::writePageFooter ( TextStream t,
const QCString lastTitle,
const QCString relPath,
const QCString navPath 
)
staticprivate

在文件 htmlgen.cpp1214 行定义.

1216 {
1217  t << substituteHtmlKeywords(g_footer,convertToHtml(lastTitle),relPath,navPath);
1218 }

引用了 convertToHtml(), g_footer , 以及 substituteHtmlKeywords().

被这些函数引用 writeExternalSearchPage(), writeFooter() , 以及 writeSearchPage().

◆ writePageLink()

void HtmlGenerator::writePageLink ( const QCString ,
bool   
)
inlinevirtual

实现了 OutputGenerator.

在文件 htmlgen.h132 行定义.

132 {}

◆ writeQuickLinks()

void HtmlGenerator::writeQuickLinks ( bool  compact,
HighlightedItem  hli,
const QCString file 
)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2628 行定义.

2629 {
2630  writeDefaultQuickLinks(m_t,compact,hli,file,m_relPath);
2631 }

引用了 m_relPath, OutputGenerator::m_t , 以及 writeDefaultQuickLinks().

◆ writeRuler()

void HtmlGenerator::writeRuler ( )
inlinevirtual

Writes a horizontal ruler to the output

实现了 BaseOutputDocInterface.

在文件 htmlgen.h212 行定义.

212 { m_t << "<hr/>"; }

引用了 OutputGenerator::m_t.

◆ writeSearchData()

void HtmlGenerator::writeSearchData ( const QCString dir)
static

在文件 htmlgen.cpp1044 行定义.

1045 {
1046  bool serverBasedSearch = Config_getBool(SERVER_BASED_SEARCH);
1047  //writeImgData(dname,serverBasedSearch ? search_server_data : search_client_data);
1049 
1050  mgr.copyResource("search_l.png",dname);
1051  Doxygen::indexList->addImageFile("search/search_l.png");
1052  mgr.copyResource("search_m.png",dname);
1053  Doxygen::indexList->addImageFile("search/search_m.png");
1054  mgr.copyResource("search_r.png",dname);
1055  Doxygen::indexList->addImageFile("search/search_r.png");
1056  if (serverBasedSearch)
1057  {
1058  mgr.copyResource("mag.svg",dname);
1059  Doxygen::indexList->addImageFile("search/mag.svg");
1060  }
1061  else
1062  {
1063  mgr.copyResource("close.svg",dname);
1064  Doxygen::indexList->addImageFile("search/close.svg");
1065  mgr.copyResource("mag_sel.svg",dname);
1066  Doxygen::indexList->addImageFile("search/mag_sel.svg");
1067  }
1068 
1069  QCString searchDirName = dname;
1070  std::ofstream f(searchDirName.str()+"/search.css",std::ofstream::out | std::ofstream::binary);
1071  if (f.is_open())
1072  {
1073  TextStream t(&f);
1074  QCString searchCss;
1075  if (Config_getBool(DISABLE_INDEX))
1076  {
1077  if (Config_getBool(GENERATE_TREEVIEW) && Config_getBool(FULL_SIDEBAR))
1078  {
1079  searchCss = mgr.getAsString("search_sidebar.css");
1080  }
1081  else
1082  {
1083  searchCss = mgr.getAsString("search_nomenu.css");
1084  }
1085  }
1086  else if (!Config_getBool(HTML_DYNAMIC_MENUS))
1087  {
1088  searchCss = mgr.getAsString("search_fixedtabs.css");
1089  }
1090  else
1091  {
1092  searchCss = mgr.getAsString("search.css");
1093  }
1094  searchCss += mgr.getAsString("search_common.css");
1095  searchCss = substitute(replaceColorMarkers(searchCss),"$doxygenversion",getDoxygenVersion());
1096  t << searchCss;
1097  Doxygen::indexList->addStyleSheetFile("search/search.css");
1098  }
1099 }

引用了 IndexList::addImageFile(), IndexList::addStyleSheetFile(), Config_getBool, ResourceMgr::copyResource(), ResourceMgr::getAsString(), Doxygen::indexList, ResourceMgr::instance(), replaceColorMarkers(), QCString::str() , 以及 substitute().

被这些函数引用 generateOutput().

◆ writeSearchInfo() [1/2]

void HtmlGenerator::writeSearchInfo ( )
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1179 行定义.

1180 {
1182 }

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

◆ writeSearchInfo() [2/2]

void HtmlGenerator::writeSearchInfo ( TextStream t,
const QCString relPath 
)
static

在文件 htmlgen.cpp1156 行定义.

1157 {
1158  bool searchEngine = Config_getBool(SEARCHENGINE);
1159  bool serverBasedSearch = Config_getBool(SERVER_BASED_SEARCH);
1160  if (searchEngine && !serverBasedSearch)
1161  {
1162  t << "<!-- window showing the filter options -->\n";
1163  t << "<div id=\"MSearchSelectWindow\"\n";
1164  t << " onmouseover=\"return searchBox.OnSearchSelectShow()\"\n";
1165  t << " onmouseout=\"return searchBox.OnSearchSelectHide()\"\n";
1166  t << " onkeydown=\"return searchBox.OnSearchSelectKey(event)\">\n";
1167  t << "</div>\n";
1168  t << "\n";
1169  t << "<!-- iframe showing the search results (closed by default) -->\n";
1170  t << "<div id=\"MSearchResultsWindow\">\n";
1171  t << "<iframe src=\"javascript:void(0)\" frameborder=\"0\" \n";
1172  t << " name=\"MSearchResults\" id=\"MSearchResults\">\n";
1173  t << "</iframe>\n";
1174  t << "</div>\n";
1175  t << "\n";
1176  }
1177 }

引用了 Config_getBool.

◆ writeSearchPage()

void HtmlGenerator::writeSearchPage ( )
static

在文件 htmlgen.cpp2634 行定义.

2635 {
2636  bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
2637  bool disableIndex = Config_getBool(DISABLE_INDEX);
2638  QCString projectName = Config_getString(PROJECT_NAME);
2639  QCString htmlOutput = Config_getString(HTML_OUTPUT);
2640 
2641  // OPENSEARCH_PROVIDER {
2642  QCString configFileName = htmlOutput+"/search_config.php";
2643  std::ofstream f(configFileName.str(),std::ofstream::out | std::ofstream::binary);
2644  if (f.is_open())
2645  {
2646  TextStream t(&f);
2647  t << "<?php\n\n";
2648  t << "$config = array(\n";
2649  t << " 'PROJECT_NAME' => \"" << convertToHtml(projectName) << "\",\n";
2650  t << " 'GENERATE_TREEVIEW' => " << (generateTreeView?"true":"false") << ",\n";
2651  t << " 'DISABLE_INDEX' => " << (disableIndex?"true":"false") << ",\n";
2652  t << ");\n\n";
2653  t << "$translator = array(\n";
2654  t << " 'search_results_title' => \"" << theTranslator->trSearchResultsTitle() << "\",\n";
2655  t << " 'search_results' => array(\n";
2656  t << " 0 => \"" << theTranslator->trSearchResults(0) << "\",\n";
2657  t << " 1 => \"" << theTranslator->trSearchResults(1) << "\",\n";
2658  t << " 2 => \"" << substitute(theTranslator->trSearchResults(2), "$", "\\$") << "\",\n";
2659  t << " ),\n";
2660  t << " 'search_matches' => \"" << theTranslator->trSearchMatches() << "\",\n";
2661  t << " 'search' => \"" << theTranslator->trSearch() << "\",\n";
2662  t << " 'split_bar' => \"" << substitute(substitute(writeSplitBarAsString("search",""), "\"","\\\""), "\n","\\n") << "\",\n";
2663  t << " 'logo' => \"" << substitute(substitute(writeLogoAsString(""), "\"","\\\""), "\n","\\n") << "\",\n";
2664  t << ");\n\n";
2665  t << "?>\n";
2666  }
2667  f.close();
2668 
2669  ResourceMgr::instance().copyResource("search_functions.php",htmlOutput);
2670  ResourceMgr::instance().copyResource("search_opensearch.php",htmlOutput);
2671  // OPENSEARCH_PROVIDER }
2672 
2673  QCString fileName = htmlOutput+"/search.php";
2674  f.open(fileName.str(),std::ofstream::out | std::ofstream::binary);
2675  if (f.is_open())
2676  {
2677  TextStream t(&f);
2678  t << substituteHtmlKeywords(g_header,"Search","");
2679 
2680  t << "<!-- " << theTranslator->trGeneratedBy() << " Doxygen "
2681  << getDoxygenVersion() << " -->\n";
2682  t << "<script type=\"text/javascript\">\n";
2683  t << "/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */\n";
2684  t << "var searchBox = new SearchBox(\"searchBox\", \""
2685  << "search\",'" << theTranslator->trSearch() << "','" << Doxygen::htmlFileExtension << "');\n";
2686  t << "/* @license-end */\n";
2687  t << "</script>\n";
2688  if (!Config_getBool(DISABLE_INDEX))
2689  {
2691  }
2692  else
2693  {
2694  t << "</div>\n";
2695  }
2696 
2697  t << "<?php\n";
2698  t << "require_once \"search_functions.php\";\n";
2699  t << "main();\n";
2700  t << "?>\n";
2701 
2702  // Write empty navigation path, to make footer connect properly
2703  if (generateTreeView)
2704  {
2705  t << "</div><!-- doc-content -->\n";
2706  }
2707 
2708  writePageFooter(t,"Search","","");
2709  }
2710  f.close();
2711 
2712  QCString scriptName = htmlOutput+"/search/search.js";
2713  f.open(scriptName.str(),std::ofstream::out | std::ofstream::binary);
2714  if (f.is_open())
2715  {
2716  TextStream t(&f);
2717  t << ResourceMgr::instance().getAsString("extsearch.js");
2718  }
2719  else
2720  {
2721  err("Failed to open file '%s' for writing...\n",qPrint(scriptName));
2722  }
2723 }

引用了 Config_getBool, Config_getString, convertToHtml(), ResourceMgr::copyResource(), err(), OutputGenerator::fileName(), g_header, ResourceMgr::getAsString(), HLI_Search, Doxygen::htmlFileExtension, ResourceMgr::instance(), qPrint(), QCString::str(), substitute(), substituteHtmlKeywords(), theTranslator, Translator::trGeneratedBy(), Translator::trSearch(), Translator::trSearchMatches(), Translator::trSearchResults(), Translator::trSearchResultsTitle(), TRUE, writeDefaultQuickLinks(), writeLogoAsString(), writePageFooter() , 以及 writeSplitBarAsString().

被这些函数引用 generateOutput().

◆ writeSplitBar()

void HtmlGenerator::writeSplitBar ( const QCString name)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp2598 行定义.

2599 {
2601 }

引用了 m_relPath, OutputGenerator::m_t , 以及 writeSplitBarAsString().

◆ writeSplitBarAsString()

QCString HtmlGenerator::writeSplitBarAsString ( const QCString name,
const QCString relpath 
)
static

在文件 htmlgen.cpp2563 行定义.

2564 {
2565  bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
2566  QCString result;
2567  // write split bar
2568  if (generateTreeView)
2569  {
2570  if (!Config_getBool(DISABLE_INDEX) || !Config_getBool(FULL_SIDEBAR))
2571  {
2572  result += QCString(
2573  "<div id=\"side-nav\" class=\"ui-resizable side-nav-resizable\">\n");
2574  }
2575  result+= QCString(
2576  " <div id=\"nav-tree\">\n"
2577  " <div id=\"nav-tree-contents\">\n"
2578  " <div id=\"nav-sync\" class=\"sync\"></div>\n"
2579  " </div>\n"
2580  " </div>\n"
2581  " <div id=\"splitbar\" style=\"-moz-user-select:none;\" \n"
2582  " class=\"ui-resizable-handle\">\n"
2583  " </div>\n"
2584  "</div>\n"
2585  "<script type=\"text/javascript\">\n"
2586  "/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */\n"
2587  "$(document).ready(function(){initNavTree('") +
2589  QCString("','") + relpath +
2590  QCString("'); initResizable(); });\n"
2591  "/* @license-end */\n"
2592  "</script>\n"
2593  "<div id=\"doc-content\">\n");
2594  }
2595  return result;
2596 }

引用了 addHtmlExtensionIfMissing() , 以及 Config_getBool.

被这些函数引用 writeExternalSearchPage(), writeSearchPage() , 以及 writeSplitBar().

◆ writeStartAnnoItem()

void HtmlGenerator::writeStartAnnoItem ( const QCString type,
const QCString file,
const QCString path,
const QCString name 
)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1381 行定义.

1383 {
1384  m_t << "<li>";
1385  if (!path.isEmpty()) docify(path);
1386  m_t << "<a class=\"el\" href=\"" << addHtmlExtensionIfMissing(f) << "\">";
1387  docify(name);
1388  m_t << "</a> ";
1389 }

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

◆ writeString()

void HtmlGenerator::writeString ( const QCString text)
virtual

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

实现了 BaseOutputDocInterface.

在文件 htmlgen.cpp1328 行定义.

1329 {
1330  m_t << text;
1331 }

引用了 OutputGenerator::m_t.

◆ writeStyleInfo()

void HtmlGenerator::writeStyleInfo ( int  part)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp1240 行定义.

1241 {
1242  //printf("writeStyleInfo(%d)\n",part);
1243  if (part==0)
1244  {
1245  if (Config_getString(HTML_STYLESHEET).isEmpty()) // write default style sheet
1246  {
1247  //printf("write doxygen.css\n");
1248  startPlainFile("doxygen.css");
1249 
1250  // alternative, cooler looking titles
1251  //t << "H1 { text-align: center; border-width: thin none thin none;\n";
1252  //t << " border-style : double; border-color : blue; padding-left : 1em; padding-right : 1em }\n";
1253 
1254  m_t << replaceColorMarkers(substitute(ResourceMgr::instance().getAsString("doxygen.css"),"$doxygenversion",getDoxygenVersion()));
1255  endPlainFile();
1256  Doxygen::indexList->addStyleSheetFile("doxygen.css");
1257  }
1258  else // write user defined style sheet
1259  {
1260  QCString cssname=Config_getString(HTML_STYLESHEET);
1261  FileInfo cssfi(cssname.str());
1262  if (!cssfi.exists() || !cssfi.isFile() || !cssfi.isReadable())
1263  {
1264  err("style sheet %s does not exist or is not readable!", qPrint(Config_getString(HTML_STYLESHEET)));
1265  }
1266  else
1267  {
1268  // convert style sheet to string
1269  QCString fileStr = fileToString(cssname);
1270  // write the string into the output dir
1271  startPlainFile(cssfi.fileName().c_str());
1272  m_t << fileStr;
1273  endPlainFile();
1274  }
1275  Doxygen::indexList->addStyleSheetFile(cssfi.fileName().c_str());
1276  }
1277  const StringVector &extraCssFiles = Config_getList(HTML_EXTRA_STYLESHEET);
1278  for (const auto &fileName : extraCssFiles)
1279  {
1280  if (!fileName.empty())
1281  {
1282  FileInfo fi(fileName);
1283  if (fi.exists())
1284  {
1285  Doxygen::indexList->addStyleSheetFile(fi.fileName().c_str());
1286  }
1287  }
1288  }
1289 
1290  Doxygen::indexList->addStyleSheetFile("jquery.js");
1291  Doxygen::indexList->addStyleSheetFile("dynsections.js");
1292  if (Config_getBool(INTERACTIVE_SVG))
1293  {
1294  Doxygen::indexList->addStyleSheetFile("svgpan.js");
1295  }
1296  }
1297 }

引用了 IndexList::addStyleSheetFile(), Config_getBool, Config_getList, Config_getString, OutputGenerator::endPlainFile(), err(), FileInfo::exists(), FileInfo::fileName(), OutputGenerator::fileName(), fileToString(), Doxygen::indexList, ResourceMgr::instance(), FileInfo::isFile(), FileInfo::isReadable(), OutputGenerator::m_t, qPrint(), replaceColorMarkers(), OutputGenerator::startPlainFile(), QCString::str() , 以及 substitute().

◆ writeStyleSheetFile()

void HtmlGenerator::writeStyleSheetFile ( TextStream t)
static

在文件 htmlgen.cpp1101 行定义.

1102 {
1103  t << replaceColorMarkers(substitute(ResourceMgr::instance().getAsString("doxygen.css"),"$doxygenversion",getDoxygenVersion()));
1104 }

引用了 ResourceMgr::instance(), replaceColorMarkers() , 以及 substitute().

被这些函数引用 readConfiguration().

◆ writeSummaryLink()

void HtmlGenerator::writeSummaryLink ( const QCString file,
const QCString anchor,
const QCString title,
bool  first 
)
virtual

实现了 OutputGenerator.

在文件 htmlgen.cpp3025 行定义.

3026 {
3027  if (first)
3028  {
3029  m_t << " <div class=\"summary\">\n";
3030  }
3031  else
3032  {
3033  m_t << " &#124;\n";
3034  }
3035  m_t << "<a href=\"";
3036  if (!file.isEmpty())
3037  {
3039  }
3040  else if (!anchor.isEmpty())
3041  {
3042  m_t << "#";
3043  m_t << anchor;
3044  }
3045  m_t << "\">";
3046  m_t << title;
3047  m_t << "</a>";
3048 }

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

◆ writeSynopsis()

void HtmlGenerator::writeSynopsis ( )
inlinevirtual

实现了 OutputGenerator.

在文件 htmlgen.h256 行定义.

256 {}

◆ writeTabData()

void HtmlGenerator::writeTabData ( )
static

Additional initialization after indices have been created

在文件 htmlgen.cpp1013 行定义.

1014 {
1016  QCString dname=Config_getString(HTML_OUTPUT);
1018  //writeColoredImgData(dname,colored_tab_data);
1019  mgr.copyResource("tab_a.lum",dname);
1020  mgr.copyResource("tab_b.lum",dname);
1021  mgr.copyResource("tab_h.lum",dname);
1022  mgr.copyResource("tab_s.lum",dname);
1023  mgr.copyResource("nav_h.lum",dname);
1024  mgr.copyResource("nav_f.lum",dname);
1025  mgr.copyResource("bc_s.luma",dname);
1026  mgr.copyResource("doxygen.svg",dname);
1027  Doxygen::indexList->addImageFile("doxygen.svg");
1028  mgr.copyResource("closed.luma",dname);
1029  mgr.copyResource("open.luma",dname);
1030  mgr.copyResource("bdwn.luma",dname);
1031  mgr.copyResource("sync_on.luma",dname);
1032  mgr.copyResource("sync_off.luma",dname);
1033 
1034  //{
1035  // unsigned char shadow[6] = { 5, 5, 5, 5, 5, 5 };
1036  // unsigned char shadow_alpha[6] = { 80, 60, 40, 20, 10, 0 };
1037  // ColoredImage img(1,6,shadow,shadow_alpha,0,0,100);
1038  // img.save(dname+"/nav_g.png");
1039  //}
1040  mgr.copyResource("nav_g.png",dname);
1041  Doxygen::indexList->addImageFile("nav_g.png");
1042 }

引用了 IndexList::addImageFile(), IndexList::addStyleSheetFile(), Config_getString, ResourceMgr::copyResource(), Doxygen::indexList , 以及 ResourceMgr::instance().

被这些函数引用 generateOutput().

◆ writeTooltip()

void HtmlGenerator::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.

在文件 htmlgen.h100 行定义.

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

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

类成员变量说明

◆ m_codeGen

◆ m_emptySection

bool HtmlGenerator::m_emptySection = false
private

◆ m_lastFile

QCString HtmlGenerator::m_lastFile
private

在文件 htmlgen.h338 行定义.

被这些函数引用 startFile().

◆ m_lastTitle

QCString HtmlGenerator::m_lastTitle
private

在文件 htmlgen.h337 行定义.

被这些函数引用 startFile() , 以及 writeFooter().

◆ m_relPath

◆ m_sectionCount


该类的文档由以下文件生成:
HtmlCodeGenerator::startCodeLine
void startCodeLine(bool)
Definition: htmlgen.cpp:850
StringVector
std::vector< std::string > StringVector
Definition: containers.h:32
g_footer
static QCString g_footer
Definition: htmlgen.cpp:61
ResourceMgr::copyResource
bool copyResource(const QCString &name, const QCString &targetDir) const
Copies a registered resource to a given target directory
Definition: resourcemgr.cpp:180
OutputGenerator::fileName
QCString fileName() const
Definition: outputgen.cpp:85
SectionType::Paragraph
@ Paragraph
HtmlCodeGenerator::writeTooltip
void writeTooltip(const QCString &id, const DocLinkInfo &docInfo, const QCString &decl, const QCString &desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo)
Definition: htmlgen.cpp:768
ResourceMgr::copyResourceAs
bool copyResourceAs(const QCString &name, const QCString &targetDir, const QCString &targetName, bool append=false) const
Copies a registered resource to a given target directory under a given target name
Definition: resourcemgr.cpp:79
HtmlCodeGenerator::startFontClass
void startFontClass(const QCString &s)
Definition: htmlgen.cpp:874
ResourceMgr::instance
static ResourceMgr & instance()
Returns the one and only instance of this class
Definition: resourcemgr.cpp:32
HtmlCodeGenerator::endFontClass
void endFontClass()
Definition: htmlgen.cpp:879
getConvertLatexMacro
static QCString getConvertLatexMacro()
Convert a set of LaTeX commands \(re)newcommand to a form readable by MathJax LaTeX syntax:
Definition: htmlgen.cpp:141
Translator::trCompoundMembers
virtual QCString trCompoundMembers()=0
Translator::trGeneratedBy
virtual QCString trGeneratedBy()=0
HtmlCodeGenerator::setId
void setId(int id)
Definition: htmlgen.h:40
g_indexLock
static std::mutex g_indexLock
Definition: htmlgen.cpp:1118
ResourceMgr::getAsString
QCString getAsString(const QCString &name) const
Gets the resource data as a C string
Definition: resourcemgr.cpp:192
relativePathToRoot
QCString relativePathToRoot(const QCString &name)
Definition: util.cpp:3656
Translator::trSearchMatches
virtual QCString trSearchMatches()=0
Dir
Class representing a directory in the file system
Definition: dir.h:68
DBG_HTML
#define DBG_HTML(x)
Definition: htmlgen.cpp:58
replaceColorMarkers
QCString replaceColorMarkers(const QCString &str)
Replaces any markers of the form ##AA in input string str by new markers of the form #AABBCC,...
Definition: util.cpp:6387
QCString::length
uint length() const
Returns the length of the string, not counting the 0-terminator.
Definition: qcstring.h:147
ClassDiagram::writeImage
void writeImage(TextStream &t, const QCString &path, const QCString &relPath, const QCString &file, bool generateMap=true) const
Definition: diagram.cpp:1342
filterTitle
QCString filterTitle(const QCString &title)
Definition: util.cpp:6254
QCString::isEmpty
bool isEmpty() const
Returns TRUE iff the string is empty
Definition: qcstring.h:144
HtmlGenerator::m_codeGen
HtmlCodeGenerator m_codeGen
Definition: htmlgen.h:344
Doxygen::indexList
static IndexList * indexList
Definition: doxygen.h:114
IndexList::addStyleSheetFile
void addStyleSheetFile(const QCString &name)
Definition: index.h:107
substituteHtmlKeywords
static QCString substituteHtmlKeywords(const QCString &str, const QCString &title, const QCString &relPath, const QCString &navPath=QCString())
Definition: htmlgen.cpp:315
HtmlCodeGenerator::writeLineNumber
void writeLineNumber(const QCString &, const QCString &, const QCString &, int, bool)
Definition: htmlgen.cpp:698
HtmlGenerator::m_emptySection
bool m_emptySection
Definition: htmlgen.h:343
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
DotGfxHierarchyTable::writeGraph
void writeGraph(TextStream &t, const QCString &path, const QCString &fileName)
Definition: dotgfxhierarchytable.cpp:75
Translator::trLegend
virtual QCString trLegend()=0
QCString::str
std::string str() const
Definition: qcstring.h:442
HtmlCodeGenerator::codify
void codify(const QCString &text)
Definition: htmlgen.cpp:587
startSectionContent
static void startSectionContent(TextStream &t, int sectionCount)
Definition: htmlgen.cpp:1596
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
HtmlCodeGenerator::writeCodeLink
void writeCodeLink(CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip)
Definition: htmlgen.cpp:727
Translator::trEnumerationValues
virtual QCString trEnumerationValues()=0
HtmlGenerator::startHtmlLink
void startHtmlLink(const QCString &url)
Definition: htmlgen.cpp:1425
err
void err(const char *fmt,...)
Definition: message.cpp:203
TextStream
Text streaming class that buffers data.
Definition: textstream.h:33
QCString::find
int find(char c, int index=0, bool cs=TRUE) const
Definition: qcstring.cpp:38
TextStream::empty
bool empty() const
Returns true iff the buffer is empty
Definition: textstream.h:232
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
HtmlDocVisitor
Concrete visitor implementation for HTML output.
Definition: htmldocvisitor.h:29
HtmlCodeGenerator::endCodeFragment
void endCodeFragment(const QCString &)
Definition: htmlgen.cpp:894
HtmlGenerator::docify
void docify(const QCString &text)
Definition: htmlgen.cpp:1499
endSectionContent
static void endSectionContent(TextStream &t)
Definition: htmlgen.cpp:1612
HtmlGenerator::m_lastFile
QCString m_lastFile
Definition: htmlgen.h:338
Translator::trGeneratedAt
virtual QCString trGeneratedAt(const QCString &date, const QCString &projName)=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
addHtmlExtensionIfMissing
QCString addHtmlExtensionIfMissing(const QCString &fName)
Definition: util.cpp:5275
HLI_Search
@ HLI_Search
Definition: index.h:165
dateToString
QCString dateToString(bool includeTime)
Definition: util.cpp:1470
QCString::stripWhiteSpace
QCString stripWhiteSpace() const
returns a copy of this string with leading and trailing whitespace removed
Definition: qcstring.h:243
Translator::trInheritedFrom
virtual QCString trInheritedFrom(const QCString &members, const QCString &what)=0
QCString::left
QCString left(size_t len) const
Definition: qcstring.h:212
HtmlCodeGenerator::writeCodeAnchor
void writeCodeAnchor(const QCString &anchor)
Definition: htmlgen.cpp:884
SectionType::Subsubsection
@ Subsubsection
IndexList::addImageFile
void addImageFile(const QCString &name)
Definition: index.h:105
HtmlGenerator::startTitle
void startTitle()
Definition: htmlgen.h:138
theTranslator
Translator * theTranslator
Definition: language.cpp:156
Translator::trSearchResults
virtual QCString trSearchResults(int numDocuments)=0
SearchIndexIntf::addWord
virtual void addWord(const QCString &word, bool hiPriority)=0
g_header
static QCString g_header
Definition: htmlgen.cpp:60
OutputGenerator::dir
QCString dir() const
Definition: outputgen.cpp:80
fileToString
QCString fileToString(const QCString &name, bool filter, bool isSourceCode)
Definition: util.cpp:1394
TRUE
#define TRUE
Definition: qcstring.h:36
OutputGenerator::Html
@ Html
Definition: outputgen.h:333
HtmlGenerator::m_sectionCount
int m_sectionCount
Definition: htmlgen.h:342
TextStream::str
std::string str() const
Return the contents of the buffer as a std::string object
Definition: textstream.h:208
SectionType::Page
@ Page
Translator::trSearch
virtual QCString trSearch()=0
IndexList::addIndexFile
void addIndexFile(const QCString &name)
Definition: index.h:103
SectionType::Subsection
@ Subsection
g_mathjax_code
static QCString g_mathjax_code
Definition: htmlgen.cpp:62
HtmlGenerator::m_lastTitle
QCString m_lastTitle
Definition: htmlgen.h:337
clearSubDirs
void clearSubDirs(const Dir &d)
Definition: util.cpp:3704
externalLinkTarget
QCString externalLinkTarget(const bool parent)
Definition: util.cpp:6323
Doxygen::searchIndex
static SearchIndexIntf * searchIndex
Definition: doxygen.h:105
HtmlGenerator::insertMemberAlignLeft
void insertMemberAlignLeft(int, bool)
Definition: htmlgen.cpp:1727
substitute
QCString substitute(const QCString &s, const QCString &src, const QCString &dst)
substitute all occurrences of src in s by dst
Definition: qcstring.cpp:465
GOF_BITMAP
@ GOF_BITMAP
Definition: dotgraph.h:27
startSectionSummary
static void startSectionSummary(TextStream &t, int sectionCount)
Definition: htmlgen.cpp:1574
HtmlGenerator::writeLogoAsString
static QCString writeLogoAsString(const QCString &path)
Definition: htmlgen.cpp:1185
g_latex_macro
static QCString g_latex_macro
Definition: htmlgen.cpp:63
Config_getBool
#define Config_getBool(name)
Definition: config.h:33
writeDefaultQuickLinks
static void writeDefaultQuickLinks(TextStream &t, bool compact, HighlightedItem hli, const QCString &file, const QCString &relPath)
Definition: htmlgen.cpp:2434
HtmlCodeGenerator::setRelativePath
void setRelativePath(const QCString &path)
Definition: htmlgen.cpp:582
Doxygen::htmlFileExtension
static QCString htmlFileExtension
Definition: doxygen.h:103
endSectionSummary
static void endSectionSummary(TextStream &t)
Definition: htmlgen.cpp:1586
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
Translator::trSearchResultsTitle
virtual QCString trSearchResultsTitle()=0
ResourceMgr
Singleton for managing resources compiled into an executable
Definition: resourcemgr.h:35
SearchIndexIntf::setCurrentDoc
virtual void setCurrentDoc(const Definition *ctx, const QCString &anchor, bool isSourceFile)=0
term
void term(const char *fmt,...)
Definition: message.cpp:220
SectionType::Section
@ Section
FileInfo
Minimal replacement for QFileInfo.
Definition: fileinfo.h:22
HtmlGenerator::writeSearchInfo
void writeSearchInfo()
Definition: htmlgen.cpp:1179
HtmlGenerator::writeSplitBarAsString
static QCString writeSplitBarAsString(const QCString &name, const QCString &relpath)
Definition: htmlgen.cpp:2563
qPrint
const char * qPrint(const char *s)
Definition: qcstring.h:589
Config_getString
#define Config_getString(name)
Definition: config.h:32
ASSERT
#define ASSERT(x)
Definition: qcstring.h:44
startSectionHeader
static void startSectionHeader(TextStream &t, const QCString &relPath, int sectionCount)
Definition: htmlgen.cpp:1548
DocNode::accept
virtual void accept(DocVisitor *v)=0
OutputGenerator::operator=
OutputGenerator & operator=(const OutputGenerator &o)
Definition: outputgen.cpp:48
EOF_Html
@ EOF_Html
Definition: dotgraph.h:28
OutputGenerator::endPlainFile
void endPlainFile()
Definition: outputgen.cpp:72
HtmlGenerator::endTitle
void endTitle()
Definition: htmlgen.h:139
Translator::trExamples
virtual QCString trExamples()=0
externalRef
QCString externalRef(const QCString &relPath, const QCString &ref, bool href)
Definition: util.cpp:6334
HtmlGenerator::endHtmlLink
void endHtmlLink()
Definition: htmlgen.cpp:1435
HtmlCodeGenerator::endCodeLine
void endCodeLine()
Definition: htmlgen.cpp:860
createSubDirs
void createSubDirs(const Dir &d)
Definition: util.cpp:3677
endSectionHeader
static void endSectionHeader(TextStream &t)
Definition: htmlgen.cpp:1568
HtmlGenerator::writePageFooter
static void writePageFooter(TextStream &t, const QCString &, const QCString &, const QCString &)
Definition: htmlgen.cpp:1214
convertToId
QCString convertToId(const QCString &s)
Definition: util.cpp:3908
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
QCString::prepend
QCString & prepend(const char *s)
Definition: qcstring.h:339
HtmlGenerator::type
virtual OutputType type() const
Definition: htmlgen.h:75
convertToHtml
QCString convertToHtml(const QCString &s, bool keepEntities)
Definition: util.cpp:4063
HtmlGenerator::m_relPath
QCString m_relPath
Definition: htmlgen.h:339
Config_getList
#define Config_getList(name)
Definition: config.h:37
HtmlCodeGenerator::startCodeFragment
void startCodeFragment(const QCString &style)
Definition: htmlgen.cpp:889
FALSE
#define FALSE
Definition: qcstring.h:33
QCString
This is an alternative implementation of QCString.
Definition: qcstring.h:108