Generator for HTML output
更多...
#include <htmlgen.h>
|
| HtmlGenerator () |
|
HtmlGenerator & | operator= (const HtmlGenerator &g) |
|
| HtmlGenerator (const HtmlGenerator &g) |
|
virtual | ~HtmlGenerator () |
|
virtual std::unique_ptr< OutputGenerator > | clone () 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 () |
|
| OutputGenerator (const QCString &dir) |
|
| OutputGenerator (const OutputGenerator &o) |
|
OutputGenerator & | operator= (const OutputGenerator &o) |
|
virtual | ~OutputGenerator () |
|
void | enable () |
|
void | disable () |
|
void | enableIf (OutputType o) |
|
void | disableIf (OutputType o) |
|
void | disableIfNot (OutputType o) |
|
bool | isEnabled (OutputType o) |
|
OutputGenerator * | get (OutputType o) |
|
QCString | dir () const |
|
QCString | fileName () const |
|
void | startPlainFile (const QCString &name) |
|
void | endPlainFile () |
|
bool | isEnabled () const |
|
void | pushGeneratorState () |
|
void | popGeneratorState () |
|
virtual | ~BaseOutputDocInterface () |
|
virtual void | parseText (const QCString &) |
|
virtual | ~CodeOutputInterface () |
|
| CodeOutputInterface () |
|
| CodeOutputInterface (const CodeOutputInterface &)=delete |
|
CodeOutputInterface & | operator= (const CodeOutputInterface &)=delete |
|
virtual int | id () const |
| Identifier for the output file 更多...
|
|
|
enum | OutputType {
Html,
Latex,
Man,
RTF,
XML,
DEF,
Perl,
Docbook
} |
|
enum | ParamListTypes { Param,
RetVal,
Exception
} |
|
enum | SectionTypes { EnumValues,
Examples
} |
|
TextStream | m_t |
|
Generator for HTML output
在文件 htmlgen.h 第 66 行定义.
◆ HtmlGenerator() [1/2]
HtmlGenerator::HtmlGenerator |
( |
| ) |
|
◆ HtmlGenerator() [2/2]
◆ ~HtmlGenerator()
HtmlGenerator::~HtmlGenerator |
( |
| ) |
|
|
virtual |
◆ addIndexItem()
◆ addWord()
void HtmlGenerator::addWord |
( |
const QCString & |
word, |
|
|
bool |
hiPriority |
|
) |
| |
|
virtual |
◆ cleanup()
void HtmlGenerator::cleanup |
( |
| ) |
|
|
virtual |
◆ clearBuffer()
void HtmlGenerator::clearBuffer |
( |
| ) |
|
◆ clone()
◆ codify()
void HtmlGenerator::codify |
( |
const QCString & |
s | ) |
|
|
inlinevirtual |
◆ docify() [1/2]
void HtmlGenerator::docify |
( |
const QCString & |
s | ) |
|
|
virtual |
◆ docify() [2/2]
void HtmlGenerator::docify |
( |
const QCString & |
text, |
|
|
bool |
inHtmlComment |
|
) |
| |
|
private |
◆ endAnonTypeScope()
void HtmlGenerator::endAnonTypeScope |
( |
int |
| ) |
|
|
inlinevirtual |
◆ endBold()
void HtmlGenerator::endBold |
( |
| ) |
|
|
inlinevirtual |
◆ endCallGraph()
实现了 OutputGenerator.
在文件 htmlgen.cpp 第 2076 行定义.
引用了 OutputGenerator::dir(), endSectionContent(), endSectionHeader(), endSectionSummary(), EOF_Html, OutputGenerator::fileName(), GOF_BITMAP, m_relPath, m_sectionCount, OutputGenerator::m_t, startSectionContent(), startSectionSummary(), TRUE , 以及 DotCallGraph::writeGraph().
◆ endCenter()
void HtmlGenerator::endCenter |
( |
| ) |
|
|
inlinevirtual |
◆ endClassDiagram()
实现了 OutputGenerator.
在文件 htmlgen.cpp 第 1625 行定义.
1636 m_t <<
" <div class=\"center\">\n";
1637 m_t <<
" <img src=\"";
1639 m_t <<
"_map\" alt=\"\"/>\n";
1649 m_t <<
" <div class=\"center\">\n";
1650 m_t <<
" <img src=\"";
引用了 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 |
◆ endCodeLine()
void HtmlGenerator::endCodeLine |
( |
| ) |
|
|
inlinevirtual |
◆ endCompoundTemplateParams()
void HtmlGenerator::endCompoundTemplateParams |
( |
| ) |
|
|
virtual |
◆ endConstraintDocs()
void HtmlGenerator::endConstraintDocs |
( |
| ) |
|
|
virtual |
◆ endConstraintList()
void HtmlGenerator::endConstraintList |
( |
| ) |
|
|
virtual |
◆ endConstraintParam()
void HtmlGenerator::endConstraintParam |
( |
| ) |
|
|
virtual |
◆ endConstraintType()
void HtmlGenerator::endConstraintType |
( |
| ) |
|
|
virtual |
◆ endContents()
void HtmlGenerator::endContents |
( |
| ) |
|
|
virtual |
◆ endDescForItem()
void HtmlGenerator::endDescForItem |
( |
| ) |
|
|
inlinevirtual |
◆ endDescItem()
void HtmlGenerator::endDescItem |
( |
| ) |
|
|
inlinevirtual |
◆ endDescription()
void HtmlGenerator::endDescription |
( |
| ) |
|
|
inlinevirtual |
◆ endDescTable()
void HtmlGenerator::endDescTable |
( |
| ) |
|
|
virtual |
◆ endDescTableData()
void HtmlGenerator::endDescTableData |
( |
| ) |
|
|
virtual |
◆ endDescTableRow()
void HtmlGenerator::endDescTableRow |
( |
| ) |
|
|
virtual |
◆ endDescTableTitle()
void HtmlGenerator::endDescTableTitle |
( |
| ) |
|
|
virtual |
◆ endDirDepGraph()
void HtmlGenerator::endDirDepGraph |
( |
DotDirDeps & |
g | ) |
|
|
virtual |
实现了 OutputGenerator.
在文件 htmlgen.cpp 第 2094 行定义.
引用了 OutputGenerator::dir(), endSectionContent(), endSectionHeader(), endSectionSummary(), EOF_Html, OutputGenerator::fileName(), GOF_BITMAP, m_relPath, m_sectionCount, OutputGenerator::m_t, startSectionContent(), startSectionSummary(), TRUE , 以及 DotDirDeps::writeGraph().
◆ endDotGraph()
实现了 OutputGenerator.
在文件 htmlgen.cpp 第 2012 行定义.
2022 if (generateLegend && !umlLook)
2024 m_t <<
"<center><span class=\"legend\">[";
2028 m_t <<
"]</span></center>";
引用了 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 |
◆ endEmphasis()
void HtmlGenerator::endEmphasis |
( |
| ) |
|
|
inlinevirtual |
◆ endExamples()
void HtmlGenerator::endExamples |
( |
| ) |
|
|
virtual |
◆ endFile()
void HtmlGenerator::endFile |
( |
| ) |
|
|
virtual |
◆ endFontClass()
void HtmlGenerator::endFontClass |
( |
| ) |
|
|
inlinevirtual |
◆ endGroupCollaboration()
实现了 OutputGenerator.
在文件 htmlgen.cpp 第 2058 行定义.
引用了 OutputGenerator::dir(), endSectionContent(), endSectionHeader(), endSectionSummary(), EOF_Html, OutputGenerator::fileName(), GOF_BITMAP, m_relPath, m_sectionCount, OutputGenerator::m_t, startSectionContent(), startSectionSummary(), TRUE , 以及 DotGroupCollaboration::writeGraph().
◆ endGroupHeader()
void HtmlGenerator::endGroupHeader |
( |
int |
extraIndentLevel | ) |
|
|
virtual |
◆ endHeaderSection()
void HtmlGenerator::endHeaderSection |
( |
| ) |
|
|
virtual |
◆ endHtmlLink()
void HtmlGenerator::endHtmlLink |
( |
| ) |
|
|
virtual |
◆ endInclDepGraph()
实现了 OutputGenerator.
在文件 htmlgen.cpp 第 2040 行定义.
引用了 OutputGenerator::dir(), endSectionContent(), endSectionHeader(), endSectionSummary(), EOF_Html, OutputGenerator::fileName(), GOF_BITMAP, m_relPath, m_sectionCount, OutputGenerator::m_t, startSectionContent(), startSectionSummary(), TRUE , 以及 DotInclDepGraph::writeGraph().
◆ endIndent()
void HtmlGenerator::endIndent |
( |
| ) |
|
|
virtual |
◆ endIndexItem()
void HtmlGenerator::endIndexItem |
( |
const QCString & |
ref, |
|
|
const QCString & |
file |
|
) |
| |
|
virtual |
◆ endIndexKey()
void HtmlGenerator::endIndexKey |
( |
| ) |
|
|
virtual |
◆ endIndexList()
void HtmlGenerator::endIndexList |
( |
| ) |
|
|
virtual |
◆ endIndexListItem()
void HtmlGenerator::endIndexListItem |
( |
| ) |
|
|
virtual |
◆ endIndexSection()
◆ endIndexValue()
void HtmlGenerator::endIndexValue |
( |
const QCString & |
, |
|
|
bool |
|
|
) |
| |
|
virtual |
◆ endInlineHeader()
void HtmlGenerator::endInlineHeader |
( |
| ) |
|
|
virtual |
◆ endInlineMemberDoc()
void HtmlGenerator::endInlineMemberDoc |
( |
| ) |
|
|
virtual |
◆ endInlineMemberName()
void HtmlGenerator::endInlineMemberName |
( |
| ) |
|
|
virtual |
◆ endInlineMemberType()
void HtmlGenerator::endInlineMemberType |
( |
| ) |
|
|
virtual |
◆ endItemList()
void HtmlGenerator::endItemList |
( |
| ) |
|
|
inlinevirtual |
◆ endItemListItem()
void HtmlGenerator::endItemListItem |
( |
| ) |
|
|
inlinevirtual |
◆ endLabels()
void HtmlGenerator::endLabels |
( |
| ) |
|
|
virtual |
◆ endMemberDeclaration()
void HtmlGenerator::endMemberDeclaration |
( |
const QCString & |
anchor, |
|
|
const QCString & |
inheritId |
|
) |
| |
|
virtual |
◆ endMemberDescription()
void HtmlGenerator::endMemberDescription |
( |
| ) |
|
|
virtual |
◆ endMemberDoc()
void HtmlGenerator::endMemberDoc |
( |
bool |
hasArgs | ) |
|
|
virtual |
◆ endMemberDocList()
void HtmlGenerator::endMemberDocList |
( |
| ) |
|
|
virtual |
◆ endMemberDocName()
void HtmlGenerator::endMemberDocName |
( |
| ) |
|
|
virtual |
◆ endMemberDocPrefixItem()
void HtmlGenerator::endMemberDocPrefixItem |
( |
| ) |
|
|
virtual |
◆ endMemberDocSimple()
void HtmlGenerator::endMemberDocSimple |
( |
bool |
| ) |
|
|
virtual |
◆ endMemberGroup()
void HtmlGenerator::endMemberGroup |
( |
bool |
| ) |
|
|
virtual |
◆ endMemberGroupDocs()
void HtmlGenerator::endMemberGroupDocs |
( |
| ) |
|
|
virtual |
◆ endMemberGroupHeader()
void HtmlGenerator::endMemberGroupHeader |
( |
| ) |
|
|
virtual |
◆ endMemberHeader()
void HtmlGenerator::endMemberHeader |
( |
| ) |
|
|
virtual |
◆ endMemberItem()
void HtmlGenerator::endMemberItem |
( |
| ) |
|
|
virtual |
◆ endMemberList()
void HtmlGenerator::endMemberList |
( |
| ) |
|
|
virtual |
◆ endMemberSections()
void HtmlGenerator::endMemberSections |
( |
| ) |
|
|
virtual |
◆ endMemberSubtitle()
void HtmlGenerator::endMemberSubtitle |
( |
| ) |
|
|
virtual |
◆ endMemberTemplateParams()
void HtmlGenerator::endMemberTemplateParams |
( |
const QCString & |
anchor, |
|
|
const QCString & |
inheritId |
|
) |
| |
|
virtual |
◆ endPageDoc()
void HtmlGenerator::endPageDoc |
( |
| ) |
|
|
virtual |
◆ endPageRef()
◆ endParagraph()
void HtmlGenerator::endParagraph |
( |
| ) |
|
|
virtual |
◆ endParameterList()
void HtmlGenerator::endParameterList |
( |
| ) |
|
|
virtual |
◆ endParameterName()
void HtmlGenerator::endParameterName |
( |
bool |
last, |
|
|
bool |
emptyList, |
|
|
bool |
closeBracket |
|
) |
| |
|
virtual |
◆ endParameterType()
void HtmlGenerator::endParameterType |
( |
| ) |
|
|
virtual |
◆ endParamList()
void HtmlGenerator::endParamList |
( |
| ) |
|
|
virtual |
◆ endProjectNumber()
void HtmlGenerator::endProjectNumber |
( |
| ) |
|
|
virtual |
◆ endQuickIndices()
void HtmlGenerator::endQuickIndices |
( |
| ) |
|
|
virtual |
◆ endSection()
◆ endSmall()
void HtmlGenerator::endSmall |
( |
| ) |
|
|
inlinevirtual |
◆ endSubsection()
void HtmlGenerator::endSubsection |
( |
| ) |
|
|
inlinevirtual |
◆ endSubsubsection()
void HtmlGenerator::endSubsubsection |
( |
| ) |
|
|
inlinevirtual |
◆ endTextBlock()
void HtmlGenerator::endTextBlock |
( |
bool |
| ) |
|
|
inlinevirtual |
◆ endTextLink()
void HtmlGenerator::endTextLink |
( |
| ) |
|
|
virtual |
◆ endTitle()
void HtmlGenerator::endTitle |
( |
| ) |
|
|
inlinevirtual |
◆ endTitleHead()
◆ endTypewriter()
void HtmlGenerator::endTypewriter |
( |
| ) |
|
|
inlinevirtual |
◆ exceptionEntry()
void HtmlGenerator::exceptionEntry |
( |
const QCString & |
prefix, |
|
|
bool |
closeBracket |
|
) |
| |
|
virtual |
◆ getMathJaxMacros()
QCString HtmlGenerator::getMathJaxMacros |
( |
| ) |
|
|
static |
◆ init()
void HtmlGenerator::init |
( |
| ) |
|
|
static |
在文件 htmlgen.cpp 第 930 行定义.
934 if (!d.exists() && !d.mkdir(dname.
str()))
936 term(
"Could not create output directory %s\n",
qPrint(dname));
992 std::ofstream f(dname.
str()+
"/dynsections.js",std::ofstream::out | std::ofstream::binary);
引用了 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 |
◆ insertMemberAlignLeft()
void HtmlGenerator::insertMemberAlignLeft |
( |
int |
annoType, |
|
|
bool |
initTag |
|
) |
| |
|
virtual |
实现了 OutputGenerator.
在文件 htmlgen.cpp 第 1727 行定义.
1729 if (!initTag)
m_t <<
" </td>";
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;
引用了 OutputGenerator::m_t.
被这些函数引用 startMemberItem().
◆ lastIndexPage()
void HtmlGenerator::lastIndexPage |
( |
| ) |
|
|
inlinevirtual |
◆ lineBreak()
void HtmlGenerator::lineBreak |
( |
const QCString & |
style | ) |
|
|
virtual |
◆ operator=()
◆ setCurrentDoc()
void HtmlGenerator::setCurrentDoc |
( |
const Definition * |
context, |
|
|
const QCString & |
anchor, |
|
|
bool |
isSourceFile |
|
) |
| |
|
virtual |
◆ startAnonTypeScope()
void HtmlGenerator::startAnonTypeScope |
( |
int |
| ) |
|
|
inlinevirtual |
◆ startBold()
void HtmlGenerator::startBold |
( |
| ) |
|
|
inlinevirtual |
◆ startCallGraph()
void HtmlGenerator::startCallGraph |
( |
| ) |
|
|
virtual |
◆ startCenter()
void HtmlGenerator::startCenter |
( |
| ) |
|
|
inlinevirtual |
◆ startClassDiagram()
void HtmlGenerator::startClassDiagram |
( |
| ) |
|
|
virtual |
◆ startCodeFragment()
void HtmlGenerator::startCodeFragment |
( |
const QCString & |
style | ) |
|
|
inlinevirtual |
◆ startCodeLine()
void HtmlGenerator::startCodeLine |
( |
bool |
hasLineNumbers | ) |
|
|
inlinevirtual |
◆ startCompoundTemplateParams()
void HtmlGenerator::startCompoundTemplateParams |
( |
| ) |
|
|
virtual |
◆ startConstraintDocs()
void HtmlGenerator::startConstraintDocs |
( |
| ) |
|
|
virtual |
◆ startConstraintList()
void HtmlGenerator::startConstraintList |
( |
const QCString & |
header | ) |
|
|
virtual |
◆ startConstraintParam()
void HtmlGenerator::startConstraintParam |
( |
| ) |
|
|
virtual |
◆ startConstraintType()
void HtmlGenerator::startConstraintType |
( |
| ) |
|
|
virtual |
◆ startContents()
void HtmlGenerator::startContents |
( |
| ) |
|
|
virtual |
◆ startDescForItem()
void HtmlGenerator::startDescForItem |
( |
| ) |
|
|
inlinevirtual |
◆ startDescItem()
void HtmlGenerator::startDescItem |
( |
| ) |
|
|
inlinevirtual |
◆ startDescription()
void HtmlGenerator::startDescription |
( |
| ) |
|
|
inlinevirtual |
◆ startDescTable()
void HtmlGenerator::startDescTable |
( |
const QCString & |
title | ) |
|
|
virtual |
◆ startDescTableData()
void HtmlGenerator::startDescTableData |
( |
| ) |
|
|
virtual |
◆ startDescTableRow()
void HtmlGenerator::startDescTableRow |
( |
| ) |
|
|
virtual |
◆ startDescTableTitle()
void HtmlGenerator::startDescTableTitle |
( |
| ) |
|
|
virtual |
◆ startDirDepGraph()
void HtmlGenerator::startDirDepGraph |
( |
| ) |
|
|
virtual |
◆ startDotGraph()
void HtmlGenerator::startDotGraph |
( |
| ) |
|
|
virtual |
◆ startDoxyAnchor()
◆ startEmphasis()
void HtmlGenerator::startEmphasis |
( |
| ) |
|
|
inlinevirtual |
◆ startExamples()
void HtmlGenerator::startExamples |
( |
| ) |
|
|
virtual |
◆ startFile()
实现了 OutputGenerator.
在文件 htmlgen.cpp 第 1120 行定义.
1140 << getDoxygenVersion() <<
" -->\n";
1145 m_t <<
"<script type=\"text/javascript\">\n";
1146 m_t <<
"/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */\n";
1147 m_t <<
"var searchBox = new SearchBox(\"searchBox\", \""
1149 m_t <<
"/* @license-end */\n";
1150 m_t <<
"</script>\n";
引用了 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 |
◆ startGroupCollaboration()
void HtmlGenerator::startGroupCollaboration |
( |
| ) |
|
|
virtual |
◆ startGroupHeader()
void HtmlGenerator::startGroupHeader |
( |
int |
extraIndentLevel | ) |
|
|
virtual |
◆ startHeaderSection()
void HtmlGenerator::startHeaderSection |
( |
| ) |
|
|
virtual |
◆ startHtmlLink()
void HtmlGenerator::startHtmlLink |
( |
const QCString & |
url | ) |
|
|
virtual |
◆ startInclDepGraph()
void HtmlGenerator::startInclDepGraph |
( |
| ) |
|
|
virtual |
◆ startIndent()
void HtmlGenerator::startIndent |
( |
| ) |
|
|
virtual |
◆ startIndexItem()
void HtmlGenerator::startIndexItem |
( |
const QCString & |
ref, |
|
|
const QCString & |
file |
|
) |
| |
|
virtual |
◆ startIndexKey()
void HtmlGenerator::startIndexKey |
( |
| ) |
|
|
virtual |
◆ startIndexList()
void HtmlGenerator::startIndexList |
( |
| ) |
|
|
virtual |
◆ startIndexListItem()
void HtmlGenerator::startIndexListItem |
( |
| ) |
|
|
virtual |
◆ startIndexSection()
◆ startIndexValue()
void HtmlGenerator::startIndexValue |
( |
bool |
| ) |
|
|
virtual |
◆ startInlineHeader()
void HtmlGenerator::startInlineHeader |
( |
| ) |
|
|
virtual |
◆ startInlineMemberDoc()
void HtmlGenerator::startInlineMemberDoc |
( |
| ) |
|
|
virtual |
◆ startInlineMemberName()
void HtmlGenerator::startInlineMemberName |
( |
| ) |
|
|
virtual |
◆ startInlineMemberType()
void HtmlGenerator::startInlineMemberType |
( |
| ) |
|
|
virtual |
◆ startItemList()
void HtmlGenerator::startItemList |
( |
| ) |
|
|
inlinevirtual |
◆ startItemListItem()
void HtmlGenerator::startItemListItem |
( |
| ) |
|
|
inlinevirtual |
◆ startLabels()
void HtmlGenerator::startLabels |
( |
| ) |
|
|
virtual |
◆ startMemberDeclaration()
void HtmlGenerator::startMemberDeclaration |
( |
| ) |
|
|
inlinevirtual |
◆ startMemberDescription()
void HtmlGenerator::startMemberDescription |
( |
const QCString & |
anchor, |
|
|
const QCString & |
inheritId, |
|
|
bool |
typ |
|
) |
| |
|
virtual |
◆ 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.cpp 第 1861 行定义.
1866 m_t <<
"\n<h2 class=\"memtitle\">"
1867 <<
"<span class=\"permalink\"><a href=\"#" << anchor <<
"\">◆ </a></span>";
1871 m_t <<
" <span class=\"overload\">[" << memCount <<
"/" << memTotal <<
"]</span>";
1874 m_t <<
"\n<div class=\"memitem\">\n";
1875 m_t <<
"<div class=\"memproto\">\n";
引用了 DBG_HTML, docify() , 以及 OutputGenerator::m_t.
◆ startMemberDocList()
void HtmlGenerator::startMemberDocList |
( |
| ) |
|
|
virtual |
◆ startMemberDocName()
void HtmlGenerator::startMemberDocName |
( |
bool |
| ) |
|
|
virtual |
◆ startMemberDocPrefixItem()
void HtmlGenerator::startMemberDocPrefixItem |
( |
| ) |
|
|
virtual |
◆ startMemberDocSimple()
void HtmlGenerator::startMemberDocSimple |
( |
bool |
isEnum | ) |
|
|
virtual |
◆ startMemberGroup()
void HtmlGenerator::startMemberGroup |
( |
| ) |
|
|
virtual |
◆ startMemberGroupDocs()
void HtmlGenerator::startMemberGroupDocs |
( |
| ) |
|
|
virtual |
◆ startMemberGroupHeader()
void HtmlGenerator::startMemberGroupHeader |
( |
bool |
| ) |
|
|
virtual |
◆ startMemberHeader()
void HtmlGenerator::startMemberHeader |
( |
const QCString & |
anchor, |
|
|
int |
typ |
|
) |
| |
|
virtual |
◆ startMemberItem()
void HtmlGenerator::startMemberItem |
( |
const QCString & |
anchor, |
|
|
int |
annoType, |
|
|
const QCString & |
inheritId |
|
) |
| |
|
virtual |
◆ startMemberList()
void HtmlGenerator::startMemberList |
( |
| ) |
|
|
virtual |
◆ startMemberSections()
void HtmlGenerator::startMemberSections |
( |
| ) |
|
|
virtual |
◆ startMemberSubtitle()
void HtmlGenerator::startMemberSubtitle |
( |
| ) |
|
|
virtual |
◆ startMemberTemplateParams()
void HtmlGenerator::startMemberTemplateParams |
( |
| ) |
|
|
virtual |
◆ startPageDoc()
void HtmlGenerator::startPageDoc |
( |
const QCString & |
pageTitle | ) |
|
|
virtual |
◆ startPageRef()
void HtmlGenerator::startPageRef |
( |
| ) |
|
|
inlinevirtual |
◆ startParagraph()
void HtmlGenerator::startParagraph |
( |
const QCString & |
classDef | ) |
|
|
virtual |
◆ startParameterList()
void HtmlGenerator::startParameterList |
( |
bool |
openBracket | ) |
|
|
virtual |
◆ startParameterName()
void HtmlGenerator::startParameterName |
( |
bool |
| ) |
|
|
virtual |
◆ startParameterType()
void HtmlGenerator::startParameterType |
( |
bool |
first, |
|
|
const QCString & |
key |
|
) |
| |
|
virtual |
◆ startParamList()
◆ startProjectNumber()
void HtmlGenerator::startProjectNumber |
( |
| ) |
|
|
virtual |
◆ startQuickIndices()
void HtmlGenerator::startQuickIndices |
( |
| ) |
|
|
inlinevirtual |
◆ startSection()
◆ startSmall()
void HtmlGenerator::startSmall |
( |
| ) |
|
|
inlinevirtual |
◆ startSubsection()
void HtmlGenerator::startSubsection |
( |
| ) |
|
|
inlinevirtual |
◆ startSubsubsection()
void HtmlGenerator::startSubsubsection |
( |
| ) |
|
|
inlinevirtual |
◆ startTextBlock()
void HtmlGenerator::startTextBlock |
( |
bool |
| ) |
|
|
inlinevirtual |
◆ startTextLink()
void HtmlGenerator::startTextLink |
( |
const QCString & |
file, |
|
|
const QCString & |
anchor |
|
) |
| |
|
virtual |
◆ startTitle()
void HtmlGenerator::startTitle |
( |
| ) |
|
|
inlinevirtual |
◆ startTitleHead()
void HtmlGenerator::startTitleHead |
( |
const QCString & |
| ) |
|
|
virtual |
◆ startTypewriter()
void HtmlGenerator::startTypewriter |
( |
| ) |
|
|
inlinevirtual |
◆ type()
◆ writeAnchor()
◆ writeChar()
void HtmlGenerator::writeChar |
( |
char |
c | ) |
|
|
virtual |
◆ writeCodeAnchor()
void HtmlGenerator::writeCodeAnchor |
( |
const QCString & |
name | ) |
|
|
inlinevirtual |
◆ writeCodeLink()
Writes a link to an object in a code fragment.
- 参数
-
type | The type of symbol, used for semantic syntax highlighting, may be Default is no info is available. |
ref | If this is non-zero, the object is to be found in an external documentation file. |
file | The file in which the object is located. |
anchor | The anchor uniquely identifying the object within the file. |
name | The text to display as a placeholder for the link. |
tooltip | The tooltip to display when the mouse is on the link. |
实现了 CodeOutputInterface.
在文件 htmlgen.h 第 93 行定义.
引用了 m_codeGen, type() , 以及 HtmlCodeGenerator::writeCodeLink().
◆ writeDoc()
◆ writeEndAnnoItem()
void HtmlGenerator::writeEndAnnoItem |
( |
const QCString & |
| ) |
|
|
inlinevirtual |
◆ writeExternalSearchPage()
void HtmlGenerator::writeExternalSearchPage |
( |
| ) |
|
|
static |
在文件 htmlgen.cpp 第 2725 行定义.
2730 std::ofstream f(
fileName.
str(),std::ofstream::out | std::ofstream::binary);
2737 << getDoxygenVersion() <<
" -->\n";
2738 t <<
"<script type=\"text/javascript\">\n";
2739 t <<
"/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */\n";
2740 t <<
"var searchBox = new SearchBox(\"searchBox\", \""
2742 t <<
"/* @license-end */\n";
2747 t <<
" <input type=\"text\" id=\"MSearchField\" name=\"query\" value=\"\" size=\"20\" accesskey=\"S\" onfocus=\"searchBox.OnSearchFieldFocus(true)\" onblur=\"searchBox.OnSearchFieldFocus(false)\"/>\n";
2749 t <<
" </div><div class=\"right\"></div>\n";
2761 t <<
"<div class=\"header\">\n";
2762 t <<
" <div class=\"headertitle\">\n";
2766 t <<
"<div class=\"contents\">\n";
2768 t <<
"<div id=\"searchresults\"></div>\n";
2771 if (generateTreeView)
2773 t <<
"</div><!-- doc-content -->\n";
2781 QCString scriptName = dname+
"/search/search.js";
2782 f.open(scriptName.
str(),std::ofstream::out | std::ofstream::binary);
2786 t <<
"var searchResultsText=["
2791 t <<
"var tagMap = {\n";
2795 for (
const auto &ml : extraSearchMappings)
2798 int eqPos = mapLine.
find(
'=');
2805 if (!first) t <<
",\n";
2806 t <<
" \"" << tagName <<
"\": \"" << destName <<
"\"";
2811 if (!first) 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";
2820 t <<
" var results = $('#results');\n";
2827 err(
"Failed to open file '%s' for writing...\n",
qPrint(scriptName));
引用了 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 |
◆ writeFooterFile()
void HtmlGenerator::writeFooterFile |
( |
TextStream & |
t | ) |
|
|
static |
◆ writeGraphicalHierarchy()
◆ writeHeaderFile()
◆ writeInheritedSectionTitle()
实现了 OutputGenerator.
在文件 htmlgen.cpp 第 2996 行定义.
3001 DBG_HTML(
m_t <<
"<!-- writeInheritedSectionTitle -->\n";)
3003 if (!a.isEmpty()) a.
prepend(
"#");
3008 classLink +=
" href=\"";
3013 classLink +=
"href=\"";
3018 m_t <<
"<tr class=\"inherit_header " <<
id <<
"\">"
3019 <<
"<td colspan=\"2\" onclick=\"javascript:toggleInherit('" <<
id <<
"')\">"
3020 <<
"<img src=\"" <<
m_relPath <<
"closed.png\" alt=\"-\"/> "
引用了 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 |
◆ writeLatexSpacing()
void HtmlGenerator::writeLatexSpacing |
( |
| ) |
|
|
inlinevirtual |
◆ 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
- 参数
-
ref | External reference (when imported from a tag file) |
file | The file part of the URL pointing to the docs. |
anchor | The anchor part of the URL pointing to the docs. |
lineNumber | The line number to write |
writeLineAnchor | Indicates if an anchor for the line number needs to be written |
实现了 CodeOutputInterface.
在文件 htmlgen.h 第 98 行定义.
引用了 m_codeGen , 以及 HtmlCodeGenerator::writeLineNumber().
◆ writeLogo()
void HtmlGenerator::writeLogo |
( |
| ) |
|
|
virtual |
◆ writeLogoAsString()
◆ writeNavigationPath()
void HtmlGenerator::writeNavigationPath |
( |
const QCString & |
s | ) |
|
|
virtual |
◆ writeNonBreakableSpace()
void HtmlGenerator::writeNonBreakableSpace |
( |
int |
n | ) |
|
|
virtual |
◆ writeObjectLink()
◆ writePageFooter()
◆ writePageLink()
void HtmlGenerator::writePageLink |
( |
const QCString & |
, |
|
|
bool |
|
|
) |
| |
|
inlinevirtual |
◆ writeQuickLinks()
◆ writeRuler()
void HtmlGenerator::writeRuler |
( |
| ) |
|
|
inlinevirtual |
◆ writeSearchData()
void HtmlGenerator::writeSearchData |
( |
const QCString & |
dir | ) |
|
|
static |
在文件 htmlgen.cpp 第 1044 行定义.
1056 if (serverBasedSearch)
1070 std::ofstream f(searchDirName.
str()+
"/search.css",std::ofstream::out | std::ofstream::binary);
1079 searchCss = mgr.
getAsString(
"search_sidebar.css");
1088 searchCss = mgr.
getAsString(
"search_fixedtabs.css");
1094 searchCss += mgr.
getAsString(
"search_common.css");
引用了 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 |
◆ writeSearchInfo() [2/2]
在文件 htmlgen.cpp 第 1156 行定义.
1160 if (searchEngine && !serverBasedSearch)
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";
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";
引用了 Config_getBool.
◆ writeSearchPage()
void HtmlGenerator::writeSearchPage |
( |
| ) |
|
|
static |
在文件 htmlgen.cpp 第 2634 行定义.
2642 QCString configFileName = htmlOutput+
"/search_config.php";
2643 std::ofstream f(configFileName.
str(),std::ofstream::out | std::ofstream::binary);
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";
2653 t <<
"$translator = array(\n";
2655 t <<
" 'search_results' => array(\n";
2674 f.open(
fileName.
str(),std::ofstream::out | std::ofstream::binary);
2681 << getDoxygenVersion() <<
" -->\n";
2682 t <<
"<script type=\"text/javascript\">\n";
2683 t <<
"/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */\n";
2684 t <<
"var searchBox = new SearchBox(\"searchBox\", \""
2686 t <<
"/* @license-end */\n";
2698 t <<
"require_once \"search_functions.php\";\n";
2703 if (generateTreeView)
2705 t <<
"</div><!-- doc-content -->\n";
2712 QCString scriptName = htmlOutput+
"/search/search.js";
2713 f.open(scriptName.
str(),std::ofstream::out | std::ofstream::binary);
2721 err(
"Failed to open file '%s' for writing...\n",
qPrint(scriptName));
引用了 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 |
◆ writeSplitBarAsString()
在文件 htmlgen.cpp 第 2563 行定义.
2568 if (generateTreeView)
2573 "<div id=\"side-nav\" class=\"ui-resizable side-nav-resizable\">\n");
2576 " <div id=\"nav-tree\">\n"
2577 " <div id=\"nav-tree-contents\">\n"
2578 " <div id=\"nav-sync\" class=\"sync\"></div>\n"
2581 " <div id=\"splitbar\" style=\"-moz-user-select:none;\" \n"
2582 " class=\"ui-resizable-handle\">\n"
2585 "<script type=\"text/javascript\">\n"
2586 "/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */\n"
2587 "$(document).ready(function(){initNavTree('") +
2590 QCString(
"'); initResizable(); });\n"
2591 "/* @license-end */\n"
2593 "<div id=\"doc-content\">\n");
引用了 addHtmlExtensionIfMissing() , 以及 Config_getBool.
被这些函数引用 writeExternalSearchPage(), writeSearchPage() , 以及 writeSplitBar().
◆ writeStartAnnoItem()
◆ writeString()
void HtmlGenerator::writeString |
( |
const QCString & |
text | ) |
|
|
virtual |
◆ writeStyleInfo()
void HtmlGenerator::writeStyleInfo |
( |
int |
part | ) |
|
|
virtual |
实现了 OutputGenerator.
在文件 htmlgen.cpp 第 1240 行定义.
1262 if (!cssfi.exists() || !cssfi.isFile() || !cssfi.isReadable())
1278 for (
const auto &
fileName : extraCssFiles)
引用了 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 |
◆ writeSummaryLink()
void HtmlGenerator::writeSummaryLink |
( |
const QCString & |
file, |
|
|
const QCString & |
anchor, |
|
|
const QCString & |
title, |
|
|
bool |
first |
|
) |
| |
|
virtual |
◆ writeSynopsis()
void HtmlGenerator::writeSynopsis |
( |
| ) |
|
|
inlinevirtual |
◆ writeTabData()
void HtmlGenerator::writeTabData |
( |
| ) |
|
|
static |
◆ writeTooltip()
Writes a tool tip definition
- 参数
-
id | unique identifier for the tooltip |
docInfo | Info about the symbol's documentation. |
decl | full declaration of the symbol (for functions) |
desc | brief description for the symbol |
defInfo | Info about the symbol's definition in the source code |
declInfo | Info about the symbol's declaration in the source code |
实现了 CodeOutputInterface.
在文件 htmlgen.h 第 100 行定义.
引用了 m_codeGen , 以及 HtmlCodeGenerator::writeTooltip().
◆ m_codeGen
在文件 htmlgen.h 第 344 行定义.
被这些函数引用 codify(), endCodeFragment(), endCodeLine(), endFontClass(), startCodeFragment(), startCodeLine(), startFile(), startFontClass(), writeCodeAnchor(), writeCodeLink(), writeDoc(), writeLineNumber() , 以及 writeTooltip().
◆ m_emptySection
bool HtmlGenerator::m_emptySection = false |
|
private |
◆ m_lastFile
◆ m_lastTitle
◆ m_relPath
在文件 htmlgen.h 第 339 行定义.
被这些函数引用 endCallGraph(), endClassDiagram(), endDirDepGraph(), endDotGraph(), endGroupCollaboration(), endInclDepGraph(), startCallGraph(), startClassDiagram(), startDirDepGraph(), startDotGraph(), startFile(), startGroupCollaboration(), startInclDepGraph(), startIndexItem(), startTextLink(), writeFooter(), writeInheritedSectionTitle(), writeLogo(), writeNavigationPath(), writeObjectLink(), writeQuickLinks(), writeSearchInfo(), writeSplitBar() , 以及 writeSummaryLink().
◆ m_sectionCount
int HtmlGenerator::m_sectionCount = 0 |
|
private |
在文件 htmlgen.h 第 342 行定义.
被这些函数引用 endCallGraph(), endClassDiagram(), endDirDepGraph(), endDotGraph(), endGroupCollaboration(), endInclDepGraph(), startCallGraph(), startClassDiagram(), startDirDepGraph(), startDotGraph(), startFile(), startGroupCollaboration() , 以及 startInclDepGraph().
该类的文档由以下文件生成:
std::vector< std::string > StringVector
bool copyResource(const QCString &name, const QCString &targetDir) const
Copies a registered resource to a given target directory
QCString fileName() const
void writeTooltip(const QCString &id, const DocLinkInfo &docInfo, const QCString &decl, const QCString &desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo)
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
void startFontClass(const QCString &s)
static ResourceMgr & instance()
Returns the one and only instance of this class
static QCString getConvertLatexMacro()
Convert a set of LaTeX commands \(re)newcommand to a form readable by MathJax LaTeX syntax:
virtual QCString trCompoundMembers()=0
virtual QCString trGeneratedBy()=0
static std::mutex g_indexLock
QCString getAsString(const QCString &name) const
Gets the resource data as a C string
QCString relativePathToRoot(const QCString &name)
virtual QCString trSearchMatches()=0
Class representing a directory in the file system
QCString replaceColorMarkers(const QCString &str)
Replaces any markers of the form ##AA in input string str by new markers of the form #AABBCC,...
uint length() const
Returns the length of the string, not counting the 0-terminator.
void writeImage(TextStream &t, const QCString &path, const QCString &relPath, const QCString &file, bool generateMap=true) const
QCString filterTitle(const QCString &title)
bool isEmpty() const
Returns TRUE iff the string is empty
HtmlCodeGenerator m_codeGen
static IndexList * indexList
void addStyleSheetFile(const QCString &name)
static QCString substituteHtmlKeywords(const QCString &str, const QCString &title, const QCString &relPath, const QCString &navPath=QCString())
void writeLineNumber(const QCString &, const QCString &, const QCString &, int, bool)
QCString writeGraph(TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool writeImageMap=TRUE, int graphId=-1)
void writeGraph(TextStream &t, const QCString &path, const QCString &fileName)
virtual QCString trLegend()=0
void codify(const QCString &text)
static void startSectionContent(TextStream &t, int sectionCount)
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)
void writeCodeLink(CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip)
virtual QCString trEnumerationValues()=0
void startHtmlLink(const QCString &url)
void err(const char *fmt,...)
Text streaming class that buffers data.
int find(char c, int index=0, bool cs=TRUE) const
bool empty() const
Returns true iff the buffer is empty
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)
Concrete visitor implementation for HTML output.
void endCodeFragment(const QCString &)
void docify(const QCString &text)
static void endSectionContent(TextStream &t)
virtual QCString trGeneratedAt(const QCString &date, const QCString &projName)=0
QCString writeGraph(TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool writeImageMap=TRUE, int graphId=-1)
QCString addHtmlExtensionIfMissing(const QCString &fName)
QCString dateToString(bool includeTime)
QCString stripWhiteSpace() const
returns a copy of this string with leading and trailing whitespace removed
virtual QCString trInheritedFrom(const QCString &members, const QCString &what)=0
QCString left(size_t len) const
void writeCodeAnchor(const QCString &anchor)
void addImageFile(const QCString &name)
Translator * theTranslator
virtual QCString trSearchResults(int numDocuments)=0
virtual void addWord(const QCString &word, bool hiPriority)=0
QCString fileToString(const QCString &name, bool filter, bool isSourceCode)
std::string str() const
Return the contents of the buffer as a std::string object
virtual QCString trSearch()=0
void addIndexFile(const QCString &name)
static QCString g_mathjax_code
void clearSubDirs(const Dir &d)
QCString externalLinkTarget(const bool parent)
static SearchIndexIntf * searchIndex
void insertMemberAlignLeft(int, bool)
QCString substitute(const QCString &s, const QCString &src, const QCString &dst)
substitute all occurrences of src in s by dst
static void startSectionSummary(TextStream &t, int sectionCount)
static QCString writeLogoAsString(const QCString &path)
static QCString g_latex_macro
#define Config_getBool(name)
static void writeDefaultQuickLinks(TextStream &t, bool compact, HighlightedItem hli, const QCString &file, const QCString &relPath)
void setRelativePath(const QCString &path)
static QCString htmlFileExtension
static void endSectionSummary(TextStream &t)
QCString writeGraph(TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool writeImageMap=TRUE, int graphId=-1)
virtual QCString trSearchResultsTitle()=0
Singleton for managing resources compiled into an executable
virtual void setCurrentDoc(const Definition *ctx, const QCString &anchor, bool isSourceFile)=0
void term(const char *fmt,...)
Minimal replacement for QFileInfo.
static QCString writeSplitBarAsString(const QCString &name, const QCString &relpath)
const char * qPrint(const char *s)
#define Config_getString(name)
static void startSectionHeader(TextStream &t, const QCString &relPath, int sectionCount)
virtual void accept(DocVisitor *v)=0
OutputGenerator & operator=(const OutputGenerator &o)
virtual QCString trExamples()=0
QCString externalRef(const QCString &relPath, const QCString &ref, bool href)
void createSubDirs(const Dir &d)
static void endSectionHeader(TextStream &t)
static void writePageFooter(TextStream &t, const QCString &, const QCString &, const QCString &)
QCString convertToId(const QCString &s)
OutputGenerator(const QCString &dir)
QCString right(size_t len) const
void startPlainFile(const QCString &name)
QCString & prepend(const char *s)
virtual OutputType type() const
QCString convertToHtml(const QCString &s, bool keepEntities)
#define Config_getList(name)
void startCodeFragment(const QCString &style)
This is an alternative implementation of QCString.