doxygen  1.8.18
About: Doxygen is a source code documentation generator tool for C++, C, Objective-C, C#, PHP, Java, Python, IDL (diverse flavors), Fortran, VHDL, Tcl, and to some extent D. Different output formats are supported.
  Fossies Dox: doxygen-1.8.18.src.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

LatexGenerator Class Reference

Generator for LaTeX output. More...

#include <latexgen.h>

+ Inheritance diagram for LatexGenerator:
+ Collaboration diagram for LatexGenerator:

Public Member Functions

 LatexGenerator ()
 
 ~LatexGenerator ()
 
void enable ()
 
void disable ()
 
void enableIf (OutputType o)
 
void disableIf (OutputType o)
 
void disableIfNot (OutputType o)
 
bool isEnabled (OutputType o)
 
OutputGeneratorget (OutputType o)
 
void codify (const char *text)
 
void writeCodeLink (const char *ref, const char *file, const char *anchor, const char *name, const char *tooltip)
 
void writeLineNumber (const char *ref, const char *file, const char *anchor, int lineNumber)
 
void writeTooltip (const char *id, const DocLinkInfo &docInfo, const char *decl, const char *desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo)
 
void startCodeLine (bool hasLineNumbers)
 
void endCodeLine ()
 
void startFontClass (const char *s)
 
void endFontClass ()
 
void writeCodeAnchor (const char *anchor)
 
void writeDoc (DocNode *, const Definition *ctx, const MemberDef *)
 
void startFile (const char *name, const char *manName, const char *title)
 
void writeSearchInfo ()
 
void writeFooter (const char *)
 
void endFile ()
 
void clearBuffer ()
 
void startIndexSection (IndexSections)
 
void endIndexSection (IndexSections)
 
void writePageLink (const char *, bool)
 
void startProjectNumber ()
 
void endProjectNumber ()
 
void writeStyleInfo (int part)
 
void startTitleHead (const char *)
 
void startTitle ()
 
void endTitleHead (const char *, const char *name)
 
void endTitle ()
 
void newParagraph ()
 
void startParagraph (const char *classDef)
 
void endParagraph ()
 
void writeString (const char *text)
 
void startIndexListItem ()
 
void endIndexListItem ()
 
void startIndexList ()
 
void endIndexList ()
 
void startIndexKey ()
 
void endIndexKey ()
 
void startIndexValue (bool)
 
void endIndexValue (const char *, bool)
 
void startItemList ()
 
void endItemList ()
 
void startIndexItem (const char *ref, const char *file)
 
void endIndexItem (const char *ref, const char *file)
 
void docify (const char *text)
 
void writeObjectLink (const char *ref, const char *file, const char *anchor, const char *name)
 
void startTextLink (const char *, const char *)
 
void endTextLink ()
 
void startHtmlLink (const char *url)
 
void endHtmlLink ()
 
void startTypewriter ()
 
void endTypewriter ()
 
void startGroupHeader (int)
 
void endGroupHeader (int)
 
void startItemListItem ()
 
void endItemListItem ()
 
void startMemberSections ()
 
void endMemberSections ()
 
void startHeaderSection ()
 
void endHeaderSection ()
 
void startMemberHeader (const char *, int)
 
void endMemberHeader ()
 
void startMemberSubtitle ()
 
void endMemberSubtitle ()
 
void startMemberDocList ()
 
void endMemberDocList ()
 
void startMemberList ()
 
void endMemberList ()
 
void startInlineHeader ()
 
void endInlineHeader ()
 
void startAnonTypeScope (int)
 
void endAnonTypeScope (int)
 
void startMemberItem (const char *, int, const char *)
 
void endMemberItem ()
 
void startMemberTemplateParams ()
 
void endMemberTemplateParams (const char *, const char *)
 
void startMemberGroupHeader (bool)
 
void endMemberGroupHeader ()
 
void startMemberGroupDocs ()
 
void endMemberGroupDocs ()
 
void startMemberGroup ()
 
void endMemberGroup (bool)
 
void insertMemberAlign (bool)
 
void insertMemberAlignLeft (int, bool)
 
void writeRuler ()
 
void writeAnchor (const char *fileName, const char *name)
 
void startCodeFragment ()
 
void endCodeFragment ()
 
void startEmphasis ()
 
void endEmphasis ()
 
void startBold ()
 
void endBold ()
 
void startDescription ()
 
void endDescription ()
 
void startDescItem ()
 
void endDescItem ()
 
void lineBreak (const char *style=0)
 
void startMemberDoc (const char *, const char *, const char *, const char *, int, int, bool)
 
void endMemberDoc (bool)
 
void startDoxyAnchor (const char *, const char *, const char *, const char *, const char *)
 
void endDoxyAnchor (const char *, const char *)
 
void writeChar (char c)
 
void writeLatexSpacing ()
 
void writeStartAnnoItem (const char *type, const char *file, const char *path, const char *name)
 
void writeEndAnnoItem (const char *name)
 
void startSubsection ()
 
void endSubsection ()
 
void startSubsubsection ()
 
void endSubsubsection ()
 
void startCenter ()
 
void endCenter ()
 
void startSmall ()
 
void endSmall ()
 
void startMemberDescription (const char *, const char *, bool)
 
void endMemberDescription ()
 
void startMemberDeclaration ()
 
void endMemberDeclaration (const char *, const char *)
 
void writeInheritedSectionTitle (const char *, const char *, const char *, const char *, const char *, const char *)
 
void startDescList (SectionTypes)
 
void endDescList ()
 
void startExamples ()
 
void endExamples ()
 
void startParamList (ParamListTypes, const char *title)
 
void endParamList ()
 
void startDescForItem ()
 
void endDescForItem ()
 
void startSection (const char *, const char *, SectionType)
 
void endSection (const char *, SectionType)
 
void addIndexItem (const char *, const char *)
 
void startIndent ()
 
void endIndent ()
 
void writeSynopsis ()
 
void startClassDiagram ()
 
void endClassDiagram (const ClassDiagram &, const char *, const char *)
 
void startPageRef ()
 
void endPageRef (const char *, const char *)
 
void startQuickIndices ()
 
void endQuickIndices ()
 
void writeSplitBar (const char *)
 
void writeNavigationPath (const char *)
 
void writeLogo ()
 
void writeQuickLinks (bool, HighlightedItem, const char *)
 
