Doxygen
Loading...
Searching...
No Matches
LatexGenerator Class Reference

Generator for LaTeX output. More...

#include <src/latexgen.h>

Inheritance diagram for LatexGenerator:
Collaboration diagram for LatexGenerator:

Public Member Functions

 LatexGenerator ()
 
 LatexGenerator (const LatexGenerator &)
 
LatexGeneratoroperator= (const LatexGenerator &)
 
 LatexGenerator (LatexGenerator &&)=delete
 
LatexGeneratoroperator= (LatexGenerator &&)=delete
 
 ~LatexGenerator ()
 
void clearBuffer ()
 
void setCurrentDoc (const Definition *, const QCString &, bool)
 
void addWord (const QCString &, bool)
 
OutputType type () const override
 
std::unique_ptr< OutputGenIntfclone () override
 
void addCodeGen (OutputCodeList &list) override
 
void cleanup () override
 
void writeDoc (const IDocNodeAST *node, const Definition *ctx, const MemberDef *, int id) override
 
void startFile (const QCString &name, const QCString &manName, const QCString &title, int id, int hierarchyLevel) override
 
void endFile () override
 
void writeSearchInfo () override
 
void writeFooter (const QCString &) override
 
void startPageDoc (const QCString &) override
 
void endPageDoc () override
 
void startIndexSection (IndexSection) override
 
void endIndexSection (IndexSection) override
 
void writePageLink (const QCString &, bool) override
 
void startProjectNumber () override
 
void endProjectNumber () override
 
void writeStyleInfo (int part) override
 
void startTitleHead (const QCString &) override
 
void endTitleHead (const QCString &, const QCString &name) override
 
void startParagraph (const QCString &classDef) override
 
void endParagraph () override
 
void writeString (const QCString &text) override
 
void startIndexListItem () override
 
void endIndexListItem () override
 
void startIndexList () override
 
void endIndexList () override
 
void startIndexKey () override
 
void endIndexKey () override
 
void startIndexValue (bool) override
 
void endIndexValue (const QCString &, bool) override
 
void startItemList () override
 
void endItemList () override
 
void startIndexItem (const QCString &ref, const QCString &file) override
 
void endIndexItem (const QCString &ref, const QCString &file) override
 
void docify (const QCString &text) override
 
void writeObjectLink (const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name) override
 
void startTextLink (const QCString &, const QCString &) override
 
void endTextLink () override
 
void startTypewriter () override
 
void endTypewriter () override
 
void startGroupHeader (int) override
 
void endGroupHeader (int) override
 
void startItemListItem () override
 
void endItemListItem () override
 
void startMemberSections () override
 
void endMemberSections () override
 
void startHeaderSection () override
 
void endHeaderSection () override
 
void startMemberHeader (const QCString &, int) override
 
void endMemberHeader () override
 
void startMemberSubtitle () override
 
void endMemberSubtitle () override
 
void startMemberDocList () override
 
void endMemberDocList () override
 
void startMemberList () override
 
void endMemberList () override
 
void startInlineHeader () override
 
void endInlineHeader () override
 
void startAnonTypeScope (int) override
 
void endAnonTypeScope (int) override
 
void startMemberItem (const QCString &, MemberItemType, const QCString &) override
 
void endMemberItem (MemberItemType) override
 
void startMemberTemplateParams () override
 
void endMemberTemplateParams (const QCString &, const QCString &) override
 
void startCompoundTemplateParams () override
 
void endCompoundTemplateParams () override
 
void startMemberGroupHeader (bool) override
 
void endMemberGroupHeader () override
 
void startMemberGroupDocs () override
 
void endMemberGroupDocs () override
 
void startMemberGroup () override
 
void endMemberGroup (bool) override
 
void insertMemberAlign (bool) override
 
void insertMemberAlignLeft (MemberItemType, bool) override
 
void writeRuler () override
 
void writeAnchor (const QCString &fileName, const QCString &name) override
 
void startEmphasis () override
 
void endEmphasis () override
 
void startBold () override
 
void endBold () override
 
void lineBreak (const QCString &style=QCString()) override
 
void startMemberDoc (const QCString &, const QCString &, const QCString &, const QCString &, int, int, bool) override
 
void endMemberDoc (bool) override
 
void startDoxyAnchor (const QCString &, const QCString &, const QCString &, const QCString &, const QCString &) override
 
void endDoxyAnchor (const QCString &, const QCString &) override
 
void addLabel (const QCString &, const QCString &) override
 
void writeChar (char c) override
 
void writeLatexSpacing () override
 
void writeStartAnnoItem (const QCString &type, const QCString &file, const QCString &path, const QCString &name) override
 
void startCenter () override
 
void endCenter () override
 
void startSmall () override
 
void endSmall () override
 
void startMemberDescription (const QCString &, const QCString &, bool) override
 
void endMemberDescription () override
 
void startMemberDeclaration () override
 
void endMemberDeclaration (const QCString &, const QCString &) override
 
void writeInheritedSectionTitle (const QCString &, const QCString &, const QCString &, const QCString &, const QCString &, const QCString &) override
 
void startExamples () override
 
void endExamples () override
 
void startDescForItem () override
 
void endDescForItem () override
 
void startSection (const QCString &, const QCString &, SectionType) override
 
void endSection (const QCString &, SectionType) override
 
void addIndexItem (const QCString &, const QCString &) override
 
void startIndent () override
 
void endIndent () override
 
void writeSynopsis () override
 
void startClassDiagram () override
 
void endClassDiagram (const ClassDiagram &, const QCString &, const QCString &) override
 
void startPageRef () override
 
void endPageRef (const QCString &, const QCString &) override
 
void startQuickIndices () override
 
void endQuickIndices () override
 
void writeSplitBar (const QCString &) override
 
void writeNavigationPath (const QCString &) override
 
void writeLogo () override
 
void writeQuickLinks (HighlightedItem, const QCString &, bool) override
 
void writeSummaryLink (const QCString &, const QCString &, const QCString &, bool) override
 
void startContents () override
 
void endContents () override
 
void writeNonBreakableSpace (int) override
 
void startDescTable (const QCString &title, const bool hasInits) override
 
void endDescTable () override
 
void startDescTableRow () override
 
void endDescTableRow () override
 
void startDescTableTitle () override
 
void endDescTableTitle () override
 
void startDescTableInit () override
 
void endDescTableInit () override
 
void startDescTableData () override
 
void endDescTableData () override
 
void lastIndexPage () override
 
void startDotGraph () override
 
void endDotGraph (DotClassGraph &) override
 
void startInclDepGraph () override
 
void endInclDepGraph (DotInclDepGraph &) override
 
void startCallGraph () override
 
void startGroupCollaboration () override
 
void endGroupCollaboration (DotGroupCollaboration &g) override
 
void endCallGraph (DotCallGraph &) override
 
void startDirDepGraph () override
 
void endDirDepGraph (DotDirDeps &g) override
 
void writeGraphicalHierarchy (DotGfxHierarchyTable &) override
 
void startTextBlock (bool) override
 
void endTextBlock (bool) override
 
void startMemberDocPrefixItem () override
 
void endMemberDocPrefixItem () override
 
void startMemberDocName (bool) override
 
void endMemberDocName () override
 
void startParameterType (bool, const QCString &) override
 
void endParameterType () override
 
void startParameterName (bool) override
 
void endParameterName () override
 
void startParameterExtra () override
 
void endParameterExtra (bool last, bool one, bool bracket) override
 
void startParameterDefVal (const char *s) override
 
void endParameterDefVal () override
 
void startParameterList (bool) override
 
void endParameterList () override
 
void exceptionEntry (const QCString &, bool) override
 
void startConstraintList (const QCString &) override
 
void startConstraintParam () override
 
void endConstraintParam () override
 
void startConstraintType () override
 
void endConstraintType () override
 
void startConstraintDocs () override
 
void endConstraintDocs () override
 
void endConstraintList () override
 
void startMemberDocSimple (bool) override
 
void endMemberDocSimple (bool) override
 
void startInlineMemberType () override
 
void endInlineMemberType () override
 
void startInlineMemberName () override
 
void endInlineMemberName () override
 
void startInlineMemberDoc () override
 
void endInlineMemberDoc () override
 
void startLabels () override
 
void writeLabel (const QCString &l, bool isLast) override
 
void endLabels () override
 
void writeLocalToc (const SectionRefs &sr, const LocalToc &lt) override
 
void startPlainFile (const QCString &name) override
 
void endPlainFile () override
 
Public Member Functions inherited from OutputGenerator
 OutputGenerator ()
 
 OutputGenerator (const QCString &dir)
 
virtual ~OutputGenerator ()=default
 
QCString dir () const
 
QCString fileName () const
 
void startPlainFile (const QCString &name)
 
void endPlainFile ()
 

Static Public Member Functions

static void init ()
 
static void writeStyleSheetFile (TextStream &t)
 
static void writeHeaderFile (TextStream &t)
 
static void writeFooterFile (TextStream &t)
 

Private Member Functions

void startTitle ()
 
void endTitle ()
 

Private Attributes

bool m_firstDescItem = true
 
bool m_disableLinks = false
 
QCString m_relPath
 
int m_indent = 0
 
bool m_templateMemberItem = false
 
std::unique_ptr< OutputCodeListm_codeList
 
LatexCodeGeneratorm_codeGen
 
bool m_insideTableEnv = false
 
int m_hierarchyLevel = 0
 

Additional Inherited Members

Public Types inherited from OutputGenerator
enum class  ParamListTypes { Param , RetVal , Exception }
 
enum class  MemberItemType { Normal , AnonymousStart , AnonymousEnd , Templated }
 
Protected Attributes inherited from OutputGenerator
TextStream m_t
 
QCString m_dir
 

Detailed Description

Generator for LaTeX output.

Definition at line 93 of file latexgen.h.

Constructor & Destructor Documentation

◆ LatexGenerator() [1/3]

LatexGenerator::LatexGenerator ( )

Definition at line 319 of file latexgen.cpp.

320 : OutputGenerator(Config_getString(LATEX_OUTPUT))
321 , m_codeList(std::make_unique<OutputCodeList>())
322{
323 m_codeGen = m_codeList->add<LatexCodeGenerator>(&m_t);
324}
std::unique_ptr< OutputCodeList > m_codeList
Definition latexgen.h:327
LatexCodeGenerator * m_codeGen
Definition latexgen.h:328
TextStream m_t
Definition outputgen.h:116
#define Config_getString(name)
Definition config.h:32

References Config_getString, m_codeGen, m_codeList, OutputGenerator::m_t, and OutputGenerator::OutputGenerator().

Referenced by LatexGenerator(), LatexGenerator(), operator=(), and operator=().

◆ LatexGenerator() [2/3]

LatexGenerator::LatexGenerator ( const LatexGenerator & og)

◆ LatexGenerator() [3/3]

LatexGenerator::LatexGenerator ( LatexGenerator && )
delete

References LatexGenerator().

◆ ~LatexGenerator()

LatexGenerator::~LatexGenerator ( )
default

Member Function Documentation

◆ addCodeGen()

void LatexGenerator::addCodeGen ( OutputCodeList & list)
overridevirtual

Implements OutputGenIntf.

Definition at line 359 of file latexgen.cpp.

360{
362}
void add(OutputCodeIntfPtr &&p)
Definition outputlist.h:194
OutputCodeDefer< LatexCodeGenerator > LatexCodeGeneratorDefer
Definition outputlist.h:102

References OutputCodeList::add(), and m_codeGen.

