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)  

HtmlGenerator Class Reference

Generator for HTML output. More...

#include <htmlgen.h>

+ Inheritance diagram for HtmlGenerator:
+ Collaboration diagram for HtmlGenerator:

Public Member Functions

 HtmlGenerator ()
 
virtual ~HtmlGenerator ()
 
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 setCurrentDoc (const Definition *context, const char *anchor, bool isSourceFile)
 
void addWord (const char *word, bool hiPriority)
 
void writeDoc (DocNode *, const Definition *, const MemberDef *)
 
void startFile (const char *name, const char *manName, const char *title)
 
void writeFooter (const char *navPath)
 
void endFile ()
 
void clearBuffer ()
 
void writeSearchInfo ()
 
void startIndexSection (IndexSections)
 
void endIndexSection (IndexSections)
 
void writePageLink (const char *, bool)
 
void startProjectNumber ()
 
void endProjectNumber ()
 
void writeStyleInfo (int part)
 
void startTitleHead (const char *)
 
void endTitleHead (const char *, const char *)
 
void startTitle ()
 
void endTitle ()
 
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 *file, const char *anchor)
 
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 *anchor, int, const char *inheritId)
 
void endMemberItem ()
 
void startMemberTemplateParams ()
 
void endMemberTemplateParams (const char *anchor, const char *inheritId)
 
void startMemberGroupHeader (bool)
 
void endMemberGroupHeader ()
 
void startMemberGroupDocs ()
 
void endMemberGroupDocs ()
 
void startMemberGroup ()
 
void endMemberGroup (bool)
 
void insertMemberAlign (bool)
 
void insertMemberAlignLeft (int, bool)
 
void startMemberDescription (const char *anchor, const char *inheritId, bool typ)
 
void endMemberDescription ()
 
void startMemberDeclaration ()
 
void endMemberDeclaration (const char *anchor, const char *inheritId)
 
void writeInheritedSectionTitle (const char *id, const char *ref, const char *file, const char *anchor, const char *title, const char *name)
 
void writeRuler ()
 
void writeAnchor (const char *, const char *name)
 
void startCodeFragment ()
 
void endCodeFragment ()
 
void startEmphasis ()
 
void endEmphasis ()
 
void startBold ()
 
void endBold ()
 
void startDescription ()
 
void endDescription ()
 
void startDescItem ()
 
void endDescItem ()
 
void startDescForItem ()
 
void endDescForItem ()
 
void lineBreak (const char *style)
 
void writeChar (char c)
 
void startMemberDoc (const char *clName, const char *memName, const char *anchor, const char *title, int memCount, int memTotal, bool showInline)
 
void endMemberDoc (bool)
 
void startDoxyAnchor (const char *fName, const char *manName, const char *anchor, const char *name, const char *args)
 
void endDoxyAnchor (const char *fName, const char *anchor)
 
void writeLatexSpacing ()
 
void writeStartAnnoItem (const char *type, const char *file, const char *path, const char *name)
 
void writeEndAnnoItem (const char *)
 
void startSubsection ()
 
void endSubsection ()
 
void startSubsubsection ()
 
void endSubsubsection ()
 
void startCenter ()
 
void endCenter ()
 
void startSmall ()
 
void endSmall ()
 
void startExamples ()
 
void endExamples ()
 
void startParamList (ParamListTypes, const char *)
 
void endParamList ()
 
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 *name)
 
void writeNavigationPath (const char *s)
 
void writeLogo ()
 
void writeQuickLinks (bool compact, HighlightedItem hli, const char *file)
 
void writeSummaryLink (const char *file, const char *anchor, const char *title, bool first)
 
void startContents ()
 
void endContents ()
 
void startPageDoc (const char *pageTitle)
 
void endPageDoc ()
 
void writeNonBreakableSpace (int)
 
void startDescTable (const char *title)
 
void endDescTable ()
 
void startDescTableRow ()
 
void endDescTableRow ()
 
void startDescTableTitle ()
 
void endDescTableTitle ()
 
void startDescTableData ()
 
void endDescTableData ()
 
void startDotGraph ()
 
void endDotGraph (DotClassGraph &g)
 
void startInclDepGraph ()
 
void endInclDepGraph (DotInclDepGraph &g)
 
void startGroupCollaboration ()
 
void endGroupCollaboration (DotGroupCollaboration &g)
 
void startCallGraph ()
 
void endCallGraph (DotCallGraph &g)
 
void startDirDepGraph ()
 
void endDirDepGraph (DotDirDeps &g)
 
void writeGraphicalHierarchy (DotGfxHierarchyTable &g)
 
void startTextBlock (bool)
 
void endTextBlock (bool)
 
void lastIndexPage ()
 
void startMemberDocPrefixItem ()
 
void endMemberDocPrefixItem ()
 
void startMemberDocName (bool)
 
void endMemberDocName ()
 
void startParameterType (bool first, const char *key)
 
void endParameterType ()
 
void startParameterName (bool)
 
void endParameterName (bool last, bool emptyList, bool closeBracket)
 
void startParameterList (bool)
 
void endParameterList ()
 
virtual 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 ()
 
- 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 ()
 
- 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, const char *cssname)
 
static void writeFooterFile (QFile &f)
 
static void writeTabData ()
 Additional initialization after indices have been created. More...
 
static void writeSearchInfo (FTextStream &t, const QCString &relPath)
 
static void writeSearchData (const char *dir)
 
static void writeSearchPage ()
 
static void writeExternalSearchPage ()
 
static QCString writeLogoAsString (const char *path)
 
static QCString writeSplitBarAsString (const char *name, const char *relpath)
 

Private Member Functions

void docify (const char *text, bool inHtmlComment)
 