void writeSummaryLink (const char *, const char *, const char *, bool)
 
void startContents ()
 
void endContents ()
 
void writeNonBreakableSpace (int)
 
void startDescTable (const char *title)
 
void endDescTable ()
 
void startDescTableRow ()
 
void endDescTableRow ()
 
void startDescTableTitle ()
 
void endDescTableTitle ()
 
void startDescTableData ()
 
void endDescTableData ()
 
void lastIndexPage ()
 
void startDotGraph ()
 
void endDotGraph (DotClassGraph &)
 
void startInclDepGraph ()
 
void endInclDepGraph (DotInclDepGraph &)
 
void startCallGraph ()
 
void startGroupCollaboration ()
 
void endGroupCollaboration (DotGroupCollaboration &g)
 
void endCallGraph (DotCallGraph &)
 
void startDirDepGraph ()
 
void endDirDepGraph (DotDirDeps &g)
 
void writeGraphicalHierarchy (DotGfxHierarchyTable &)
 
void startTextBlock (bool)
 
void endTextBlock (bool)
 
void startMemberDocPrefixItem ()
 
void endMemberDocPrefixItem ()
 
void startMemberDocName (bool)
 
void endMemberDocName ()
 
void startParameterType (bool, const char *)
 
void endParameterType ()
 
void startParameterName (bool)
 
void endParameterName (bool, bool, bool)
 
void startParameterList (bool)
 
void endParameterList ()
 
void exceptionEntry (const char *, bool)
 
void startConstraintList (const char *)
 
void startConstraintParam ()
 
void endConstraintParam ()
 
void startConstraintType ()
 
void endConstraintType ()
 
void startConstraintDocs ()
 
void endConstraintDocs ()
 
void endConstraintList ()
 
void startMemberDocSimple (bool)
 
void endMemberDocSimple (bool)
 
void startInlineMemberType ()
 
void endInlineMemberType ()
 
void startInlineMemberName ()
 
void endInlineMemberName ()
 
void startInlineMemberDoc ()
 
void endInlineMemberDoc ()
 
void startLabels ()
 
void writeLabel (const char *l, bool isLast)
 
void endLabels ()
 
void setCurrentDoc (const Definition *, const char *, bool)
 
void addWord (const char *, bool)
 
- Public Member Functions inherited from OutputGenerator
 OutputGenerator ()
 Copyright (C) 1997-2015 by Dimitri van Heesch. More...
 
virtual ~OutputGenerator ()
 
void startPlainFile (const char *name)
 
void endPlainFile ()
 
bool isEnabled () const
 
void pushGeneratorState ()
 
void popGeneratorState ()
 
virtual void startPageDoc (const char *)
 
virtual void endPageDoc ()
 
- Public Member Functions inherited from BaseOutputDocInterface
virtual ~BaseOutputDocInterface ()
 
virtual void parseText (const QCString &)
 
- Public Member Functions inherited from CodeOutputInterface
virtual ~CodeOutputInterface ()
 

Static Public Member Functions

static void init ()
 
static void writeStyleSheetFile (QFile &f)
 
static void writeHeaderFile (QFile &f)
 
static void writeFooterFile (QFile &f)
 

Private Member Functions

 LatexGenerator (const LatexGenerator &)
 
LatexGeneratoroperator= (const LatexGenerator &)
 

Private Attributes

bool m_insideTabbing
 
bool m_firstDescItem
 
bool m_disableLinks
 
QCString m_relPath
 
int m_indent
 
bool templateMemberItem
 
bool m_prettyCode
 
LatexCodeGenerator m_codeGen
 

Additional Inherited Members

- Public Types inherited from OutputGenerator
enum  OutputType {
  Html, Latex, Man, RTF,
  XML, DEF, Perl, Docbook
}
 
- Public Types inherited from BaseOutputDocInterface
enum  ParamListTypes { Param, RetVal, Exception }
 
enum  SectionTypes { EnumValues, Examples }
 
- Protected Attributes inherited from OutputGenerator
FTextStream t
 
QFilem_file
 
QCString m_fileName
 
QCString m_dir
 
bool m_active
 
QStack< bool > * m_genStack
 

Detailed Description

Generator for LaTeX output.

Definition at line 71 of file latexgen.h.

Constructor & Destructor Documentation

◆ LatexGenerator() [1/2]

◆ ~LatexGenerator()

LatexGenerator::~LatexGenerator ( )

Definition at line 280 of file latexgen.cpp.

◆ LatexGenerator() [2/2]

LatexGenerator::LatexGenerator ( const LatexGenerator )
private

Member Function Documentation

◆ addIndexItem()

void LatexGenerator::addIndexItem ( const char *  s1,
const char *  s2 
)
virtual

◆ addWord()

void LatexGenerator::addWord ( const char *  ,
bool   
)
inlinevirtual

Implements CodeOutputInterface.

Definition at line 325 of file latexgen.h.

◆ clearBuffer()

void LatexGenerator::clearBuffer ( )

◆ codify()

void LatexGenerator::codify ( const char *  s)
inlinevirtual

Writes an code fragment to the output. This function should keep spaces visible, should break lines at a newline and should convert tabs to the right number of spaces.

Implements CodeOutputInterface.

Definition at line 94 of file latexgen.h.

References LatexCodeGenerator::codify(), and m_codeGen.

◆ disable()

void LatexGenerator::disable ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 86 of file latexgen.h.

References FALSE, and OutputGenerator::m_active.

Referenced by disableIf(), and disableIfNot().

◆ disableIf()

void LatexGenerator::disableIf ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 88 of file latexgen.h.

References disable(), and OutputGenerator::Latex.

◆ disableIfNot()

void LatexGenerator::disableIfNot ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 89 of file latexgen.h.

References disable(), and OutputGenerator::Latex.

◆ docify()

void LatexGenerator::docify ( const char *  s)
virtual

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

Implements BaseOutputDocInterface.

Definition at line 1817 of file latexgen.cpp.

References FALSE, filterLatexString(), m_insideTabbing, and OutputGenerator::t.

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

◆ enable()

void LatexGenerator::enable ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 84 of file latexgen.h.

References OutputGenerator::m_active, OutputGenerator::m_genStack, QStack< type >::top(), and TRUE.

Referenced by enableIf().

◆ enableIf()

void LatexGenerator::enableIf ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 87 of file latexgen.h.

References enable(), and OutputGenerator::Latex.