◆ addIndexItem()

void LatexGenerator::addIndexItem ( const QCString & s1,
const QCString & s2 )
overridevirtual

Implements OutputGenIntf.

Definition at line 1695 of file latexgen.cpp.

1696{
1697 if (!s1.isEmpty())
1698 {
1699 m_t << "\\index{";
1701 m_t << "@{";
1703 m_t << "}";
1704 if (!s2.isEmpty())
1705 {
1706 m_t << "!";
1708 m_t << "@{";
1710 m_t << "}";
1711 }
1712 m_t << "}";
1713 }
1714}
bool isEmpty() const
Returns TRUE iff the string is empty.
Definition qcstring.h:150
QCString latexEscapeIndexChars(const QCString &s)
QCString latexEscapeLabelName(const QCString &s)

References QCString::isEmpty(), latexEscapeIndexChars(), latexEscapeLabelName(), and OutputGenerator::m_t.

◆ addLabel()

void LatexGenerator::addLabel ( const QCString & fName,
const QCString & anchor )
overridevirtual

Implements OutputGenIntf.

Definition at line 1661 of file latexgen.cpp.

1662{
1663 m_t << "\\label{";
1664 if (!fName.isEmpty()) m_t << stripPath(fName);
1665 if (!anchor.isEmpty()) m_t << "_" << anchor;
1666 if (m_insideTableEnv) m_t << "}";
1667 m_t << "} \n";
1668}
bool m_insideTableEnv
Definition latexgen.h:329
QCString stripPath(const QCString &s)
Definition util.cpp:5457

References QCString::isEmpty(), m_insideTableEnv, OutputGenerator::m_t, and stripPath().

◆ addWord()

void LatexGenerator::addWord ( const QCString & ,
bool  )
inline

Definition at line 110 of file latexgen.h.

110{}

◆ cleanup()

void LatexGenerator::cleanup ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 676 of file latexgen.cpp.

677{
678 QCString dname = Config_getString(LATEX_OUTPUT);
679 Dir d(dname.str());
680 clearSubDirs(d);
681}
const std::string & str() const
Definition qcstring.h:537
void clearSubDirs(const Dir &d)
Definition util.cpp:4176

References clearSubDirs(), Config_getString, and QCString::str().

◆ clearBuffer()

void LatexGenerator::clearBuffer ( )

◆ clone()

std::unique_ptr< OutputGenIntf > LatexGenerator::clone ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 115 of file latexgen.h.

115{ return std::make_unique<LatexGenerator>(*this); }

◆ docify()

void LatexGenerator::docify ( const QCString & text)
overridevirtual

Implements OutputGenIntf.

Definition at line 1764 of file latexgen.cpp.

1765{
1767 m_codeGen->insideTabbing(), // insideTabbing
1768 false, // insidePre
1769 false, // insideItem
1770 m_codeGen->usedTableLevel()>0, // insideTable
1771 false // keepSpaces
1772 );
1773}
void filterLatexString(TextStream &t, const QCString &str, bool insideTabbing, bool insidePre, bool insideItem, bool insideTable, bool keepSpaces, const bool retainNewline=false)

References filterLatexString(), m_codeGen, and OutputGenerator::m_t.

Referenced by startConstraintList(), startExamples(), startMemberDocSimple(), startParameterDefVal(), startParameterType(), writeChar(), and writeStartAnnoItem().

◆ endAnonTypeScope()

void LatexGenerator::endAnonTypeScope ( int indent)
overridevirtual

Implements OutputGenIntf.

Definition at line 1807 of file latexgen.cpp.

1808{
1809 if (indent==0)
1810 {
1811 m_t << "\n" << "\\end{tabbing}";
1812 m_codeGen->setInsideTabbing(false);
1813 }
1814 m_indent=indent;
1815}

References m_codeGen, m_indent, and OutputGenerator::m_t.

◆ endBold()

void LatexGenerator::endBold ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 202 of file latexgen.h.

202{ m_t << "}"; }

References OutputGenerator::m_t.

◆ endCallGraph()

void LatexGenerator::endCallGraph ( DotCallGraph & g)
overridevirtual

Implements OutputGenIntf.

Definition at line 2055 of file latexgen.cpp.

2056{
2058}
QCString writeGraph(TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool writeImageMap=TRUE, int graphId=-1)
QCString dir() const
Definition outputgen.cpp:52
QCString fileName() const
Definition outputgen.cpp:57

References OutputGenerator::dir(), EPS, OutputGenerator::fileName(), LaTeX, m_relPath, OutputGenerator::m_t, and DotCallGraph::writeGraph().

◆ endCenter()

void LatexGenerator::endCenter ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 214 of file latexgen.h.

214{ m_t << "\\end{center}\n"; }

References OutputGenerator::m_t.

◆ endClassDiagram()

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

Implements OutputGenIntf.

Definition at line 1789 of file latexgen.cpp.

1791{
1793}
void writeFigure(TextStream &t, const QCString &path, const QCString &file) const
Definition diagram.cpp:1073

References OutputGenerator::dir(), OutputGenerator::fileName(), OutputGenerator::m_t, and ClassDiagram::writeFigure().

◆ endCompoundTemplateParams()

void LatexGenerator::endCompoundTemplateParams ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 185 of file latexgen.h.

185{ m_t << "}\n"; }

References OutputGenerator::m_t.

◆ endConstraintDocs()

void LatexGenerator::endConstraintDocs ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2184 of file latexgen.cpp.

2185{
2186}

◆ endConstraintList()

void LatexGenerator::endConstraintList ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2188 of file latexgen.cpp.

2189{
2190 m_t << "\\end{description}\n";
2191 m_t << "\\end{Desc}\n";
2192}

References OutputGenerator::m_t.

◆ endConstraintParam()

void LatexGenerator::endConstraintParam ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2166 of file latexgen.cpp.

2167{
2168}

◆ endConstraintType()

void LatexGenerator::endConstraintType ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2175 of file latexgen.cpp.

2176{
2177 m_t << "}]";
2178}

References OutputGenerator::m_t.

◆ endContents()

void LatexGenerator::endContents ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 245 of file latexgen.h.

245{}

◆ endDescForItem()

void LatexGenerator::endDescForItem ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 226 of file latexgen.h.

226{}

◆ endDescTable()

void LatexGenerator::endDescTable ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 1913 of file latexgen.cpp.

1914{
1915 m_codeGen->decUsedTableLevel();
1916 m_t << "\\end{DoxyEnumFields}\n";
1917}

References m_codeGen, and OutputGenerator::m_t.

◆ endDescTableData()

void LatexGenerator::endDescTableData ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 1953 of file latexgen.cpp.

1954{
1955 m_t << "\\\\\n\\hline\n\n";
1956}

References OutputGenerator::m_t.

◆ endDescTableInit()

void LatexGenerator::endDescTableInit ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 1944 of file latexgen.cpp.

1945{
1946}

◆ endDescTableRow()

void LatexGenerator::endDescTableRow ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 1926 of file latexgen.cpp.

1927{
1928}

◆ endDescTableTitle()

void LatexGenerator::endDescTableTitle ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 1935 of file latexgen.cpp.

1936{
1937}

◆ endDirDepGraph()

void LatexGenerator::endDirDepGraph ( DotDirDeps & g)
overridevirtual

Implements OutputGenIntf.

Definition at line 2064 of file latexgen.cpp.

2065{
2067}
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)

References OutputGenerator::dir(), EPS, OutputGenerator::fileName(), LaTeX, m_relPath, OutputGenerator::m_t, and DotDirDeps::writeGraph().

◆ endDotGraph()

void LatexGenerator::endDotGraph ( DotClassGraph & g)
overridevirtual

Implements OutputGenIntf.

Definition at line 2028 of file latexgen.cpp.

2029{
2031}
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)

References OutputGenerator::dir(), EPS, OutputGenerator::fileName(), LaTeX, m_relPath, OutputGenerator::m_t, and DotClassGraph::writeGraph().

◆ endDoxyAnchor()

void LatexGenerator::endDoxyAnchor ( const QCString & ,
const QCString &  )
overridevirtual

Implements OutputGenIntf.

Definition at line 1657 of file latexgen.cpp.

1658{
1659}

◆ endEmphasis()

void LatexGenerator::endEmphasis ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 200 of file latexgen.h.

200{ m_t << "}"; }

References OutputGenerator::m_t.

◆ endExamples()

void LatexGenerator::endExamples ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2076 of file latexgen.cpp.

2077{
2078 m_t << "\\end{Desc}\n";
2079}

References OutputGenerator::m_t.

◆ endFile()

void LatexGenerator::endFile ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 720 of file latexgen.cpp.

721{
722 endPlainFile();
723 m_codeGen->setSourceFileName("");
724}
void endPlainFile() override
Definition latexgen.h:315

References endPlainFile(), and m_codeGen.

◆ endGroupCollaboration()

void LatexGenerator::endGroupCollaboration ( DotGroupCollaboration & g)
overridevirtual

Implements OutputGenIntf.

Definition at line 2046 of file latexgen.cpp.

2047{
2049}
QCString writeGraph(TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool writeImageMap=TRUE, int graphId=-1)

References OutputGenerator::dir(), EPS, OutputGenerator::fileName(), LaTeX, m_relPath, OutputGenerator::m_t, and DotGroupCollaboration::writeGraph().

◆ endGroupHeader()

void LatexGenerator::endGroupHeader ( int )
overridevirtual

Implements OutputGenIntf.

Definition at line 1538 of file latexgen.cpp.

1539{
1541 m_t << "}\n";
1542}
#define FALSE
Definition qcstring.h:34

References FALSE, m_disableLinks, and OutputGenerator::m_t.

◆ endHeaderSection()

void LatexGenerator::endHeaderSection ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 167 of file latexgen.h.

167{}

◆ endInclDepGraph()

void LatexGenerator::endInclDepGraph ( DotInclDepGraph & g)
overridevirtual

Implements OutputGenIntf.

Definition at line 2037 of file latexgen.cpp.

2038{
2040}
QCString writeGraph(TextStream &t, GraphOutputFormat gf, EmbeddedOutputFormat ef, const QCString &path, const QCString &fileName, const QCString &relPath, bool writeImageMap=TRUE, int graphId=-1)

References OutputGenerator::dir(), EPS, OutputGenerator::fileName(), LaTeX, m_relPath, OutputGenerator::m_t, and DotInclDepGraph::writeGraph().

◆ endIndent()

void LatexGenerator::endIndent ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 231 of file latexgen.h.

231{}

◆ endIndexItem()

void LatexGenerator::endIndexItem ( const QCString & ref,
const QCString & file )
overridevirtual

Implements OutputGenIntf.

Definition at line 1333 of file latexgen.cpp.

1334{
1335 if (ref.isEmpty() && !fn.isEmpty())
1336 {
1337 m_t << "}{\\pageref{" << stripPath(fn) << "}}{}\n";
1338 }
1339}

References QCString::isEmpty(), OutputGenerator::m_t, and stripPath().

◆ endIndexKey()

void LatexGenerator::endIndexKey ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 1355 of file latexgen.cpp.

1356{
1357}

◆ endIndexList()

void LatexGenerator::endIndexList ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 142 of file latexgen.h.

142{ m_t << "\\end{DoxyCompactList}\n"; }

References OutputGenerator::m_t.

◆ endIndexListItem()

void LatexGenerator::endIndexListItem ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 140 of file latexgen.h.

140{}

◆ endIndexSection()

void LatexGenerator::endIndexSection ( IndexSection is)
overridevirtual