HtmlGeneratoroperator= (const HtmlGenerator &g)
 
 HtmlGenerator (const HtmlGenerator &g)
 

Static Private Member Functions

static void writePageFooter (FTextStream &t, const QCString &, const QCString &, const QCString &)
 

Private Attributes

QCString m_lastTitle
 
QCString m_lastFile
 
QCString m_relPath
 
int m_sectionCount
 
bool m_emptySection
 
HtmlCodeGenerator 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 HTML output.

Definition at line 71 of file htmlgen.h.

Constructor & Destructor Documentation

◆ HtmlGenerator() [1/2]

HtmlGenerator::HtmlGenerator ( )

◆ ~HtmlGenerator()

HtmlGenerator::~HtmlGenerator ( )
virtual

Definition at line 923 of file htmlgen.cpp.

◆ HtmlGenerator() [2/2]

HtmlGenerator::HtmlGenerator ( const HtmlGenerator g)
private

Member Function Documentation

◆ addIndexItem()

void HtmlGenerator::addIndexItem ( const char *  ,
const char *   
)
virtual

Implements BaseOutputDocInterface.

Definition at line 2138 of file htmlgen.cpp.

◆ addWord()

void HtmlGenerator::addWord ( const char *  word,
bool  hiPriority 
)
virtual

Implements CodeOutputInterface.

Definition at line 3060 of file htmlgen.cpp.

References SearchIndexIntf::addWord(), and Doxygen::searchIndex.

◆ clearBuffer()

void HtmlGenerator::clearBuffer ( )

◆ codify()

void HtmlGenerator::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 98 of file htmlgen.h.

References HtmlCodeGenerator::codify(), and m_codeGen.

◆ disable()

void HtmlGenerator::disable ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 90 of file htmlgen.h.

References FALSE, and OutputGenerator::m_active.

Referenced by disableIf(), and disableIfNot().

◆ disableIf()

void HtmlGenerator::disableIf ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 92 of file htmlgen.h.

References disable(), and OutputGenerator::Html.

◆ disableIfNot()

void HtmlGenerator::disableIfNot ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 93 of file htmlgen.h.

References disable(), and OutputGenerator::Html.

◆ docify() [1/2]

void HtmlGenerator::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 1487 of file htmlgen.cpp.

References FALSE.

Referenced by startExamples(), startMemberDoc(), startParamList(), writeChar(), writeObjectLink(), and writeStartAnnoItem().

◆ docify() [2/2]

void HtmlGenerator::docify ( const char *  text,
bool  inHtmlComment 
)
private

Definition at line 1492 of file htmlgen.cpp.

References OutputGenerator::t.

◆ enable()

void HtmlGenerator::enable ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 88 of file htmlgen.h.

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

Referenced by enableIf().

◆ enableIf()

void HtmlGenerator::enableIf ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 91 of file htmlgen.h.

References enable(), and OutputGenerator::Html.

◆ endAnonTypeScope()

void HtmlGenerator::endAnonTypeScope ( int  )
inlinevirtual

Implements OutputGenerator.

Definition at line 189 of file htmlgen.h.

◆ endBold()

void HtmlGenerator::endBold ( )
inlinevirtual

End a section of text displayed in bold face.

Implements BaseOutputDocInterface.

Definition at line 220 of file htmlgen.h.

References OutputGenerator::t.

◆ endCallGraph()

◆ endCenter()

void HtmlGenerator::endCenter ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 246 of file htmlgen.h.

References endl(), and OutputGenerator::t.

◆ endClassDiagram()

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

◆ endCodeFragment()

void HtmlGenerator::endCodeFragment ( )
virtual

Ends a source code fragment

Implements BaseOutputDocInterface.

Definition at line 2860 of file htmlgen.cpp.

References endCodeLine(), PREFRAG_END, and OutputGenerator::t.

◆ endCodeLine()

void HtmlGenerator::endCodeLine ( )
inlinevirtual

Ends a line of code started with startCodeLine()

Implements CodeOutputInterface.

Definition at line 112 of file htmlgen.h.

References HtmlCodeGenerator::endCodeLine(), and m_codeGen.

Referenced by endCodeFragment().

◆ endConstraintDocs()

void HtmlGenerator::endConstraintDocs ( )
virtual

Implements OutputGenerator.

Definition at line 2842 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

◆ endConstraintList()

void HtmlGenerator::endConstraintList ( )
virtual

Implements OutputGenerator.

Definition at line 2847 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

◆ endConstraintParam()

void HtmlGenerator::endConstraintParam ( )
virtual

Implements OutputGenerator.

Definition at line 2822 of file htmlgen.cpp.

References OutputGenerator::t.

◆ endConstraintType()

void HtmlGenerator::endConstraintType ( )
virtual

Implements OutputGenerator.

Definition at line 2832 of file htmlgen.cpp.

References OutputGenerator::t.

◆ endContents()

void HtmlGenerator::endContents ( )
virtual

Implements OutputGenerator.

Definition at line 2596 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

◆ endDescForItem()

void HtmlGenerator::endDescForItem ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 226 of file htmlgen.h.

References OutputGenerator::t.

◆ endDescItem()

void HtmlGenerator::endDescItem ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 224 of file htmlgen.h.

References OutputGenerator::t.

◆ endDescription()

void HtmlGenerator::endDescription ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 222 of file htmlgen.h.

References endl(), and OutputGenerator::t.

◆ endDescTable()

void HtmlGenerator::endDescTable ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2156 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

◆ endDescTableData()

void HtmlGenerator::endDescTableData ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2186 of file htmlgen.cpp.

References OutputGenerator::t.

◆ endDescTableRow()

void HtmlGenerator::endDescTableRow ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2166 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