◆ endAnonTypeScope()

void LatexGenerator::endAnonTypeScope ( int  indent)
virtual

Implements OutputGenerator.

Definition at line 1854 of file latexgen.cpp.

References endl(), FALSE, m_indent, m_insideTabbing, and OutputGenerator::t.

◆ endBold()

void LatexGenerator::endBold ( )
inlinevirtual

End a section of text displayed in bold face.

Implements BaseOutputDocInterface.

Definition at line 207 of file latexgen.h.

References OutputGenerator::t.

◆ endCallGraph()

void LatexGenerator::endCallGraph ( DotCallGraph g)
virtual

◆ endCenter()

void LatexGenerator::endCenter ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 227 of file latexgen.h.

References endl(), and OutputGenerator::t.

◆ endClassDiagram()

void LatexGenerator::endClassDiagram ( const ClassDiagram d,
const char *  fileName,
const char *   
)
virtual

◆ endCodeFragment()

void LatexGenerator::endCodeFragment ( )
virtual

Ends a source code fragment

Implements BaseOutputDocInterface.

Definition at line 2262 of file latexgen.cpp.

References DoxyCodeOpen, endCodeLine(), FALSE, and OutputGenerator::t.

◆ endCodeLine()

void LatexGenerator::endCodeLine ( )
inlinevirtual

Ends a line of code started with startCodeLine()

Implements CodeOutputInterface.

Definition at line 108 of file latexgen.h.

References LatexCodeGenerator::endCodeLine(), and m_codeGen.

Referenced by endCodeFragment().

◆ endConstraintDocs()

void LatexGenerator::endConstraintDocs ( )
virtual

Implements OutputGenerator.

Definition at line 2246 of file latexgen.cpp.

◆ endConstraintList()

void LatexGenerator::endConstraintList ( )
virtual

Implements OutputGenerator.

Definition at line 2250 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

◆ endConstraintParam()

void LatexGenerator::endConstraintParam ( )
virtual

Implements OutputGenerator.

Definition at line 2228 of file latexgen.cpp.

◆ endConstraintType()

void LatexGenerator::endConstraintType ( )
virtual

Implements OutputGenerator.

Definition at line 2237 of file latexgen.cpp.

References OutputGenerator::t.

◆ endContents()

void LatexGenerator::endContents ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 262 of file latexgen.h.

◆ endDescForItem()

void LatexGenerator::endDescForItem ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 243 of file latexgen.h.

◆ endDescItem()

void LatexGenerator::endDescItem ( )
virtual

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

Implements BaseOutputDocInterface.

Definition at line 2124 of file latexgen.cpp.

References endl(), FALSE, lineBreak(), m_firstDescItem, and OutputGenerator::t.

◆ endDescList()

void LatexGenerator::endDescList ( )
inline

Definition at line 237 of file latexgen.h.

References endl(), and OutputGenerator::t.

◆ endDescription()

void LatexGenerator::endDescription ( )
virtual

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

Implements BaseOutputDocInterface.

Definition at line 2112 of file latexgen.cpp.

References endl(), m_firstDescItem, OutputGenerator::t, and TRUE.

◆ endDescTable()

void LatexGenerator::endDescTable ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1960 of file latexgen.cpp.

References decUsedTableLevels(), endl(), and OutputGenerator::t.

◆ endDescTableData()

void LatexGenerator::endDescTableData ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1991 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

◆ endDescTableRow()

void LatexGenerator::endDescTableRow ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1973 of file latexgen.cpp.

◆ endDescTableTitle()

void LatexGenerator::endDescTableTitle ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1982 of file latexgen.cpp.

◆ endDirDepGraph()

void LatexGenerator::endDirDepGraph ( DotDirDeps g)
virtual

◆ endDotGraph()

void LatexGenerator::endDotGraph ( DotClassGraph g)
virtual

◆ endDoxyAnchor()

void LatexGenerator::endDoxyAnchor ( const char *  fName,
const char *  anchor 
)
virtual

Implements OutputGenerator.

Definition at line 1723 of file latexgen.cpp.

◆ endEmphasis()

void LatexGenerator::endEmphasis ( )
inlinevirtual

Ends a section of text displayed in italic.

Implements BaseOutputDocInterface.

Definition at line 205 of file latexgen.h.

References OutputGenerator::t.

◆ endExamples()

void LatexGenerator::endExamples ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2144 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

◆ endFile()

void LatexGenerator::endFile ( )
virtual

◆ endFontClass()

void LatexGenerator::endFontClass ( )
inlinevirtual

Ends a block started with startFontClass()

Implements CodeOutputInterface.

Definition at line 112 of file latexgen.h.

References LatexCodeGenerator::endFontClass(), and m_codeGen.

◆ endGroupCollaboration()

void LatexGenerator::endGroupCollaboration ( DotGroupCollaboration g)
virtual

◆ endGroupHeader()

void LatexGenerator::endGroupHeader ( int  )
virtual

Implements OutputGenerator.

Definition at line 1606 of file latexgen.cpp.

References endl(), FALSE, m_disableLinks, and OutputGenerator::t.

◆ endHeaderSection()

void LatexGenerator::endHeaderSection ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 172 of file latexgen.h.

◆ endHtmlLink()

void LatexGenerator::endHtmlLink ( )
virtual

Ends a link started by startHtmlLink().

Implements BaseOutputDocInterface.

Definition at line 1414 of file latexgen.cpp.

References OutputGenerator::t.

◆ endInclDepGraph()

void LatexGenerator::endInclDepGraph ( DotInclDepGraph g)
virtual

◆ endIndent()

void LatexGenerator::endIndent ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 248 of file latexgen.h.

◆ endIndexItem()

void LatexGenerator::endIndexItem ( const char *  ref,
const char *  file 
)
virtual

Implements OutputGenerator.

Definition at line 1387 of file latexgen.cpp.

References endl(), stripPath(), and OutputGenerator::t.

◆ endIndexKey()

void LatexGenerator::endIndexKey ( )
virtual

Implements OutputGenerator.

Definition at line 1451 of file latexgen.cpp.

◆ endIndexList()

void LatexGenerator::endIndexList ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 145 of file latexgen.h.

References endl(), and OutputGenerator::t.

◆ endIndexListItem()

void LatexGenerator::endIndexListItem ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 143 of file latexgen.h.

◆ endIndexSection()

◆ endIndexValue()