Implements OutputGenIntf.

Definition at line 1078 of file latexgen.cpp.

1079{
1080 switch (is)
1081 {
1083 break;
1085 break;
1087 {
1089 {
1090 writePageLink(Doxygen::mainPage->getOutputFileBase(), FALSE);
1091 }
1092 }
1093 break;
1095 m_t << "}\n\\input{modules}\n";
1096 break;
1098 m_t << "}\n\\input{topics}\n";
1099 break;
1101 m_t << "}\n\\input{dirs}\n";
1102 break;
1104 m_t << "}\n\\input{namespaces}\n";
1105 break;
1107 m_t << "}\n\\input{concepts}\n";
1108 break;
1110 m_t << "}\n\\input{hierarchy}\n";
1111 break;
1113 m_t << "}\n\\input{annotated}\n";
1114 break;
1116 m_t << "}\n\\input{files}\n";
1117 break;
1119 m_t << "}\n\\input{pages}\n";
1120 break;
1122 {
1123 m_t << "}\n";
1124 for (const auto &gd : *Doxygen::groupLinkedMap)
1125 {
1126 if (!gd->isReference() && !gd->isASubGroup())
1127 {
1128 writePageLink(gd->getOutputFileBase(), FALSE);
1129 }
1130 }
1131 }
1132 break;
1134 {
1135 m_t << "}\n";
1136 for (const auto &mod : ModuleManager::instance().modules())
1137 {
1138 if (!mod->isReference() && mod->isPrimaryInterface())
1139 {
1140 writePageLink(mod->getOutputFileBase(), FALSE);
1141 }
1142 }
1143 }
1144 break;
1146 {
1147 bool found=FALSE;
1148 for (const auto &dd : *Doxygen::dirLinkedMap)
1149 {
1150 if (dd->isLinkableInProject())
1151 {
1152 if (!found)
1153 {
1154 m_t << "}\n";
1155 found = TRUE;
1156 }
1157 m_t << "\\input{" << dd->getOutputFileBase() << "}\n";
1158 }
1159 }
1160 }
1161 break;
1163 {
1164 bool found=FALSE;
1165 for (const auto &nd : *Doxygen::namespaceLinkedMap)
1166 {
1167 if (nd->isLinkableInProject() && !nd->isAlias())
1168 {
1169 if (!found)
1170 {
1171 m_t << "}\n";
1172 found=true;
1173 }
1174 m_t << "\\input{" << nd->getOutputFileBase() << "}\n";
1175 }
1176 }
1177 }
1178 break;
1180 {
1181 bool found=FALSE;
1182 for (const auto &cd : *Doxygen::conceptLinkedMap)
1183 {
1184 if (cd->isLinkableInProject() && !cd->isAlias())
1185 {
1186 if (!found)
1187 {
1188 m_t << "}\n";
1189 found=true;
1190 }
1191 m_t << "\\input{" << cd->getOutputFileBase() << "}\n";
1192 }
1193 }
1194 }
1195 break;
1197 {
1198 bool found=FALSE;
1199 for (const auto &cd : *Doxygen::classLinkedMap)
1200 {
1201 if (cd->isLinkableInProject() &&
1202 !cd->isImplicitTemplateInstance() &&
1203 !cd->isEmbeddedInOuterScope() &&
1204 !cd->isAlias()
1205 )
1206 {
1207 if (!found)
1208 {
1209 m_t << "}\n"; // end doxysection or chapter title
1210 found=TRUE;
1211 }
1212 m_t << "\\input{" << cd->getOutputFileBase() << "}\n";
1213 }
1214 }
1215 }
1216 break;
1218 {
1219 bool isFirst=TRUE;
1220 for (const auto &fn : *Doxygen::inputNameLinkedMap)
1221 {
1222 for (const auto &fd : *fn)
1223 {
1224 if (fd->isLinkableInProject())
1225 {
1226 if (isFirst)
1227 {
1228 m_t << "}\n"; // end doxysection or chapter title
1229 }
1230 isFirst=FALSE;
1231 m_t << "\\input{" << fd->getOutputFileBase() << "}\n";
1232 }
1233 if (fd->generateSourceFile())
1234 {
1235 if (isFirst)
1236 {
1237 m_t << "}\n"; // end doxysection or chapter title
1238 }
1239 isFirst=FALSE;
1240 m_t << "\\input{" << fd->getSourceFileBase() << "}\n";
1241 }
1242 }
1243 }
1244 }
1245 break;
1247 {
1248 m_t << "}\n";
1249 for (const auto &pd : *Doxygen::exampleLinkedMap)
1250 {
1251 m_t << "\\input{" << pd->getOutputFileBase() << "}\n";
1252 }
1253 }
1254 break;
1256 {
1257 for (const auto &pd : *Doxygen::pageLinkedMap)
1258 {
1259 if (!pd->getGroupDef() && !pd->isReference() && !pd->hasParentPage()
1260 && pd->name() != "citelist" && Doxygen::mainPage.get() != pd.get())
1261 {
1262 writePageLink(pd->getOutputFileBase(), FALSE);
1263 }
1264 }
1265 }
1266 break;
1268 break;
1271 break;
1272 }
1273}
static NamespaceLinkedMap * namespaceLinkedMap
Definition doxygen.h:115
static ConceptLinkedMap * conceptLinkedMap
Definition doxygen.h:98
static std::unique_ptr< PageDef > mainPage
Definition doxygen.h:101
static FileNameLinkedMap * inputNameLinkedMap
Definition doxygen.h:105
static ClassLinkedMap * classLinkedMap
Definition doxygen.h:96
static PageLinkedMap * exampleLinkedMap
Definition doxygen.h:99
static PageLinkedMap * pageLinkedMap
Definition doxygen.h:100
static DirLinkedMap * dirLinkedMap
Definition doxygen.h:129
static GroupLinkedMap * groupLinkedMap
Definition doxygen.h:114
void writePageLink(const QCString &, bool) override
static ModuleManager & instance()
static QCString g_footer
Definition htmlgen.cpp:67
static QCString g_footer_file
Definition htmlgen.cpp:66
@ isMainPage
Definition index.h:35
@ isTitlePageAuthor
Definition index.h:34
@ isFileIndex
Definition index.h:43
@ isFileDocumentation
Definition index.h:51
@ isPageDocumentation
Definition index.h:53
@ isDirDocumentation
Definition index.h:47
@ isModuleDocumentation
Definition index.h:45
@ isClassHierarchyIndex
Definition index.h:41
@ isModuleIndex
Definition index.h:36
@ isTopicIndex
Definition index.h:37
@ isConceptIndex
Definition index.h:40
@ isExampleDocumentation
Definition index.h:52
@ isClassDocumentation
Definition index.h:49
@ isPageIndex
Definition index.h:44
@ isCompoundIndex
Definition index.h:42
@ isEndIndex
Definition index.h:55
@ isConceptDocumentation
Definition index.h:50
@ isDirIndex
Definition index.h:38
@ isNamespaceIndex
Definition index.h:39
@ isNamespaceDocumentation
Definition index.h:48
@ isTitlePageStart
Definition index.h:33
@ isTopicDocumentation
Definition index.h:46
@ isPageDocumentation2
Definition index.h:54
static QCString substituteLatexKeywords(const QCString &file, const QCString &str, const QCString &title)
Definition latexgen.cpp:796
QCString convertToLaTeX(const QCString &s, bool insideTabbing, bool keepSpaces=FALSE)
#define TRUE
Definition qcstring.h:37
bool found
Definition util.cpp:984

References Doxygen::classLinkedMap, Doxygen::conceptLinkedMap, Config_getString, convertToLaTeX(), Doxygen::dirLinkedMap, Doxygen::exampleLinkedMap, FALSE, found, g_footer, g_footer_file, Doxygen::groupLinkedMap, Doxygen::inputNameLinkedMap, ModuleManager::instance(), isClassDocumentation, isClassHierarchyIndex, isCompoundIndex, isConceptDocumentation, isConceptIndex, isDirDocumentation, isDirIndex, isEndIndex, isExampleDocumentation, isFileDocumentation, isFileIndex, isMainPage, isModuleDocumentation, isModuleIndex, isNamespaceDocumentation, isNamespaceIndex, isPageDocumentation, isPageDocumentation2, isPageIndex, isTitlePageAuthor, isTitlePageStart, isTopicDocumentation, isTopicIndex, m_codeGen, OutputGenerator::m_t, Doxygen::mainPage, Doxygen::namespaceLinkedMap, Doxygen::pageLinkedMap, substituteLatexKeywords(), TRUE, and writePageLink().

◆ endIndexValue()

void LatexGenerator::endIndexValue ( const QCString & name,
bool  )
overridevirtual

Implements OutputGenIntf.

Definition at line 1365 of file latexgen.cpp.

1366{
1367 //if (hasBrief) m_t << ")";
1368 m_t << "}{\\pageref{" << stripPath(name) << "}}{}\n";
1369}

References OutputGenerator::m_t, and stripPath().

◆ endInlineHeader()

void LatexGenerator::endInlineHeader ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2206 of file latexgen.cpp.

2207{
2208 m_t << "}\n";
2209}

References OutputGenerator::m_t.

◆ endInlineMemberDoc()

void LatexGenerator::endInlineMemberDoc ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2280 of file latexgen.cpp.

2281{
2282 m_t << "\\\\\n\\hline\n\n";
2283}

References OutputGenerator::m_t.

◆ endInlineMemberName()

void LatexGenerator::endInlineMemberName ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2270 of file latexgen.cpp.

2271{
2272 m_t << "&\n";
2273 m_codeGen->setInsideTabbing(false);
2274}

References m_codeGen, and OutputGenerator::m_t.

◆ endInlineMemberType()

void LatexGenerator::endInlineMemberType ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2259 of file latexgen.cpp.

2260{
2261 m_t << "&\n";
2262 m_codeGen->setInsideTabbing(false);
2263}

References m_codeGen, and OutputGenerator::m_t.

◆ endItemList()

void LatexGenerator::endItemList ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 148 of file latexgen.h.

148{ m_t << "\\end{DoxyCompactItemize}\n"; }

References OutputGenerator::m_t.

◆ endItemListItem()

void LatexGenerator::endItemListItem ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 162 of file latexgen.h.

162{}

◆ endLabels()

void LatexGenerator::endLabels ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2296 of file latexgen.cpp.

2297{
2298}

◆ endMemberDeclaration()

void LatexGenerator::endMemberDeclaration ( const QCString & ,
const QCString &  )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 220 of file latexgen.h.

220{}

◆ endMemberDescription()

void LatexGenerator::endMemberDescription ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 1866 of file latexgen.cpp.

1867{
1868 if (!m_codeGen->insideTabbing())
1869 {
1870 //m_t << "\\item\\end{DoxyCompactList}";
1871 m_t << "\\end{DoxyCompactList}";
1872 }
1873 else
1874 {
1875 m_t << "}\\\\\n";
1876 }
1877}

References m_codeGen, and OutputGenerator::m_t.

◆ endMemberDoc()

void LatexGenerator::endMemberDoc ( bool )
overridevirtual

Implements OutputGenIntf.

Definition at line 1634 of file latexgen.cpp.

1635{
1637 m_t << "}\n\n";
1638 //if (Config_getBool(COMPACT_LATEX)) m_t << "\\hfill";
1639}

References FALSE, m_disableLinks, and OutputGenerator::m_t.

◆ endMemberDocList()

void LatexGenerator::endMemberDocList ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 173 of file latexgen.h.

