Generator for LaTeX output.
更多...
#include <latexgen.h>
|
| LatexGenerator () |
|
| LatexGenerator (const LatexGenerator &) |
|
LatexGenerator & | operator= (const LatexGenerator &) |
|
virtual | ~LatexGenerator () |
|
virtual std::unique_ptr< OutputGenerator > | clone () const |
|
void | cleanup () |
|
virtual OutputType | type () const |
|
void | codify (const QCString &text) |
|
void | writeCodeLink (CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip) |
|
void | writeLineNumber (const QCString &ref, const QCString &file, const QCString &anchor, int lineNumber, bool writeLineAnchor) |
|
void | writeTooltip (const QCString &id, const DocLinkInfo &docInfo, const QCString &decl, const QCString &desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo) |
|
void | startCodeLine (bool hasLineNumbers) |
|
void | endCodeLine () |
|
void | startFontClass (const QCString &s) |
|
void | endFontClass () |
|
void | writeCodeAnchor (const QCString &anchor) |
|
void | startCodeFragment (const QCString &style) |
|
void | endCodeFragment (const QCString &style) |
|
void | writeDoc (DocNode *, const Definition *ctx, const MemberDef *, int id) |
|
void | startFile (const QCString &name, const QCString &manName, const QCString &title, int id) |
|
void | writeSearchInfo () |
|
void | writeFooter (const QCString &) |
|
void | endFile () |
|
void | clearBuffer () |
|
void | startIndexSection (IndexSections) |
|
void | endIndexSection (IndexSections) |
|
void | writePageLink (const QCString &, bool) |
|
void | startProjectNumber () |
|
void | endProjectNumber () |
|
void | writeStyleInfo (int part) |
|
void | startTitleHead (const QCString &) |
|
void | startTitle () |
|
void | endTitleHead (const QCString &, const QCString &name) |
|
void | endTitle () |
|
void | newParagraph () |
|
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 &, const QCString &) |
|
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 &, int, const QCString &) |
|
void | endMemberItem () |
|
void | startMemberTemplateParams () |
|
void | endMemberTemplateParams (const QCString &, const QCString &) |
|
void | startCompoundTemplateParams () |
|
void | endCompoundTemplateParams () |
|
void | startMemberGroupHeader (bool) |
|
void | endMemberGroupHeader () |
|
void | startMemberGroupDocs () |
|
void | endMemberGroupDocs () |
|
void | startMemberGroup () |
|
void | endMemberGroup (bool) |
|
void | insertMemberAlign (bool) |
|
void | insertMemberAlignLeft (int, bool) |
|
void | writeRuler () |
|
void | writeAnchor (const QCString &fileName, const QCString &name) |
|
void | startEmphasis () |
|
void | endEmphasis () |
|
void | startBold () |
|
void | endBold () |
|
void | startDescription () |
|
void | endDescription () |
|
void | startDescItem () |
|
void | endDescItem () |
|
void | lineBreak (const QCString &style=QCString()) |
|
void | startMemberDoc (const QCString &, const QCString &, const QCString &, const QCString &, int, int, bool) |
|
void | endMemberDoc (bool) |
|
void | startDoxyAnchor (const QCString &, const QCString &, const QCString &, const QCString &, const QCString &) |
|
void | endDoxyAnchor (const QCString &, const QCString &) |
|
void | writeChar (char c) |
|
void | writeLatexSpacing () |
|
void | writeStartAnnoItem (const QCString &type, const QCString &file, const QCString &path, const QCString &name) |
|
void | writeEndAnnoItem (const QCString &name) |
|
void | startSubsection () |
|
void | endSubsection () |
|
void | startSubsubsection () |
|
void | endSubsubsection () |
|
void | startCenter () |
|
void | endCenter () |
|
void | startSmall () |
|
void | endSmall () |
|
void | startMemberDescription (const QCString &, const QCString &, bool) |
|
void | endMemberDescription () |
|
void | startMemberDeclaration () |
|
void | endMemberDeclaration (const QCString &, const QCString &) |
|
void | writeInheritedSectionTitle (const QCString &, const QCString &, const QCString &, const QCString &, const QCString &, const QCString &) |
|
void | startDescList (SectionTypes) |
|
void | endDescList () |
|
void | startExamples () |
|
void | endExamples () |
|
void | startParamList (ParamListTypes, const QCString &title) |
|
void | endParamList () |
|
void | startDescForItem () |
|
void | endDescForItem () |
|
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 &) |
|
void | writeNavigationPath (const QCString &) |
|
void | writeLogo () |
|
void | writeQuickLinks (bool, HighlightedItem, const QCString &) |
|
void | writeSummaryLink (const QCString &, const QCString &, const QCString &, bool) |
|
void | startContents () |
|
void | endContents () |
|
void | writeNonBreakableSpace (int) |
|
void | startDescTable (const QCString &title) |
|
void | endDescTable () |
|
void | startDescTableRow () |
|
void | endDescTableRow () |
|
void | startDescTableTitle () |
|
void | endDescTableTitle () |
|
void | startDescTableData () |
|
void | endDescTableData () |
|
void | lastIndexPage () |
|
void | startDotGraph () |
|
void | endDotGraph (DotClassGraph &) |
|
void | startInclDepGraph () |
|
void | endInclDepGraph (DotInclDepGraph &) |
|
void | startCallGraph () |
|
void | startGroupCollaboration () |
|
void | endGroupCollaboration (DotGroupCollaboration &g) |
|
void | endCallGraph (DotCallGraph &) |
|
void | startDirDepGraph () |
|
void | endDirDepGraph (DotDirDeps &g) |
|
void | writeGraphicalHierarchy (DotGfxHierarchyTable &) |
|
void | startTextBlock (bool) |
|
void | endTextBlock (bool) |
|
void | startMemberDocPrefixItem () |
|
void | endMemberDocPrefixItem () |
|
void | startMemberDocName (bool) |
|
void | endMemberDocName () |
|
void | startParameterType (bool, const QCString &) |
|
void | endParameterType () |
|
void | startParameterName (bool) |
|
void | endParameterName (bool, bool, bool) |
|
void | startParameterList (bool) |
|
void | endParameterList () |
|
void | exceptionEntry (const QCString &, bool) |
|
void | startConstraintList (const QCString &) |
|
void | startConstraintParam () |
|
void | endConstraintParam () |
|
void | startConstraintType () |
|
void | endConstraintType () |
|
void | startConstraintDocs () |
|
void | endConstraintDocs () |
|
void | endConstraintList () |
|
void | startMemberDocSimple (bool) |
|
void | endMemberDocSimple (bool) |
|
void | startInlineMemberType () |
|
void | endInlineMemberType () |
|
void | startInlineMemberName () |
|
void | endInlineMemberName () |
|
void | startInlineMemberDoc () |
|
void | endInlineMemberDoc () |
|
void | startLabels () |
|
void | writeLabel (const QCString &l, bool isLast) |
|
void | endLabels () |
|
void | setCurrentDoc (const Definition *, const QCString &, bool) |
|
void | addWord (const QCString &, bool) |
|
| 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 void | startPageDoc (const QCString &) |
|
virtual void | endPageDoc () |
|
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 LaTeX output.
在文件 latexgen.h 第 79 行定义.
◆ LatexGenerator() [1/2]
LatexGenerator::LatexGenerator |
( |
| ) |
|
◆ LatexGenerator() [2/2]
◆ ~LatexGenerator()
LatexGenerator::~LatexGenerator |
( |
| ) |
|
|
virtual |
◆ addIndexItem()
◆ addWord()
void LatexGenerator::addWord |
( |
const QCString & |
, |
|
|
bool |
|
|
) |
| |
|
inlinevirtual |
◆ cleanup()
void LatexGenerator::cleanup |
( |
| ) |
|
|
virtual |
◆ clearBuffer()
void LatexGenerator::clearBuffer |
( |
| ) |
|
◆ clone()
◆ codify()
void LatexGenerator::codify |
( |
const QCString & |
s | ) |
|
|
inlinevirtual |
◆ docify()
void LatexGenerator::docify |
( |
const QCString & |
s | ) |
|
|
virtual |
Writes an ASCII string to the output. Converts characters that have A special meaning, like &
in html.
实现了 BaseOutputDocInterface.
在文件 latexgen.cpp 第 1546 行定义.
引用了 filterLatexString(), m_codeGen, m_insideTabbing, OutputGenerator::m_t , 以及 LatexCodeGenerator::usedTableLevel().
被这些函数引用 startConstraintList(), startExamples(), startMemberDocSimple(), startParameterType(), startParamList(), writeChar(), writeObjectLink() , 以及 writeStartAnnoItem().
◆ endAnonTypeScope()
void LatexGenerator::endAnonTypeScope |
( |
int |
indent | ) |
|
|
virtual |
◆ endBold()
void LatexGenerator::endBold |
( |
| ) |
|
|
inlinevirtual |
◆ endCallGraph()
◆ endCenter()
void LatexGenerator::endCenter |
( |
| ) |
|
|
inlinevirtual |
◆ endClassDiagram()
◆ endCodeFragment()
void LatexGenerator::endCodeFragment |
( |
const QCString & |
style | ) |
|
|
inlinevirtual |
◆ endCodeLine()
void LatexGenerator::endCodeLine |
( |
| ) |
|
|
inlinevirtual |
◆ endCompoundTemplateParams()
void LatexGenerator::endCompoundTemplateParams |
( |
| ) |
|
|
inlinevirtual |
◆ endConstraintDocs()
void LatexGenerator::endConstraintDocs |
( |
| ) |
|
|
virtual |
◆ endConstraintList()
void LatexGenerator::endConstraintList |
( |
| ) |
|
|
virtual |
◆ endConstraintParam()
void LatexGenerator::endConstraintParam |
( |
| ) |
|
|
virtual |
◆ endConstraintType()
void LatexGenerator::endConstraintType |
( |
| ) |
|
|
virtual |
◆ endContents()
void LatexGenerator::endContents |
( |
| ) |
|
|
inlinevirtual |
◆ endDescForItem()
void LatexGenerator::endDescForItem |
( |
| ) |
|
|
inlinevirtual |
◆ endDescItem()
void LatexGenerator::endDescItem |
( |
| ) |
|
|
virtual |
◆ endDescList()
void LatexGenerator::endDescList |
( |
| ) |
|
|
inline |
◆ endDescription()
void LatexGenerator::endDescription |
( |
| ) |
|
|
virtual |
◆ endDescTable()
void LatexGenerator::endDescTable |
( |
| ) |
|
|
virtual |
◆ endDescTableData()
void LatexGenerator::endDescTableData |
( |
| ) |
|
|
virtual |
◆ endDescTableRow()
void LatexGenerator::endDescTableRow |
( |
| ) |
|
|
virtual |
◆ endDescTableTitle()
void LatexGenerator::endDescTableTitle |
( |
| ) |
|
|
virtual |
◆ endDirDepGraph()
void LatexGenerator::endDirDepGraph |
( |
DotDirDeps & |
g | ) |
|
|
virtual |
◆ endDotGraph()
◆ endDoxyAnchor()
void LatexGenerator::endDoxyAnchor |
( |
const QCString & |
fName, |
|
|
const QCString & |
anchor |
|
) |
| |
|
virtual |
◆ endEmphasis()
void LatexGenerator::endEmphasis |
( |
| ) |
|
|
inlinevirtual |
◆ endExamples()
void LatexGenerator::endExamples |
( |
| ) |
|
|
virtual |
◆ endFile()
void LatexGenerator::endFile |
( |
| ) |
|
|
virtual |
◆ endFontClass()
void LatexGenerator::endFontClass |
( |
| ) |
|
|
inlinevirtual |
◆ endGroupCollaboration()
◆ endGroupHeader()
void LatexGenerator::endGroupHeader |
( |
int |
| ) |
|
|
virtual |
◆ endHeaderSection()
void LatexGenerator::endHeaderSection |
( |
| ) |
|
|
inlinevirtual |
◆ endHtmlLink()
void LatexGenerator::endHtmlLink |
( |
| ) |
|
|
virtual |
◆ endInclDepGraph()
◆ endIndent()
void LatexGenerator::endIndent |
( |
| ) |
|
|
inlinevirtual |
◆ endIndexItem()
void LatexGenerator::endIndexItem |
( |
const QCString & |
ref, |
|
|
const QCString & |
file |
|
) |
| |
|
virtual |
◆ endIndexKey()
void LatexGenerator::endIndexKey |
( |
| ) |
|
|
virtual |
◆ endIndexList()
void LatexGenerator::endIndexList |
( |
| ) |
|
|
inlinevirtual |
◆ endIndexListItem()
void LatexGenerator::endIndexListItem |
( |
| ) |
|
|
inlinevirtual |
◆ endIndexSection()
实现了 OutputGenerator.
在文件 latexgen.cpp 第 861 行定义.
873 m_t <<
"}\n\\label{index}";
875 m_t <<
"\\input{" << indexName <<
"}\n";
879 m_t <<
"}\n\\input{modules}\n";
882 m_t <<
"}\n\\input{dirs}\n";
885 m_t <<
"}\n\\input{namespaces}\n";
888 m_t <<
"}\n\\input{concepts}\n";
891 m_t <<
"}\n\\input{hierarchy}\n";
894 m_t <<
"}\n\\input{annotated}\n";
897 m_t <<
"}\n\\input{files}\n";
900 m_t <<
"}\n\\input{pages}\n";
907 if (!gd->isReference())
914 m_t <<
"\\input{" << gd->getOutputFileBase() <<
"}\n";
924 if (dd->isLinkableInProject())
931 m_t <<
"\\input{" << dd->getOutputFileBase() <<
"}\n";
941 if (nd->isLinkableInProject() && !nd->isAlias())
948 m_t <<
"\\input{" << nd->getOutputFileBase() <<
"}\n";
958 if (cd->isLinkableInProject() && !cd->isAlias())
965 m_t <<
"\\input{" << cd->getOutputFileBase() <<
"}\n";
975 if (cd->isLinkableInProject() &&
976 cd->templateMaster()==0 &&
977 !cd->isEmbeddedInOuterScope() &&
986 m_t <<
"\\input{" << cd->getOutputFileBase() <<
"}\n";
996 for (
const auto &fd : *fn)
998 if (fd->isLinkableInProject())
1005 m_t <<
"\\input{" << fd->getOutputFileBase() <<
"}\n";
1007 if (fd->generateSourceFile())
1014 m_t <<
"\\input{" << fd->getSourceFileBase() <<
"}\n";
1025 m_t <<
"\\input{" << pd->getOutputFileBase() <<
"}\n";
1036 if (!pd->getGroupDef() && !pd->isReference())
1038 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
1039 m_t <<
"{" << pd->title();
1042 if (compactLatex || first)
m_t <<
"\\input" ;
else m_t <<
"\\include";
1043 m_t <<
"{" << pd->getOutputFileBase() <<
"}\n";
引用了 Doxygen::classLinkedMap, Doxygen::conceptLinkedMap, Config_getBool, Config_getString, convertToLaTeX(), Doxygen::dirLinkedMap, Doxygen::exampleLinkedMap, FALSE, g_footer, Doxygen::groupLinkedMap, Doxygen::inputNameLinkedMap, isClassDocumentation, isClassHierarchyIndex, isCompoundIndex, isConceptDocumentation, isConceptIndex, isDirDocumentation, isDirIndex, isEndIndex, isExampleDocumentation, isFileDocumentation, isFileIndex, isMainPage, isModuleDocumentation, isModuleIndex, isNamespaceDocumentation, isNamespaceIndex, isPageDocumentation, isPageDocumentation2, isPageIndex, isTitlePageAuthor, isTitlePageStart, OutputGenerator::m_t, Doxygen::namespaceLinkedMap, Doxygen::pageLinkedMap, substituteLatexKeywords() , 以及 TRUE.
◆ endIndexValue()
void LatexGenerator::endIndexValue |
( |
const QCString & |
name, |
|
|
bool |
|
|
) |
| |
|
virtual |
◆ endInlineHeader()
void LatexGenerator::endInlineHeader |
( |
| ) |
|
|
virtual |
◆ endInlineMemberDoc()
void LatexGenerator::endInlineMemberDoc |
( |
| ) |
|
|
virtual |
◆ endInlineMemberName()
void LatexGenerator::endInlineMemberName |
( |
| ) |
|
|
virtual |
◆ endInlineMemberType()
void LatexGenerator::endInlineMemberType |
( |
| ) |
|
|
virtual |
◆ endItemList()
void LatexGenerator::endItemList |
( |
| ) |
|
|
inlinevirtual |
◆ endItemListItem()
void LatexGenerator::endItemListItem |
( |
| ) |
|
|
inlinevirtual |
◆ endLabels()
void LatexGenerator::endLabels |
( |
| ) |
|
|
virtual |
◆ endMemberDeclaration()
void LatexGenerator::endMemberDeclaration |
( |
const QCString & |
, |
|
|
const QCString & |
|
|
) |
| |
|
inlinevirtual |
◆ endMemberDescription()
void LatexGenerator::endMemberDescription |
( |
| ) |
|
|
virtual |
◆ endMemberDoc()
void LatexGenerator::endMemberDoc |
( |
bool |
| ) |
|
|
virtual |
◆ endMemberDocList()
void LatexGenerator::endMemberDocList |
( |
| ) |
|
|
inlinevirtual |
◆ endMemberDocName()
void LatexGenerator::endMemberDocName |
( |
| ) |
|
|
inlinevirtual |
◆ endMemberDocPrefixItem()
void LatexGenerator::endMemberDocPrefixItem |
( |
| ) |
|
|
inlinevirtual |
◆ endMemberDocSimple()
void LatexGenerator::endMemberDocSimple |
( |
bool |
isEnum | ) |
|
|
virtual |
◆ endMemberGroup()
void LatexGenerator::endMemberGroup |
( |
bool |
hasHeader | ) |
|
|
virtual |
◆ endMemberGroupDocs()
void LatexGenerator::endMemberGroupDocs |
( |
| ) |
|
|
virtual |
◆ endMemberGroupHeader()
void LatexGenerator::endMemberGroupHeader |
( |
| ) |
|
|
virtual |
◆ endMemberHeader()
void LatexGenerator::endMemberHeader |
( |
| ) |
|
|
virtual |
◆ endMemberItem()
void LatexGenerator::endMemberItem |
( |
| ) |
|
|
virtual |
◆ endMemberList()
void LatexGenerator::endMemberList |
( |
| ) |
|
|
virtual |
◆ endMemberSections()
void LatexGenerator::endMemberSections |
( |
| ) |
|
|
inlinevirtual |
◆ endMemberSubtitle()
void LatexGenerator::endMemberSubtitle |
( |
| ) |
|
|
inlinevirtual |
◆ endMemberTemplateParams()
void LatexGenerator::endMemberTemplateParams |
( |
const QCString & |
, |
|
|
const QCString & |
|
|
) |
| |
|
virtual |
◆ endPageRef()
void LatexGenerator::endPageRef |
( |
const QCString & |
clname, |
|
|
const QCString & |
anchor |
|
) |
| |
|
virtual |
◆ endParagraph()
void LatexGenerator::endParagraph |
( |
| ) |
|
|
virtual |
◆ endParameterList()
void LatexGenerator::endParameterList |
( |
| ) |
|
|
virtual |
◆ endParameterName()
void LatexGenerator::endParameterName |
( |
bool |
last, |
|
|
bool |
, |
|
|
bool |
closeBracket |
|
) |
| |
|
virtual |
◆ endParameterType()
void LatexGenerator::endParameterType |
( |
| ) |
|
|
virtual |
◆ endParamList()
void LatexGenerator::endParamList |
( |
| ) |
|
|
virtual |
◆ endProjectNumber()
void LatexGenerator::endProjectNumber |
( |
| ) |
|
|
inlinevirtual |
◆ endQuickIndices()
void LatexGenerator::endQuickIndices |
( |
| ) |
|
|
inlinevirtual |
◆ endSection()
◆ endSmall()
void LatexGenerator::endSmall |
( |
| ) |
|
|
inlinevirtual |
◆ endSubsection()
void LatexGenerator::endSubsection |
( |
| ) |
|
|
inlinevirtual |
◆ endSubsubsection()
void LatexGenerator::endSubsubsection |
( |
| ) |
|
|
inlinevirtual |
◆ endTextBlock()
void LatexGenerator::endTextBlock |
( |
bool |
| ) |
|
|
inlinevirtual |
◆ endTextLink()
void LatexGenerator::endTextLink |
( |
| ) |
|
|
virtual |
◆ endTitle()
void LatexGenerator::endTitle |
( |
| ) |
|
|
inlinevirtual |
◆ endTitleHead()
void LatexGenerator::endTitleHead |
( |
const QCString & |
fileName, |
|
|
const QCString & |
name |
|
) |
| |
|
virtual |
◆ endTypewriter()
void LatexGenerator::endTypewriter |
( |
| ) |
|
|
inlinevirtual |
◆ exceptionEntry()
void LatexGenerator::exceptionEntry |
( |
const QCString & |
prefix, |
|
|
bool |
closeBracket |
|
) |
| |
|
virtual |
◆ init()
void LatexGenerator::init |
( |
| ) |
|
|
static |
在文件 latexgen.cpp 第 465 行定义.
469 if (!d.exists() && !d.mkdir(dname.
str()))
471 term(
"Could not create output directory %s\n",
qPrint(dname));
引用了 Config_getString, createSubDirs(), Dir::exists(), fileToString(), g_footer, g_header, ResourceMgr::getAsString(), ResourceMgr::instance(), Dir::mkdir(), qPrint(), QCString::str(), term(), writeLatexMakefile() , 以及 writeMakeBat().
被这些函数引用 generateOutput().
◆ insertMemberAlign()
void LatexGenerator::insertMemberAlign |
( |
bool |
| ) |
|
|
inlinevirtual |
◆ insertMemberAlignLeft()
void LatexGenerator::insertMemberAlignLeft |
( |
int |
, |
|
|
bool |
|
|
) |
| |
|
inlinevirtual |
◆ lastIndexPage()
void LatexGenerator::lastIndexPage |
( |
| ) |
|
|
virtual |
◆ lineBreak()
◆ newParagraph()
void LatexGenerator::newParagraph |
( |
| ) |
|
◆ operator=()
◆ setCurrentDoc()
◆ startAnonTypeScope()
void LatexGenerator::startAnonTypeScope |
( |
int |
indent | ) |
|
|
virtual |
◆ startBold()
void LatexGenerator::startBold |
( |
| ) |
|
|
inlinevirtual |
◆ startCallGraph()
void LatexGenerator::startCallGraph |
( |
| ) |
|
|
virtual |
◆ startCenter()
void LatexGenerator::startCenter |
( |
| ) |
|
|
inlinevirtual |
◆ startClassDiagram()
void LatexGenerator::startClassDiagram |
( |
| ) |
|
|
virtual |
◆ startCodeFragment()
void LatexGenerator::startCodeFragment |
( |
const QCString & |
style | ) |
|
|
inlinevirtual |
◆ startCodeLine()
void LatexGenerator::startCodeLine |
( |
bool |
hasLineNumbers | ) |
|
|
inlinevirtual |
◆ startCompoundTemplateParams()
void LatexGenerator::startCompoundTemplateParams |
( |
| ) |
|
|
inlinevirtual |
◆ startConstraintDocs()
void LatexGenerator::startConstraintDocs |
( |
| ) |
|
|
virtual |
◆ startConstraintList()
void LatexGenerator::startConstraintList |
( |
const QCString & |
header | ) |
|
|
virtual |
◆ startConstraintParam()
void LatexGenerator::startConstraintParam |
( |
| ) |
|
|
virtual |
◆ startConstraintType()
void LatexGenerator::startConstraintType |
( |
| ) |
|
|
virtual |
◆ startContents()
void LatexGenerator::startContents |
( |
| ) |
|
|
inlinevirtual |
◆ startDescForItem()
void LatexGenerator::startDescForItem |
( |
| ) |
|
|
inlinevirtual |
◆ startDescItem()
void LatexGenerator::startDescItem |
( |
| ) |
|
|
virtual |
◆ startDescList()
◆ startDescription()
void LatexGenerator::startDescription |
( |
| ) |
|
|
virtual |
◆ startDescTable()
void LatexGenerator::startDescTable |
( |
const QCString & |
title | ) |
|
|
virtual |
◆ startDescTableData()
void LatexGenerator::startDescTableData |
( |
| ) |
|
|
virtual |
◆ startDescTableRow()
void LatexGenerator::startDescTableRow |
( |
| ) |
|
|
virtual |
◆ startDescTableTitle()
void LatexGenerator::startDescTableTitle |
( |
| ) |
|
|
virtual |
◆ startDirDepGraph()
void LatexGenerator::startDirDepGraph |
( |
| ) |
|
|
virtual |
◆ startDotGraph()
void LatexGenerator::startDotGraph |
( |
| ) |
|
|
virtual |
◆ startDoxyAnchor()
◆ startEmphasis()
void LatexGenerator::startEmphasis |
( |
| ) |
|
|
inlinevirtual |
◆ startExamples()
void LatexGenerator::startExamples |
( |
| ) |
|
|
virtual |
◆ startFile()
◆ startFontClass()
void LatexGenerator::startFontClass |
( |
const QCString & |
clsName | ) |
|
|
inlinevirtual |
◆ startGroupCollaboration()
void LatexGenerator::startGroupCollaboration |
( |
| ) |
|
|
virtual |
◆ startGroupHeader()
void LatexGenerator::startGroupHeader |
( |
int |
extraIndentLevel | ) |
|
|
virtual |
◆ startHeaderSection()
void LatexGenerator::startHeaderSection |
( |
| ) |
|
|
inlinevirtual |
◆ startHtmlLink()
void LatexGenerator::startHtmlLink |
( |
const QCString & |
url | ) |
|
|
virtual |
◆ startInclDepGraph()
void LatexGenerator::startInclDepGraph |
( |
| ) |
|
|
virtual |
◆ startIndent()
void LatexGenerator::startIndent |
( |
| ) |
|
|
inlinevirtual |
◆ startIndexItem()
void LatexGenerator::startIndexItem |
( |
const QCString & |
ref, |
|
|
const QCString & |
file |
|
) |
| |
|
virtual |
◆ startIndexKey()
void LatexGenerator::startIndexKey |
( |
| ) |
|
|
virtual |
◆ startIndexList()
void LatexGenerator::startIndexList |
( |
| ) |
|
|
inlinevirtual |
◆ startIndexListItem()
void LatexGenerator::startIndexListItem |
( |
| ) |
|
|
inlinevirtual |
◆ startIndexSection()
实现了 OutputGenerator.
在文件 latexgen.cpp 第 702 行定义.
713 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
721 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
725 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
729 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
733 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
737 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
741 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
745 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
749 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
756 if (!gd->isReference())
758 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
769 if (dd->isLinkableInProject())
771 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
782 if (nd->isLinkableInProject() && !nd->isAlias())
784 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
795 if (cd->isLinkableInProject() && !cd->isAlias())
797 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
808 if (cd->isLinkableInProject() &&
809 cd->templateMaster()==0 &&
810 !cd->isEmbeddedInOuterScope() &&
814 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
826 for (
const auto &fd : *fn)
828 if (fd->isLinkableInProject() || fd->generateSourceFile())
832 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
844 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
850 if (compactLatex)
m_t <<
"\\doxysection";
else m_t <<
"\\chapter";
引用了 Doxygen::classLinkedMap, Doxygen::conceptLinkedMap, Config_getBool, Config_getString, convertToLaTeX(), Doxygen::dirLinkedMap, FALSE, g_header, Doxygen::groupLinkedMap, Doxygen::inputNameLinkedMap, isClassDocumentation, isClassHierarchyIndex, isCompoundIndex, isConceptDocumentation, isConceptIndex, isDirDocumentation, isDirIndex, isEndIndex, isExampleDocumentation, isFileDocumentation, isFileIndex, isMainPage, isModuleDocumentation, isModuleIndex, isNamespaceDocumentation, isNamespaceIndex, isPageDocumentation, isPageDocumentation2, isPageIndex, isTitlePageAuthor, isTitlePageStart, OutputGenerator::m_t, Doxygen::namespaceLinkedMap, substituteLatexKeywords() , 以及 TRUE.
◆ startIndexValue()
void LatexGenerator::startIndexValue |
( |
bool |
hasBrief | ) |
|
|
virtual |
◆ startInlineHeader()
void LatexGenerator::startInlineHeader |
( |
| ) |
|
|
virtual |
◆ startInlineMemberDoc()
void LatexGenerator::startInlineMemberDoc |
( |
| ) |
|
|
virtual |
◆ startInlineMemberName()
void LatexGenerator::startInlineMemberName |
( |
| ) |
|
|
virtual |
◆ startInlineMemberType()
void LatexGenerator::startInlineMemberType |
( |
| ) |
|
|
virtual |
◆ startItemList()
void LatexGenerator::startItemList |
( |
| ) |
|
|
inlinevirtual |
◆ startItemListItem()
void LatexGenerator::startItemListItem |
( |
| ) |
|
|
inlinevirtual |
◆ startLabels()
void LatexGenerator::startLabels |
( |
| ) |
|
|
virtual |
◆ startMemberDeclaration()
void LatexGenerator::startMemberDeclaration |
( |
| ) |
|
|
inlinevirtual |
◆ startMemberDescription()
void LatexGenerator::startMemberDescription |
( |
const QCString & |
, |
|
|
const QCString & |
, |
|
|
bool |
|
|
) |
| |
|
virtual |
◆ startMemberDoc()
void LatexGenerator::startMemberDoc |
( |
const QCString & |
clname, |
|
|
const QCString & |
memname, |
|
|
const QCString & |
, |
|
|
const QCString & |
title, |
|
|
int |
memCount, |
|
|
int |
memTotal, |
|
|
bool |
showInline |
|
) |
| |
|
virtual |
◆ startMemberDocList()
void LatexGenerator::startMemberDocList |
( |
| ) |
|
|
inlinevirtual |
◆ startMemberDocName()
void LatexGenerator::startMemberDocName |
( |
bool |
| ) |
|
|
inlinevirtual |
◆ startMemberDocPrefixItem()
void LatexGenerator::startMemberDocPrefixItem |
( |
| ) |
|
|
inlinevirtual |
◆ startMemberDocSimple()
void LatexGenerator::startMemberDocSimple |
( |
bool |
isEnum | ) |
|
|
virtual |
◆ startMemberGroup()
void LatexGenerator::startMemberGroup |
( |
| ) |
|
|
virtual |
◆ startMemberGroupDocs()
void LatexGenerator::startMemberGroupDocs |
( |
| ) |
|
|
virtual |
◆ startMemberGroupHeader()
void LatexGenerator::startMemberGroupHeader |
( |
bool |
hasHeader | ) |
|
|
virtual |
◆ startMemberHeader()
void LatexGenerator::startMemberHeader |
( |
const QCString & |
, |
|
|
int |
|
|
) |
| |
|
virtual |
◆ startMemberItem()
void LatexGenerator::startMemberItem |
( |
const QCString & |
, |
|
|
int |
annoType, |
|
|
const QCString & |
|
|
) |
| |
|
virtual |
◆ startMemberList()
void LatexGenerator::startMemberList |
( |
| ) |
|
|
virtual |
◆ startMemberSections()
void LatexGenerator::startMemberSections |
( |
| ) |
|
|
inlinevirtual |
◆ startMemberSubtitle()
void LatexGenerator::startMemberSubtitle |
( |
| ) |
|
|
inlinevirtual |
◆ startMemberTemplateParams()
void LatexGenerator::startMemberTemplateParams |
( |
| ) |
|
|
virtual |
◆ startPageRef()
void LatexGenerator::startPageRef |
( |
| ) |
|
|
virtual |
◆ startParagraph()
void LatexGenerator::startParagraph |
( |
const QCString & |
classDef | ) |
|
|
virtual |
◆ startParameterList()
void LatexGenerator::startParameterList |
( |
bool |
openBracket | ) |
|
|
virtual |
◆ startParameterName()
void LatexGenerator::startParameterName |
( |
bool |
| ) |
|
|
virtual |
◆ startParameterType()
void LatexGenerator::startParameterType |
( |
bool |
first, |
|
|
const QCString & |
key |
|
) |
| |
|
virtual |
◆ startParamList()
◆ startProjectNumber()
void LatexGenerator::startProjectNumber |
( |
| ) |
|
|
virtual |
◆ startQuickIndices()
void LatexGenerator::startQuickIndices |
( |
| ) |
|
|
inlinevirtual |
◆ startSection()
◆ startSmall()
void LatexGenerator::startSmall |
( |
| ) |
|
|
inlinevirtual |
◆ startSubsection()
void LatexGenerator::startSubsection |
( |
| ) |
|
|
inlinevirtual |
◆ startSubsubsection()
void LatexGenerator::startSubsubsection |
( |
| ) |
|
|
inlinevirtual |
◆ startTextBlock()
void LatexGenerator::startTextBlock |
( |
bool |
| ) |
|
|
inlinevirtual |
◆ startTextLink()
void LatexGenerator::startTextLink |
( |
const QCString & |
f, |
|
|
const QCString & |
anchor |
|
) |
| |
|
virtual |
◆ startTitle()
void LatexGenerator::startTitle |
( |
| ) |
|
|
virtual |
◆ startTitleHead()
void LatexGenerator::startTitleHead |
( |
const QCString & |
fileName | ) |
|
|
virtual |
◆ startTypewriter()
void LatexGenerator::startTypewriter |
( |
| ) |
|
|
inlinevirtual |
◆ type()
◆ writeAnchor()
void LatexGenerator::writeAnchor |
( |
const QCString & |
fileName, |
|
|
const QCString & |
name |
|
) |
| |
|
virtual |
◆ writeChar()
void LatexGenerator::writeChar |
( |
char |
c | ) |
|
|
virtual |
◆ writeCodeAnchor()
void LatexGenerator::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.
在文件 latexgen.h 第 99 行定义.
引用了 m_codeGen, type() , 以及 LatexCodeGenerator::writeCodeLink().
◆ writeDoc()
◆ writeEndAnnoItem()
void LatexGenerator::writeEndAnnoItem |
( |
const QCString & |
name | ) |
|
|
virtual |
◆ writeFooter()
void LatexGenerator::writeFooter |
( |
const QCString & |
| ) |
|
|
inlinevirtual |
◆ writeFooterFile()
void LatexGenerator::writeFooterFile |
( |
TextStream & |
t | ) |
|
|
static |
◆ writeGraphicalHierarchy()
◆ writeHeaderFile()
void LatexGenerator::writeHeaderFile |
( |
TextStream & |
t | ) |
|
|
static |
◆ writeInheritedSectionTitle()
◆ writeLabel()
void LatexGenerator::writeLabel |
( |
const QCString & |
l, |
|
|
bool |
isLast |
|
) |
| |
|
virtual |
◆ writeLatexSpacing()
void LatexGenerator::writeLatexSpacing |
( |
| ) |
|
|
inlinevirtual |
◆ writeLineNumber()
void LatexGenerator::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.
在文件 latexgen.h 第 104 行定义.
引用了 m_codeGen , 以及 LatexCodeGenerator::writeLineNumber().
◆ writeLogo()
void LatexGenerator::writeLogo |
( |
| ) |
|
|
inlinevirtual |
◆ writeNavigationPath()
void LatexGenerator::writeNavigationPath |
( |
const QCString & |
| ) |
|
|
inlinevirtual |
◆ writeNonBreakableSpace()
void LatexGenerator::writeNonBreakableSpace |
( |
int |
| ) |
|
|
virtual |
◆ writeObjectLink()
◆ writePageLink()
void LatexGenerator::writePageLink |
( |
const QCString & |
name, |
|
|
bool |
|
|
) |
| |
|
virtual |
◆ writeQuickLinks()
◆ writeRuler()
void LatexGenerator::writeRuler |
( |
| ) |
|
|
inlinevirtual |
◆ writeSearchInfo()
void LatexGenerator::writeSearchInfo |
( |
| ) |
|
|
inlinevirtual |
◆ writeSplitBar()
void LatexGenerator::writeSplitBar |
( |
const QCString & |
| ) |
|
|
inlinevirtual |
◆ writeStartAnnoItem()
◆ writeString()
void LatexGenerator::writeString |
( |
const QCString & |
text | ) |
|
|
virtual |
◆ writeStyleInfo()
void LatexGenerator::writeStyleInfo |
( |
int |
part | ) |
|
|
virtual |
◆ writeStyleSheetFile()
void LatexGenerator::writeStyleSheetFile |
( |
TextStream & |
t | ) |
|
|
static |
◆ writeSummaryLink()
◆ writeSynopsis()
void LatexGenerator::writeSynopsis |
( |
| ) |
|
|
inlinevirtual |
◆ 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.
在文件 latexgen.h 第 106 行定义.
引用了 m_codeGen , 以及 LatexCodeGenerator::writeTooltip().
◆ m_codeGen
在文件 latexgen.h 第 343 行定义.
被这些函数引用 codify(), docify(), endCodeFragment(), endCodeLine(), endDescTable(), endFile(), endFontClass(), endMemberDocSimple(), startCodeFragment(), startCodeLine(), startDescTable(), startFile(), startFontClass(), startMemberDocSimple(), writeCodeAnchor(), writeCodeLink(), writeDoc(), writeLineNumber() , 以及 writeTooltip().
◆ m_disableLinks
bool LatexGenerator::m_disableLinks = false |
|
private |
◆ m_firstDescItem
bool LatexGenerator::m_firstDescItem = true |
|
private |
◆ m_indent
int LatexGenerator::m_indent = 0 |
|
private |
◆ m_insideTabbing
bool LatexGenerator::m_insideTabbing = false |
|
private |
在文件 latexgen.h 第 337 行定义.
被这些函数引用 docify(), endAnonTypeScope(), endInlineMemberName(), endInlineMemberType(), endMemberDescription(), endMemberItem(), endMemberList(), lineBreak(), startAnonTypeScope(), startInlineMemberName(), startInlineMemberType(), startMemberDescription(), startMemberItem(), startMemberList(), writeDoc() , 以及 writeNonBreakableSpace().
◆ m_relPath
◆ templateMemberItem
bool LatexGenerator::templateMemberItem = false |
|
private |
该类的文档由以下文件生成:
virtual QCString getDefFileExtension() const =0
QCString fileName() const
static ResourceMgr & instance()
Returns the one and only instance of this class
virtual QCString trCompoundMembers()=0
QCString latexFilterURL(const QCString &s)
void writeTooltip(const QCString &, const DocLinkInfo &, const QCString &, const QCString &, const SourceLinkInfo &, const SourceLinkInfo &) override
QCString getAsString(const QCString &name) const
Gets the resource data as a C string
QCString relativePathToRoot(const QCString &name)
Class representing a directory in the file system
void startCodeFragment(const QCString &style) override
static ConceptLinkedMap * conceptLinkedMap
bool isEmpty() const
Returns TRUE iff the string is empty
static PageLinkedMap * pageLinkedMap
void writeLineNumber(const QCString &, const QCString &, const QCString &, int, bool) override
QCString writeGraph(TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool writeImageMap=TRUE, int graphId=-1)
static void writeMakeBat()
void endFontClass() override
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)
virtual QCString trEnumerationValues()=0
void startFontClass(const QCString &) override
static DirLinkedMap * dirLinkedMap
void endCodeLine() override
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)
QCString convertToLaTeX(const QCString &s, bool insideTabbing, bool keepSpaces)
void docify(const QCString &text)
static FileNameLinkedMap * inputNameLinkedMap
void startSubsubsection()
QCString writeGraph(TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool writeImageMap=TRUE, int graphId=-1)
@ isNamespaceDocumentation
virtual OutputType type() const
Translator * theTranslator
static GroupLinkedMap * groupLinkedMap
QCString stripPath(const QCString &s)
Concrete visitor implementation for LaTeX output.
QCString latexEscapeLabelName(const QCString &s)
int usedTableLevel() const
QCString fileToString(const QCString &name, bool filter, bool isSourceCode)
void setSourceFileName(const QCString &sourceFileName)
static void writeDefaultStyleSheet(TextStream &t)
void clearSubDirs(const Dir &d)
void writeCodeAnchor(const QCString &) override
void endCodeFragment(const QCString &style) override
void setRelativePath(const QCString &path)
void codify(const QCString &text) override
#define Config_getBool(name)
QCString writeGraph(TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool writeImageMap=TRUE, int graphId=-1)
void startCodeLine(bool) override
void term(const char *fmt,...)
static QCString substituteLatexKeywords(const QCString &str, const QCString &title)
const char * qPrint(const char *s)
#define Config_getString(name)
static NamespaceLinkedMap * namespaceLinkedMap
void writeCodeLink(CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip) override
virtual void accept(DocVisitor *v)=0
void lineBreak(const QCString &style=QCString())
OutputGenerator & operator=(const OutputGenerator &o)
QCString latexEscapePDFString(const QCString &s)
virtual QCString trExamples()=0
void filterLatexString(TextStream &t, const QCString &str, bool insideTabbing, bool insidePre, bool insideItem, bool insideTable, bool keepSpaces)
static ClassLinkedMap * classLinkedMap
void createSubDirs(const Dir &d)
LatexCodeGenerator m_codeGen
QCString latexEscapeIndexChars(const QCString &s)
OutputGenerator(const QCString &dir)
QCString right(size_t len) const
void startPlainFile(const QCString &name)
void writeFigure(TextStream &t, const QCString &path, const QCString &file) const
static void writeLatexMakefile()
static PageLinkedMap * exampleLinkedMap
This is an alternative implementation of QCString.