void LatexGenerator::endIndexValue ( const char *  name,
bool   
)
virtual

Implements OutputGenerator.

Definition at line 1461 of file latexgen.cpp.

References endl(), stripPath(), and OutputGenerator::t.

◆ endInlineHeader()

void LatexGenerator::endInlineHeader ( )
virtual

Implements OutputGenerator.

Definition at line 2283 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

◆ endInlineMemberDoc()

void LatexGenerator::endInlineMemberDoc ( )
virtual

Implements OutputGenerator.

Definition at line 2355 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

◆ endInlineMemberName()

void LatexGenerator::endInlineMemberName ( )
virtual

Implements OutputGenerator.

Definition at line 2345 of file latexgen.cpp.

References endl(), FALSE, m_insideTabbing, and OutputGenerator::t.

◆ endInlineMemberType()

void LatexGenerator::endInlineMemberType ( )
virtual

Implements OutputGenerator.

Definition at line 2334 of file latexgen.cpp.

References endl(), FALSE, m_insideTabbing, and OutputGenerator::t.

◆ endItemList()

void LatexGenerator::endItemList ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 151 of file latexgen.h.

References endl(), and OutputGenerator::t.

◆ endItemListItem()

void LatexGenerator::endItemListItem ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 167 of file latexgen.h.

◆ endLabels()

void LatexGenerator::endLabels ( )
virtual

Implements OutputGenerator.

Definition at line 2371 of file latexgen.cpp.

◆ endMemberDeclaration()