173{}

◆ endMemberDocName()

void LatexGenerator::endMemberDocName ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 278 of file latexgen.h.

278{}

◆ endMemberDocPrefixItem()

void LatexGenerator::endMemberDocPrefixItem ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 276 of file latexgen.h.

276{ m_t << "\\\\\n"; }

References OutputGenerator::m_t.

◆ endMemberDocSimple()

void LatexGenerator::endMemberDocSimple ( bool isEnum)
overridevirtual

Implements OutputGenIntf.

Definition at line 2240 of file latexgen.cpp.

2241{
2242 m_insideTableEnv=false;
2243 m_codeGen->decUsedTableLevel();
2244 if (isEnum)
2245 {
2246 m_t << "\\end{DoxyEnumFields}\n";
2247 }
2248 else
2249 {
2250 m_t << "\\end{DoxyFields}\n";
2251 }
2252}

References m_codeGen, m_insideTableEnv, and OutputGenerator::m_t.

◆ endMemberGroup()

void LatexGenerator::endMemberGroup ( bool hasHeader)
overridevirtual

Implements OutputGenIntf.

Definition at line 2017 of file latexgen.cpp.

2018{
2019 if (hasHeader)m_t << "\\end{Indent}";
2020 m_t << "\n";
2021}

References OutputGenerator::m_t.

◆ endMemberGroupDocs()

void LatexGenerator::endMemberGroupDocs ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2008 of file latexgen.cpp.

2009{
2010 m_t << "}";
2011}

References OutputGenerator::m_t.

◆ endMemberGroupHeader()

void LatexGenerator::endMemberGroupHeader ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 1996 of file latexgen.cpp.

1997{
1998 // changed back to rev 756 due to bug 660501
1999 m_t << "}\\par\n";
2000 //m_t << "}\n";
2001}

References OutputGenerator::m_t.

◆ endMemberHeader()

void LatexGenerator::endMemberHeader ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 1556 of file latexgen.cpp.

1557{
1559 m_t << "}\n";
1560}

References FALSE, m_disableLinks, and OutputGenerator::m_t.

◆ endMemberItem()

void LatexGenerator::endMemberItem ( MemberItemType )
overridevirtual

Implements OutputGenIntf.

Definition at line 1843 of file latexgen.cpp.

1844{
1845 if (m_codeGen->insideTabbing())
1846 {
1847 m_t << "\\\\";
1848 }
1850 m_t << "\n";
1851}

References FALSE, m_codeGen, OutputGenerator::m_t, and m_templateMemberItem.

◆ endMemberList()

void LatexGenerator::endMemberList ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 1971 of file latexgen.cpp.

1972{
1973 //printf("LatexGenerator::endMemberList(%d)\n",m_codeGen->InsideTabbing());
1974 if (!m_codeGen->insideTabbing())
1975 {
1976 m_t << "\\end{DoxyCompactItemize}\n";
1977 }
1978}

References m_codeGen, and OutputGenerator::m_t.

◆ endMemberSections()

void LatexGenerator::endMemberSections ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 165 of file latexgen.h.

165{}

◆ endMemberSubtitle()

void LatexGenerator::endMemberSubtitle ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 171 of file latexgen.h.

171{}

◆ endMemberTemplateParams()

void LatexGenerator::endMemberTemplateParams ( const QCString & ,
const QCString &  )
overridevirtual

Implements OutputGenIntf.

Definition at line 1825 of file latexgen.cpp.

1826{
1828 {
1829 m_t << "}\\\\";
1830 }
1831}

References OutputGenerator::m_t, and m_templateMemberItem.

◆ endPageDoc()

void LatexGenerator::endPageDoc ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 126 of file latexgen.h.

126{}

◆ endPageRef()

void LatexGenerator::endPageRef ( const QCString & clname,
const QCString & anchor )
overridevirtual

Implements OutputGenIntf.

Definition at line 1454 of file latexgen.cpp.

1455{
1456 m_t << "}{";
1457 if (!clname.isEmpty()) m_t << clname;
1458 if (!anchor.isEmpty()) m_t << "_" << anchor;
1459 m_t << "}";
1460}

References QCString::isEmpty(), and OutputGenerator::m_t.

◆ endParagraph()

void LatexGenerator::endParagraph ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 1314 of file latexgen.cpp.

1315{
1316 m_t << "\n" << "\n";
1317}

References OutputGenerator::m_t.

◆ endParameterDefVal()

void LatexGenerator::endParameterDefVal ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 286 of file latexgen.h.

286{ endTypewriter(); }
void endTypewriter() override
Definition latexgen.h:158

References endTypewriter().

◆ endParameterExtra()

void LatexGenerator::endParameterExtra ( bool last,
bool one,
bool bracket )
overridevirtual

Implements OutputGenIntf.

Definition at line 2118 of file latexgen.cpp.

2119{
2120 m_t << "}";
2121 if (last)
2122 {
2123 m_t << "\\end{DoxyParamCaption}";
2124 if (closeBracket) m_t << ")";
2125 }
2126}

References OutputGenerator::m_t.

◆ endParameterList()

void LatexGenerator::endParameterList ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2088 of file latexgen.cpp.

2089{
2090}

◆ endParameterName()

void LatexGenerator::endParameterName ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2108 of file latexgen.cpp.

2109{
2110 m_t << "}";
2111}

References OutputGenerator::m_t.

◆ endParameterType()

void LatexGenerator::endParameterType ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2098 of file latexgen.cpp.

2099{
2100 m_t << "}]";
2101}

References OutputGenerator::m_t.

◆ endPlainFile()

void LatexGenerator::endPlainFile ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 315 of file latexgen.h.

References OutputGenerator::endPlainFile().

Referenced by endFile(), and writeStyleInfo().

◆ endProjectNumber()

void LatexGenerator::endProjectNumber ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 131 of file latexgen.h.

131{}

◆ endQuickIndices()

void LatexGenerator::endQuickIndices ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 238 of file latexgen.h.

238{}

◆ endSection()

void LatexGenerator::endSection ( const QCString & lab,
SectionType  )
overridevirtual

Implements OutputGenIntf.

Definition at line 1758 of file latexgen.cpp.

1759{
1760 m_t << "}\\label{" << lab << "}\n";
1761}

References OutputGenerator::m_t.

◆ endSmall()

void LatexGenerator::endSmall ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 216 of file latexgen.h.

216{ m_t << "\\normalsize "; }

References OutputGenerator::m_t.

◆ endTextBlock()

void LatexGenerator::endTextBlock ( bool )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 273 of file latexgen.h.

273{}

◆ endTextLink()

void LatexGenerator::endTextLink ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 1395 of file latexgen.cpp.

1396{
1397 bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
1398 if (!m_disableLinks && pdfHyperlinks)
1399 {
1400 m_t << "}";
1401 }
1402 m_t << "}";
1403}
#define Config_getBool(name)
Definition config.h:33

References Config_getBool, m_disableLinks, and OutputGenerator::m_t.

◆ endTitle()

void LatexGenerator::endTitle ( )
inlineprivate

Definition at line 320 of file latexgen.h.

320{ m_t << "}"; }

References OutputGenerator::m_t.

◆ endTitleHead()

void LatexGenerator::endTitleHead ( const QCString & fileName,
const QCString & name )
overridevirtual

Implements OutputGenIntf.

Definition at line 1477 of file latexgen.cpp.

1478{
1479 m_t << "}\n";
1480
1481 bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
1482 bool usePDFLatex = Config_getBool(USE_PDFLATEX);
1483 if (usePDFLatex && pdfHyperlinks && !fileName.isEmpty())
1484 {
1485 m_t << "\\hypertarget{" << stripPath(fileName) << "}{}";
1486 }
1487
1488 QCString fn = stripPath(fileName);
1489 if (!fn.isEmpty())
1490 {
1491 m_t << "\\label{" << fn << "}";
1492 }
1493 if (!name.isEmpty())
1494 {
1495 m_t << "\\index{";
1496 m_t << latexEscapeLabelName(name);
1497 m_t << "@{";
1498 m_t << latexEscapeIndexChars(name);
1499 m_t << "}}\n";
1500 }
1501}

References Config_getBool, OutputGenerator::fileName(), QCString::isEmpty(), latexEscapeIndexChars(), latexEscapeLabelName(), OutputGenerator::m_t, and stripPath().

◆ endTypewriter()

void LatexGenerator::endTypewriter ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 158 of file latexgen.h.

158{ m_t << "}"; }

References OutputGenerator::m_t.

Referenced by endParameterDefVal().

◆ exceptionEntry()

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

Implements OutputGenIntf.

Definition at line 2128 of file latexgen.cpp.

2129{
2130 if (!prefix.isEmpty())
2131 {
2132 m_t << " " << prefix << "(";
2133 }
2134 else if (closeBracket)
2135 {
2136 m_t << ")";
2137 }
2138 m_t << " ";
2139}
constexpr auto prefix
Definition anchor.cpp:44

References OutputGenerator::m_t, and prefix.

◆ init()

void LatexGenerator::init ( )
static

Definition at line 630 of file latexgen.cpp.

631{
632 QCString dname = Config_getString(LATEX_OUTPUT);
633 Dir d(dname.str());
634 if (!d.exists() && !d.mkdir(dname.str()))
635 {
636 term("Could not create output directory {}\n",dname);
637 }
638
639 if (!Config_getString(LATEX_HEADER).isEmpty())
640 {
641 g_header_file=Config_getString(LATEX_HEADER);
643 //printf("g_header='%s'\n",qPrint(g_header));
644 QCString result = substituteLatexKeywords(g_header_file,g_header,QCString());
646 }
647 else
648 {
649 g_header_file = "header.tex";
651 QCString result = substituteLatexKeywords(g_header_file,g_header,QCString());
652 checkBlocks(result,"<default header.tex>",latexMarkerInfo);
653 }
654 if (!Config_getString(LATEX_FOOTER).isEmpty())
655 {
656 g_footer_file=Config_getString(LATEX_FOOTER);
658 //printf("g_footer='%s'\n",qPrint(g_footer));
659 QCString result = substituteLatexKeywords(g_footer_file,g_footer,QCString());
661 }
662 else
663 {
664 g_footer_file = "footer.tex";
666 QCString result = substituteLatexKeywords(g_footer_file,g_footer,QCString());
667 checkBlocks(result,"<default footer.tex>",latexMarkerInfo);
668 }
669
671 writeMakeBat();
672
673 createSubDirs(d);
674}
static ResourceMgr & instance()
Returns the one and only instance of this class.
QCString getAsString(const QCString &name) const
Gets the resource data as a C string.
static QCString g_header
Definition htmlgen.cpp:64
static QCString g_header_file
Definition htmlgen.cpp:65
static void writeLatexMakefile()
Definition latexgen.cpp:364
static const SelectionMarkerInfo latexMarkerInfo
Definition latexgen.cpp:55
static void writeMakeBat()
Definition latexgen.cpp:500
#define term(fmt,...)
Definition message.h:137
void checkBlocks(const QCString &s, const QCString fileName, const SelectionMarkerInfo &markerInfo)
Definition util.cpp:6998
QCString fileToString(const QCString &name, bool filter, bool isSourceCode)
Definition util.cpp:1441
void createSubDirs(const Dir &d)
Definition util.cpp:4149

References checkBlocks(), Config_getString, createSubDirs(), Dir::exists(), fileToString(), g_footer, g_footer_file, g_header, g_header_file, ResourceMgr::getAsString(), ResourceMgr::instance(), latexMarkerInfo, Dir::mkdir(), QCString::str(), substituteLatexKeywords(), term, writeLatexMakefile(), and writeMakeBat().

