The `LatexGenerator` Class Reference

Generator for LaTeX output. More...

Declaration

class LatexGenerator { ... }

Included Headers

Base classes

class	OutputGenerator
	Base class for shared implementation for all output generators. More...

class	OutputGenIntf
	Abstract interface for output generators. More...

Public Constructors Index

	LatexGenerator ()


	LatexGenerator (const LatexGenerator &)


	LatexGenerator (LatexGenerator &&)=delete

Public Destructor Index

	~LatexGenerator ()

Public Operators Index

LatexGenerator &	operator= (const LatexGenerator &)


LatexGenerator &	operator= (LatexGenerator &&)=delete

Public Member Functions Index

void	clearBuffer ()


void	setCurrentDoc (const Definition *, const QCString &, bool)


void	addWord (const QCString &, bool)


OutputType	type () const override


std::unique_ptr< OutputGenIntf >	clone () 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 (const QCString &, 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 (const QCString &, 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 &, 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	writePageOutline () 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	startLocalToc (int level) override


void	endLocalToc () override


void	startTocEntry (const SectionInfo *) override


void	endTocEntry (const SectionInfo *) override


void	startPlainFile (const QCString &name) override


void	endPlainFile () override

Private Member Functions Index

void	startTitle ()


void	endTitle ()

Private Member Attributes Index

bool	m_firstDescItem = true


bool	m_disableLinks = false


QCString	m_relPath


int	m_indent = 0


bool	m_templateMemberItem = false


std::unique_ptr< OutputCodeList >	m_codeList


LatexCodeGenerator *	m_codeGen


bool	m_insideTableEnv = false


int	m_hierarchyLevel = 0

Public Static Functions Index

static void	init ()


static void	writeStyleSheetFile (TextStream &t)


static void	writeHeaderFile (TextStream &t)


static void	writeFooterFile (TextStream &t)

Description

Generator for LaTeX output.

Definition at line 93 of file latexgen.h.

Public Constructors

LatexGenerator()

LatexGenerator::LatexGenerator ()

Declaration at line 96 of file latexgen.h, definition at line 319 of file latexgen.cpp.

319LatexGenerator::LatexGenerator()

320 : OutputGenerator(Config_getString(LATEX_OUTPUT))

321 , m_codeList(std::make_unique<OutputCodeList>())

322{

323 m_codeGen = m_codeList->add<LatexCodeGenerator>(&m_t);

324}

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

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

LatexGenerator()

LatexGenerator::LatexGenerator (const LatexGenerator & og)

Declaration at line 97 of file latexgen.h, definition at line 326 of file latexgen.cpp.

326LatexGenerator::LatexGenerator(const LatexGenerator &og) : OutputGenerator(og.m_dir), OutputGenIntf()

327{

328 m_codeList = std::make_unique<OutputCodeList>(*og.m_codeList);

329 m_codeGen = m_codeList->get<LatexCodeGenerator>(OutputType::Latex);

330 m_codeGen->setTextStream(&m_t);

331 m_firstDescItem = og.m_firstDescItem;

332 m_disableLinks = og.m_disableLinks;

333 m_relPath = og.m_relPath;

334 m_indent = og.m_indent;

335 m_templateMemberItem = og.m_templateMemberItem;

336 m_hierarchyLevel = og.m_hierarchyLevel;

337}

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

LatexGenerator()

LatexGenerator::LatexGenerator (LatexGenerator &&)

delete

Definition at line 99 of file latexgen.h.

Reference LatexGenerator.

Public Destructor

~LatexGenerator()

LatexGenerator::~LatexGenerator ()

Definition at line 101 of file latexgen.h.

Public Operators

operator=()

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

Declaration at line 98 of file latexgen.h, definition at line 339 of file latexgen.cpp.

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

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);

347 m_firstDescItem = og.m_firstDescItem;

348 m_disableLinks = og.m_disableLinks;

349 m_relPath = og.m_relPath;

350 m_indent = og.m_indent;

351 m_templateMemberItem = og.m_templateMemberItem;

352 m_hierarchyLevel = og.m_hierarchyLevel;

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=()

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

delete

Definition at line 100 of file latexgen.h.

Reference LatexGenerator.

Public Member Functions

addCodeGen()

void LatexGenerator::addCodeGen (OutputCodeList & list)

virtual

Declaration at line 116 of file latexgen.h, definition at line 359 of file latexgen.cpp.

359void LatexGenerator::addCodeGen(OutputCodeList &list)

360{

361 list.add<LatexCodeGeneratorDefer>(m_codeGen);

362}

References OutputCodeList::add and m_codeGen.

addIndexItem()

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

virtual

Declaration at line 229 of file latexgen.h, definition at line 1695 of file latexgen.cpp.

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

1696{

1697 if (!s1.isEmpty())

1698 {

1699 m_t << "\\index{";

1700 m_t << latexEscapeLabelName(s1);

1701 m_t << "@{";

1702 m_t << latexEscapeIndexChars(s1);

1703 m_t << "}";

1704 if (!s2.isEmpty())

1705 {

1706 m_t << "!";

1707 m_t << latexEscapeLabelName(s2);

1708 m_t << "@{";

1709 m_t << latexEscapeIndexChars(s2);

1710 m_t << "}";

1711 }

1712 m_t << "}";

1713 }

1714}

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

addLabel()

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

virtual

Declaration at line 208 of file latexgen.h, definition at line 1661 of file latexgen.cpp.

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

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}

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 void addWord(const QCString &,bool) {}

cleanup()

void LatexGenerator::cleanup ()

virtual

Declaration at line 117 of file latexgen.h, definition at line 676 of file latexgen.cpp.

676void LatexGenerator::cleanup()

677{

678 QCString dname = Config_getString(LATEX_OUTPUT);

679 Dir d(dname.str());

680 clearSubDirs(d);

681}

References clearSubDirs, Config_getString and QCString::str.

clearBuffer()

void LatexGenerator::clearBuffer ()

Definition at line 107 of file latexgen.h.

clone()

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

inline virtual

Definition at line 115 of file latexgen.h.

115 std::unique_ptr<OutputGenIntf> clone() override { return std::make_unique<LatexGenerator>(*this); }

docify()

void LatexGenerator::docify (const QCString & text)

virtual

Declaration at line 151 of file latexgen.h, definition at line 1764 of file latexgen.cpp.

1764void LatexGenerator::docify(const QCString &str)

1765{

1766 filterLatexString(m_t,str,

1767 m_codeGen->insideTabbing(), // insideTabbing

1768 false, // insidePre

1769 false, // insideItem

1770 m_codeGen->usedTableLevel()>0, // insideTable

1771 false // keepSpaces

1772 );

1773}

References filterLatexString, m_codeGen and OutputGenerator::m_t.

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

endAnonTypeScope()

void LatexGenerator::endAnonTypeScope (int indent)

virtual

Declaration at line 179 of file latexgen.h, definition at line 1807 of file latexgen.cpp.

1807void LatexGenerator::endAnonTypeScope(int indent)

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 ()

inline virtual

Definition at line 202 of file latexgen.h.

202 void endBold() override { m_t << "}"; }

Reference OutputGenerator::m_t.

endCallGraph()

void LatexGenerator::endCallGraph (DotCallGraph & g)

virtual

Declaration at line 268 of file latexgen.h, definition at line 2055 of file latexgen.cpp.

2055void LatexGenerator::endCallGraph(DotCallGraph &g)

2056{

2057 g.writeGraph(m_t,GraphOutputFormat::EPS,EmbeddedOutputFormat::LaTeX,dir(),fileName(),m_relPath);

2058}

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

endCenter()

void LatexGenerator::endCenter ()

inline virtual

Definition at line 214 of file latexgen.h.

214 void endCenter() override { m_t << "\\end{center}\n"; }

Reference OutputGenerator::m_t.

endClassDiagram()

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

virtual

Declaration at line 234 of file latexgen.h, definition at line 1789 of file latexgen.cpp.

1789void LatexGenerator::endClassDiagram(const ClassDiagram &d,

1790 const QCString &fileName,const QCString &)

1791{

1792 d.writeFigure(m_t,dir(),fileName);

1793}

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

endCompoundTemplateParams()

void LatexGenerator::endCompoundTemplateParams ()

inline virtual

Definition at line 185 of file latexgen.h.

185 void endCompoundTemplateParams() override { m_t << "}\n"; }

Reference OutputGenerator::m_t.

endConstraintDocs()

void LatexGenerator::endConstraintDocs ()

virtual

Declaration at line 298 of file latexgen.h, definition at line 2184 of file latexgen.cpp.