void LatexGenerator::endMemberDeclaration ( const char *  ,
const char *   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 233 of file latexgen.h.

◆ endMemberDescription()

void LatexGenerator::endMemberDescription ( )
virtual

Implements OutputGenerator.

Definition at line 1913 of file latexgen.cpp.

References m_insideTabbing, and OutputGenerator::t.

◆ endMemberDoc()

void LatexGenerator::endMemberDoc ( bool  )
virtual

Implements OutputGenerator.

Definition at line 1696 of file latexgen.cpp.

References FALSE, m_disableLinks, and OutputGenerator::t.

◆ endMemberDocList()

void LatexGenerator::endMemberDocList ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 178 of file latexgen.h.

◆ endMemberDocName()

void LatexGenerator::endMemberDocName ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 293 of file latexgen.h.

◆ endMemberDocPrefixItem()

void LatexGenerator::endMemberDocPrefixItem ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 291 of file latexgen.h.

References endl(), and OutputGenerator::t.

◆ endMemberDocSimple()

void LatexGenerator::endMemberDocSimple ( bool  isEnum)
virtual

Implements OutputGenerator.

Definition at line 2316 of file latexgen.cpp.

References decUsedTableLevels(), endl(), and OutputGenerator::t.

◆ endMemberGroup()

void LatexGenerator::endMemberGroup ( bool  hasHeader)
virtual

Implements OutputGenerator.

Definition at line 2055 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

◆ endMemberGroupDocs()

void LatexGenerator::endMemberGroupDocs ( )
virtual

Implements OutputGenerator.

Definition at line 2046 of file latexgen.cpp.

References OutputGenerator::t.

◆ endMemberGroupHeader()

void LatexGenerator::endMemberGroupHeader ( )
virtual

Implements OutputGenerator.

Definition at line 2034 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

◆ endMemberHeader()

void LatexGenerator::endMemberHeader ( )
virtual

Implements OutputGenerator.

Definition at line 1625 of file latexgen.cpp.

References endl(), FALSE, m_disableLinks, and OutputGenerator::t.

◆ endMemberItem()

void LatexGenerator::endMemberItem ( )
virtual

Implements OutputGenerator.

Definition at line 1890 of file latexgen.cpp.

References endl(), FALSE, m_insideTabbing, OutputGenerator::t, and templateMemberItem.

◆ endMemberList()

void LatexGenerator::endMemberList ( )
virtual

Implements OutputGenerator.

Definition at line 2009 of file latexgen.cpp.

References endl(), m_insideTabbing, and OutputGenerator::t.

◆ endMemberSections()

void LatexGenerator::endMemberSections ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 170 of file latexgen.h.

◆ endMemberSubtitle()

void LatexGenerator::endMemberSubtitle ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 176 of file latexgen.h.

◆ endMemberTemplateParams()

void LatexGenerator::endMemberTemplateParams ( const char *  ,
const char *   
)
virtual

Implements OutputGenerator.

Definition at line 1872 of file latexgen.cpp.

References OutputGenerator::t, and templateMemberItem.

◆ endPageRef()

void LatexGenerator::endPageRef ( const char *  clname,
const char *  anchor 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1528 of file latexgen.cpp.

References OutputGenerator::t.

◆ endParagraph()

void LatexGenerator::endParagraph ( )
virtual

Ends a paragraph

Implements BaseOutputDocInterface.

Definition at line 1368 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

◆ endParameterList()

void LatexGenerator::endParameterList ( )
virtual

Implements OutputGenerator.

Definition at line 2168 of file latexgen.cpp.

◆ endParameterName()

void LatexGenerator::endParameterName ( bool  last,
bool  ,
bool  closeBracket 
)
virtual

Implements OutputGenerator.

Definition at line 2188 of file latexgen.cpp.

References OutputGenerator::t.

◆ endParameterType()

void LatexGenerator::endParameterType ( )
virtual

Implements OutputGenerator.

Definition at line 2178 of file latexgen.cpp.

References OutputGenerator::t.

◆ endParamList()

void LatexGenerator::endParamList ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2156 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

◆ endProjectNumber()

void LatexGenerator::endProjectNumber ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 131 of file latexgen.h.

◆ endQuickIndices()

void LatexGenerator::endQuickIndices ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 255 of file latexgen.h.

◆ endSection()

void LatexGenerator::endSection ( const char *  lab,
SectionType   
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1811 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

◆ endSmall()

void LatexGenerator::endSmall ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 229 of file latexgen.h.

References OutputGenerator::t.

◆ endSubsection()

void LatexGenerator::endSubsection ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 223 of file latexgen.h.

References endl(), and OutputGenerator::t.

◆ endSubsubsection()

void LatexGenerator::endSubsubsection ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 225 of file latexgen.h.

References endl(), and OutputGenerator::t.

◆ endTextBlock()

void LatexGenerator::endTextBlock ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 288 of file latexgen.h.

◆ endTextLink()

void LatexGenerator::endTextLink ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1491 of file latexgen.cpp.

References Config_getBool, m_disableLinks, and OutputGenerator::t.

◆ endTitle()

void LatexGenerator::endTitle ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 136 of file latexgen.h.

References OutputGenerator::t.

◆ endTitleHead()

void LatexGenerator::endTitleHead ( const char *  fileName,
const char *  name 
)
virtual

◆ endTypewriter()

void LatexGenerator::endTypewriter ( )
inlinevirtual

End a section of text displayed in typewriter style.

Implements BaseOutputDocInterface.

Definition at line 163 of file latexgen.h.

References OutputGenerator::t.

◆ exceptionEntry()

void LatexGenerator::exceptionEntry ( const char *  prefix,
bool  closeBracket 
)
virtual

Implements OutputGenerator.

Definition at line 2198 of file latexgen.cpp.

References OutputGenerator::t.

◆ get()

OutputGenerator* LatexGenerator::get ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 91 of file latexgen.h.

References OutputGenerator::Latex.

◆ init()

void LatexGenerator::init ( )
static

◆ insertMemberAlign()

void LatexGenerator::insertMemberAlign ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 197 of file latexgen.h.

◆ insertMemberAlignLeft()

void LatexGenerator::insertMemberAlignLeft ( int  ,
bool   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 198 of file latexgen.h.

◆ isEnabled()

bool LatexGenerator::isEnabled ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 90 of file latexgen.h.

References OutputGenerator::Latex, and OutputGenerator::m_active.

◆ lastIndexPage()

void LatexGenerator::lastIndexPage ( )
virtual

Implements OutputGenerator.

Definition at line 1996 of file latexgen.cpp.

◆ lineBreak()

void LatexGenerator::lineBreak ( const char *  style = 0)
virtual

Implements BaseOutputDocInterface.

Definition at line 2288 of file latexgen.cpp.

References m_insideTabbing, and OutputGenerator::t.

Referenced by endDescItem().

◆ newParagraph()

void LatexGenerator::newParagraph ( )

Definition at line 1358 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

Referenced by startDotGraph().

◆ operator=()

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

◆ setCurrentDoc()

void LatexGenerator::setCurrentDoc ( const Definition ,
const char *  ,
bool   
)
inlinevirtual

Implements CodeOutputInterface.

Definition at line 324 of file latexgen.h.

◆ startAnonTypeScope()

void LatexGenerator::startAnonTypeScope ( int  indent)
virtual

Implements OutputGenerator.

Definition at line 1843 of file latexgen.cpp.

References endl(), m_indent, m_insideTabbing, OutputGenerator::t, and TRUE.

◆ startBold()

void LatexGenerator::startBold ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 206 of file latexgen.h.

References OutputGenerator::t.

◆ startCallGraph()

void LatexGenerator::startCallGraph ( )
virtual

Implements OutputGenerator.

Definition at line 2089 of file latexgen.cpp.

◆ startCenter()

void LatexGenerator::startCenter ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 226 of file latexgen.h.

References endl(), and OutputGenerator::t.

◆ startClassDiagram()

void LatexGenerator::startClassDiagram ( )
virtual

Implements OutputGenerator.

Definition at line 1830 of file latexgen.cpp.

◆ startCodeFragment()

void LatexGenerator::startCodeFragment ( )
virtual

Starts a source code fragment. The fragment will be fed to the code parser (see code.h) for syntax highlighting and cross-referencing. The fragment ends by a call to endCodeFragment()

Implements BaseOutputDocInterface.

Definition at line 2256 of file latexgen.cpp.

References DoxyCodeOpen, OutputGenerator::t, TRUE, and usedTableLevels().

◆ startCodeLine()

void LatexGenerator::startCodeLine ( bool  hasLineNumbers)
inlinevirtual

Implements CodeOutputInterface.

Definition at line 106 of file latexgen.h.

References m_codeGen, and LatexCodeGenerator::startCodeLine().

◆ startConstraintDocs()

void LatexGenerator::startConstraintDocs ( )
virtual

Implements OutputGenerator.

Definition at line 2242 of file latexgen.cpp.

◆ startConstraintList()

void LatexGenerator::startConstraintList ( const char *  header)
virtual

Implements OutputGenerator.

Definition at line 2215 of file latexgen.cpp.

References docify(), endl(), and OutputGenerator::t.

◆ startConstraintParam()

void LatexGenerator::startConstraintParam ( )
virtual

Implements OutputGenerator.

Definition at line 2223 of file latexgen.cpp.

References OutputGenerator::t.

◆ startConstraintType()

void LatexGenerator::startConstraintType ( )
virtual

Implements OutputGenerator.

Definition at line 2232 of file latexgen.cpp.

References OutputGenerator::t.

◆ startContents()

void LatexGenerator::startContents ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 261 of file latexgen.h.

◆ startDescForItem()

void LatexGenerator::startDescForItem ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 242 of file latexgen.h.

References endl(), and OutputGenerator::t.

◆ startDescItem()

void LatexGenerator::startDescItem ( )
virtual

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

Implements BaseOutputDocInterface.

Definition at line 2118 of file latexgen.cpp.

References m_firstDescItem, OutputGenerator::t, and TRUE.

◆ startDescList()

void LatexGenerator::startDescList ( SectionTypes  )
inline

Definition at line 236 of file latexgen.h.

References OutputGenerator::t.

◆ startDescription()

void LatexGenerator::startDescription ( )
virtual

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

Implements BaseOutputDocInterface.

Definition at line 2107 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

◆ startDescTable()

void LatexGenerator::startDescTable ( const char *  title)
virtual

Implements BaseOutputDocInterface.

Definition at line 1954 of file latexgen.cpp.

References endl(), incUsedTableLevels(), and OutputGenerator::t.

◆ startDescTableData()

void LatexGenerator::startDescTableData ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1986 of file latexgen.cpp.

References OutputGenerator::t.

◆ startDescTableRow()

void LatexGenerator::startDescTableRow ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1966 of file latexgen.cpp.

References OutputGenerator::t.

◆ startDescTableTitle()

void LatexGenerator::startDescTableTitle ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1977 of file latexgen.cpp.

References OutputGenerator::t.

◆ startDirDepGraph()

void LatexGenerator::startDirDepGraph ( )
virtual

Implements OutputGenerator.

Definition at line 2098 of file latexgen.cpp.

◆ startDotGraph()

void LatexGenerator::startDotGraph ( )
virtual

Implements OutputGenerator.

Definition at line 2061 of file latexgen.cpp.

References newParagraph().

◆ startDoxyAnchor()

void LatexGenerator::startDoxyAnchor ( const char *  fName,
const char *  ,
const char *  anchor,
const char *  ,
const char *   
)
virtual

Implements OutputGenerator.

Definition at line 1703 of file latexgen.cpp.

References Config_getBool, endl(), stripPath(), and OutputGenerator::t.

◆ startEmphasis()

void LatexGenerator::startEmphasis ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 204 of file latexgen.h.

References OutputGenerator::t.

◆ startExamples()

void LatexGenerator::startExamples ( )
virtual

◆ startFile()

void LatexGenerator::startFile ( const char *  name,
const char *  manName,
const char *  title 
)
virtual

◆ startFontClass()

void LatexGenerator::startFontClass ( const char *  clsName)
inlinevirtual

Starts a block with a certain meaning. Used for syntax highlighting, which elements of the same type are rendered using the same 'font class'.

Parameters
clsNameThe category name.

Implements CodeOutputInterface.

Definition at line 110 of file latexgen.h.

References m_codeGen, and LatexCodeGenerator::startFontClass().

◆ startGroupCollaboration()

void LatexGenerator::startGroupCollaboration ( )
virtual

Implements OutputGenerator.

Definition at line 2080 of file latexgen.cpp.

◆ startGroupHeader()

void LatexGenerator::startGroupHeader ( int  extraIndentLevel)
virtual

Implements OutputGenerator.

Definition at line 1580 of file latexgen.cpp.

References Config_getBool, m_disableLinks, OutputGenerator::t, and TRUE.

◆ startHeaderSection()

void LatexGenerator::startHeaderSection ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 171 of file latexgen.h.

◆ startHtmlLink()

void LatexGenerator::startHtmlLink ( const char *  url)
virtual

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

Parameters
urlThe URL to link to.

Implements BaseOutputDocInterface.

Definition at line 1403 of file latexgen.cpp.

References Config_getBool, latexFilterURL(), and OutputGenerator::t.

◆ startInclDepGraph()

void LatexGenerator::startInclDepGraph ( )
virtual

Implements OutputGenerator.

Definition at line 2071 of file latexgen.cpp.

◆ startIndent()

void LatexGenerator::startIndent ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 247 of file latexgen.h.

◆ startIndexItem()

void LatexGenerator::startIndexItem ( const char *  ref,
const char *  file 
)
virtual

Implements OutputGenerator.

Definition at line 1378 of file latexgen.cpp.

References OutputGenerator::t.

◆ startIndexKey()

void LatexGenerator::startIndexKey ( )
virtual

Implements OutputGenerator.

Definition at line 1446 of file latexgen.cpp.

References OutputGenerator::t.

◆ startIndexList()

void LatexGenerator::startIndexList ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 144 of file latexgen.h.

References endl(), and OutputGenerator::t.

◆ startIndexListItem()

void LatexGenerator::startIndexListItem ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 142 of file latexgen.h.

◆ startIndexSection()

◆ startIndexValue()

void LatexGenerator::startIndexValue ( bool  hasBrief)
virtual

Implements OutputGenerator.

Definition at line 1455 of file latexgen.cpp.

References OutputGenerator::t.

◆ startInlineHeader()

void LatexGenerator::startInlineHeader ( )
virtual

Implements OutputGenerator.

Definition at line 2271 of file latexgen.cpp.

References Config_getBool, and OutputGenerator::t.

◆ startInlineMemberDoc()

void LatexGenerator::startInlineMemberDoc ( )
virtual

Implements OutputGenerator.

Definition at line 2351 of file latexgen.cpp.

◆ startInlineMemberName()

void LatexGenerator::startInlineMemberName ( )
virtual

Implements OutputGenerator.

Definition at line 2340 of file latexgen.cpp.

References m_insideTabbing, and TRUE.

◆ startInlineMemberType()

void LatexGenerator::startInlineMemberType ( )
virtual

Implements OutputGenerator.

Definition at line 2329 of file latexgen.cpp.

References m_insideTabbing, and TRUE.

◆ startItemList()

void LatexGenerator::startItemList ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 150 of file latexgen.h.

References endl(), and OutputGenerator::t.

◆ startItemListItem()

void LatexGenerator::startItemListItem ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 166 of file latexgen.h.

References endl(), and OutputGenerator::t.

◆ startLabels()

void LatexGenerator::startLabels ( )
virtual

Implements OutputGenerator.

Definition at line 2360 of file latexgen.cpp.

References OutputGenerator::t.

◆ startMemberDeclaration()

void LatexGenerator::startMemberDeclaration ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 232 of file latexgen.h.

◆ startMemberDescription()

void LatexGenerator::startMemberDescription ( const char *  ,
const char *  ,
bool   
)
virtual

Implements OutputGenerator.

Definition at line 1900 of file latexgen.cpp.

References m_indent, m_insideTabbing, and OutputGenerator::t.

◆ startMemberDoc()

void LatexGenerator::startMemberDoc ( const char *  clname,
const char *  memname,
const char *  ,
const char *  title,
int  memCount,
int  memTotal,
bool  showInline 
)
virtual

◆ startMemberDocList()

void LatexGenerator::startMemberDocList ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 177 of file latexgen.h.

◆ startMemberDocName()

void LatexGenerator::startMemberDocName ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 292 of file latexgen.h.

◆ startMemberDocPrefixItem()

void LatexGenerator::startMemberDocPrefixItem ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 290 of file latexgen.h.

◆ startMemberDocSimple()

void LatexGenerator::startMemberDocSimple ( bool  isEnum)
virtual

◆ startMemberGroup()

void LatexGenerator::startMemberGroup ( )
virtual

Implements OutputGenerator.

Definition at line 2051 of file latexgen.cpp.

◆ startMemberGroupDocs()

void LatexGenerator::startMemberGroupDocs ( )
virtual

Implements OutputGenerator.

Definition at line 2041 of file latexgen.cpp.

References OutputGenerator::t.

◆ startMemberGroupHeader()

void LatexGenerator::startMemberGroupHeader ( bool  hasHeader)
virtual

Implements OutputGenerator.

Definition at line 2019 of file latexgen.cpp.

References OutputGenerator::t.

◆ startMemberHeader()

void LatexGenerator::startMemberHeader ( const char *  ,
int   
)
virtual

Implements OutputGenerator.

Definition at line 1612 of file latexgen.cpp.

References Config_getBool, m_disableLinks, OutputGenerator::t, and TRUE.

◆ startMemberItem()

void LatexGenerator::startMemberItem ( const char *  ,
int  annoType,
const char *   
)
virtual

Implements OutputGenerator.

Definition at line 1880 of file latexgen.cpp.

References endl(), m_insideTabbing, OutputGenerator::t, and templateMemberItem.

◆ startMemberList()

void LatexGenerator::startMemberList ( )
virtual

Implements OutputGenerator.

Definition at line 2001 of file latexgen.cpp.

References endl(), m_insideTabbing, and OutputGenerator::t.

◆ startMemberSections()

void LatexGenerator::startMemberSections ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 169 of file latexgen.h.

◆ startMemberSubtitle()

void LatexGenerator::startMemberSubtitle ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 175 of file latexgen.h.

◆ startMemberTemplateParams()

void LatexGenerator::startMemberTemplateParams ( )
virtual

Implements OutputGenerator.

Definition at line 1864 of file latexgen.cpp.

References OutputGenerator::t, and templateMemberItem.

◆ startPageRef()

void LatexGenerator::startPageRef ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1523 of file latexgen.cpp.

References OutputGenerator::t.

◆ startParagraph()

void LatexGenerator::startParagraph ( const char *  classDef)
virtual

Starts a new paragraph

Starts a new paragraph

Implements BaseOutputDocInterface.

Definition at line 1363 of file latexgen.cpp.

References endl(), and OutputGenerator::t.

◆ startParameterList()

void LatexGenerator::startParameterList ( bool  openBracket)
virtual

Implements OutputGenerator.

Definition at line 2161 of file latexgen.cpp.

References OutputGenerator::t.

◆ startParameterName()

void LatexGenerator::startParameterName ( bool  )
virtual

Implements OutputGenerator.

Definition at line 2183 of file latexgen.cpp.

References OutputGenerator::t.

◆ startParameterType()

void LatexGenerator::startParameterType ( bool  first,
const char *  key 
)
virtual

Implements OutputGenerator.

Definition at line 2172 of file latexgen.cpp.

References docify(), and OutputGenerator::t.

◆ startParamList()

void LatexGenerator::startParamList ( ParamListTypes  ,
const char *  title 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 2149 of file latexgen.cpp.

References docify(), and OutputGenerator::t.

◆ startProjectNumber()

void LatexGenerator::startProjectNumber ( )
virtual

Implements OutputGenerator.

Definition at line 910 of file latexgen.cpp.

References OutputGenerator::t.

◆ startQuickIndices()

void LatexGenerator::startQuickIndices ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 254 of file latexgen.h.

◆ startSection()

void LatexGenerator::startSection ( const char *  lab,
const char *  ,
SectionType  type 
)
virtual

◆ startSmall()

void LatexGenerator::startSmall ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 228 of file latexgen.h.

References OutputGenerator::t.

◆ startSubsection()

void LatexGenerator::startSubsection ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 222 of file latexgen.h.

References OutputGenerator::t.

◆ startSubsubsection()

void LatexGenerator::startSubsubsection ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 224 of file latexgen.h.

References OutputGenerator::t.

◆ startTextBlock()

void LatexGenerator::startTextBlock ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 287 of file latexgen.h.

◆ startTextLink()

void LatexGenerator::startTextLink ( const char *  f,
const char *  anchor 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1475 of file latexgen.cpp.

References Config_getBool, m_disableLinks, stripPath(), and OutputGenerator::t.

◆ startTitle()

void LatexGenerator::startTitle ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1568 of file latexgen.cpp.

References Config_getBool, and OutputGenerator::t.

◆ startTitleHead()

void LatexGenerator::startTitleHead ( const char *  fileName)
virtual

Implements OutputGenerator.

Definition at line 1537 of file latexgen.cpp.

References Config_getBool, stripPath(), and OutputGenerator::t.

◆ startTypewriter()

void LatexGenerator::startTypewriter ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 162 of file latexgen.h.

References OutputGenerator::t.

◆ writeAnchor()

void LatexGenerator::writeAnchor ( const char *  fileName,
const char *  name 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1727 of file latexgen.cpp.

References Config_getBool, endl(), stripPath(), and OutputGenerator::t.

◆ writeChar()

void LatexGenerator::writeChar ( char  c)
virtual

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

Implements BaseOutputDocInterface.

Definition at line 1822 of file latexgen.cpp.

References cs, and docify().

◆ writeCodeAnchor()

void LatexGenerator::writeCodeAnchor ( const char *  name)
inlinevirtual

Write an anchor to a source listing.

Parameters
nameThe name of the anchor.

Implements CodeOutputInterface.

Definition at line 114 of file latexgen.h.

References m_codeGen, and LatexCodeGenerator::writeCodeAnchor().

◆ writeCodeLink()

void LatexGenerator::writeCodeLink ( const char *  ref,
const char *  file,
const char *  anchor,
const char *  name,
const char *  tooltip 
)
inlinevirtual

Writes a link to an object in a code fragment.

Parameters
refIf this is non-zero, the object is to be found in an external documentation file.
fileThe file in which the object is located.
anchorThe anchor uniquely identifying the object within the file.
nameThe text to display as a placeholder for the link.
tooltipThe tooltip to display when the mouse is on the link.

Implements CodeOutputInterface.

Definition at line 96 of file latexgen.h.

References m_codeGen, and LatexCodeGenerator::writeCodeLink().

◆ writeDoc()

void LatexGenerator::writeDoc ( DocNode n,
const Definition ctx,
const MemberDef  
)
virtual

◆ writeEndAnnoItem()

void LatexGenerator::writeEndAnnoItem ( const char *  name)
virtual

Implements OutputGenerator.

Definition at line 1441 of file latexgen.cpp.

References endl(), stripPath(), and OutputGenerator::t.

◆ writeFooter()

void LatexGenerator::writeFooter ( const char *  )
inlinevirtual

Implements OutputGenerator.

Definition at line 123 of file latexgen.h.

◆ writeFooterFile()

void LatexGenerator::writeFooterFile ( QFile f)
static

Definition at line 871 of file latexgen.cpp.

References endl(), getDoxygenVersion(), OutputGenerator::t, and writeDefaultFooter().

Referenced by readConfiguration().

◆ writeGraphicalHierarchy()

void LatexGenerator::writeGraphicalHierarchy ( DotGfxHierarchyTable )
inlinevirtual

Implements OutputGenerator.

Definition at line 285 of file latexgen.h.

◆ writeHeaderFile()

void LatexGenerator::writeHeaderFile ( QFile f)
static

◆ writeInheritedSectionTitle()

void LatexGenerator::writeInheritedSectionTitle ( const char *  ,
const char *  ,
const char *  ,
const char *  ,
const char *  ,
const char *   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 234 of file latexgen.h.

◆ writeLabel()

void LatexGenerator::writeLabel ( const char *  l,
bool  isLast 
)
virtual

Implements OutputGenerator.

Definition at line 2365 of file latexgen.cpp.

References languages::l, and OutputGenerator::t.

◆ writeLatexSpacing()

void LatexGenerator::writeLatexSpacing ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 218 of file latexgen.h.

References OutputGenerator::t.

◆ writeLineNumber()

void LatexGenerator::writeLineNumber ( const char *  ref,
const char *  file,
const char *  anchor,
int  lineNumber 
)
inlinevirtual

Writes the line number of a source listing

Parameters
refExternal reference (when imported from a tag file)
fileThe file part of the URL pointing to the docs.
anchorThe anchor part of the URL pointing to the docs.
lineNumberThe line number to write

Implements CodeOutputInterface.

Definition at line 100 of file latexgen.h.

References m_codeGen, and LatexCodeGenerator::writeLineNumber().

◆ writeLogo()

void LatexGenerator::writeLogo ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 258 of file latexgen.h.

◆ writeNavigationPath()

void LatexGenerator::writeNavigationPath ( const char *  )
inlinevirtual

Implements OutputGenerator.

Definition at line 257 of file latexgen.h.

◆ writeNonBreakableSpace()

void LatexGenerator::writeNonBreakableSpace ( int  )
virtual

Implements BaseOutputDocInterface.

Definition at line 1927 of file latexgen.cpp.

References m_insideTabbing, and OutputGenerator::t.

◆ writeObjectLink()

void LatexGenerator::writeObjectLink ( const char *  ref,
const char *  file,
const char *  anchor,
const char *  name 
)
virtual

Writes a link to an object in the documentation.

Parameters
refIf this is non-zero, the object is to be found in an external documentation file.
fileThe file in which the object is located.
anchorThe anchor uniquely identifying the object within the file.
nameThe text to display as a placeholder for the link.

Implements BaseOutputDocInterface.

Definition at line 1501 of file latexgen.cpp.

References Config_getBool, docify(), m_disableLinks, stripPath(), and OutputGenerator::t.

◆ writePageLink()

void LatexGenerator::writePageLink ( const char *  name,
bool   
)
virtual

Implements OutputGenerator.

Definition at line 1329 of file latexgen.cpp.

References OutputGenerator::t.

◆ writeQuickLinks()

void LatexGenerator::writeQuickLinks ( bool  ,
HighlightedItem  ,
const char *   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 259 of file latexgen.h.

◆ writeRuler()

void LatexGenerator::writeRuler ( )
inlinevirtual

Writes a horizontal ruler to the output

Implements BaseOutputDocInterface.

Definition at line 200 of file latexgen.h.

References endl(), and OutputGenerator::t.

◆ writeSearchInfo()

void LatexGenerator::writeSearchInfo ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 122 of file latexgen.h.

◆ writeSplitBar()

void LatexGenerator::writeSplitBar ( const char *  )
inlinevirtual

Implements OutputGenerator.

Definition at line 256 of file latexgen.h.

◆ writeStartAnnoItem()

void LatexGenerator::writeStartAnnoItem ( const char *  type,
const char *  file,
const char *  path,
const char *  name 
)
virtual

Implements OutputGenerator.

Definition at line 1432 of file latexgen.cpp.

References docify(), and OutputGenerator::t.

◆ writeString()

void LatexGenerator::writeString ( const char *  text)
virtual

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

Implements BaseOutputDocInterface.

Definition at line 1373 of file latexgen.cpp.

References OutputGenerator::t.

◆ writeStyleInfo()

void LatexGenerator::writeStyleInfo ( int  part)
virtual

◆ writeStyleSheetFile()

void LatexGenerator::writeStyleSheetFile ( QFile f)
static

Definition at line 878 of file latexgen.cpp.

References endl(), getDoxygenVersion(), OutputGenerator::t, and writeDefaultStyleSheet().

Referenced by readConfiguration().

◆ writeSummaryLink()

void LatexGenerator::writeSummaryLink ( const char *  ,
const char *  ,
const char *  ,
bool   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 260 of file latexgen.h.

◆ writeSynopsis()

void LatexGenerator::writeSynopsis ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 249 of file latexgen.h.

◆ writeTooltip()

void LatexGenerator::writeTooltip ( const char *  id,
const DocLinkInfo docInfo,
const char *  decl,
const char *  desc,
const SourceLinkInfo defInfo,
const SourceLinkInfo declInfo 
)
inlinevirtual

Writes a tool tip definition

Parameters
idunique identifier for the tooltip
docInfoInfo about the symbol's documentation.
declfull declaration of the symbol (for functions)
descbrief description for the symbol
defInfoInfo about the symbol's definition in the source code
declInfoInfo about the symbol's declaration in the source code

Implements CodeOutputInterface.

Definition at line 102 of file latexgen.h.

References m_codeGen, and LatexCodeGenerator::writeTooltip().

Member Data Documentation

◆ m_codeGen

◆ m_disableLinks

◆ m_firstDescItem

bool LatexGenerator::m_firstDescItem
private

Definition at line 332 of file latexgen.h.

Referenced by endDescItem(), endDescription(), LatexGenerator(), and startDescItem().

◆ m_indent

int LatexGenerator::m_indent
private

◆ m_insideTabbing

◆ m_prettyCode

bool LatexGenerator::m_prettyCode
private

Definition at line 337 of file latexgen.h.

Referenced by endIndexSection(), and LatexGenerator().

◆ m_relPath

QCString LatexGenerator::m_relPath
private

◆ templateMemberItem

bool LatexGenerator::templateMemberItem
private

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