Referenced by generateOutput().

◆ insertMemberAlign()

void LatexGenerator::insertMemberAlign ( bool )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 194 of file latexgen.h.

194{}

◆ insertMemberAlignLeft()

void LatexGenerator::insertMemberAlignLeft ( MemberItemType ,
bool  )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 195 of file latexgen.h.

195{}

◆ lastIndexPage()

void LatexGenerator::lastIndexPage ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 1958 of file latexgen.cpp.

1959{
1960}

◆ lineBreak()

void LatexGenerator::lineBreak ( const QCString & style = QCString())
overridevirtual

Implements OutputGenIntf.

Definition at line 2211 of file latexgen.cpp.

2212{
2213 if (m_codeGen->insideTabbing())
2214 {
2215 m_t << "\\\\\n";
2216 }
2217 else
2218 {
2219 m_t << "\\newline\n";
2220 }
2221}

References m_codeGen, and OutputGenerator::m_t.

◆ operator=() [1/2]

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

Definition at line 339 of file latexgen.cpp.

340{
341 if (this!=&og)
342 {
343 m_dir = og.m_dir;
344 m_codeList = std::make_unique<OutputCodeList>(*og.m_codeList);
345 m_codeGen = m_codeList->get<LatexCodeGenerator>(OutputType::Latex);
346 m_codeGen->setTextStream(&m_t);
349 m_relPath = og.m_relPath;
350 m_indent = og.m_indent;
353 }
354 return *this;
355}

References Latex, LatexGenerator(), m_codeGen, m_codeList, OutputGenerator::m_dir, m_disableLinks, m_firstDescItem, m_hierarchyLevel, m_indent, m_relPath, OutputGenerator::m_t, and m_templateMemberItem.

◆ operator=() [2/2]

LatexGenerator & LatexGenerator::operator= ( LatexGenerator && )
delete

References LatexGenerator().

◆ setCurrentDoc()

void LatexGenerator::setCurrentDoc ( const Definition * ,
const QCString & ,
bool  )
inline

Definition at line 109 of file latexgen.h.

109{}

◆ startAnonTypeScope()

void LatexGenerator::startAnonTypeScope ( int indent)
overridevirtual

Implements OutputGenIntf.

Definition at line 1796 of file latexgen.cpp.

1797{
1798 if (indent==0)
1799 {
1800 m_t << "\\begin{tabbing}\n";
1801 m_t << "xx\\=xx\\=xx\\=xx\\=xx\\=xx\\=xx\\=xx\\=xx\\=\\kill\n";
1802 m_codeGen->setInsideTabbing(true);
1803 }
1804 m_indent=indent;
1805}

References m_codeGen, m_indent, and OutputGenerator::m_t.

◆ startBold()

void LatexGenerator::startBold ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 201 of file latexgen.h.

201{ m_t << "{\\bfseries "; }

References OutputGenerator::m_t.

◆ startCallGraph()

void LatexGenerator::startCallGraph ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2051 of file latexgen.cpp.

2052{
2053}

◆ startCenter()

void LatexGenerator::startCenter ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 213 of file latexgen.h.

213{ m_t << "\\begin{center}\n"; }

References OutputGenerator::m_t.

◆ startClassDiagram()

void LatexGenerator::startClassDiagram ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 1783 of file latexgen.cpp.

1784{
1785 //if (Config_getBool(COMPACT_LATEX)) m_t << "\\doxysubsubsection"; else m_t << "\\doxysubsection";
1786 //m_t << "{";
1787}

◆ startCompoundTemplateParams()

void LatexGenerator::startCompoundTemplateParams ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 184 of file latexgen.h.

184{ m_t << "\\subsubsection*{";}

References OutputGenerator::m_t.

◆ startConstraintDocs()

void LatexGenerator::startConstraintDocs ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2180 of file latexgen.cpp.

2181{
2182}

◆ startConstraintList()

void LatexGenerator::startConstraintList ( const QCString & header)
overridevirtual

Implements OutputGenIntf.

Definition at line 2153 of file latexgen.cpp.

2154{
2155 m_t << "\\begin{Desc}\n\\item[";
2156 docify(header);
2157 m_t << "]";
2158 m_t << "\\begin{description}\n";
2159}
void docify(const QCString &text) override

References docify(), and OutputGenerator::m_t.

◆ startConstraintParam()

void LatexGenerator::startConstraintParam ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2161 of file latexgen.cpp.

2162{
2163 m_t << "\\item[{\\em ";
2164}

References OutputGenerator::m_t.

◆ startConstraintType()

void LatexGenerator::startConstraintType ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2170 of file latexgen.cpp.

2171{
2172 m_t << "} : {\\em ";
2173}

References OutputGenerator::m_t.

◆ startContents()

void LatexGenerator::startContents ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 244 of file latexgen.h.

244{}

◆ startDescForItem()

void LatexGenerator::startDescForItem ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 225 of file latexgen.h.

225{ m_t << "\\par\n"; }

References OutputGenerator::m_t.

◆ startDescTable()

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

Implements OutputGenIntf.

Definition at line 1907 of file latexgen.cpp.

1908{
1909 m_codeGen->incUsedTableLevel();
1910 m_t << "\\begin{DoxyEnumFields}[" << (hasInits?3:2) << "]{" << title << "}\n";
1911}

References m_codeGen, and OutputGenerator::m_t.

◆ startDescTableData()

void LatexGenerator::startDescTableData ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 1948 of file latexgen.cpp.

1949{
1950 m_t << "&";
1951}

References OutputGenerator::m_t.

◆ startDescTableInit()

void LatexGenerator::startDescTableInit ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 1939 of file latexgen.cpp.

1940{
1941 m_t << "&";
1942}

References OutputGenerator::m_t.

◆ startDescTableRow()

void LatexGenerator::startDescTableRow ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 1919 of file latexgen.cpp.

1920{
1921 // this is needed to prevent the \hypertarget, \label, and \index commands from messing up
1922 // the row height (based on http://tex.stackexchange.com/a/186102)
1923 m_t << "\\raisebox{\\heightof{T}}[0pt][0pt]{";
1924}

References OutputGenerator::m_t.

◆ startDescTableTitle()

void LatexGenerator::startDescTableTitle ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 1930 of file latexgen.cpp.

1931{
1932 m_t << "}";
1933}

References OutputGenerator::m_t.

◆ startDirDepGraph()

void LatexGenerator::startDirDepGraph ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2060 of file latexgen.cpp.

2061{
2062}

◆ startDotGraph()

void LatexGenerator::startDotGraph ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2023 of file latexgen.cpp.

2024{
2025 m_t << "\n" << "\n";
2026}

References OutputGenerator::m_t.

◆ startDoxyAnchor()

void LatexGenerator::startDoxyAnchor ( const QCString & fName,
const QCString & ,
const QCString & anchor,
const QCString & ,
const QCString &  )
overridevirtual

Implements OutputGenIntf.

Definition at line 1641 of file latexgen.cpp.

1644{
1645 bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
1646 bool usePDFLatex = Config_getBool(USE_PDFLATEX);
1647 if (m_insideTableEnv) m_t << "\\mbox{"; // see issue #6093
1648 if (usePDFLatex && pdfHyperlinks)
1649 {
1650 m_t << "\\Hypertarget{";
1651 if (!fName.isEmpty()) m_t << stripPath(fName);
1652 if (!anchor.isEmpty()) m_t << "_" << anchor;
1653 m_t << "}";
1654 }
1655}

References Config_getBool, QCString::isEmpty(), m_insideTableEnv, OutputGenerator::m_t, and stripPath().

◆ startEmphasis()

void LatexGenerator::startEmphasis ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 199 of file latexgen.h.

199{ m_t << "{\\em "; }

References OutputGenerator::m_t.

◆ startExamples()

void LatexGenerator::startExamples ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2069 of file latexgen.cpp.

2070{
2071 m_t << "\\begin{Desc}\n\\item[";
2073 m_t << "]";
2074}
virtual QCString trExamples()=0
Translator * theTranslator
Definition language.cpp:71

References docify(), OutputGenerator::m_t, and theTranslator.

◆ startFile()

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

Implements OutputGenIntf.

Definition at line 706 of file latexgen.cpp.

707{
708#if 0
709 setEncoding(Config_getString(LATEX_OUTPUT_ENCODING));
710#endif
711 QCString fileName=name;
712 m_hierarchyLevel = hierarchyLevel;
714 if (!fileName.endsWith(".tex") && !fileName.endsWith(".sty")) fileName+=".tex";
716 m_codeGen->setRelativePath(m_relPath);
717 m_codeGen->setSourceFileName(stripPath(fileName));
718}
void startPlainFile(const QCString &name) override
Definition latexgen.h:314
QCString relativePathToRoot(const QCString &name)
Definition util.cpp:4088

References Config_getString, OutputGenerator::fileName(), m_codeGen, m_hierarchyLevel, m_relPath, relativePathToRoot(), startPlainFile(), and stripPath().

◆ startGroupCollaboration()

void LatexGenerator::startGroupCollaboration ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2042 of file latexgen.cpp.

2043{
2044}

◆ startGroupHeader()

void LatexGenerator::startGroupHeader ( int extraIndentLevel)
overridevirtual

Implements OutputGenIntf.

Definition at line 1515 of file latexgen.cpp.

1516{
1517 if (Config_getBool(COMPACT_LATEX))
1518 {
1519 extraIndentLevel++;
1520 }
1521
1522 if (extraIndentLevel>=3)
1523 {
1524 m_t << "\\doxysubparagraph*{";
1525 }
1526 else if (extraIndentLevel==2)
1527 {
1528 m_t << "\\doxyparagraph{";
1529 }
1530 else
1531 {
1532 extraIndentLevel += m_hierarchyLevel + 1;
1533 m_t << "\\doxy" << QCString("sub").repeat(extraIndentLevel) << "section{";
1534 }
1536}

References Config_getBool, m_disableLinks, m_hierarchyLevel, OutputGenerator::m_t, QCString::repeat(), and TRUE.

◆ startHeaderSection()

void LatexGenerator::startHeaderSection ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 166 of file latexgen.h.

166{}

◆ startInclDepGraph()

void LatexGenerator::startInclDepGraph ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2033 of file latexgen.cpp.

2034{
2035}

◆ startIndent()

void LatexGenerator::startIndent ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 230 of file latexgen.h.

230{}

◆ startIndexItem()

void LatexGenerator::startIndexItem ( const QCString & ref,
const QCString & file )
overridevirtual

Implements OutputGenIntf.

Definition at line 1324 of file latexgen.cpp.

1325{
1326 m_t << "\\item ";
1327 if (ref.isEmpty() && !fn.isEmpty())
1328 {
1329 m_t << "\\contentsline{section}{";
1330 }
1331}

References QCString::isEmpty(), and OutputGenerator::m_t.

◆ startIndexKey()

void LatexGenerator::startIndexKey ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 1350 of file latexgen.cpp.

1351{
1352 m_t << "\\item\\contentsline{section}{";
1353}

References OutputGenerator::m_t.

◆ startIndexList()

void LatexGenerator::startIndexList ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 141 of file latexgen.h.

141{ m_t << "\\begin{DoxyCompactList}\n"; }

References OutputGenerator::m_t.

◆ startIndexListItem()

void LatexGenerator::startIndexListItem ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 139 of file latexgen.h.

139{}

◆ startIndexSection()