2184void LatexGenerator::endConstraintDocs()

2185{

2186}

endConstraintList()

void LatexGenerator::endConstraintList ()

virtual

Declaration at line 299 of file latexgen.h, definition at line 2188 of file latexgen.cpp.

2188void LatexGenerator::endConstraintList()

2189{

2190 m_t << "\\end{description}\n";

2191 m_t << "\\end{Desc}\n";

2192}

Reference OutputGenerator::m_t.

endConstraintParam()

void LatexGenerator::endConstraintParam ()

virtual

Declaration at line 294 of file latexgen.h, definition at line 2166 of file latexgen.cpp.

2166void LatexGenerator::endConstraintParam()

2167{

2168}

endConstraintType()

void LatexGenerator::endConstraintType ()

virtual

Declaration at line 296 of file latexgen.h, definition at line 2175 of file latexgen.cpp.

2175void LatexGenerator::endConstraintType()

2176{

2177 m_t << "}]";

2178}

Reference OutputGenerator::m_t.

endContents()

void LatexGenerator::endContents ()

inline virtual

Definition at line 246 of file latexgen.h.

246 void endContents() override {}

endDescForItem()

void LatexGenerator::endDescForItem ()

inline virtual

Definition at line 226 of file latexgen.h.

226 void endDescForItem() override {}

endDescTable()

void LatexGenerator::endDescTable ()

virtual

Declaration at line 250 of file latexgen.h, definition at line 1913 of file latexgen.cpp.

1913void LatexGenerator::endDescTable()

1914{

1915 m_codeGen->decUsedTableLevel();

1916 m_t << "\\end{DoxyEnumFields}\n";

1917}

References m_codeGen and OutputGenerator::m_t.

endDescTableData()

void LatexGenerator::endDescTableData ()

virtual

Declaration at line 258 of file latexgen.h, definition at line 1953 of file latexgen.cpp.

1953void LatexGenerator::endDescTableData()

1954{

1955 m_t << "\\\\\n\\hline\n\n";

1956}

Reference OutputGenerator::m_t.

endDescTableInit()

void LatexGenerator::endDescTableInit ()

virtual

Declaration at line 256 of file latexgen.h, definition at line 1944 of file latexgen.cpp.

1944void LatexGenerator::endDescTableInit()

1945{

1946}

endDescTableRow()

void LatexGenerator::endDescTableRow ()

virtual

Declaration at line 252 of file latexgen.h, definition at line 1926 of file latexgen.cpp.

1926void LatexGenerator::endDescTableRow()

1927{

1928}

endDescTableTitle()

void LatexGenerator::endDescTableTitle ()

virtual

Declaration at line 254 of file latexgen.h, definition at line 1935 of file latexgen.cpp.

1935void LatexGenerator::endDescTableTitle()

1936{

1937}

endDirDepGraph()

void LatexGenerator::endDirDepGraph (DotDirDeps & g)

virtual

Declaration at line 270 of file latexgen.h, definition at line 2064 of file latexgen.cpp.

2064void LatexGenerator::endDirDepGraph(DotDirDeps &g)

2065{

2066 g.writeGraph(m_t,GraphOutputFormat::EPS,EmbeddedOutputFormat::LaTeX,dir(),fileName(),m_relPath);

2067}

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

endDotGraph()

void LatexGenerator::endDotGraph (DotClassGraph & g)

virtual

Declaration at line 262 of file latexgen.h, definition at line 2028 of file latexgen.cpp.

2028void LatexGenerator::endDotGraph(DotClassGraph &g)

2029{

2030 g.writeGraph(m_t,GraphOutputFormat::EPS,EmbeddedOutputFormat::LaTeX,dir(),fileName(),m_relPath);

2031}

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

endDoxyAnchor()

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

virtual

Declaration at line 207 of file latexgen.h, definition at line 1657 of file latexgen.cpp.

1657void LatexGenerator::endDoxyAnchor(const QCString &/* fName */,const QCString &/* anchor */)

1658{

1659}

endEmphasis()

void LatexGenerator::endEmphasis ()

inline virtual

Definition at line 200 of file latexgen.h.

200 void endEmphasis() override { m_t << "}"; }

Reference OutputGenerator::m_t.

endExamples()

void LatexGenerator::endExamples ()

virtual

Declaration at line 224 of file latexgen.h, definition at line 2076 of file latexgen.cpp.

2076void LatexGenerator::endExamples()

2077{

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

2079}

Reference OutputGenerator::m_t.

endFile()

void LatexGenerator::endFile ()

virtual

Declaration at line 120 of file latexgen.h, definition at line 720 of file latexgen.cpp.

720void LatexGenerator::endFile()

721{

722 endPlainFile();

723 m_codeGen->setSourceFileName("");

724}

References endPlainFile and m_codeGen.

endGroupCollaboration()

void LatexGenerator::endGroupCollaboration (DotGroupCollaboration & g)

virtual

Declaration at line 267 of file latexgen.h, definition at line 2046 of file latexgen.cpp.

2046void LatexGenerator::endGroupCollaboration(DotGroupCollaboration &g)

2047{

2048 g.writeGraph(m_t,GraphOutputFormat::EPS,EmbeddedOutputFormat::LaTeX,dir(),fileName(),m_relPath);

2049}

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

endGroupHeader()

void LatexGenerator::endGroupHeader (int)

virtual

Declaration at line 160 of file latexgen.h, definition at line 1538 of file latexgen.cpp.

1538void LatexGenerator::endGroupHeader(int)

1539{

1540 m_disableLinks=FALSE;

1541 m_t << "}\n";

1542}

References FALSE, m_disableLinks and OutputGenerator::m_t.

endHeaderSection()

void LatexGenerator::endHeaderSection ()

inline virtual

Definition at line 167 of file latexgen.h.

167 void endHeaderSection() override {}

endInclDepGraph()

void LatexGenerator::endInclDepGraph (DotInclDepGraph & g)

virtual

Declaration at line 264 of file latexgen.h, definition at line 2037 of file latexgen.cpp.

2037void LatexGenerator::endInclDepGraph(DotInclDepGraph &g)

2038{

2039 g.writeGraph(m_t,GraphOutputFormat::EPS,EmbeddedOutputFormat::LaTeX,dir(),fileName(),m_relPath);

2040}

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

endIndent()

void LatexGenerator::endIndent ()

inline virtual

Definition at line 231 of file latexgen.h.

231 void endIndent() override {}

endIndexItem()

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

virtual

Declaration at line 150 of file latexgen.h, definition at line 1333 of file latexgen.cpp.

1333void LatexGenerator::endIndexItem(const QCString &ref,const QCString &fn)

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 ()

virtual

Declaration at line 144 of file latexgen.h, definition at line 1355 of file latexgen.cpp.

1355void LatexGenerator::endIndexKey()

1356{

1357}

endIndexList()

void LatexGenerator::endIndexList ()

inline virtual

Definition at line 142 of file latexgen.h.

142 void endIndexList() override { m_t << "\\end{DoxyCompactList}\n"; }

Reference OutputGenerator::m_t.

endIndexListItem()

void LatexGenerator::endIndexListItem ()

inline virtual

Definition at line 140 of file latexgen.h.

140 void endIndexListItem() override {}

endIndexSection()

void LatexGenerator::endIndexSection (IndexSection is)

virtual

Declaration at line 128 of file latexgen.h, definition at line 1078 of file latexgen.cpp.

1078void LatexGenerator::endIndexSection(IndexSection is)