◆ endDescTableTitle()

void HtmlGenerator::endDescTableTitle ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2176 of file htmlgen.cpp.

References OutputGenerator::t.

◆ endDirDepGraph()

◆ endDotGraph()

◆ endDoxyAnchor()

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

Implements OutputGenerator.

Definition at line 1294 of file htmlgen.cpp.

◆ endEmphasis()

void HtmlGenerator::endEmphasis ( )
inlinevirtual

Ends a section of text displayed in italic.

Implements BaseOutputDocInterface.

Definition at line 218 of file htmlgen.h.

References OutputGenerator::t.

◆ endExamples()

void HtmlGenerator::endExamples ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2198 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

◆ endFile()

void HtmlGenerator::endFile ( )
virtual

Implements OutputGenerator.

Definition at line 1212 of file htmlgen.cpp.

References OutputGenerator::endPlainFile().

◆ endFontClass()

void HtmlGenerator::endFontClass ( )
inlinevirtual

Ends a block started with startFontClass()

Implements CodeOutputInterface.

Definition at line 116 of file htmlgen.h.

References HtmlCodeGenerator::endFontClass(), and m_codeGen.

◆ endGroupCollaboration()

◆ endGroupHeader()

void HtmlGenerator::endGroupHeader ( int  extraIndentLevel)
virtual

Implements OutputGenerator.

Definition at line 1444 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

◆ endHeaderSection()

void HtmlGenerator::endHeaderSection ( )
virtual

Implements OutputGenerator.

Definition at line 2897 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

◆ endHtmlLink()

void HtmlGenerator::endHtmlLink ( )
virtual

Ends a link started by startHtmlLink().

Implements BaseOutputDocInterface.

Definition at line 1423 of file htmlgen.cpp.

References OutputGenerator::t.

Referenced by endDotGraph().

◆ endInclDepGraph()

◆ endIndent()

void HtmlGenerator::endIndent ( )
virtual

Implements OutputGenerator.

Definition at line 2132 of file htmlgen.cpp.

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

◆ endIndexItem()

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

Implements OutputGenerator.

Definition at line 1356 of file htmlgen.cpp.

References OutputGenerator::t.

◆ endIndexKey()

void HtmlGenerator::endIndexKey ( )
virtual

Implements OutputGenerator.

Definition at line 1817 of file htmlgen.cpp.

References OutputGenerator::t.

◆ endIndexList()

void HtmlGenerator::endIndexList ( )
virtual

Implements OutputGenerator.

Definition at line 1806 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

◆ endIndexListItem()

void HtmlGenerator::endIndexListItem ( )
virtual

Implements OutputGenerator.

Definition at line 1326 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

◆ endIndexSection()

void HtmlGenerator::endIndexSection ( IndexSections  )
inlinevirtual

Implements OutputGenerator.

Definition at line 133 of file htmlgen.h.

◆ endIndexValue()

void HtmlGenerator::endIndexValue ( const char *  ,
bool   
)
virtual

Implements OutputGenerator.

Definition at line 1828 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

◆ endInlineHeader()

void HtmlGenerator::endInlineHeader ( )
virtual

Implements OutputGenerator.

Definition at line 2912 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

◆ endInlineMemberDoc()

void HtmlGenerator::endInlineMemberDoc ( )
virtual

Implements OutputGenerator.

Definition at line 2962 of file htmlgen.cpp.

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

◆ endInlineMemberName()

void HtmlGenerator::endInlineMemberName ( )
virtual

Implements OutputGenerator.

Definition at line 2950 of file htmlgen.cpp.

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

◆ endInlineMemberType()

void HtmlGenerator::endInlineMemberType ( )
virtual

Implements OutputGenerator.

Definition at line 2938 of file htmlgen.cpp.

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

◆ endItemList()

void HtmlGenerator::endItemList ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 155 of file htmlgen.h.

References endl(), and OutputGenerator::t.

◆ endItemListItem()

void HtmlGenerator::endItemListItem ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 172 of file htmlgen.h.

References OutputGenerator::t.

◆ endLabels()

void HtmlGenerator::endLabels ( )
virtual

Implements OutputGenerator.

Definition at line 2982 of file htmlgen.cpp.

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

◆ endMemberDeclaration()

void HtmlGenerator::endMemberDeclaration ( const char *  anchor,
const char *  inheritId 
)
virtual

Implements OutputGenerator.

Definition at line 3042 of file htmlgen.cpp.

References OutputGenerator::t.

◆ endMemberDescription()

void HtmlGenerator::endMemberDescription ( )
virtual

Implements OutputGenerator.

Definition at line 1740 of file htmlgen.cpp.

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

◆ endMemberDoc()

void HtmlGenerator::endMemberDoc ( bool  hasArgs)
virtual

Implements OutputGenerator.

Definition at line 1981 of file htmlgen.cpp.

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

◆ endMemberDocList()

void HtmlGenerator::endMemberDocList ( )
virtual

Implements OutputGenerator.

Definition at line 1838 of file htmlgen.cpp.

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

◆ endMemberDocName()

void HtmlGenerator::endMemberDocName ( )
virtual

Implements OutputGenerator.

Definition at line 1883 of file htmlgen.cpp.

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

◆ endMemberDocPrefixItem()

void HtmlGenerator::endMemberDocPrefixItem ( )
virtual

Implements OutputGenerator.

Definition at line 1867 of file htmlgen.cpp.

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

◆ endMemberDocSimple()

void HtmlGenerator::endMemberDocSimple ( bool  )
virtual

Implements OutputGenerator.

Definition at line 2926 of file htmlgen.cpp.

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

◆ endMemberGroup()

void HtmlGenerator::endMemberGroup ( bool  )
virtual

Implements OutputGenerator.

Definition at line 2121 of file htmlgen.cpp.

◆ endMemberGroupDocs()

void HtmlGenerator::endMemberGroupDocs ( )
virtual

Implements OutputGenerator.

Definition at line 2112 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

◆ endMemberGroupHeader()

void HtmlGenerator::endMemberGroupHeader ( )
virtual

Implements OutputGenerator.

Definition at line 2102 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

◆ endMemberHeader()

void HtmlGenerator::endMemberHeader ( )
virtual

Implements OutputGenerator.

Definition at line 1783 of file htmlgen.cpp.

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

◆ endMemberItem()

void HtmlGenerator::endMemberItem ( )
virtual

Implements OutputGenerator.

Definition at line 1680 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

◆ endMemberList()

void HtmlGenerator::endMemberList ( )
virtual

Implements OutputGenerator.

Definition at line 1654 of file htmlgen.cpp.

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

◆ endMemberSections()

void HtmlGenerator::endMemberSections ( )
virtual

Implements OutputGenerator.

Definition at line 1754 of file htmlgen.cpp.

References DBG_HTML, endl(), m_emptySection, and OutputGenerator::t.

◆ endMemberSubtitle()

void HtmlGenerator::endMemberSubtitle ( )
virtual

Implements OutputGenerator.

Definition at line 1795 of file htmlgen.cpp.

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

◆ endMemberTemplateParams()

void HtmlGenerator::endMemberTemplateParams ( const char *  anchor,
const char *  inheritId 
)
virtual

Implements OutputGenerator.

Definition at line 1690 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

◆ endPageDoc()

void HtmlGenerator::endPageDoc ( )
virtual

Reimplemented from OutputGenerator.

Definition at line 2606 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

◆ endPageRef()

void HtmlGenerator::endPageRef ( const char *  ,
const char *   
)
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 262 of file htmlgen.h.

◆ endParagraph()

void HtmlGenerator::endParagraph ( )
virtual

Ends a paragraph

Implements BaseOutputDocInterface.

Definition at line 1311 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

◆ endParameterList()

void HtmlGenerator::endParameterList ( )
virtual

Implements OutputGenerator.

Definition at line 1958 of file htmlgen.cpp.

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

◆ endParameterName()

void HtmlGenerator::endParameterName ( bool  last,
bool  emptyList,
bool  closeBracket 
)
virtual

Implements OutputGenerator.

Definition at line 1928 of file htmlgen.cpp.

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

◆ endParameterType()

void HtmlGenerator::endParameterType ( )
virtual

Implements OutputGenerator.

Definition at line 1916 of file htmlgen.cpp.

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

◆ endParamList()

void HtmlGenerator::endParamList ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2211 of file htmlgen.cpp.

References OutputGenerator::t.

◆ endProjectNumber()

void HtmlGenerator::endProjectNumber ( )
virtual

Implements OutputGenerator.

Definition at line 1222 of file htmlgen.cpp.

References OutputGenerator::t.

◆ endQuickIndices()

void HtmlGenerator::endQuickIndices ( )
virtual

Implements OutputGenerator.

Definition at line 2545 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

◆ endSection()

void HtmlGenerator::endSection ( const char *  ,
SectionType  type 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1474 of file htmlgen.cpp.

References ASSERT, Page, Paragraph, Section, Subsection, Subsubsection, and OutputGenerator::t.

◆ endSmall()

void HtmlGenerator::endSmall ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 248 of file htmlgen.h.

References endl(), and OutputGenerator::t.

◆ endSubsection()

void HtmlGenerator::endSubsection ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 242 of file htmlgen.h.

References endl(), and OutputGenerator::t.

◆ endSubsubsection()

void HtmlGenerator::endSubsubsection ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 244 of file htmlgen.h.

References endl(), and OutputGenerator::t.

◆ endTextBlock()

void HtmlGenerator::endTextBlock ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 299 of file htmlgen.h.

References OutputGenerator::t.

◆ endTextLink()

void HtmlGenerator::endTextLink ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1408 of file htmlgen.cpp.

References OutputGenerator::t.

◆ endTitle()

void HtmlGenerator::endTitle ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 141 of file htmlgen.h.

References OutputGenerator::t.

Referenced by endTitleHead().

◆ endTitleHead()

void HtmlGenerator::endTitleHead ( const char *  ,
const char *   
)
virtual

Implements OutputGenerator.

Definition at line 2891 of file htmlgen.cpp.

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

◆ endTypewriter()

void HtmlGenerator::endTypewriter ( )
inlinevirtual

End a section of text displayed in typewriter style.

Implements BaseOutputDocInterface.

Definition at line 168 of file htmlgen.h.

References OutputGenerator::t.

◆ exceptionEntry()

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

Implements OutputGenerator.

Definition at line 1965 of file htmlgen.cpp.

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

◆ get()

OutputGenerator* HtmlGenerator::get ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 95 of file htmlgen.h.

References OutputGenerator::Html.

◆ init()

◆ insertMemberAlign()

void HtmlGenerator::insertMemberAlign ( bool  templ)
virtual

Implements OutputGenerator.

Definition at line 1702 of file htmlgen.cpp.

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

◆ insertMemberAlignLeft()

void HtmlGenerator::insertMemberAlignLeft ( int  annoType,
bool  initTag 
)
virtual

Implements OutputGenerator.

Definition at line 1709 of file htmlgen.cpp.

References OutputGenerator::t.

Referenced by startMemberItem().

◆ isEnabled()

bool HtmlGenerator::isEnabled ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 94 of file htmlgen.h.

References OutputGenerator::Html, and OutputGenerator::m_active.

◆ lastIndexPage()

void HtmlGenerator::lastIndexPage ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 301 of file htmlgen.h.

◆ lineBreak()

void HtmlGenerator::lineBreak ( const char *  style)
virtual

Implements BaseOutputDocInterface.

Definition at line 2868 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

◆ operator=()

HtmlGenerator& HtmlGenerator::operator= ( const HtmlGenerator g)
private

◆ setCurrentDoc()

void HtmlGenerator::setCurrentDoc ( const Definition context,
const char *  anchor,
bool  isSourceFile 
)
virtual

Implements CodeOutputInterface.

Definition at line 3052 of file htmlgen.cpp.

References Doxygen::searchIndex, and SearchIndexIntf::setCurrentDoc().

◆ startAnonTypeScope()

void HtmlGenerator::startAnonTypeScope ( int  )
inlinevirtual

Implements OutputGenerator.

Definition at line 188 of file htmlgen.h.

◆ startBold()

void HtmlGenerator::startBold ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 219 of file htmlgen.h.

References OutputGenerator::t.

◆ startCallGraph()

void HtmlGenerator::startCallGraph ( )
virtual

Implements OutputGenerator.

Definition at line 2056 of file htmlgen.cpp.

References m_relPath, m_sectionCount, startSectionHeader(), and OutputGenerator::t.

◆ startCenter()

void HtmlGenerator::startCenter ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 245 of file htmlgen.h.

References endl(), and OutputGenerator::t.

◆ startClassDiagram()

void HtmlGenerator::startClassDiagram ( )
virtual

Implements OutputGenerator.

Definition at line 1608 of file htmlgen.cpp.

References m_relPath, m_sectionCount, startSectionHeader(), and OutputGenerator::t.

◆ startCodeFragment()

void HtmlGenerator::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 2855 of file htmlgen.cpp.

References PREFRAG_START, and OutputGenerator::t.

◆ startCodeLine()

void HtmlGenerator::startCodeLine ( bool  hasLineNumbers)
inlinevirtual

Implements CodeOutputInterface.

Definition at line 110 of file htmlgen.h.

References m_codeGen, and HtmlCodeGenerator::startCodeLine().

◆ startConstraintDocs()

void HtmlGenerator::startConstraintDocs ( )
virtual

Implements OutputGenerator.

Definition at line 2837 of file htmlgen.cpp.

References OutputGenerator::t.

◆ startConstraintList()

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

Implements OutputGenerator.

Definition at line 2810 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

◆ startConstraintParam()

void HtmlGenerator::startConstraintParam ( )
virtual

Implements OutputGenerator.

Definition at line 2817 of file htmlgen.cpp.

References OutputGenerator::t.

◆ startConstraintType()

void HtmlGenerator::startConstraintType ( )
virtual

Implements OutputGenerator.

Definition at line 2827 of file htmlgen.cpp.

References OutputGenerator::t.

◆ startContents()

void HtmlGenerator::startContents ( )
virtual

Implements OutputGenerator.

Definition at line 2591 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

◆ startDescForItem()

void HtmlGenerator::startDescForItem ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 225 of file htmlgen.h.

References OutputGenerator::t.

◆ startDescItem()

void HtmlGenerator::startDescItem ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 223 of file htmlgen.h.

References OutputGenerator::t.

◆ startDescription()

void HtmlGenerator::startDescription ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 221 of file htmlgen.h.

References endl(), and OutputGenerator::t.

◆ startDescTable()

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

Implements BaseOutputDocInterface.

Definition at line 2151 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

◆ startDescTableData()

void HtmlGenerator::startDescTableData ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2181 of file htmlgen.cpp.

References OutputGenerator::t.

◆ startDescTableRow()

void HtmlGenerator::startDescTableRow ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2161 of file htmlgen.cpp.

References OutputGenerator::t.

◆ startDescTableTitle()

void HtmlGenerator::startDescTableTitle ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2171 of file htmlgen.cpp.

References OutputGenerator::t.

◆ startDirDepGraph()

void HtmlGenerator::startDirDepGraph ( )
virtual

Implements OutputGenerator.

Definition at line 2074 of file htmlgen.cpp.

References m_relPath, m_sectionCount, startSectionHeader(), and OutputGenerator::t.

◆ startDotGraph()

void HtmlGenerator::startDotGraph ( )
virtual

Implements OutputGenerator.

Definition at line 1992 of file htmlgen.cpp.

References m_relPath, m_sectionCount, startSectionHeader(), and OutputGenerator::t.

◆ startDoxyAnchor()

void HtmlGenerator::startDoxyAnchor ( const char *  fName,
const char *  manName,
const char *  anchor,
const char *  name,
const char *  args 
)
virtual

Implements OutputGenerator.

Definition at line 1287 of file htmlgen.cpp.

References OutputGenerator::t.

◆ startEmphasis()

void HtmlGenerator::startEmphasis ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 217 of file htmlgen.h.

References OutputGenerator::t.

◆ startExamples()

void HtmlGenerator::startExamples ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2191 of file htmlgen.cpp.

References docify(), OutputGenerator::t, theTranslator, and Translator::trExamples().

◆ startFile()

◆ startFontClass()

void HtmlGenerator::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 114 of file htmlgen.h.

References m_codeGen, and HtmlCodeGenerator::startFontClass().

◆ startGroupCollaboration()

void HtmlGenerator::startGroupCollaboration ( )
virtual

Implements OutputGenerator.

Definition at line 2038 of file htmlgen.cpp.

References m_relPath, m_sectionCount, startSectionHeader(), and OutputGenerator::t.

◆ startGroupHeader()

void HtmlGenerator::startGroupHeader ( int  extraIndentLevel)
virtual

Implements OutputGenerator.

Definition at line 1428 of file htmlgen.cpp.

References OutputGenerator::t.

◆ startHeaderSection()

void HtmlGenerator::startHeaderSection ( )
virtual

Implements OutputGenerator.

Definition at line 2880 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

◆ startHtmlLink()

void HtmlGenerator::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 1413 of file htmlgen.cpp.

References Config_getBool, and OutputGenerator::t.

Referenced by endDotGraph().

◆ startInclDepGraph()

void HtmlGenerator::startInclDepGraph ( )
virtual

Implements OutputGenerator.

Definition at line 2020 of file htmlgen.cpp.

References m_relPath, m_sectionCount, startSectionHeader(), and OutputGenerator::t.

◆ startIndent()

void HtmlGenerator::startIndent ( )
virtual

Implements OutputGenerator.

Definition at line 2125 of file htmlgen.cpp.

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

◆ startIndexItem()

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

◆ startIndexKey()

void HtmlGenerator::startIndexKey ( )
virtual

Implements OutputGenerator.

Definition at line 1811 of file htmlgen.cpp.

References OutputGenerator::t.

◆ startIndexList()

void HtmlGenerator::startIndexList ( )
virtual

Implements OutputGenerator.

Definition at line 1801 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

◆ startIndexListItem()

void HtmlGenerator::startIndexListItem ( )
virtual

Implements OutputGenerator.

Definition at line 1321 of file htmlgen.cpp.

References OutputGenerator::t.

◆ startIndexSection()

void HtmlGenerator::startIndexSection ( IndexSections  )
inlinevirtual

Implements OutputGenerator.

Definition at line 132 of file htmlgen.h.

◆ startIndexValue()

void HtmlGenerator::startIndexValue ( bool  )
virtual

Implements OutputGenerator.

Definition at line 1822 of file htmlgen.cpp.

References OutputGenerator::t.

◆ startInlineHeader()

void HtmlGenerator::startInlineHeader ( )
virtual

Implements OutputGenerator.

Definition at line 2902 of file htmlgen.cpp.

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

◆ startInlineMemberDoc()

void HtmlGenerator::startInlineMemberDoc ( )
virtual

Implements OutputGenerator.

Definition at line 2956 of file htmlgen.cpp.

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

◆ startInlineMemberName()

void HtmlGenerator::startInlineMemberName ( )
virtual

Implements OutputGenerator.

Definition at line 2944 of file htmlgen.cpp.

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

◆ startInlineMemberType()

void HtmlGenerator::startInlineMemberType ( )
virtual

Implements OutputGenerator.

Definition at line 2932 of file htmlgen.cpp.

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

◆ startItemList()

void HtmlGenerator::startItemList ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 154 of file htmlgen.h.

References endl(), and OutputGenerator::t.

◆ startItemListItem()

void HtmlGenerator::startItemListItem ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 171 of file htmlgen.h.

References OutputGenerator::t.

◆ startLabels()

void HtmlGenerator::startLabels ( )
virtual

Implements OutputGenerator.

Definition at line 2968 of file htmlgen.cpp.

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

◆ startMemberDeclaration()

void HtmlGenerator::startMemberDeclaration ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 206 of file htmlgen.h.

◆ startMemberDescription()

void HtmlGenerator::startMemberDescription ( const char *  anchor,
const char *  inheritId,
bool  typ 
)
virtual

Implements OutputGenerator.

Definition at line 1721 of file htmlgen.cpp.

References DBG_HTML, endl(), FALSE, m_emptySection, and OutputGenerator::t.

◆ startMemberDoc()

void HtmlGenerator::startMemberDoc ( const char *  clName,
const char *  memName,
const char *  anchor,
const char *  title,
int  memCount,
int  memTotal,
bool  showInline 
)
virtual

Implements OutputGenerator.

Definition at line 1843 of file htmlgen.cpp.

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

◆ startMemberDocList()

void HtmlGenerator::startMemberDocList ( )
virtual

Implements OutputGenerator.

Definition at line 1833 of file htmlgen.cpp.

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

◆ startMemberDocName()

void HtmlGenerator::startMemberDocName ( bool  )
virtual

Implements OutputGenerator.

Definition at line 1873 of file htmlgen.cpp.

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

◆ startMemberDocPrefixItem()

void HtmlGenerator::startMemberDocPrefixItem ( )
virtual

Implements OutputGenerator.

Definition at line 1861 of file htmlgen.cpp.

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

◆ startMemberDocSimple()

void HtmlGenerator::startMemberDocSimple ( bool  isEnum)
virtual

◆ startMemberGroup()

void HtmlGenerator::startMemberGroup ( )
virtual

Implements OutputGenerator.

Definition at line 2117 of file htmlgen.cpp.

◆ startMemberGroupDocs()

void HtmlGenerator::startMemberGroupDocs ( )
virtual

Implements OutputGenerator.

Definition at line 2107 of file htmlgen.cpp.

References OutputGenerator::t.

◆ startMemberGroupHeader()

void HtmlGenerator::startMemberGroupHeader ( bool  )
virtual

Implements OutputGenerator.

Definition at line 2097 of file htmlgen.cpp.

References OutputGenerator::t.

◆ startMemberHeader()

void HtmlGenerator::startMemberHeader ( const char *  anchor,
int  typ 
)
virtual

Implements OutputGenerator.

Definition at line 1763 of file htmlgen.cpp.

References DBG_HTML, endl(), FALSE, m_emptySection, OutputGenerator::t, and TRUE.

◆ startMemberItem()

void HtmlGenerator::startMemberItem ( const char *  anchor,
int  annoType,
const char *  inheritId 
)
virtual

Implements OutputGenerator.

Definition at line 1663 of file htmlgen.cpp.

References DBG_HTML, endl(), FALSE, insertMemberAlignLeft(), m_emptySection, and OutputGenerator::t.

◆ startMemberList()

void HtmlGenerator::startMemberList ( )
virtual

Implements OutputGenerator.

Definition at line 1649 of file htmlgen.cpp.

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

◆ startMemberSections()

void HtmlGenerator::startMemberSections ( )
virtual

Implements OutputGenerator.

Definition at line 1746 of file htmlgen.cpp.

References DBG_HTML, endl(), m_emptySection, OutputGenerator::t, and TRUE.

◆ startMemberSubtitle()

void HtmlGenerator::startMemberSubtitle ( )
virtual

Implements OutputGenerator.

Definition at line 1789 of file htmlgen.cpp.

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

◆ startMemberTemplateParams()

void HtmlGenerator::startMemberTemplateParams ( )
virtual

Implements OutputGenerator.

Definition at line 1686 of file htmlgen.cpp.

◆ startPageDoc()

void HtmlGenerator::startPageDoc ( const char *  pageTitle)
virtual

Reimplemented from OutputGenerator.

Definition at line 2601 of file htmlgen.cpp.

References getDirHtmlClassOfPage(), and OutputGenerator::t.

◆ startPageRef()

void HtmlGenerator::startPageRef ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 261 of file htmlgen.h.

◆ startParagraph()

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

Starts a new paragraph

Starts a new paragraph

Implements BaseOutputDocInterface.

Definition at line 1303 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

◆ startParameterList()

void HtmlGenerator::startParameterList ( bool  openBracket)
virtual

Implements OutputGenerator.

Definition at line 1889 of file htmlgen.cpp.

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

◆ startParameterName()

void HtmlGenerator::startParameterName ( bool  )
virtual

Implements OutputGenerator.

Definition at line 1922 of file htmlgen.cpp.

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

◆ startParameterType()

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

Implements OutputGenerator.

Definition at line 1897 of file htmlgen.cpp.

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

◆ startParamList()

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

Implements BaseOutputDocInterface.

Definition at line 2203 of file htmlgen.cpp.

References docify(), and OutputGenerator::t.

◆ startProjectNumber()

void HtmlGenerator::startProjectNumber ( )
virtual

Implements OutputGenerator.

Definition at line 1217 of file htmlgen.cpp.

References OutputGenerator::t.

◆ startQuickIndices()

void HtmlGenerator::startQuickIndices ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 263 of file htmlgen.h.

◆ startSection()

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

Implements BaseOutputDocInterface.

Definition at line 1460 of file htmlgen.cpp.

References ASSERT, Page, Paragraph, Section, Subsection, Subsubsection, and OutputGenerator::t.

◆ startSmall()

void HtmlGenerator::startSmall ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 247 of file htmlgen.h.

References endl(), and OutputGenerator::t.

◆ startSubsection()

void HtmlGenerator::startSubsection ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 241 of file htmlgen.h.

References OutputGenerator::t.

◆ startSubsubsection()

void HtmlGenerator::startSubsubsection ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 243 of file htmlgen.h.

References OutputGenerator::t.

◆ startTextBlock()

void HtmlGenerator::startTextBlock ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 297 of file htmlgen.h.

References OutputGenerator::t.

◆ startTextLink()

void HtmlGenerator::startTextLink ( const char *  file,
const char *  anchor 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1400 of file htmlgen.cpp.

References addHtmlExtensionIfMissing(), m_relPath, and OutputGenerator::t.

◆ startTitle()

void HtmlGenerator::startTitle ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 140 of file htmlgen.h.

References OutputGenerator::t.

Referenced by startTitleHead().

◆ startTitleHead()

void HtmlGenerator::startTitleHead ( const char *  )
virtual

Implements OutputGenerator.

Definition at line 2885 of file htmlgen.cpp.

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

◆ startTypewriter()

void HtmlGenerator::startTypewriter ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 167 of file htmlgen.h.

References OutputGenerator::t.

◆ writeAnchor()

void HtmlGenerator::writeAnchor ( const char *  ,
const char *  name 
)
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 213 of file htmlgen.h.

References OutputGenerator::t.

◆ writeChar()

void HtmlGenerator::writeChar ( char  c)
virtual

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

Implements BaseOutputDocInterface.

Definition at line 1526 of file htmlgen.cpp.

References cs, and docify().

◆ writeCodeAnchor()

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

Write an anchor to a source listing.

Parameters
nameThe name of the anchor.

Implements CodeOutputInterface.

Definition at line 118 of file htmlgen.h.

References m_codeGen, and HtmlCodeGenerator::writeCodeAnchor().

◆ writeCodeLink()

void HtmlGenerator::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 100 of file htmlgen.h.

References m_codeGen, and HtmlCodeGenerator::writeCodeLink().

◆ writeDoc()

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

Implements OutputGenerator.

Definition at line 2216 of file htmlgen.cpp.

References DocNode::accept(), m_codeGen, and OutputGenerator::t.

◆ writeEndAnnoItem()

void HtmlGenerator::writeEndAnnoItem ( const char *  )
inlinevirtual

Implements OutputGenerator.

Definition at line 240 of file htmlgen.h.

References endl(), and OutputGenerator::t.

◆ writeExternalSearchPage()

◆ writeFooter()

void HtmlGenerator::writeFooter ( const char *  navPath)
virtual

◆ writeFooterFile()

void HtmlGenerator::writeFooterFile ( QFile f)
static

◆ writeGraphicalHierarchy()

void HtmlGenerator::writeGraphicalHierarchy ( DotGfxHierarchyTable g)
virtual

◆ writeHeaderFile()

void HtmlGenerator::writeHeaderFile ( QFile f,
const char *  cssname 
)
static

◆ writeInheritedSectionTitle()

void HtmlGenerator::writeInheritedSectionTitle ( const char *  id,
const char *  ref,
const char *  file,
const char *  anchor,
const char *  title,
const char *  name 
)
virtual

◆ writeLabel()

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

Implements OutputGenerator.

Definition at line 2974 of file htmlgen.cpp.

References DBG_HTML, endl(), languages::l, and OutputGenerator::t.

◆ writeLatexSpacing()

void HtmlGenerator::writeLatexSpacing ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 237 of file htmlgen.h.

◆ writeLineNumber()

void HtmlGenerator::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 104 of file htmlgen.h.

References m_codeGen, and HtmlCodeGenerator::writeLineNumber().

◆ writeLogo()

void HtmlGenerator::writeLogo ( )
virtual

Implements OutputGenerator.

Definition at line 1193 of file htmlgen.cpp.

References m_relPath, OutputGenerator::t, and writeLogoAsString().

◆ writeLogoAsString()

QCString HtmlGenerator::writeLogoAsString ( const char *  path)
static

◆ writeNavigationPath()

void HtmlGenerator::writeNavigationPath ( const char *  s)
virtual

Implements OutputGenerator.

Definition at line 2586 of file htmlgen.cpp.

References m_relPath, substitute(), and OutputGenerator::t.

◆ writeNonBreakableSpace()

void HtmlGenerator::writeNonBreakableSpace ( int  n)
virtual

Implements BaseOutputDocInterface.

Definition at line 2142 of file htmlgen.cpp.

References OutputGenerator::t.

◆ writeObjectLink()

void HtmlGenerator::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 1379 of file htmlgen.cpp.

References addHtmlExtensionIfMissing(), docify(), externalLinkTarget(), externalRef(), m_relPath, OutputGenerator::t, and TRUE.

◆ writePageFooter()

void HtmlGenerator::writePageFooter ( FTextStream t,
const QCString lastTitle,
const QCString relPath,
const QCString navPath 
)
staticprivate

◆ writePageLink()

void HtmlGenerator::writePageLink ( const char *  ,
bool   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 134 of file htmlgen.h.

◆ writeQuickLinks()

void HtmlGenerator::writeQuickLinks ( bool  compact,
HighlightedItem  hli,
const char *  file 
)
virtual

Implements OutputGenerator.

Definition at line 2611 of file htmlgen.cpp.

References m_relPath, OutputGenerator::t, and writeDefaultQuickLinks().

◆ writeRuler()

void HtmlGenerator::writeRuler ( )
inlinevirtual

Writes a horizontal ruler to the output

Implements BaseOutputDocInterface.

Definition at line 212 of file htmlgen.h.

References OutputGenerator::t.

◆ writeSearchData()

◆ writeSearchInfo() [1/2]

void HtmlGenerator::writeSearchInfo ( )
virtual

Implements OutputGenerator.

Definition at line 1163 of file htmlgen.cpp.

References m_relPath, and OutputGenerator::t.

◆ writeSearchInfo() [2/2]

void HtmlGenerator::writeSearchInfo ( FTextStream t,
const QCString relPath 
)
static

Definition at line 1140 of file htmlgen.cpp.

References Config_getBool, and OutputGenerator::t.

◆ writeSearchPage()

◆ writeSplitBar()

void HtmlGenerator::writeSplitBar ( const char *  name)
virtual

Implements OutputGenerator.

Definition at line 2581 of file htmlgen.cpp.

References m_relPath, OutputGenerator::t, and writeSplitBarAsString().

◆ writeSplitBarAsString()

QCString HtmlGenerator::writeSplitBarAsString ( const char *  name,
const char *  relpath 
)
static

◆ writeStartAnnoItem()

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

Implements OutputGenerator.

Definition at line 1369 of file htmlgen.cpp.

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

◆ writeString()

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

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

Implements BaseOutputDocInterface.

Definition at line 1316 of file htmlgen.cpp.

References OutputGenerator::t.

◆ writeStyleInfo()

◆ writeStyleSheetFile()

void HtmlGenerator::writeStyleSheetFile ( QFile f)
static

◆ writeSummaryLink()

void HtmlGenerator::writeSummaryLink ( const char *  file,
const char *  anchor,
const char *  title,
bool  first 
)
virtual

Implements OutputGenerator.

Definition at line 3017 of file htmlgen.cpp.

References addHtmlExtensionIfMissing(), m_relPath, and OutputGenerator::t.

◆ writeSynopsis()

void HtmlGenerator::writeSynopsis ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 258 of file htmlgen.h.

◆ writeTabData()

void HtmlGenerator::writeTabData ( )
static

Additional initialization after indices have been created.

Definition at line 1009 of file htmlgen.cpp.

References IndexList::addStyleSheetFile(), Config_getString, ResourceMgr::copyResource(), Doxygen::indexList, and ResourceMgr::instance().

Referenced by generateOutput().

◆ writeTooltip()

void HtmlGenerator::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 106 of file htmlgen.h.

References m_codeGen, and HtmlCodeGenerator::writeTooltip().

Member Data Documentation

◆ m_codeGen

◆ m_emptySection

bool HtmlGenerator::m_emptySection
private

◆ m_lastFile

QCString HtmlGenerator::m_lastFile
private

Definition at line 343 of file htmlgen.h.

Referenced by startFile().

◆ m_lastTitle

QCString HtmlGenerator::m_lastTitle
private

Definition at line 342 of file htmlgen.h.

Referenced by startFile(), and writeFooter().

◆ m_relPath

◆ m_sectionCount


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