void LatexGenerator::startIndexSection ( IndexSection is)
overridevirtual

Implements OutputGenIntf.

Definition at line 912 of file latexgen.cpp.

913{
914 bool compactLatex = Config_getBool(COMPACT_LATEX);
915 switch (is)
916 {
919 break;
921 break;
923 break;
925 if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
926 m_t << "{"; //Module Index}\n"
927 break;
929 if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
930 m_t << "{"; //Topic Index}\n"
931 break;
933 if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
934 m_t << "{"; //Directory Index}\n"
935 break;
937 if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
938 m_t << "{"; //Namespace Index}\n"
939 break;
941 if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
942 m_t << "{"; //Concept Index}\n"
943 break;
945 if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
946 m_t << "{"; //Hierarchical Index}\n"
947 break;
949 if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
950 m_t << "{"; //Annotated Compound Index}\n"
951 break;
953 if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
954 m_t << "{"; //Annotated File Index}\n"
955 break;
957 if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
958 m_t << "{"; //Annotated Page Index}\n"
959 break;
961 {
962 for (const auto &gd : *Doxygen::groupLinkedMap)
963 {
964 if (!gd->isReference())
965 {
966 if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
967 m_t << "{"; //Topic Documentation}\n";
968 break;
969 }
970 }
971 }
972 break;
974 {
975 for (const auto &mod : ModuleManager::instance().modules())
976 {
977 if (!mod->isReference() && mod->isPrimaryInterface())
978 {
979 if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
980 m_t << "{"; //Topic Documentation}\n";
981 break;
982 }
983 }
984 }
985 break;
987 {
988 for (const auto &dd : *Doxygen::dirLinkedMap)
989 {
990 if (dd->isLinkableInProject())
991 {
992 if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
993 m_t << "{"; //Dir Documentation}\n";
994 break;
995 }
996 }
997 }
998 break;
1000 {
1001 for (const auto &nd : *Doxygen::namespaceLinkedMap)
1002 {
1003 if (nd->isLinkableInProject() && !nd->isAlias())
1004 {
1005 if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
1006 m_t << "{"; // Namespace Documentation}\n":
1007 break;
1008 }
1009 }
1010 }
1011 break;
1013 {
1014 for (const auto &cd : *Doxygen::conceptLinkedMap)
1015 {
1016 if (cd->isLinkableInProject() && !cd->isAlias())
1017 {
1018 if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
1019 m_t << "{"; // Concept Documentation}\n":
1020 break;
1021 }
1022 }
1023 }
1024 break;
1026 {
1027 for (const auto &cd : *Doxygen::classLinkedMap)
1028 {
1029 if (cd->isLinkableInProject() &&
1030 !cd->isImplicitTemplateInstance() &&
1031 !cd->isEmbeddedInOuterScope() &&
1032 !cd->isAlias()
1033 )
1034 {
1035 if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
1036 m_t << "{"; //Compound Documentation}\n";
1037 break;
1038 }
1039 }
1040 }
1041 break;
1043 {
1044 bool isFirst=TRUE;
1045 for (const auto &fn : *Doxygen::inputNameLinkedMap)
1046 {
1047 for (const auto &fd : *fn)
1048 {
1049 if (fd->isLinkableInProject() || fd->generateSourceFile())
1050 {
1051 if (isFirst)
1052 {
1053 if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
1054 m_t << "{"; //File Documentation}\n";
1055 isFirst=FALSE;
1056 break;
1057 }
1058 }
1059 }
1060 }
1061 }
1062 break;
1064 {
1065 if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";
1066 m_t << "{"; //Example Documentation}\n";
1067 }
1068 break;
1070 break;
1072 break;
1074 break;
1075 }
1076}

References Doxygen::classLinkedMap, Doxygen::conceptLinkedMap, Config_getBool, Config_getString, convertToLaTeX(), Doxygen::dirLinkedMap, FALSE, g_header, g_header_file, Doxygen::groupLinkedMap, Doxygen::inputNameLinkedMap, ModuleManager::instance(), isClassDocumentation, isClassHierarchyIndex, isCompoundIndex, isConceptDocumentation, isConceptIndex, isDirDocumentation, isDirIndex, isEndIndex, isExampleDocumentation, isFileDocumentation, isFileIndex, isMainPage, isModuleDocumentation, isModuleIndex, isNamespaceDocumentation, isNamespaceIndex, isPageDocumentation, isPageDocumentation2, isPageIndex, isTitlePageAuthor, isTitlePageStart, isTopicDocumentation, isTopicIndex, m_codeGen, OutputGenerator::m_t, Doxygen::namespaceLinkedMap, substituteLatexKeywords(), and TRUE.

◆ startIndexValue()

void LatexGenerator::startIndexValue ( bool hasBrief)
overridevirtual

Implements OutputGenIntf.

Definition at line 1359 of file latexgen.cpp.

1360{
1361 m_t << " ";
1362 if (hasBrief) m_t << "\\\\*";
1363}

References OutputGenerator::m_t.

◆ startInlineHeader()

void LatexGenerator::startInlineHeader ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2194 of file latexgen.cpp.

2195{
2196 if (Config_getBool(COMPACT_LATEX))
2197 {
2198 m_t << "\\doxyparagraph*{";
2199 }
2200 else
2201 {
2202 m_t << "\\doxy" << QCString("sub").repeat(m_hierarchyLevel + 1) << "section*{";
2203 }
2204}

References Config_getBool, m_hierarchyLevel, OutputGenerator::m_t, and QCString::repeat().

◆ startInlineMemberDoc()

void LatexGenerator::startInlineMemberDoc ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2276 of file latexgen.cpp.

2277{
2278}

◆ startInlineMemberName()

void LatexGenerator::startInlineMemberName ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2265 of file latexgen.cpp.

2266{
2267 m_codeGen->setInsideTabbing(true); // to prevent \+ from causing unwanted breaks
2268}

References m_codeGen.

◆ startInlineMemberType()

void LatexGenerator::startInlineMemberType ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2254 of file latexgen.cpp.

2255{
2256 m_codeGen->setInsideTabbing(true); // to prevent \+ from causing unwanted breaks
2257}

References m_codeGen.

◆ startItemList()

void LatexGenerator::startItemList ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 147 of file latexgen.h.

147{ m_t << "\\begin{DoxyCompactItemize}\n"; }

References OutputGenerator::m_t.

◆ startItemListItem()

void LatexGenerator::startItemListItem ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 161 of file latexgen.h.

161{ m_t << "\\item \n"; }

References OutputGenerator::m_t.

◆ startLabels()

void LatexGenerator::startLabels ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2285 of file latexgen.cpp.

2286{
2287 m_t << "\\hspace{0.3cm}";
2288}

References OutputGenerator::m_t.

◆ startMemberDeclaration()

void LatexGenerator::startMemberDeclaration ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 219 of file latexgen.h.

219{}

◆ startMemberDescription()

void LatexGenerator::startMemberDescription ( const QCString & ,
const QCString & ,
bool  )
overridevirtual

Implements OutputGenIntf.

Definition at line 1853 of file latexgen.cpp.

1854{
1855 if (!m_codeGen->insideTabbing())
1856 {
1857 m_t << "\\begin{DoxyCompactList}\\small\\item\\em ";
1858 }
1859 else
1860 {
1861 for (int i=0;i<m_indent+2;i++) m_t << "\\>";
1862 m_t << "{\\em ";
1863 }
1864}

References m_codeGen, m_indent, and OutputGenerator::m_t.

◆ startMemberDoc()

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

Implements OutputGenIntf.

Definition at line 1562 of file latexgen.cpp.

1569{
1570 if (!memname.isEmpty() && memname[0]!='@')
1571 {
1572 m_t << "\\index{";
1573 if (!clname.isEmpty())
1574 {
1575 m_t << latexEscapeLabelName(clname);
1576 m_t << "@{";
1577 m_t << latexEscapeIndexChars(clname);
1578 m_t << "}!";
1579 }
1580 m_t << latexEscapeLabelName(memname);
1581 m_t << "@{";
1582 m_t << latexEscapeIndexChars(memname);
1583 m_t << "}}\n";
1584
1585 m_t << "\\index{";
1586 m_t << latexEscapeLabelName(memname);
1587 m_t << "@{";
1588 m_t << latexEscapeIndexChars(memname);
1589 m_t << "}";
1590 if (!clname.isEmpty())
1591 {
1592 m_t << "!";
1593 m_t << latexEscapeLabelName(clname);
1594 m_t << "@{";
1595 m_t << latexEscapeIndexChars(clname);
1596 m_t << "}";
1597 }
1598 m_t << "}\n";
1599 }
1600 bool compactLatex = Config_getBool(COMPACT_LATEX);
1601 bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
1602 if (showInline)
1603 {
1604 m_t << "\\doxysubparagraph";
1605 }
1606 else if (compactLatex)
1607 {
1608 m_t << "\\doxyparagraph";
1609 }
1610 else
1611 {
1612 m_t << "\\doxy" << QCString("sub").repeat(m_hierarchyLevel + 2) << "section";
1613 }
1614
1615 m_t << "{";
1616 if (pdfHyperlinks)
1617 {
1618 m_t << "\\texorpdfstring{";
1619 }
1620 m_t << latexEscapeIndexChars(title);
1621 if (pdfHyperlinks)
1622 {
1623 m_t << "}{" << latexEscapePDFString(title) << "}";
1624 }
1625 if (memTotal>1)
1626 {
1627 m_t << "\\hspace{0.1cm}{\\footnotesize\\ttfamily [" << memCount << "/" << memTotal << "]}";
1628 }
1629 m_t << "}";
1630 m_t << "\n{\\footnotesize\\ttfamily ";
1631 //m_disableLinks=TRUE;
1632}
QCString latexEscapePDFString(const QCString &s)

References Config_getBool, QCString::isEmpty(), latexEscapeIndexChars(), latexEscapeLabelName(), latexEscapePDFString(), m_hierarchyLevel, OutputGenerator::m_t, and QCString::repeat().

◆ startMemberDocList()

void LatexGenerator::startMemberDocList ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 172 of file latexgen.h.

172{}

◆ startMemberDocName()

void LatexGenerator::startMemberDocName ( bool )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 277 of file latexgen.h.

277{}

◆ startMemberDocPrefixItem()

void LatexGenerator::startMemberDocPrefixItem ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 275 of file latexgen.h.

275{}

◆ startMemberDocSimple()

void LatexGenerator::startMemberDocSimple ( bool isEnum)
overridevirtual

Implements OutputGenIntf.

Definition at line 2223 of file latexgen.cpp.

2224{
2225 m_codeGen->incUsedTableLevel();
2226 if (isEnum)
2227 {
2228 m_t << "\\begin{DoxyEnumFields}{";
2230 }
2231 else
2232 {
2233 m_t << "\\begin{DoxyFields}{";
2235 }
2236 m_t << "}\n";
2237 m_insideTableEnv=true;
2238}
virtual QCString trEnumerationValues()=0
virtual QCString trCompoundMembers()=0

References docify(), m_codeGen, m_insideTableEnv, OutputGenerator::m_t, and theTranslator.

◆ startMemberGroup()

void LatexGenerator::startMemberGroup ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2013 of file latexgen.cpp.

2014{
2015}

◆ startMemberGroupDocs()

void LatexGenerator::startMemberGroupDocs ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2003 of file latexgen.cpp.

2004{
2005 m_t << "{\\em ";
2006}

References OutputGenerator::m_t.

◆ startMemberGroupHeader()