1079{

1080 switch (is)

1081 {

1082 case IndexSection::isTitlePageStart:

1083 break;

1084 case IndexSection::isTitlePageAuthor:

1085 break;

1086 case IndexSection::isMainPage:

1087 {

1088 if (Doxygen::mainPage)

1089 {

1090 writePageLink(Doxygen::mainPage->getOutputFileBase(), FALSE);

1091 }

1092 }

1093 break;

1094 case IndexSection::isModuleIndex:

1095 m_t << "}\n\\input{modules}\n";

1096 break;

1097 case IndexSection::isTopicIndex:

1098 m_t << "}\n\\input{topics}\n";

1099 break;

1100 case IndexSection::isDirIndex:

1101 m_t << "}\n\\input{dirs}\n";

1102 break;

1103 case IndexSection::isNamespaceIndex:

1104 m_t << "}\n\\input{namespaces}\n";

1105 break;

1106 case IndexSection::isConceptIndex:

1107 m_t << "}\n\\input{concepts}\n";

1108 break;

1109 case IndexSection::isClassHierarchyIndex:

1110 m_t << "}\n\\input{hierarchy}\n";

1111 break;

1112 case IndexSection::isCompoundIndex:

1113 m_t << "}\n\\input{annotated}\n";

1114 break;

1115 case IndexSection::isFileIndex:

1116 m_t << "}\n\\input{files}\n";

1117 break;

1118 case IndexSection::isPageIndex:

1119 m_t << "}\n\\input{pages}\n";

1120 break;

1121 case IndexSection::isTopicDocumentation:

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;

1133 case IndexSection::isModuleDocumentation:

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;

1145 case IndexSection::isDirDocumentation:

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;

1162 case IndexSection::isNamespaceDocumentation:

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;

1179 case IndexSection::isConceptDocumentation:

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;

1196 case IndexSection::isClassDocumentation:

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;

1217 case IndexSection::isFileDocumentation:

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;

1246 case IndexSection::isExampleDocumentation:

1247 {

1248 m_t << "}\n";

1249 for (const auto &pd : *Doxygen::exampleLinkedMap)

1250 {

1251 m_t << "\\input{" << pd->getOutputFileBase() << "}\n";

1252 }

1253 }

1254 break;

1255 case IndexSection::isPageDocumentation:

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;

1267 case IndexSection::isPageDocumentation2:

1268 break;

1269 case IndexSection::isEndIndex:

1270 m_t << substituteLatexKeywords(g_footer_file,g_footer,convertToLaTeX(Config_getString(PROJECT_NAME),m_codeGen->insideTabbing()));

1271 break;

1272 }

1273}

References Doxygen::classLinkedMap, Doxygen::conceptLinkedMap, Config_getString, convertToLaTeX, Doxygen::dirLinkedMap, Doxygen::exampleLinkedMap, FALSE, 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)

virtual

Declaration at line 146 of file latexgen.h, definition at line 1365 of file latexgen.cpp.

1365void LatexGenerator::endIndexValue(const QCString &name,bool /*hasBrief*/)

1366{

1367 //if (hasBrief) m_t << ")";

1368 m_t << "}{\\pageref{" << stripPath(name) << "}}{}\n";

1369}

References OutputGenerator::m_t and stripPath.

endInlineHeader()

void LatexGenerator::endInlineHeader ()

virtual

Declaration at line 177 of file latexgen.h, definition at line 2206 of file latexgen.cpp.

2206void LatexGenerator::endInlineHeader()

2207{

2208 m_t << "}\n";

2209}

Reference OutputGenerator::m_t.

endInlineMemberDoc()

void LatexGenerator::endInlineMemberDoc ()

virtual

Declaration at line 308 of file latexgen.h, definition at line 2280 of file latexgen.cpp.

2280void LatexGenerator::endInlineMemberDoc()

2281{

2282 m_t << "\\\\\n\\hline\n\n";

2283}

Reference OutputGenerator::m_t.

endInlineMemberName()

void LatexGenerator::endInlineMemberName ()

virtual

Declaration at line 306 of file latexgen.h, definition at line 2270 of file latexgen.cpp.

2270void LatexGenerator::endInlineMemberName()

2271{

2272 m_t << "&\n";

2273 m_codeGen->setInsideTabbing(false);

2274}

References m_codeGen and OutputGenerator::m_t.

endInlineMemberType()

void LatexGenerator::endInlineMemberType ()

virtual

Declaration at line 304 of file latexgen.h, definition at line 2259 of file latexgen.cpp.

2259void LatexGenerator::endInlineMemberType()

2260{

2261 m_t << "&\n";

2262 m_codeGen->setInsideTabbing(false);

2263}

References m_codeGen and OutputGenerator::m_t.

endItemList()

void LatexGenerator::endItemList ()

inline virtual

Definition at line 148 of file latexgen.h.

148 void endItemList() override { m_t << "\\end{DoxyCompactItemize}\n"; }

Reference OutputGenerator::m_t.

endItemListItem()

void LatexGenerator::endItemListItem ()

inline virtual

Definition at line 162 of file latexgen.h.

162 void endItemListItem() override {}

endLabels()

void LatexGenerator::endLabels ()

virtual

Declaration at line 312 of file latexgen.h, definition at line 2296 of file latexgen.cpp.

2296void LatexGenerator::endLabels()

2297{

2298}

endLocalToc()

void LatexGenerator::endLocalToc ()

inline virtual

Definition at line 315 of file latexgen.h.

315 void endLocalToc() override {}

endMemberDeclaration()

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

inline virtual

Definition at line 220 of file latexgen.h.

220 void endMemberDeclaration(const QCString &,const QCString &) override {}

endMemberDescription()

void LatexGenerator::endMemberDescription ()

virtual

Declaration at line 218 of file latexgen.h, definition at line 1866 of file latexgen.cpp.

1866void LatexGenerator::endMemberDescription()

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)

virtual

Declaration at line 205 of file latexgen.h, definition at line 1634 of file latexgen.cpp.

1634void LatexGenerator::endMemberDoc(bool)

1635{

1636 m_disableLinks=FALSE;

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 ()

inline virtual

Definition at line 173 of file latexgen.h.

173 void endMemberDocList() override {}

endMemberDocName()

void LatexGenerator::endMemberDocName ()

inline virtual

Definition at line 279 of file latexgen.h.

279 void endMemberDocName() override {}

endMemberDocPrefixItem()

void LatexGenerator::endMemberDocPrefixItem ()

inline virtual

Definition at line 277 of file latexgen.h.

277 void endMemberDocPrefixItem() override { m_t << "\\\\\n"; }

Reference OutputGenerator::m_t.

endMemberDocSimple()

void LatexGenerator::endMemberDocSimple (bool isEnum)

virtual

Declaration at line 302 of file latexgen.h, definition at line 2240 of file latexgen.cpp.

2240void LatexGenerator::endMemberDocSimple(bool isEnum)

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)

virtual

Declaration at line 192 of file latexgen.h, definition at line 2017 of file latexgen.cpp.

2017void LatexGenerator::endMemberGroup(bool hasHeader)

2018{

2019 if (hasHeader)m_t << "\\end{Indent}";

2020 m_t << "\n";

2021}

Reference OutputGenerator::m_t.

endMemberGroupDocs()

void LatexGenerator::endMemberGroupDocs ()

virtual

Declaration at line 190 of file latexgen.h, definition at line 2008 of file latexgen.cpp.

2008void LatexGenerator::endMemberGroupDocs()

2009{

2010 m_t << "}";

2011}

Reference OutputGenerator::m_t.

endMemberGroupHeader()

void LatexGenerator::endMemberGroupHeader ()

virtual

Declaration at line 188 of file latexgen.h, definition at line 1996 of file latexgen.cpp.

1996void LatexGenerator::endMemberGroupHeader()

1997{

1998 // changed back to rev 756 due to bug 660501

1999 m_t << "}\\par\n";

2000 //m_t << "}\n";

2001}

Reference OutputGenerator::m_t.

endMemberHeader()

void LatexGenerator::endMemberHeader ()

virtual

Declaration at line 169 of file latexgen.h, definition at line 1556 of file latexgen.cpp.

1556void LatexGenerator::endMemberHeader()

1557{

1558 m_disableLinks=FALSE;

1559 m_t << "}\n";

1560}

References FALSE, m_disableLinks and OutputGenerator::m_t.

endMemberItem()

void LatexGenerator::endMemberItem (MemberItemType)

virtual

Declaration at line 181 of file latexgen.h, definition at line 1843 of file latexgen.cpp.

1843void LatexGenerator::endMemberItem(MemberItemType)

1844{

1845 if (m_codeGen->insideTabbing())

1846 {

1847 m_t << "\\\\";

1848 }

1849 m_templateMemberItem = FALSE;

1850 m_t << "\n";

1851}

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

endMemberList()

void LatexGenerator::endMemberList ()

virtual

Declaration at line 175 of file latexgen.h, definition at line 1971 of file latexgen.cpp.

1971void LatexGenerator::endMemberList()

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 ()

inline virtual

Definition at line 165 of file latexgen.h.

165 void endMemberSections() override {}

endMemberSubtitle()

void LatexGenerator::endMemberSubtitle ()

inline virtual

Definition at line 171 of file latexgen.h.

171 void endMemberSubtitle() override {}

endMemberTemplateParams()

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

virtual

Declaration at line 183 of file latexgen.h, definition at line 1825 of file latexgen.cpp.

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

1826{

1827 if (m_templateMemberItem)

1828 {

1829 m_t << "}\\\\";

1830 }

1831}

References OutputGenerator::m_t and m_templateMemberItem.

endPageDoc()

void LatexGenerator::endPageDoc ()

inline virtual

Definition at line 126 of file latexgen.h.