void LatexGenerator::startMemberGroupHeader ( bool hasHeader)
overridevirtual

Implements OutputGenIntf.

Definition at line 1981 of file latexgen.cpp.

1982{
1983 if (hasHeader) m_t << "\\begin{Indent}";
1984 m_t << "\\textbf{ ";
1985 // changed back to rev 756 due to bug 660501
1986 //if (Config_getBool(COMPACT_LATEX))
1987 //{
1988 // m_t << "\\doxysubparagraph*{";
1989 //}
1990 //else
1991 //{
1992 // m_t << "\\doxyparagraph*{";
1993 //}
1994}

References OutputGenerator::m_t.

◆ startMemberHeader()

void LatexGenerator::startMemberHeader ( const QCString & ,
int  )
overridevirtual

Implements OutputGenIntf.

Definition at line 1544 of file latexgen.cpp.

1545{
1546 int l = m_hierarchyLevel + 1;
1547 if (Config_getBool(COMPACT_LATEX))
1548 {
1549 ++l;
1550 }
1551
1552 m_t << "\\doxysub" << QCString("sub").repeat(l) << "section*{";
1554}

References Config_getBool, m_disableLinks, m_hierarchyLevel, OutputGenerator::m_t, QCString::repeat(), and TRUE.

◆ startMemberItem()

void LatexGenerator::startMemberItem ( const QCString & ,
MemberItemType type,
const QCString &  )
overridevirtual

Implements OutputGenIntf.

Definition at line 1833 of file latexgen.cpp.

1834{
1835 //printf("LatexGenerator::startMemberItem(%d)\n",annType);
1836 if (!m_codeGen->insideTabbing())
1837 {
1838 m_t << "\\item \n";
1840 }
1841}
OutputType type() const override
Definition latexgen.h:114

References m_codeGen, OutputGenerator::m_t, m_templateMemberItem, OutputGenerator::Templated, and type().

◆ startMemberList()

void LatexGenerator::startMemberList ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 1963 of file latexgen.cpp.

1964{
1965 if (!m_codeGen->insideTabbing())
1966 {
1967 m_t << "\\begin{DoxyCompactItemize}\n";
1968 }
1969}

References m_codeGen, and OutputGenerator::m_t.

◆ startMemberSections()

void LatexGenerator::startMemberSections ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 164 of file latexgen.h.

164{}

◆ startMemberSubtitle()

void LatexGenerator::startMemberSubtitle ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 170 of file latexgen.h.

170{}

◆ startMemberTemplateParams()

void LatexGenerator::startMemberTemplateParams ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 1817 of file latexgen.cpp.

1818{
1820 {
1821 m_t << "{\\footnotesize ";
1822 }
1823}

References OutputGenerator::m_t, and m_templateMemberItem.

◆ startPageDoc()

void LatexGenerator::startPageDoc ( const QCString & )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 125 of file latexgen.h.

125{}

◆ startPageRef()

void LatexGenerator::startPageRef ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 1449 of file latexgen.cpp.

1450{
1451 m_t << " \\doxyref{}{";
1452}

References OutputGenerator::m_t.

◆ startParagraph()

void LatexGenerator::startParagraph ( const QCString & classDef)
overridevirtual

Implements OutputGenIntf.

Definition at line 1309 of file latexgen.cpp.

1310{
1311 m_t << "\n" << "\n";
1312}

References OutputGenerator::m_t.

◆ startParameterDefVal()

void LatexGenerator::startParameterDefVal ( const char * s)
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 285 of file latexgen.h.

285{ docify(s); startTypewriter(); }
void startTypewriter() override
Definition latexgen.h:157

References docify(), and startTypewriter().

◆ startParameterExtra()

void LatexGenerator::startParameterExtra ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 2113 of file latexgen.cpp.

2114{
2115 m_t << "{";
2116}

References OutputGenerator::m_t.

◆ startParameterList()

void LatexGenerator::startParameterList ( bool openBracket)
overridevirtual

Implements OutputGenIntf.

Definition at line 2081 of file latexgen.cpp.

2082{
2083 /* start of ParameterType ParameterName list */
2084 if (openBracket) m_t << "(";
2085 m_t << "\\begin{DoxyParamCaption}";
2086}

References OutputGenerator::m_t.

◆ startParameterName()

void LatexGenerator::startParameterName ( bool )
overridevirtual

Implements OutputGenIntf.

Definition at line 2103 of file latexgen.cpp.

2104{
2105 m_t << "{";
2106}

References OutputGenerator::m_t.

◆ startParameterType()

void LatexGenerator::startParameterType ( bool first,
const QCString & key )
overridevirtual

Implements OutputGenIntf.

Definition at line 2092 of file latexgen.cpp.

2093{
2094 m_t << "\\item[{";
2095 if (!first && !key.isEmpty()) docify(key);
2096}

References docify(), QCString::isEmpty(), and OutputGenerator::m_t.

◆ startPlainFile()

void LatexGenerator::startPlainFile ( const QCString & name)
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 314 of file latexgen.h.

void startPlainFile(const QCString &name)
Definition outputgen.cpp:32

References OutputGenerator::startPlainFile().

Referenced by startFile(), and writeStyleInfo().

◆ startProjectNumber()

void LatexGenerator::startProjectNumber ( )
overridevirtual

Implements OutputGenIntf.

Definition at line 731 of file latexgen.cpp.

732{
733 m_t << "\\\\[1ex]\\large ";
734}

References OutputGenerator::m_t.

◆ startQuickIndices()

void LatexGenerator::startQuickIndices ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 237 of file latexgen.h.

237{}

◆ startSection()

void LatexGenerator::startSection ( const QCString & lab,
const QCString & ,
SectionType type )
overridevirtual

Implements OutputGenIntf.

Definition at line 1717 of file latexgen.cpp.

1718{
1719 bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
1720 bool usePDFLatex = Config_getBool(USE_PDFLATEX);
1721 if (usePDFLatex && pdfHyperlinks)
1722 {
1723 m_t << "\\hypertarget{" << stripPath(lab) << "}{}";
1724 }
1725 m_t << "\\";
1726 if (Config_getBool(COMPACT_LATEX))
1727 {
1728 switch(type.level())
1729 {
1730 case SectionType::Page: m_t << "doxysubsection"; break;
1731 case SectionType::Section: m_t << "doxysubsubsection"; break;
1732 case SectionType::Subsection: m_t << "doxysubsubsubsection"; break;
1733 case SectionType::Subsubsection: m_t << "doxysubsubsubsubsection"; break;
1734 case SectionType::Paragraph: m_t << "doxysubsubsubsubsubsection"; break;
1735 case SectionType::Subparagraph: m_t << "doxysubsubsubsubsubsubsection"; break;
1736 case SectionType::Subsubparagraph: m_t << "doxysubsubsubsubsubsubsection"; break;
1737 default: ASSERT(0); break;
1738 }
1739 m_t << "{";
1740 }
1741 else
1742 {
1743 switch(type.level())
1744 {
1745 case SectionType::Page: m_t << "doxysection"; break;
1746 case SectionType::Section: m_t << "doxysubsection"; break;
1747 case SectionType::Subsection: m_t << "doxysubsubsection"; break;
1748 case SectionType::Subsubsection: m_t << "doxysubsubsubsection"; break;
1749 case SectionType::Paragraph: m_t << "doxysubsubsubsubsection"; break;
1750 case SectionType::Subparagraph: m_t << "doxysubsubsubsubsubsection"; break;
1751 case SectionType::Subsubparagraph: m_t << "doxysubsubsubsubsubsubsection"; break;
1752 default: ASSERT(0); break;
1753 }
1754 m_t << "{";
1755 }
1756}
static constexpr int Section
Definition section.h:33
static constexpr int Subsection
Definition section.h:34
static constexpr int Subsubsection
Definition section.h:35
static constexpr int Page
Definition section.h:31
static constexpr int Paragraph
Definition section.h:36
static constexpr int Subsubparagraph
Definition section.h:38
static constexpr int Subparagraph
Definition section.h:37
#define ASSERT(x)
Definition qcstring.h:39

References ASSERT, Config_getBool, OutputGenerator::m_t, SectionType::Page, SectionType::Paragraph, SectionType::Section, stripPath(), SectionType::Subparagraph, SectionType::Subsection, SectionType::Subsubparagraph, SectionType::Subsubsection, and type().

◆ startSmall()

void LatexGenerator::startSmall ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 215 of file latexgen.h.

215{ m_t << "\\footnotesize "; }

References OutputGenerator::m_t.

◆ startTextBlock()

void LatexGenerator::startTextBlock ( bool )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 272 of file latexgen.h.

272{}

◆ startTextLink()

void LatexGenerator::startTextLink ( const QCString & f,
const QCString & anchor )
overridevirtual

Implements OutputGenIntf.

Definition at line 1379 of file latexgen.cpp.

1380{
1381 bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
1382 if (!m_disableLinks && pdfHyperlinks)
1383 {
1384 m_t << "\\mbox{\\hyperlink{";
1385 if (!f.isEmpty()) m_t << stripPath(f);
1386 if (!anchor.isEmpty()) m_t << "_" << anchor;
1387 m_t << "}{";
1388 }
1389 else
1390 {
1391 m_t << "\\textbf{ ";
1392 }
1393}

References Config_getBool, QCString::isEmpty(), m_disableLinks, OutputGenerator::m_t, and stripPath().

◆ startTitle()

void LatexGenerator::startTitle ( )
private

Definition at line 1503 of file latexgen.cpp.

1504{
1505 if (Config_getBool(COMPACT_LATEX))
1506 {
1507 m_t << "\\doxysubsection{";
1508 }
1509 else
1510 {
1511 m_t << "\\doxysection{";
1512 }
1513}

References Config_getBool, and OutputGenerator::m_t.

◆ startTitleHead()

void LatexGenerator::startTitleHead ( const QCString & fileName)
overridevirtual

Implements OutputGenIntf.

Definition at line 1463 of file latexgen.cpp.

1464{
1465 int hierarchyLevel = m_hierarchyLevel;
1466 if (Config_getBool(COMPACT_LATEX))
1467 {
1468 ++hierarchyLevel;
1469 }
1470
1471 if (hierarchyLevel < 0)
1472 m_t << "\\chapter{";
1473 else
1474 m_t << "\\doxy" << QCString("sub").repeat(hierarchyLevel) << "section{";
1475}

References Config_getBool, OutputGenerator::fileName(), m_hierarchyLevel, OutputGenerator::m_t, and QCString::repeat().

◆ startTypewriter()

void LatexGenerator::startTypewriter ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 157 of file latexgen.h.

157{ m_t << "{\\ttfamily "; }

References OutputGenerator::m_t.

Referenced by startParameterDefVal().

◆ type()

OutputType LatexGenerator::type ( ) const
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 114 of file latexgen.h.

114{ return OutputType::Latex; }

References Latex.

Referenced by startMemberItem(), and startSection().

◆ writeAnchor()

void LatexGenerator::writeAnchor ( const QCString & fileName,
const QCString & name )
overridevirtual

Implements OutputGenIntf.

Definition at line 1670 of file latexgen.cpp.

1671{
1672 //printf("LatexGenerator::writeAnchor(%s,%s)\n",fName,name);
1673 m_t << "\\label{" << stripPath(name) << "}\n";
1674 bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
1675 bool usePDFLatex = Config_getBool(USE_PDFLATEX);
1676 if (usePDFLatex && pdfHyperlinks)
1677 {
1678 if (!fName.isEmpty())
1679 {
1680 m_t << "\\Hypertarget{" << stripPath(fName) << "_" << stripPath(name) << "}\n";
1681 }
1682 else
1683 {
1684 m_t << "\\Hypertarget{" << stripPath(name) << "}\n";
1685 }
1686 }
1687}