126 void endPageDoc() override {}

endPageRef()

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

virtual

Declaration at line 236 of file latexgen.h, definition at line 1454 of file latexgen.cpp.

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

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 ()

virtual

Declaration at line 137 of file latexgen.h, definition at line 1314 of file latexgen.cpp.

1314void LatexGenerator::endParagraph()

1315{

1316 m_t << "\n" << "\n";

1317}

Reference OutputGenerator::m_t.

endParameterDefVal()

void LatexGenerator::endParameterDefVal ()

inline virtual

Definition at line 287 of file latexgen.h.

287 void endParameterDefVal() override { endTypewriter(); }

Reference endTypewriter.

endParameterExtra()

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

virtual

Declaration at line 285 of file latexgen.h, definition at line 2118 of file latexgen.cpp.

2118void LatexGenerator::endParameterExtra(bool last,bool /*emptyList*/,bool closeBracket)

2119{

2120 m_t << "}";

2121 if (last)

2122 {

2123 m_t << "\\end{DoxyParamCaption}";

2124 if (closeBracket) m_t << ")";

2125 }

2126}

Reference OutputGenerator::m_t.

endParameterList()

void LatexGenerator::endParameterList ()

virtual

Declaration at line 289 of file latexgen.h, definition at line 2088 of file latexgen.cpp.

2088void LatexGenerator::endParameterList()

2089{

2090}

endParameterName()

void LatexGenerator::endParameterName ()

virtual

Declaration at line 283 of file latexgen.h, definition at line 2108 of file latexgen.cpp.

2108void LatexGenerator::endParameterName()

2109{

2110 m_t << "}";

2111}

Reference OutputGenerator::m_t.

endParameterType()

void LatexGenerator::endParameterType ()

virtual

Declaration at line 281 of file latexgen.h, definition at line 2098 of file latexgen.cpp.

2098void LatexGenerator::endParameterType()

2099{

2100 m_t << "}]";

2101}

Reference OutputGenerator::m_t.

endPlainFile()

void LatexGenerator::endPlainFile ()

inline virtual

Definition at line 320 of file latexgen.h.

320 void endPlainFile() override { OutputGenerator::endPlainFile(); }

Reference OutputGenerator::endPlainFile.

Referenced by endFile and writeStyleInfo.

endProjectNumber()

void LatexGenerator::endProjectNumber ()

inline virtual

Definition at line 131 of file latexgen.h.

131 void endProjectNumber() override {}

endQuickIndices()

void LatexGenerator::endQuickIndices ()

inline virtual

Definition at line 238 of file latexgen.h.

238 void endQuickIndices() override {}

endSection()

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

virtual

Declaration at line 228 of file latexgen.h, definition at line 1758 of file latexgen.cpp.

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

1759{

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

1761}

Reference OutputGenerator::m_t.

endSmall()

void LatexGenerator::endSmall ()

inline virtual

Definition at line 216 of file latexgen.h.

216 void endSmall() override { m_t << "\\normalsize "; }

Reference OutputGenerator::m_t.

endTextBlock()

void LatexGenerator::endTextBlock (bool)

inline virtual

Definition at line 274 of file latexgen.h.

274 void endTextBlock(bool) override {}

endTextLink()

void LatexGenerator::endTextLink ()

virtual

Declaration at line 156 of file latexgen.h, definition at line 1395 of file latexgen.cpp.

1395void LatexGenerator::endTextLink()

1396{

1397 bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);

1398 if (!m_disableLinks && pdfHyperlinks)

1399 {

1400 m_t << "}";

1401 }

1402 m_t << "}";

1403}

References Config_getBool, m_disableLinks and OutputGenerator::m_t.

endTitleHead()

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

virtual

Declaration at line 134 of file latexgen.h, definition at line 1477 of file latexgen.cpp.

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

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.

endTocEntry()

void LatexGenerator::endTocEntry (const SectionInfo *)

inline virtual

Definition at line 317 of file latexgen.h.

317 void endTocEntry(const SectionInfo *) override {}

endTypewriter()

void LatexGenerator::endTypewriter ()

inline virtual

Definition at line 158 of file latexgen.h.

158 void endTypewriter() override { m_t << "}"; }

Reference OutputGenerator::m_t.

Referenced by endParameterDefVal.

exceptionEntry()

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

virtual

Declaration at line 290 of file latexgen.h, definition at line 2128 of file latexgen.cpp.

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

2129{

2130 if (!prefix.isEmpty())

2131 {

2132 m_t << " " << prefix << "(";

2133 }

2134 else if (closeBracket)

2135 {

2136 m_t << ")";

2137 }

2138 m_t << " ";

2139}

References OutputGenerator::m_t and prefix.

insertMemberAlign()

void LatexGenerator::insertMemberAlign (bool)

inline virtual

Definition at line 194 of file latexgen.h.

194 void insertMemberAlign(bool) override {}

insertMemberAlignLeft()

void LatexGenerator::insertMemberAlignLeft (MemberItemType, bool)

inline virtual

Definition at line 195 of file latexgen.h.

195 void insertMemberAlignLeft(MemberItemType,bool) override {}

lastIndexPage()

void LatexGenerator::lastIndexPage ()

virtual

Declaration at line 259 of file latexgen.h, definition at line 1958 of file latexgen.cpp.

1958void LatexGenerator::lastIndexPage()

1959{

1960}

lineBreak()

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

virtual

Declaration at line 203 of file latexgen.h, definition at line 2211 of file latexgen.cpp.

2211void LatexGenerator::lineBreak(const QCString &)

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.

setCurrentDoc()

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

inline

Definition at line 109 of file latexgen.h.

109 void setCurrentDoc(const Definition *,const QCString &,bool) {}

startAnonTypeScope()

void LatexGenerator::startAnonTypeScope (int indent)

virtual

Declaration at line 178 of file latexgen.h, definition at line 1796 of file latexgen.cpp.

1796void LatexGenerator::startAnonTypeScope(int indent)

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 ()

inline virtual

Definition at line 201 of file latexgen.h.

201 void startBold() override { m_t << "{\\bfseries "; }

Reference OutputGenerator::m_t.

startCallGraph()

void LatexGenerator::startCallGraph ()

virtual

Declaration at line 265 of file latexgen.h, definition at line 2051 of file latexgen.cpp.

2051void LatexGenerator::startCallGraph()

2052{

2053}

startCenter()

void LatexGenerator::startCenter ()

inline virtual

Definition at line 213 of file latexgen.h.

213 void startCenter() override { m_t << "\\begin{center}\n"; }

Reference OutputGenerator::m_t.

startClassDiagram()

void LatexGenerator::startClassDiagram ()

virtual

Declaration at line 233 of file latexgen.h, definition at line 1783 of file latexgen.cpp.

1783void LatexGenerator::startClassDiagram()

1784{

1785 //if (Config_getBool(COMPACT_LATEX)) m_t << "\\doxysubsubsection"; else m_t << "\\doxysubsection";

1786 //m_t << "{";

1787}

startCompoundTemplateParams()

void LatexGenerator::startCompoundTemplateParams ()

inline virtual

Definition at line 184 of file latexgen.h.

184 void startCompoundTemplateParams() override { m_t << "\\subsubsection*{";}

Reference OutputGenerator::m_t.

startConstraintDocs()

void LatexGenerator::startConstraintDocs ()

virtual

Declaration at line 297 of file latexgen.h, definition at line 2180 of file latexgen.cpp.

2180void LatexGenerator::startConstraintDocs()

2181{

2182}

startConstraintList()

void LatexGenerator::startConstraintList (const QCString & header)

virtual

Declaration at line 292 of file latexgen.h, definition at line 2153 of file latexgen.cpp.

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

2154{

2155 m_t << "\\begin{Desc}\n\\item[";

2156 docify(header);

2157 m_t << "]";

2158 m_t << "\\begin{description}\n";

2159}

References docify and OutputGenerator::m_t.

startConstraintParam()

void LatexGenerator::startConstraintParam ()

virtual

Declaration at line 293 of file latexgen.h, definition at line 2161 of file latexgen.cpp.

2161void LatexGenerator::startConstraintParam()

2162{

2163 m_t << "\\item[{\\em ";

2164}

Reference OutputGenerator::m_t.

startConstraintType()

void LatexGenerator::startConstraintType ()

virtual

Declaration at line 295 of file latexgen.h, definition at line 2170 of file latexgen.cpp.

2170void LatexGenerator::startConstraintType()

2171{

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

2173}

Reference OutputGenerator::m_t.

startContents()

void LatexGenerator::startContents ()

inline virtual

Definition at line 245 of file latexgen.h.

245 void startContents() override {}

startDescForItem()

void LatexGenerator::startDescForItem ()

inline virtual

Definition at line 225 of file latexgen.h.

225 void startDescForItem() override { m_t << "\\par\n"; }

Reference OutputGenerator::m_t.

startDescTable()

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

virtual

Declaration at line 249 of file latexgen.h, definition at line 1907 of file latexgen.cpp.

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

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 ()

virtual

Declaration at line 257 of file latexgen.h, definition at line 1948 of file latexgen.cpp.

1948void LatexGenerator::startDescTableData()

1949{

1950 m_t << "&";

1951}

Reference OutputGenerator::m_t.

startDescTableInit()

void LatexGenerator::startDescTableInit ()

virtual

Declaration at line 255 of file latexgen.h, definition at line 1939 of file latexgen.cpp.

1939void LatexGenerator::startDescTableInit()

1940{

1941 m_t << "&";

1942}

Reference OutputGenerator::m_t.

startDescTableRow()

void LatexGenerator::startDescTableRow ()

virtual

Declaration at line 251 of file latexgen.h, definition at line 1919 of file latexgen.cpp.

1919void LatexGenerator::startDescTableRow()

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}

Reference OutputGenerator::m_t.

startDescTableTitle()

void LatexGenerator::startDescTableTitle ()

virtual

Declaration at line 253 of file latexgen.h, definition at line 1930 of file latexgen.cpp.

1930void LatexGenerator::startDescTableTitle()

1931{

1932 m_t << "}";

1933}

Reference OutputGenerator::m_t.

startDirDepGraph()

void LatexGenerator::startDirDepGraph ()

virtual

Declaration at line 269 of file latexgen.h, definition at line 2060 of file latexgen.cpp.

2060void LatexGenerator::startDirDepGraph()

2061{

2062}

startDotGraph()

void LatexGenerator::startDotGraph ()

virtual

Declaration at line 261 of file latexgen.h, definition at line 2023 of file latexgen.cpp.

2023void LatexGenerator::startDotGraph()

2024{

2025 m_t << "\n" << "\n";

2026}

Reference OutputGenerator::m_t.

startDoxyAnchor()

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

virtual

Declaration at line 206 of file latexgen.h, definition at line 1641 of file latexgen.cpp.

1641void LatexGenerator::startDoxyAnchor(const QCString &fName,const QCString &,

1642 const QCString &anchor, const QCString &,

1643 const QCString &)

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 ()

inline virtual

Definition at line 199 of file latexgen.h.

199 void startEmphasis() override { m_t << "{\\em "; }

Reference OutputGenerator::m_t.

startExamples()

void LatexGenerator::startExamples ()

virtual

Declaration at line 223 of file latexgen.h, definition at line 2069 of file latexgen.cpp.

2069void LatexGenerator::startExamples()

2070{

2071 m_t << "\\begin{Desc}\n\\item[";

2072 docify(theTranslator->trExamples());

2073 m_t << "]";

2074}

References docify, OutputGenerator::m_t and theTranslator.

startFile()

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

virtual

Declaration at line 119 of file latexgen.h, definition at line 706 of file latexgen.cpp.

706void LatexGenerator::startFile(const QCString &name,const QCString &,const QCString &,int,int hierarchyLevel)

707{

708#if 0

709 setEncoding(Config_getString(LATEX_OUTPUT_ENCODING));

710#endif

711 QCString fileName=name;

712 m_hierarchyLevel = hierarchyLevel;

713 m_relPath = relativePathToRoot(fileName);

714 if (!fileName.endsWith(".tex") && !fileName.endsWith(".sty")) fileName+=".tex";

715 startPlainFile(fileName);

716 m_codeGen->setRelativePath(m_relPath);

717 m_codeGen->setSourceFileName(stripPath(fileName));

718}

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

startGroupCollaboration()

void LatexGenerator::startGroupCollaboration ()

virtual

Declaration at line 266 of file latexgen.h, definition at line 2042 of file latexgen.cpp.

2042void LatexGenerator::startGroupCollaboration()

2043{

2044}

startGroupHeader()

void LatexGenerator::startGroupHeader (const QCString &, int extraIndentLevel)

virtual

Declaration at line 159 of file latexgen.h, definition at line 1515 of file latexgen.cpp.

1515void LatexGenerator::startGroupHeader(const QCString &,int extraIndentLevel)

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 }

1535 m_disableLinks=TRUE;

1536}

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

startHeaderSection()

void LatexGenerator::startHeaderSection ()

inline virtual

Definition at line 166 of file latexgen.h.

166 void startHeaderSection() override {}

startInclDepGraph()

void LatexGenerator::startInclDepGraph ()

virtual

Declaration at line 263 of file latexgen.h, definition at line 2033 of file latexgen.cpp.

2033void LatexGenerator::startInclDepGraph()

2034{

2035}

startIndent()

void LatexGenerator::startIndent ()

inline virtual

Definition at line 230 of file latexgen.h.

230 void startIndent() override {}

startIndexItem()

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

virtual

Declaration at line 149 of file latexgen.h, definition at line 1324 of file latexgen.cpp.

1324void LatexGenerator::startIndexItem(const QCString &ref,const QCString &fn)

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 ()

virtual

Declaration at line 143 of file latexgen.h, definition at line 1350 of file latexgen.cpp.

1350void LatexGenerator::startIndexKey()

1351{

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

1353}

Reference OutputGenerator::m_t.

startIndexList()

void LatexGenerator::startIndexList ()

inline virtual

Definition at line 141 of file latexgen.h.

141 void startIndexList() override { m_t << "\\begin{DoxyCompactList}\n"; }

Reference OutputGenerator::m_t.

startIndexListItem()

void LatexGenerator::startIndexListItem ()

inline virtual

Definition at line 139 of file latexgen.h.

139 void startIndexListItem() override {}

startIndexSection()

void LatexGenerator::startIndexSection (IndexSection is)

virtual

Declaration at line 127 of file latexgen.h, definition at line 912 of file latexgen.cpp.

912void LatexGenerator::startIndexSection(IndexSection is)

913{

914 bool compactLatex = Config_getBool(COMPACT_LATEX);

915 switch (is)

916 {

917 case IndexSection::isTitlePageStart:

918 m_t << substituteLatexKeywords(g_header_file,g_header,convertToLaTeX(Config_getString(PROJECT_NAME),m_codeGen->insideTabbing()));

919 break;

920 case IndexSection::isTitlePageAuthor:

921 break;

922 case IndexSection::isMainPage:

923 break;

924 case IndexSection::isModuleIndex:

925 if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";

926 m_t << "{"; //Module Index}\n"

927 break;

928 case IndexSection::isTopicIndex:

929 if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";

930 m_t << "{"; //Topic Index}\n"

931 break;

932 case IndexSection::isDirIndex:

933 if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";

934 m_t << "{"; //Directory Index}\n"

935 break;

936 case IndexSection::isNamespaceIndex:

937 if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";

938 m_t << "{"; //Namespace Index}\n"

939 break;

940 case IndexSection::isConceptIndex:

941 if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";

942 m_t << "{"; //Concept Index}\n"

943 break;

944 case IndexSection::isClassHierarchyIndex:

945 if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";

946 m_t << "{"; //Hierarchical Index}\n"

947 break;

948 case IndexSection::isCompoundIndex:

949 if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";

950 m_t << "{"; //Annotated Compound Index}\n"

951 break;

952 case IndexSection::isFileIndex:

953 if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";

954 m_t << "{"; //Annotated File Index}\n"

955 break;

956 case IndexSection::isPageIndex:

957 if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";

958 m_t << "{"; //Annotated Page Index}\n"

959 break;

960 case IndexSection::isTopicDocumentation:

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;

973 case IndexSection::isModuleDocumentation:

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;

986 case IndexSection::isDirDocumentation:

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;

999 case IndexSection::isNamespaceDocumentation:

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;

1012 case IndexSection::isConceptDocumentation:

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;

1025 case IndexSection::isClassDocumentation:

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;

1042 case IndexSection::isFileDocumentation:

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;

1063 case IndexSection::isExampleDocumentation:

1064 {

1065 if (compactLatex) m_t << "\\doxysection"; else m_t << "\\chapter";

1066 m_t << "{"; //Example Documentation}\n";

1067 }

1068 break;

1069 case IndexSection::isPageDocumentation:

1070 break;

1071 case IndexSection::isPageDocumentation2:

1072 break;

1073 case IndexSection::isEndIndex:

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)

virtual

Declaration at line 145 of file latexgen.h, definition at line 1359 of file latexgen.cpp.

1359void LatexGenerator::startIndexValue(bool hasBrief)

1360{

1361 m_t << " ";

1362 if (hasBrief) m_t << "\\\\*";

1363}

Reference OutputGenerator::m_t.

startInlineHeader()

void LatexGenerator::startInlineHeader ()

virtual

Declaration at line 176 of file latexgen.h, definition at line 2194 of file latexgen.cpp.

2194void LatexGenerator::startInlineHeader()

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 ()

virtual

Declaration at line 307 of file latexgen.h, definition at line 2276 of file latexgen.cpp.

2276void LatexGenerator::startInlineMemberDoc()

2277{

2278}

startInlineMemberName()

void LatexGenerator::startInlineMemberName ()

virtual

Declaration at line 305 of file latexgen.h, definition at line 2265 of file latexgen.cpp.

2265void LatexGenerator::startInlineMemberName()

2266{

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

2268}

Reference m_codeGen.

startInlineMemberType()

void LatexGenerator::startInlineMemberType ()

virtual

Declaration at line 303 of file latexgen.h, definition at line 2254 of file latexgen.cpp.

2254void LatexGenerator::startInlineMemberType()

2255{

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

2257}

Reference m_codeGen.

startItemList()

void LatexGenerator::startItemList ()

inline virtual

Definition at line 147 of file latexgen.h.

147 void startItemList() override { m_t << "\\begin{DoxyCompactItemize}\n"; }

Reference OutputGenerator::m_t.

startItemListItem()

void LatexGenerator::startItemListItem ()

inline virtual

Definition at line 161 of file latexgen.h.

161 void startItemListItem() override { m_t << "\\item \n"; }

Reference OutputGenerator::m_t.

startLabels()

void LatexGenerator::startLabels ()

virtual

Declaration at line 310 of file latexgen.h, definition at line 2285 of file latexgen.cpp.

2285void LatexGenerator::startLabels()

2286{

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

2288}

Reference OutputGenerator::m_t.

startLocalToc()

void LatexGenerator::startLocalToc (int level)

virtual

Declaration at line 314 of file latexgen.h, definition at line 2318 of file latexgen.cpp.

2318void LatexGenerator::startLocalToc(int level)

2319{

2320 int maxLevel = level + m_hierarchyLevel;

2321 m_t << "\\etocsetnexttocdepth{" << maxLevel << "}\n";

2322 m_t << "\\localtableofcontents\n";

2323}

References m_hierarchyLevel and OutputGenerator::m_t.

startMemberDeclaration()

void LatexGenerator::startMemberDeclaration ()

inline virtual

Definition at line 219 of file latexgen.h.

219 void startMemberDeclaration() override {}

startMemberDescription()

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

virtual

Declaration at line 217 of file latexgen.h, definition at line 1853 of file latexgen.cpp.

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

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)

virtual

Declaration at line 204 of file latexgen.h, definition at line 1562 of file latexgen.cpp.

1562void LatexGenerator::startMemberDoc(const QCString &clname,

1563 const QCString &memname,

1564 const QCString &,

1565 const QCString &title,

1566 int memCount,

1567 int memTotal,

1568 bool showInline)

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}

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

startMemberDocList()

void LatexGenerator::startMemberDocList ()

inline virtual

Definition at line 172 of file latexgen.h.

172 void startMemberDocList() override {}

startMemberDocName()

void LatexGenerator::startMemberDocName (bool)

inline virtual

Definition at line 278 of file latexgen.h.

278 void startMemberDocName(bool) override {}

startMemberDocPrefixItem()

void LatexGenerator::startMemberDocPrefixItem ()

inline virtual

Definition at line 276 of file latexgen.h.

276 void startMemberDocPrefixItem() override {}

startMemberDocSimple()

void LatexGenerator::startMemberDocSimple (bool isEnum)

virtual

Declaration at line 301 of file latexgen.h, definition at line 2223 of file latexgen.cpp.

2223void LatexGenerator::startMemberDocSimple(bool isEnum)

2224{

2225 m_codeGen->incUsedTableLevel();

2226 if (isEnum)

2227 {

2228 m_t << "\\begin{DoxyEnumFields}{";

2229 docify(theTranslator->trEnumerationValues());

2230 }

2231 else

2232 {

2233 m_t << "\\begin{DoxyFields}{";

2234 docify(theTranslator->trCompoundMembers());

2235 }

2236 m_t << "}\n";

2237 m_insideTableEnv=true;

2238}

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

startMemberGroup()

void LatexGenerator::startMemberGroup ()

virtual

Declaration at line 191 of file latexgen.h, definition at line 2013 of file latexgen.cpp.

2013void LatexGenerator::startMemberGroup()

2014{

2015}

startMemberGroupDocs()

void LatexGenerator::startMemberGroupDocs ()

virtual

Declaration at line 189 of file latexgen.h, definition at line 2003 of file latexgen.cpp.

2003void LatexGenerator::startMemberGroupDocs()

2004{

2005 m_t << "{\\em ";

2006}

Reference OutputGenerator::m_t.

startMemberGroupHeader()

void LatexGenerator::startMemberGroupHeader (const QCString &, bool hasHeader)

virtual

Declaration at line 187 of file latexgen.h, definition at line 1981 of file latexgen.cpp.

1981void LatexGenerator::startMemberGroupHeader(const QCString &,bool hasHeader)

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}

Reference OutputGenerator::m_t.

startMemberHeader()

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

virtual

Declaration at line 168 of file latexgen.h, definition at line 1544 of file latexgen.cpp.

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

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*{";

1553 m_disableLinks=TRUE;

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 &)

virtual

Declaration at line 180 of file latexgen.h, definition at line 1833 of file latexgen.cpp.

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

1834{

1835 //printf("LatexGenerator::startMemberItem(%d)\n",annType);

1836 if (!m_codeGen->insideTabbing())

1837 {

1838 m_t << "\\item \n";

1839 m_templateMemberItem = (type == MemberItemType::Templated);

1840 }

1841}

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

startMemberList()

void LatexGenerator::startMemberList ()

virtual

Declaration at line 174 of file latexgen.h, definition at line 1963 of file latexgen.cpp.

1963void LatexGenerator::startMemberList()

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 ()

inline virtual

Definition at line 164 of file latexgen.h.

164 void startMemberSections() override {}

startMemberSubtitle()

void LatexGenerator::startMemberSubtitle ()

inline virtual

Definition at line 170 of file latexgen.h.

170 void startMemberSubtitle() override {}

startMemberTemplateParams()

void LatexGenerator::startMemberTemplateParams ()

virtual

Declaration at line 182 of file latexgen.h, definition at line 1817 of file latexgen.cpp.

1817void LatexGenerator::startMemberTemplateParams()

1818{

1819 if (m_templateMemberItem)

1820 {

1821 m_t << "{\\footnotesize ";

1822 }

1823}

References OutputGenerator::m_t and m_templateMemberItem.

startPageDoc()

void LatexGenerator::startPageDoc (const QCString &)

inline virtual

Definition at line 125 of file latexgen.h.

125 void startPageDoc(const QCString &) override {}

startPageRef()

void LatexGenerator::startPageRef ()

virtual

Declaration at line 235 of file latexgen.h, definition at line 1449 of file latexgen.cpp.

1449void LatexGenerator::startPageRef()

1450{

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

1452}

Reference OutputGenerator::m_t.

startParagraph()

void LatexGenerator::startParagraph (const QCString & classDef)

virtual

Declaration at line 136 of file latexgen.h, definition at line 1309 of file latexgen.cpp.

1309void LatexGenerator::startParagraph(const QCString &)

1310{

1311 m_t << "\n" << "\n";

1312}

Reference OutputGenerator::m_t.

startParameterDefVal()

void LatexGenerator::startParameterDefVal (const char * s)

inline virtual

Definition at line 286 of file latexgen.h.

286 void startParameterDefVal(const char *s) override { docify(s); startTypewriter(); }

References docify and startTypewriter.

startParameterExtra()

void LatexGenerator::startParameterExtra ()

virtual

Declaration at line 284 of file latexgen.h, definition at line 2113 of file latexgen.cpp.

2113void LatexGenerator::startParameterExtra()

2114{

2115 m_t << "{";

2116}

Reference OutputGenerator::m_t.

startParameterList()

void LatexGenerator::startParameterList (bool openBracket)

virtual

Declaration at line 288 of file latexgen.h, definition at line 2081 of file latexgen.cpp.

2081void LatexGenerator::startParameterList(bool openBracket)

2082{

2083 /* start of ParameterType ParameterName list */

2084 if (openBracket) m_t << "(";

2085 m_t << "\\begin{DoxyParamCaption}";

2086}

Reference OutputGenerator::m_t.

startParameterName()

void LatexGenerator::startParameterName (bool)

virtual

Declaration at line 282 of file latexgen.h, definition at line 2103 of file latexgen.cpp.

2103void LatexGenerator::startParameterName(bool /*oneArgOnly*/)

2104{

2105 m_t << "{";

2106}

Reference OutputGenerator::m_t.

startParameterType()

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

virtual

Declaration at line 280 of file latexgen.h, definition at line 2092 of file latexgen.cpp.

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

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)

inline virtual

Definition at line 319 of file latexgen.h.

319 void startPlainFile(const QCString &name) override { OutputGenerator::startPlainFile(name); }

Reference OutputGenerator::startPlainFile.

Referenced by startFile and writeStyleInfo.

startProjectNumber()

void LatexGenerator::startProjectNumber ()

virtual

Declaration at line 130 of file latexgen.h, definition at line 731 of file latexgen.cpp.

731void LatexGenerator::startProjectNumber()

732{

733 m_t << "\\\\[1ex]\\large ";

734}

Reference OutputGenerator::m_t.

startQuickIndices()

void LatexGenerator::startQuickIndices ()

inline virtual

Definition at line 237 of file latexgen.h.

237 void startQuickIndices() override {}

startSection()

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

virtual

Declaration at line 227 of file latexgen.h, definition at line 1717 of file latexgen.cpp.

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

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}

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 ()

inline virtual

Definition at line 215 of file latexgen.h.

215 void startSmall() override { m_t << "\\footnotesize "; }

Reference OutputGenerator::m_t.

startTextBlock()

void LatexGenerator::startTextBlock (bool)

inline virtual

Definition at line 273 of file latexgen.h.

273 void startTextBlock(bool) override {}

startTextLink()

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

virtual

Declaration at line 155 of file latexgen.h, definition at line 1379 of file latexgen.cpp.

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

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.

startTitleHead()

void LatexGenerator::startTitleHead (const QCString & fileName)

virtual

Declaration at line 133 of file latexgen.h, definition at line 1463 of file latexgen.cpp.

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

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.

startTocEntry()

void LatexGenerator::startTocEntry (const SectionInfo *)

inline virtual

Definition at line 316 of file latexgen.h.

316 void startTocEntry(const SectionInfo *) override {}

startTypewriter()

void LatexGenerator::startTypewriter ()

inline virtual

Definition at line 157 of file latexgen.h.

157 void startTypewriter() override { m_t << "{\\ttfamily "; }

Reference OutputGenerator::m_t.

Referenced by startParameterDefVal.

type()

OutputType LatexGenerator::type ()

inline virtual

Definition at line 114 of file latexgen.h.

114 OutputType type() const override { return OutputType::Latex; }

Reference Latex.

Referenced by startMemberItem and startSection.

writeAnchor()

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

virtual

Declaration at line 198 of file latexgen.h, definition at line 1670 of file latexgen.cpp.

1670void LatexGenerator::writeAnchor(const QCString &fName,const QCString &name)

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)

virtual

Declaration at line 209 of file latexgen.h, definition at line 1775 of file latexgen.cpp.

1775void LatexGenerator::writeChar(char c)

1776{

1777 char cs[2];

1778 cs[0]=c;

1779 cs[1]=0;

1780 docify(cs);

1781}

Reference docify.

writeDoc()

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

virtual

Declaration at line 118 of file latexgen.h, definition at line 2141 of file latexgen.cpp.

2141void LatexGenerator::writeDoc(const IDocNodeAST *ast,const Definition *ctx,const MemberDef *,int)

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(""),

2148 m_hierarchyLevel);

2149 std::visit(visitor,astImpl->root);

2150 }

2151}

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

writeFooter()

void LatexGenerator::writeFooter (const QCString &)

inline virtual

Definition at line 123 of file latexgen.h.

123 void writeFooter(const QCString &) override {}

writeGraphicalHierarchy()

void LatexGenerator::writeGraphicalHierarchy (DotGfxHierarchyTable &)

inline virtual

Definition at line 271 of file latexgen.h.

271 void writeGraphicalHierarchy(DotGfxHierarchyTable &) override {}

writeInheritedSectionTitle()

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

virtual

Declaration at line 221 of file latexgen.h, definition at line 2300 of file latexgen.cpp.

2300void LatexGenerator::writeInheritedSectionTitle(

2301 const QCString &/*id*/,const QCString &ref,

2302 const QCString &file, const QCString &anchor,

2303 const QCString &title, const QCString &name)

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}

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)

virtual

Declaration at line 311 of file latexgen.h, definition at line 2290 of file latexgen.cpp.

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

2291{

2292 m_t << "{\\ttfamily [" << l << "]}";

2293 if (!isLast) m_t << ", ";

2294}

Reference OutputGenerator::m_t.

writeLatexSpacing()

void LatexGenerator::writeLatexSpacing ()

inline virtual

Definition at line 210 of file latexgen.h.

210 void writeLatexSpacing() override { m_t << "\\hspace{0.3cm}"; }

Reference OutputGenerator::m_t.

writeLogo()

void LatexGenerator::writeLogo ()

inline virtual

Definition at line 241 of file latexgen.h.

241 void writeLogo() override {}

writeNavigationPath()

void LatexGenerator::writeNavigationPath (const QCString &)

inline virtual

Definition at line 240 of file latexgen.h.

240 void writeNavigationPath(const QCString &) override {}

writeNonBreakableSpace()

void LatexGenerator::writeNonBreakableSpace (int)

virtual

Declaration at line 247 of file latexgen.h, definition at line 1880 of file latexgen.cpp.

1880void LatexGenerator::writeNonBreakableSpace(int)

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)

virtual

Declaration at line 152 of file latexgen.h, definition at line 1443 of file latexgen.cpp.

1443void LatexGenerator::writeObjectLink(const QCString &ref, const QCString &f,

1444 const QCString &anchor, const QCString &text)

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)

virtual

Declaration at line 129 of file latexgen.h, definition at line 1275 of file latexgen.cpp.

1275void LatexGenerator::writePageLink(const QCString &name, bool /*first*/)

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}

Reference OutputGenerator::m_t.

Referenced by endIndexSection.

writePageOutline()

void LatexGenerator::writePageOutline ()

inline virtual

Definition at line 244 of file latexgen.h.

244 void writePageOutline() override {}

writeQuickLinks()

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

inline virtual

Definition at line 242 of file latexgen.h.

242 void writeQuickLinks(HighlightedItem,const QCString &,bool) override {}

writeRuler()

void LatexGenerator::writeRuler ()

inline virtual

Definition at line 197 of file latexgen.h.

197 void writeRuler() override { m_t << "\n\n"; }

Reference OutputGenerator::m_t.

writeSearchInfo()

void LatexGenerator::writeSearchInfo ()

inline virtual

Definition at line 122 of file latexgen.h.

122 void writeSearchInfo() override {}

writeSplitBar()

void LatexGenerator::writeSplitBar (const QCString &, const QCString &)

inline virtual

Definition at line 239 of file latexgen.h.

239 void writeSplitBar(const QCString &,const QCString &) override {}

writeStartAnnoItem()

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

virtual

Declaration at line 211 of file latexgen.h, definition at line 1341 of file latexgen.cpp.

1341void LatexGenerator::writeStartAnnoItem(const QCString &,const QCString &,

1342 const QCString &path,const QCString &name)

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)

virtual

Declaration at line 138 of file latexgen.h, definition at line 1319 of file latexgen.cpp.

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

1320{

1321 m_t << text;

1322}

Reference OutputGenerator::m_t.

writeStyleInfo()

void LatexGenerator::writeStyleInfo (int part)

virtual

Declaration at line 132 of file latexgen.h, definition at line 1284 of file latexgen.cpp.

1284void LatexGenerator::writeStyleInfo(int part)

1285{

1286 if (part > 0)

1287 return;

1288

1289 startPlainFile("doxygen.sty");

1290 writeDefaultStyleSheet(m_t);

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}

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

writeSummaryLink()

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

inline virtual

Definition at line 243 of file latexgen.h.

243 void writeSummaryLink(const QCString &,const QCString &,const QCString &,bool) override {}

writeSynopsis()

void LatexGenerator::writeSynopsis ()

inline virtual

Definition at line 232 of file latexgen.h.

232 void writeSynopsis() override {}

Private Member Functions

endTitle()

void LatexGenerator::endTitle ()

inline

Definition at line 325 of file latexgen.h.

325 void endTitle() { m_t << "}"; }

Reference OutputGenerator::m_t.

startTitle()

void LatexGenerator::startTitle ()

Declaration at line 324 of file latexgen.h, definition at line 1503 of file latexgen.cpp.

1503void LatexGenerator::startTitle()

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.

Private Member Attributes

m_codeGen

LatexCodeGenerator* LatexGenerator::m_codeGen

m_codeList

std::unique_ptr<OutputCodeList> LatexGenerator::m_codeList

Definition at line 332 of file latexgen.h.

332 std::unique_ptr<OutputCodeList> m_codeList;

Referenced by LatexGenerator, LatexGenerator, operator= and writeDoc.

m_disableLinks

bool LatexGenerator::m_disableLinks = false

Definition at line 328 of file latexgen.h.

328 bool m_disableLinks = false;

Referenced by endGroupHeader, endMemberDoc, endMemberHeader, endTextLink, LatexGenerator, operator=, startGroupHeader, startMemberHeader, startTextLink, writeInheritedSectionTitle and writeObjectLink.

m_firstDescItem

bool LatexGenerator::m_firstDescItem = true

Definition at line 327 of file latexgen.h.

327 bool m_firstDescItem = true;

Referenced by LatexGenerator and operator=.

m_hierarchyLevel

int LatexGenerator::m_hierarchyLevel = 0

Definition at line 335 of file latexgen.h.

335 int m_hierarchyLevel = 0;

Referenced by LatexGenerator, operator=, startFile, startGroupHeader, startInlineHeader, startLocalToc, startMemberDoc, startMemberHeader, startTitleHead, writeDoc and writeInheritedSectionTitle.

m_indent

int LatexGenerator::m_indent = 0

Definition at line 330 of file latexgen.h.

330 int m_indent = 0;

Referenced by endAnonTypeScope, LatexGenerator, operator=, startAnonTypeScope and startMemberDescription.

m_insideTableEnv

bool LatexGenerator::m_insideTableEnv = false

Definition at line 334 of file latexgen.h.

334 bool m_insideTableEnv = false;

Referenced by addLabel, endMemberDocSimple, startDoxyAnchor and startMemberDocSimple.

m_relPath

QCString LatexGenerator::m_relPath

Definition at line 329 of file latexgen.h.

329 QCString m_relPath;

Referenced by endCallGraph, endDirDepGraph, endDotGraph, endGroupCollaboration, endInclDepGraph, LatexGenerator, operator= and startFile.

m_templateMemberItem

bool LatexGenerator::m_templateMemberItem = false

Definition at line 331 of file latexgen.h.

331 bool m_templateMemberItem = false;

Referenced by endMemberItem, endMemberTemplateParams, LatexGenerator, operator=, startMemberItem and startMemberTemplateParams.

Public Static Functions

init()

void LatexGenerator::init ()

static

Declaration at line 103 of file latexgen.h, definition at line 630 of file latexgen.cpp.

630void LatexGenerator::init()

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);

642 g_header=fileToString(g_header_file);

643 //printf("g_header='%s'\n",qPrint(g_header));

644 QCString result = substituteLatexKeywords(g_header_file,g_header,QCString());

645 checkBlocks(result,g_header_file,latexMarkerInfo);

646 }

647 else

648 {

649 g_header_file = "header.tex";

650 g_header = ResourceMgr::instance().getAsString(g_header_file);

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);

657 g_footer=fileToString(g_footer_file);

658 //printf("g_footer='%s'\n",qPrint(g_footer));

659 QCString result = substituteLatexKeywords(g_footer_file,g_footer,QCString());

660 checkBlocks(result,g_footer_file,latexMarkerInfo);

661 }

662 else

663 {

664 g_footer_file = "footer.tex";

665 g_footer = ResourceMgr::instance().getAsString(g_footer_file);

666 QCString result = substituteLatexKeywords(g_footer_file,g_footer,QCString());

667 checkBlocks(result,"<default footer.tex>",latexMarkerInfo);

668 }

669

670 writeLatexMakefile();

671 writeMakeBat();

672

673 createSubDirs(d);

674}

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.

writeFooterFile()

void LatexGenerator::writeFooterFile (TextStream & t)

static

Declaration at line 106 of file latexgen.h, definition at line 694 of file latexgen.cpp.

694void LatexGenerator::writeFooterFile(TextStream &t)

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.

writeHeaderFile()

void LatexGenerator::writeHeaderFile (TextStream & t)

static

Declaration at line 105 of file latexgen.h, definition at line 688 of file latexgen.cpp.

688void LatexGenerator::writeHeaderFile(TextStream &t)

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.

writeStyleSheetFile()

void LatexGenerator::writeStyleSheetFile (TextStream & t)

static

Declaration at line 104 of file latexgen.h, definition at line 700 of file latexgen.cpp.

700void LatexGenerator::writeStyleSheetFile(TextStream &t)

701{

702 t << "% stylesheet for doxygen " << getDoxygenVersion() << "\n";

703 writeDefaultStyleSheet(t);

704}

Reference writeDefaultStyleSheet.

Referenced by readConfiguration.

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

Generated via doxygen2docusaurus by Doxygen 1.14.0.

Declaration​

Included Headers​

Base classes​

Public Constructors Index​

Public Destructor Index​

Public Operators Index​

Public Member Functions Index​

Private Member Functions Index​

Private Member Attributes Index​

Public Static Functions Index​

Description​

Public Constructors​

LatexGenerator()​

LatexGenerator()​

LatexGenerator()​

Public Destructor​

~LatexGenerator()​

Public Operators​

operator=()​

operator=()​

Public Member Functions​

addCodeGen()​

addIndexItem()​

addLabel()​

addWord()​

cleanup()​

clearBuffer()​

clone()​

docify()​

endAnonTypeScope()​

endBold()​

endCallGraph()​

endCenter()​

endClassDiagram()​

endCompoundTemplateParams()​

endConstraintDocs()​

endConstraintList()​

endConstraintParam()​

endConstraintType()​

endContents()​

endDescForItem()​

endDescTable()​

endDescTableData()​

endDescTableInit()​

endDescTableRow()​

endDescTableTitle()​

endDirDepGraph()​

endDotGraph()​

endDoxyAnchor()​

endEmphasis()​

endExamples()​

endFile()​

endGroupCollaboration()​

endGroupHeader()​

endHeaderSection()​

endInclDepGraph()​

endIndent()​

endIndexItem()​

endIndexKey()​

endIndexList()​

endIndexListItem()​

endIndexSection()​

endIndexValue()​

endInlineHeader()​

endInlineMemberDoc()​

endInlineMemberName()​

endInlineMemberType()​

endItemList()​

endItemListItem()​

endLabels()​

endLocalToc()​

endMemberDeclaration()​

endMemberDescription()​

endMemberDoc()​

endMemberDocList()​

endMemberDocName()​

endMemberDocPrefixItem()​

endMemberDocSimple()​

endMemberGroup()​

endMemberGroupDocs()​

Declaration

Included Headers

Base classes

Public Constructors Index

Public Destructor Index

Public Operators Index

Public Member Functions Index

Private Member Functions Index

Private Member Attributes Index

Public Static Functions Index

Description

Public Constructors

LatexGenerator()

LatexGenerator()

LatexGenerator()

Public Destructor

~LatexGenerator()

Public Operators

operator=()

operator=()

Public Member Functions

addCodeGen()

addIndexItem()

addLabel()

addWord()

cleanup()

clearBuffer()

clone()

docify()

endAnonTypeScope()

endBold()

endCallGraph()

endCenter()

endClassDiagram()

endCompoundTemplateParams()

endConstraintDocs()

endConstraintList()

endConstraintParam()

endConstraintType()

endContents()

endDescForItem()

endDescTable()

endDescTableData()

endDescTableInit()

endDescTableRow()

endDescTableTitle()

endDirDepGraph()

endDotGraph()

endDoxyAnchor()

endEmphasis()

endExamples()

endFile()

endGroupCollaboration()

endGroupHeader()

endHeaderSection()

endInclDepGraph()

endIndent()

endIndexItem()

endIndexKey()

endIndexList()

endIndexListItem()

endIndexSection()

endIndexValue()

endInlineHeader()

endInlineMemberDoc()

endInlineMemberName()

endInlineMemberType()

endItemList()

endItemListItem()

endLabels()

endLocalToc()

endMemberDeclaration()

endMemberDescription()

endMemberDoc()

endMemberDocList()

endMemberDocName()

endMemberDocPrefixItem()

endMemberDocSimple()

endMemberGroup()

endMemberGroupDocs()