References Config_getBool, QCString::isEmpty(), OutputGenerator::m_t, and stripPath().

◆ writeChar()

void LatexGenerator::writeChar ( char c)
overridevirtual

Implements OutputGenIntf.

Definition at line 1775 of file latexgen.cpp.

1776{
1777 char cs[2];
1778 cs[0]=c;
1779 cs[1]=0;
1780 docify(cs);
1781}

References docify().

◆ writeDoc()

void LatexGenerator::writeDoc ( const IDocNodeAST * node,
const Definition * ctx,
const MemberDef * ,
int id )
overridevirtual

Implements OutputGenIntf.

Definition at line 2141 of file latexgen.cpp.

2142{
2143 const DocNodeAST *astImpl = dynamic_cast<const DocNodeAST*>(ast);
2144 if (astImpl)
2145 {
2146 LatexDocVisitor visitor(m_t,*m_codeList,*m_codeGen,
2147 ctx?ctx->getDefFileExtension():QCString(""),
2149 std::visit(visitor,astImpl->root);
2150 }
2151}
virtual QCString getDefFileExtension() const =0
DocNodeVariant root
Definition docnode.h:1481

References Definition::getDefFileExtension(), m_codeGen, m_codeList, m_hierarchyLevel, OutputGenerator::m_t, and DocNodeAST::root.

◆ writeFooter()

void LatexGenerator::writeFooter ( const QCString & )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 123 of file latexgen.h.

123{}

◆ writeFooterFile()

void LatexGenerator::writeFooterFile ( TextStream & t)
static

Definition at line 694 of file latexgen.cpp.

695{
696 t << "% Latex footer for doxygen " << getDoxygenVersion() << "\n";
697 t << ResourceMgr::instance().getAsString("footer.tex");
698}

References ResourceMgr::getAsString(), and ResourceMgr::instance().

Referenced by readConfiguration().

◆ writeGraphicalHierarchy()

void LatexGenerator::writeGraphicalHierarchy ( DotGfxHierarchyTable & )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 270 of file latexgen.h.

270{}

◆ writeHeaderFile()

void LatexGenerator::writeHeaderFile ( TextStream & t)
static

Definition at line 688 of file latexgen.cpp.

689{
690 t << "% Latex header for doxygen " << getDoxygenVersion() << "\n";
691 t << ResourceMgr::instance().getAsString("header.tex");
692}

References ResourceMgr::getAsString(), and ResourceMgr::instance().

Referenced by readConfiguration().

◆ writeInheritedSectionTitle()

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

Implements OutputGenIntf.

Definition at line 2300 of file latexgen.cpp.

2304{
2305 if (Config_getBool(COMPACT_LATEX))
2306 {
2307 m_t << "\\doxyparagraph*{";
2308 }
2309 else
2310 {
2311 m_t << "\\doxy" << QCString("sub").repeat(m_hierarchyLevel + 1) << "section*{";
2312 }
2313 m_t << theTranslator->trInheritedFrom(convertToLaTeX(title,m_codeGen->insideTabbing()),
2314 objectLinkToString(ref, file, anchor, name, m_codeGen->insideTabbing(), m_disableLinks));
2315 m_t << "}\n";
2316}
virtual QCString trInheritedFrom(const QCString &members, const QCString &what)=0
static QCString objectLinkToString(const QCString &, const QCString &f, const QCString &anchor, const QCString &text)

References Config_getBool, convertToLaTeX(), m_codeGen, m_disableLinks, m_hierarchyLevel, OutputGenerator::m_t, objectLinkToString(), QCString::repeat(), and theTranslator.

◆ writeLabel()

void LatexGenerator::writeLabel ( const QCString & l,
bool isLast )
overridevirtual

Implements OutputGenIntf.

Definition at line 2290 of file latexgen.cpp.

2291{
2292 m_t << "{\\ttfamily [" << l << "]}";
2293 if (!isLast) m_t << ", ";
2294}

References OutputGenerator::m_t.

◆ writeLatexSpacing()

void LatexGenerator::writeLatexSpacing ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 210 of file latexgen.h.

210{ m_t << "\\hspace{0.3cm}"; }

References OutputGenerator::m_t.

◆ writeLocalToc()

void LatexGenerator::writeLocalToc ( const SectionRefs & sr,
const LocalToc & lt )
overridevirtual

Implements OutputGenIntf.

Definition at line 2318 of file latexgen.cpp.

2319{
2320 if (localToc.isLatexEnabled())
2321 {
2322 int maxLevel = localToc.latexLevel() + m_hierarchyLevel;
2323 m_t << "\\etocsetnexttocdepth{" << maxLevel << "}\n";
2324 m_t << "\\localtableofcontents\n";
2325 }
2326}

References LocalToc::isLatexEnabled(), LocalToc::latexLevel(), m_hierarchyLevel, and OutputGenerator::m_t.

◆ writeLogo()

void LatexGenerator::writeLogo ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 241 of file latexgen.h.

241{}

◆ writeNavigationPath()

void LatexGenerator::writeNavigationPath ( const QCString & )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 240 of file latexgen.h.

240{}

◆ writeNonBreakableSpace()

void LatexGenerator::writeNonBreakableSpace ( int )
overridevirtual

Implements OutputGenIntf.

Definition at line 1880 of file latexgen.cpp.

1881{
1882 //printf("writeNonBreakableSpace()\n");
1883 if (m_codeGen->insideTabbing())
1884 {
1885 m_t << "\\>";
1886 }
1887 else
1888 {
1889 m_t << "~";
1890 }
1891}

References m_codeGen, and OutputGenerator::m_t.

◆ writeObjectLink()

void LatexGenerator::writeObjectLink ( const QCString & ref,
const QCString & file,
const QCString & anchor,
const QCString & name )
overridevirtual

Implements OutputGenIntf.

Definition at line 1443 of file latexgen.cpp.

1445{
1446 m_t << objectLinkToString(ref,f,anchor,text,m_codeGen->insideTabbing(),m_disableLinks);
1447}

References m_codeGen, m_disableLinks, OutputGenerator::m_t, and objectLinkToString().

◆ writePageLink()

void LatexGenerator::writePageLink ( const QCString & name,
bool  )
overridevirtual

Implements OutputGenIntf.

Definition at line 1275 of file latexgen.cpp.

1276{
1277 //bool &compactLatex = Config_getBool(COMPACT_LATEX);
1278 // next is remove for bug615957
1279 //if (compactLatex || first) m_t << "\\input" ; else m_t << "\\include";
1280 m_t << "\\input" ;
1281 m_t << "{" << name << "}\n";
1282}

References OutputGenerator::m_t.

Referenced by endIndexSection().

◆ writeQuickLinks()

void LatexGenerator::writeQuickLinks ( HighlightedItem ,
const QCString & ,
bool  )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 242 of file latexgen.h.

242{}

◆ writeRuler()

void LatexGenerator::writeRuler ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 197 of file latexgen.h.

197{ m_t << "\n\n"; }

References OutputGenerator::m_t.

◆ writeSearchInfo()

void LatexGenerator::writeSearchInfo ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 122 of file latexgen.h.

122{}

◆ writeSplitBar()

void LatexGenerator::writeSplitBar ( const QCString & )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 239 of file latexgen.h.

239{}

◆ writeStartAnnoItem()

void LatexGenerator::writeStartAnnoItem ( const QCString & type,
const QCString & file,
const QCString & path,
const QCString & name )
overridevirtual

Implements OutputGenIntf.

Definition at line 1341 of file latexgen.cpp.

1343{
1344 m_t << "\\item\\contentsline{section}\\textbf{ ";
1345 if (!path.isEmpty()) docify(path);
1346 docify(name);
1347 m_t << "} ";
1348}

References docify(), QCString::isEmpty(), and OutputGenerator::m_t.

◆ writeString()

void LatexGenerator::writeString ( const QCString & text)
overridevirtual

Implements OutputGenIntf.

Definition at line 1319 of file latexgen.cpp.

1320{
1321 m_t << text;
1322}

References OutputGenerator::m_t.

◆ writeStyleInfo()

void LatexGenerator::writeStyleInfo ( int part)
overridevirtual

an extension of the etoc package is required that is only available in the newer version. Providing the updated version to be used with older versions of LaTeX

Implements OutputGenIntf.

Definition at line 1284 of file latexgen.cpp.

1285{
1286 if (part > 0)
1287 return;
1288
1289 startPlainFile("doxygen.sty");
1291 endPlainFile();
1292
1293 // workaround for the problem caused by change in LaTeX in version 2019
1294 // in the unmaintained tabu package
1295 startPlainFile("tabu_doxygen.sty");
1296 m_t << ResourceMgr::instance().getAsString("tabu_doxygen.sty");
1297 endPlainFile();
1298 startPlainFile("longtable_doxygen.sty");
1299 m_t << ResourceMgr::instance().getAsString("longtable_doxygen.sty");
1300 endPlainFile();
1301 /// an extension of the etoc package is required that is only available in the
1302 /// newer version. Providing the updated version to be used with older versions
1303 /// of LaTeX
1304 startPlainFile("etoc_doxygen.sty");
1305 m_t << ResourceMgr::instance().getAsString("etoc_doxygen.sty");
1306 endPlainFile();
1307}
static void writeDefaultStyleSheet(TextStream &t)
Definition htmlgen.cpp:1357

References endPlainFile(), ResourceMgr::getAsString(), ResourceMgr::instance(), OutputGenerator::m_t, startPlainFile(), and writeDefaultStyleSheet().

◆ writeStyleSheetFile()

void LatexGenerator::writeStyleSheetFile ( TextStream & t)
static

Definition at line 700 of file latexgen.cpp.

701{
702 t << "% stylesheet for doxygen " << getDoxygenVersion() << "\n";
704}

References writeDefaultStyleSheet().

Referenced by readConfiguration().

◆ writeSummaryLink()

void LatexGenerator::writeSummaryLink ( const QCString & ,
const QCString & ,
const QCString & ,
bool  )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 243 of file latexgen.h.

243{}

◆ writeSynopsis()

void LatexGenerator::writeSynopsis ( )
inlineoverridevirtual

Implements OutputGenIntf.

Definition at line 232 of file latexgen.h.

232{}

Member Data Documentation

◆ m_codeGen

◆ m_codeList

std::unique_ptr<OutputCodeList> LatexGenerator::m_codeList
private

Definition at line 327 of file latexgen.h.

Referenced by LatexGenerator(), LatexGenerator(), operator=(), and writeDoc().

◆ m_disableLinks

◆ m_firstDescItem

bool LatexGenerator::m_firstDescItem = true
private

Definition at line 322 of file latexgen.h.

Referenced by LatexGenerator(), and operator=().

◆ m_hierarchyLevel

◆ m_indent

int LatexGenerator::m_indent = 0
private

◆ m_insideTableEnv

bool LatexGenerator::m_insideTableEnv = false
private

Definition at line 329 of file latexgen.h.

Referenced by addLabel(), endMemberDocSimple(), startDoxyAnchor(), and startMemberDocSimple().

◆ m_relPath

QCString LatexGenerator::m_relPath
private

◆ m_templateMemberItem

bool LatexGenerator::m_templateMemberItem = false
private

The documentation for this class was generated from the following files: