HtmlGenerator Class Reference

#include <htmlgen.h>

Inheritance diagram for HtmlGenerator:

OutputGenerator BaseOutputDocInterface CodeOutputInterface List of all members.

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)
OutputGenerator * get (OutputType o)
void printDoc (DocNode *, const char *)
void startFile (const char *name, const char *manName, const char *title)
void writeFooter ()
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 endTitleHead (const char *, const char *)
void startTitle ()
void endTitle ()
void newParagraph ()
void startParagraph ()
void endParagraph ()
void writeString (const char *text)
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 codify (const char *text)
void writeObjectLink (const char *ref, const char *file, const char *anchor, const char *name)
void writeCodeLink (const char *ref, const char *file, const char *anchor, const char *name, const char *tooltip)
void startTextLink (const char *file, const char *anchor)
void endTextLink ()
void startHtmlLink (const char *url)
void endHtmlLink ()
void startTypewriter ()
void endTypewriter ()
void startGroupHeader ()
void endGroupHeader ()
void writeListItem ()
void startMemberSections ()
void endMemberSections ()
void startMemberHeader ()
void endMemberHeader ()
void startMemberSubtitle ()
void endMemberSubtitle ()
void startMemberDocList ()
void endMemberDocList ()
void startMemberList ()
void endMemberList ()
void startAnonTypeScope (int)
void endAnonTypeScope (int)
void startMemberItem (int)
void endMemberItem ()
void startMemberTemplateParams ()
void endMemberTemplateParams ()
void startMemberGroupHeader (bool)
void endMemberGroupHeader ()
void startMemberGroupDocs ()
void endMemberGroupDocs ()
void startMemberGroup ()
void endMemberGroup (bool)
void insertMemberAlign (bool)
void startMemberDescription ()
void endMemberDescription ()
void writeRuler ()
void writeAnchor (const char *, const char *name)
void startCodeFragment ()
void endCodeFragment ()
void writeLineNumber (const char *, const char *, const char *, int)
void startCodeLine ()
void endCodeLine ()
void startEmphasis ()
void endEmphasis ()
void startBold ()
void endBold ()
void startDescription ()
void endDescription ()
void startDescItem ()
void endDescItem ()
void lineBreak ()
void writeChar (char c)
void startMemberDoc (const char *, const char *, const char *, const char *)
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 startCodeAnchor (const char *label)
void endCodeAnchor ()
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 startDescList (SectionTypes)
void endDescList ()
void startSimpleSect (SectionTypes, const char *, const char *, const char *)
void endSimpleSect ()
void startParamList (ParamListTypes, const char *)
void endParamList ()
void writeDescItem ()
void startSection (const char *, const char *, SectionInfo::SectionType)
void endSection (const char *, SectionInfo::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 writeQuickLinks (bool compact, HighlightedItem hli)
void startContents ()
void endContents ()
void writeNonBreakableSpace (int)
void startDescTable ()
void endDescTable ()
void startDescTableTitle ()
void endDescTableTitle ()
void startDescTableData ()
void endDescTableData ()
void startDotGraph ()
void endDotGraph (const DotClassGraph &g)
void startInclDepGraph ()
void endInclDepGraph (const DotInclDepGraph &g)
void startGroupCollaboration ()
void endGroupCollaboration (const DotGroupCollaboration &g)
void startCallGraph ()
void endCallGraph (const DotCallGraph &g)
void startDirDepGraph ()
void endDirDepGraph (const DotDirDeps &g)
void writeGraphicalHierarchy (const 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 ()
void startConstraintList (const char *)
void startConstraintParam ()
void endConstraintParam ()
void startConstraintType ()
void endConstraintType ()
void startConstraintDocs ()
void endConstraintDocs ()
void endConstraintList ()
void startFontClass (const char *s)
void endFontClass ()
void writeCodeAnchor (const char *anchor)
void linkableSymbol (int, const char *, Definition *, Definition *)

Static Public Member Functions

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

Detailed Description

Definition at line 29 of file htmlgen.h.

Constructor & Destructor Documentation

HtmlGenerator::HtmlGenerator (  ) 

Definition at line 516 of file htmlgen.cpp.

References Config_getString.

HtmlGenerator::~HtmlGenerator (  )  [virtual]

Definition at line 522 of file htmlgen.cpp.

Member Function Documentation

void HtmlGenerator::init (  )  [static]

Definition at line 527 of file htmlgen.cpp.

References Config_getString, createSubDirs(), err(), fileToString(), QCString, and writeLogo().

Referenced by generateOutput().

void HtmlGenerator::writeStyleSheetFile ( QFile &  f  )  [static]

Definition at line 555 of file htmlgen.cpp.

References OutputGenerator::t.

Referenced by readConfiguration().

void HtmlGenerator::writeHeaderFile ( QFile &  f  )  [static]

Definition at line 601 of file htmlgen.cpp.

References relativePathToRoot(), and OutputGenerator::t.

Referenced by readConfiguration().

void HtmlGenerator::writeFooterFile ( QFile &  f  )  [static]

Definition at line 608 of file htmlgen.cpp.

References OutputGenerator::t, theTranslator, and Translator::trGeneratedAt().

Referenced by readConfiguration().

void HtmlGenerator::enable (  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 39 of file htmlgen.h.

References OutputGenerator::active, and OutputGenerator::genStack.

void HtmlGenerator::disable (  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 41 of file htmlgen.h.

References OutputGenerator::active.

void HtmlGenerator::enableIf ( OutputType  o  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 42 of file htmlgen.h.

References OutputGenerator::active, and OutputGenerator::Html.

void HtmlGenerator::disableIf ( OutputType  o  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 43 of file htmlgen.h.

References OutputGenerator::active, and OutputGenerator::Html.

void HtmlGenerator::disableIfNot ( OutputType  o  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 44 of file htmlgen.h.

References OutputGenerator::active, and OutputGenerator::Html.

bool HtmlGenerator::isEnabled ( OutputType  o  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 45 of file htmlgen.h.

References OutputGenerator::active, and OutputGenerator::Html.

OutputGenerator* HtmlGenerator::get ( OutputType  o  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 46 of file htmlgen.h.

References OutputGenerator::Html.

void HtmlGenerator::printDoc ( DocNode *  ,
const char *   
) [virtual]

Implements OutputGenerator.

Definition at line 1677 of file htmlgen.cpp.

References DocNode::accept().

void HtmlGenerator::startFile ( const char *  name,
const char *  manName,
const char *  title 
) [virtual]

Implements OutputGenerator.

Definition at line 672 of file htmlgen.cpp.

References IndexList::addIndexFile(), Config_getString, convertToHtml(), Doxygen::htmlFileExtension, Doxygen::indexList, QCString, relativePathToRoot(), OutputGenerator::startPlainFile(), substituteKeywords(), theTranslator, Translator::trGeneratedBy(), and versionString.

void HtmlGenerator::writeFooter (  )  [virtual]

Implements OutputGenerator.

Definition at line 744 of file htmlgen.cpp.

void HtmlGenerator::endFile (  )  [virtual]

Implements OutputGenerator.

Definition at line 749 of file htmlgen.cpp.

References OutputGenerator::endPlainFile().

void HtmlGenerator::clearBuffer (  ) 

void HtmlGenerator::startIndexSection ( IndexSections   )  [inline, virtual]

Implements OutputGenerator.

Definition at line 55 of file htmlgen.h.

void HtmlGenerator::endIndexSection ( IndexSections   )  [inline, virtual]

Implements OutputGenerator.

Definition at line 56 of file htmlgen.h.

void HtmlGenerator::writePageLink ( const char *  ,
bool   
) [inline, virtual]

Implements OutputGenerator.

Definition at line 57 of file htmlgen.h.

void HtmlGenerator::startProjectNumber (  )  [virtual]

Implements OutputGenerator.

Definition at line 754 of file htmlgen.cpp.

void HtmlGenerator::endProjectNumber (  )  [virtual]

Implements OutputGenerator.

Definition at line 759 of file htmlgen.cpp.

void HtmlGenerator::writeStyleInfo ( int  part  )  [virtual]

Implements OutputGenerator.

Definition at line 764 of file htmlgen.cpp.

References Config_getString, OutputGenerator::endPlainFile(), err(), fileToString(), QCString, and OutputGenerator::startPlainFile().

void HtmlGenerator::startTitleHead ( const char *   )  [inline, virtual]

Implements OutputGenerator.

Definition at line 61 of file htmlgen.h.

References startTitle().

void HtmlGenerator::endTitleHead ( const char *  ,
const char *   
) [inline, virtual]

Implements OutputGenerator.

Definition at line 62 of file htmlgen.h.

References endTitle().

void HtmlGenerator::startTitle (  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 63 of file htmlgen.h.

References OutputGenerator::t.

Referenced by startTitleHead().

void HtmlGenerator::endTitle (  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 64 of file htmlgen.h.

References OutputGenerator::t.

Referenced by endTitleHead().

void HtmlGenerator::newParagraph (  )  [virtual]

Starts a new paragraph

Implements BaseOutputDocInterface.

Definition at line 820 of file htmlgen.cpp.

void HtmlGenerator::startParagraph (  )  [virtual]

Starts a new paragraph

Implements BaseOutputDocInterface.

Definition at line 825 of file htmlgen.cpp.

void HtmlGenerator::endParagraph (  )  [virtual]

End a paragraph

Implements BaseOutputDocInterface.

Definition at line 830 of file htmlgen.cpp.

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

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

Implements BaseOutputDocInterface.

Definition at line 835 of file htmlgen.cpp.

void HtmlGenerator::startIndexList (  )  [virtual]

Implements OutputGenerator.

Definition at line 1303 of file htmlgen.cpp.

void HtmlGenerator::endIndexList (  )  [virtual]

Implements OutputGenerator.

Definition at line 1308 of file htmlgen.cpp.

void HtmlGenerator::startIndexKey (  )  [virtual]

Implements OutputGenerator.

Definition at line 1313 of file htmlgen.cpp.

void HtmlGenerator::endIndexKey (  )  [virtual]

Implements OutputGenerator.

Definition at line 1319 of file htmlgen.cpp.

void HtmlGenerator::startIndexValue ( bool   )  [virtual]

Implements OutputGenerator.

Definition at line 1324 of file htmlgen.cpp.

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

Implements OutputGenerator.

Definition at line 1330 of file htmlgen.cpp.

void HtmlGenerator::startItemList (  )  [inline, virtual]

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

Implements BaseOutputDocInterface.

Definition at line 76 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::endItemList (  )  [inline, virtual]

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

Implements BaseOutputDocInterface.

Definition at line 77 of file htmlgen.h.

References OutputGenerator::t.

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

Implements OutputGenerator.

Definition at line 840 of file htmlgen.cpp.

References Doxygen::htmlFileExtension, QCString, and Doxygen::tagDestinationDict.

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

Implements OutputGenerator.

Definition at line 875 of file htmlgen.cpp.

void HtmlGenerator::docify ( const char *  text  )  [virtual]

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

Implements BaseOutputDocInterface.

Definition at line 1030 of file htmlgen.cpp.

Referenced by startDoxyAnchor(), startParamList(), startSimpleSect(), writeChar(), writeCodeLink(), writeObjectLink(), and writeStartAnnoItem().

void HtmlGenerator::codify ( const char *  text  )  [virtual]

Writes an ASCII string 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 1059 of file htmlgen.cpp.

References Config_getInt, and spaces.

Referenced by endCodeLine(), and writeLineNumber().

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:
ref If this is non-zero, the object is to be found in an external documentation file.
file The file in which the object is located.
anchor The anchor uniquely identifying the object within the file.
name The text to display as a placeholder for the link.

Implements BaseOutputDocInterface.

Definition at line 898 of file htmlgen.cpp.

References docify(), Doxygen::htmlFileExtension, QCString, and Doxygen::tagDestinationDict.

Referenced by startSimpleSect().

void HtmlGenerator::writeCodeLink ( const char *  ref,
const char *  file,
const char *  anchor,
const char *  name,
const char *  tooltip 
) [virtual]

Writes a link to an object in a code fragment.

Parameters:
ref If this is non-zero, the object is to be found in an external documentation file.
file The file in which the object is located.
anchor The anchor uniquely identifying the object within the file.
name The text to display as a placeholder for the link.
tooltip The tooltip to display when the mouse is on the link.

Implements CodeOutputInterface.

Definition at line 929 of file htmlgen.cpp.

References convertToXML(), docify(), Doxygen::htmlFileExtension, QCString, and Doxygen::tagDestinationDict.

Referenced by writeLineNumber().

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

Implements BaseOutputDocInterface.

Definition at line 965 of file htmlgen.cpp.

References Doxygen::htmlFileExtension.

void HtmlGenerator::endTextLink (  )  [virtual]

Implements BaseOutputDocInterface.

Definition at line 973 of file htmlgen.cpp.

void HtmlGenerator::startHtmlLink ( const char *  url  )  [virtual]

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

Parameters:
url The URL to link to.

Implements BaseOutputDocInterface.

Definition at line 978 of file htmlgen.cpp.

References Config_getBool.

Referenced by endDotGraph().

void HtmlGenerator::endHtmlLink (  )  [virtual]

Ends a link started by startHtmlLink().

Implements BaseOutputDocInterface.

Definition at line 987 of file htmlgen.cpp.

Referenced by endDotGraph().

void HtmlGenerator::startTypewriter (  )  [inline, virtual]

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

Implements BaseOutputDocInterface.

Definition at line 91 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::endTypewriter (  )  [inline, virtual]

End a section of text displayed in typewriter style.

Implements BaseOutputDocInterface.

Definition at line 92 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::startGroupHeader (  )  [virtual]

Implements OutputGenerator.

Definition at line 992 of file htmlgen.cpp.

Referenced by startMemberHeader().

void HtmlGenerator::endGroupHeader (  )  [virtual]

Implements OutputGenerator.

Definition at line 997 of file htmlgen.cpp.

Referenced by endMemberHeader().

void HtmlGenerator::writeListItem (  )  [inline, virtual]

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

Implements BaseOutputDocInterface.

Definition at line 95 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::startMemberSections (  )  [virtual]

Implements OutputGenerator.

Definition at line 1245 of file htmlgen.cpp.

References Config_getBool, and DBG_HTML.

void HtmlGenerator::endMemberSections (  )  [virtual]

Implements OutputGenerator.

Definition at line 1256 of file htmlgen.cpp.

References Config_getBool, and DBG_HTML.

void HtmlGenerator::startMemberHeader (  )  [virtual]

Implements OutputGenerator.

Definition at line 1265 of file htmlgen.cpp.

References Config_getBool, DBG_HTML, and startGroupHeader().

void HtmlGenerator::endMemberHeader (  )  [virtual]

Implements OutputGenerator.

Definition at line 1278 of file htmlgen.cpp.

References Config_getBool, DBG_HTML, and endGroupHeader().

void HtmlGenerator::startMemberSubtitle (  )  [virtual]

Implements OutputGenerator.

Definition at line 1291 of file htmlgen.cpp.

References Config_getBool, and DBG_HTML.

void HtmlGenerator::endMemberSubtitle (  )  [virtual]

Implements OutputGenerator.

Definition at line 1297 of file htmlgen.cpp.

References Config_getBool, and DBG_HTML.

void HtmlGenerator::startMemberDocList (  )  [virtual]

Implements OutputGenerator.

Definition at line 1335 of file htmlgen.cpp.

References DBG_HTML.

void HtmlGenerator::endMemberDocList (  )  [virtual]

Implements OutputGenerator.

Definition at line 1343 of file htmlgen.cpp.

References DBG_HTML.

void HtmlGenerator::startMemberList (  )  [virtual]

Implements OutputGenerator.

Definition at line 1137 of file htmlgen.cpp.

References Config_getBool, and DBG_HTML.

void HtmlGenerator::endMemberList (  )  [virtual]

Implements OutputGenerator.

Definition at line 1149 of file htmlgen.cpp.

References Config_getBool, and DBG_HTML.

void HtmlGenerator::startAnonTypeScope ( int   )  [inline, virtual]

Implements OutputGenerator.

Definition at line 107 of file htmlgen.h.

void HtmlGenerator::endAnonTypeScope ( int   )  [inline, virtual]

Implements OutputGenerator.

Definition at line 108 of file htmlgen.h.

void HtmlGenerator::startMemberItem ( int   )  [virtual]

Implements OutputGenerator.

Definition at line 1165 of file htmlgen.cpp.

References Config_getBool, and DBG_HTML.

void HtmlGenerator::endMemberItem (  )  [virtual]

Implements OutputGenerator.

Definition at line 1185 of file htmlgen.cpp.

References Config_getBool.

void HtmlGenerator::startMemberTemplateParams (  )  [virtual]

Implements OutputGenerator.

Definition at line 1195 of file htmlgen.cpp.

void HtmlGenerator::endMemberTemplateParams (  )  [virtual]

Implements OutputGenerator.

Definition at line 1199 of file htmlgen.cpp.

References Config_getBool.

void HtmlGenerator::startMemberGroupHeader ( bool   )  [virtual]

Implements OutputGenerator.

Definition at line 1567 of file htmlgen.cpp.

void HtmlGenerator::endMemberGroupHeader (  )  [virtual]

Implements OutputGenerator.

Definition at line 1572 of file htmlgen.cpp.

void HtmlGenerator::startMemberGroupDocs (  )  [virtual]

Implements OutputGenerator.

Definition at line 1577 of file htmlgen.cpp.

void HtmlGenerator::endMemberGroupDocs (  )  [virtual]

Implements OutputGenerator.

Definition at line 1582 of file htmlgen.cpp.

void HtmlGenerator::startMemberGroup (  )  [virtual]

Implements OutputGenerator.

Definition at line 1587 of file htmlgen.cpp.

void HtmlGenerator::endMemberGroup ( bool   )  [virtual]

Implements OutputGenerator.

Definition at line 1591 of file htmlgen.cpp.

void HtmlGenerator::insertMemberAlign ( bool   )  [virtual]

Implements OutputGenerator.

Definition at line 1209 of file htmlgen.cpp.

References Config_getBool, DBG_HTML, and QCString.

void HtmlGenerator::startMemberDescription (  )  [virtual]

Implements OutputGenerator.

Definition at line 1219 of file htmlgen.cpp.

References Config_getBool, and DBG_HTML.

void HtmlGenerator::endMemberDescription (  )  [virtual]

Implements OutputGenerator.

Definition at line 1232 of file htmlgen.cpp.

References Config_getBool, and DBG_HTML.

void HtmlGenerator::writeRuler (  )  [inline, virtual]

Writes a horizontal ruler to the output

Implements BaseOutputDocInterface.

Definition at line 125 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::writeAnchor ( const char *  ,
const char *  name 
) [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 126 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::startCodeFragment (  )  [inline, 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 128 of file htmlgen.h.

References PREFRAG_START, and OutputGenerator::t.

void HtmlGenerator::endCodeFragment (  )  [inline, virtual]

Ends a source code fragment

Implements BaseOutputDocInterface.

Definition at line 129 of file htmlgen.h.

References PREFRAG_END, and OutputGenerator::t.

void HtmlGenerator::writeLineNumber ( const char *  ,
const char *  ,
const char *  ,
int   
) [virtual]

Implements CodeOutputInterface.

Definition at line 1621 of file htmlgen.cpp.

References codify(), endCodeAnchor(), QCString, startCodeAnchor(), and writeCodeLink().

void HtmlGenerator::startCodeLine (  )  [inline, virtual]

Implements CodeOutputInterface.

Definition at line 131 of file htmlgen.h.

void HtmlGenerator::endCodeLine (  )  [inline, virtual]

Implements CodeOutputInterface.

Definition at line 132 of file htmlgen.h.

References codify().

void HtmlGenerator::startEmphasis (  )  [inline, virtual]

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

Implements BaseOutputDocInterface.

Definition at line 133 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::endEmphasis (  )  [inline, virtual]

Ends a section of text displayed in italic.

Implements BaseOutputDocInterface.

Definition at line 134 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::startBold (  )  [inline, virtual]

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

Implements BaseOutputDocInterface.

Definition at line 135 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::endBold (  )  [inline, virtual]

End a section of text displayed in bold face.

Implements BaseOutputDocInterface.

Definition at line 136 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::startDescription (  )  [inline, virtual]

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

Implements BaseOutputDocInterface.

Definition at line 137 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::endDescription (  )  [inline, virtual]

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

Implements BaseOutputDocInterface.

Definition at line 138 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::startDescItem (  )  [inline, virtual]

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

Implements BaseOutputDocInterface.

Definition at line 139 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::endDescItem (  )  [inline, virtual]

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

Implements BaseOutputDocInterface.

Definition at line 140 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::lineBreak (  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 141 of file htmlgen.h.

References OutputGenerator::t.

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 1108 of file htmlgen.cpp.

References docify().

void HtmlGenerator::startMemberDoc ( const char *  ,
const char *  ,
const char *  ,
const char *   
) [virtual]

Implements OutputGenerator.

Definition at line 1351 of file htmlgen.cpp.

References DBG_HTML.

void HtmlGenerator::endMemberDoc ( bool   )  [virtual]

Implements OutputGenerator.

Definition at line 1475 of file htmlgen.cpp.

References DBG_HTML.

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

Implements OutputGenerator.

Definition at line 802 of file htmlgen.cpp.

References docify().

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

Implements OutputGenerator.

Definition at line 816 of file htmlgen.cpp.

void HtmlGenerator::startCodeAnchor ( const char *  label  )  [inline, virtual]

Implements CodeOutputInterface.

Definition at line 149 of file htmlgen.h.

References OutputGenerator::t.

Referenced by writeLineNumber().

void HtmlGenerator::endCodeAnchor (  )  [inline, virtual]

Implements CodeOutputInterface.

Definition at line 150 of file htmlgen.h.

Referenced by writeLineNumber().

void HtmlGenerator::writeLatexSpacing (  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 151 of file htmlgen.h.

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

Implements OutputGenerator.

Definition at line 888 of file htmlgen.cpp.

References docify(), and Doxygen::htmlFileExtension.

void HtmlGenerator::writeEndAnnoItem ( const char *   )  [inline, virtual]

Implements OutputGenerator.

Definition at line 154 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::startSubsection (  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 155 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::endSubsection (  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 156 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::startSubsubsection (  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 157 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::endSubsubsection (  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 158 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::startCenter (  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 159 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::endCenter (  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 160 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::startSmall (  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 161 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::endSmall (  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 162 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::startDescList ( SectionTypes   )  [inline]

Definition at line 163 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::endDescList (  )  [inline]

Definition at line 164 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::startSimpleSect ( SectionTypes  ,
const char *  ,
const char *  ,
const char *   
) [virtual]

Implements BaseOutputDocInterface.

Definition at line 1643 of file htmlgen.cpp.

References docify(), and writeObjectLink().

void HtmlGenerator::endSimpleSect (  )  [virtual]

Implements BaseOutputDocInterface.

Definition at line 1659 of file htmlgen.cpp.

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

Implements BaseOutputDocInterface.

Definition at line 1664 of file htmlgen.cpp.

References docify().

void HtmlGenerator::endParamList (  )  [virtual]

Implements BaseOutputDocInterface.

Definition at line 1672 of file htmlgen.cpp.

void HtmlGenerator::writeDescItem (  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 169 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::startSection ( const char *  ,
const char *  ,
SectionInfo::SectionType   
) [virtual]

Implements BaseOutputDocInterface.

Definition at line 1002 of file htmlgen.cpp.

References SectionInfo::Page, SectionInfo::Paragraph, SectionInfo::Section, SectionInfo::Subsection, and SectionInfo::Subsubsection.

void HtmlGenerator::endSection ( const char *  ,
SectionInfo::SectionType   
) [virtual]

Implements BaseOutputDocInterface.

Definition at line 1016 of file htmlgen.cpp.

References SectionInfo::Page, SectionInfo::Paragraph, SectionInfo::Section, SectionInfo::Subsection, and SectionInfo::Subsubsection.

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

Implements BaseOutputDocInterface.

Definition at line 1608 of file htmlgen.cpp.

void HtmlGenerator::startIndent (  )  [virtual]

Implements OutputGenerator.

Definition at line 1595 of file htmlgen.cpp.

References DBG_HTML.

void HtmlGenerator::endIndent (  )  [virtual]

Implements OutputGenerator.

Definition at line 1602 of file htmlgen.cpp.

References DBG_HTML.

void HtmlGenerator::writeSynopsis (  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 175 of file htmlgen.h.

void HtmlGenerator::startClassDiagram (  )  [virtual]

Implements OutputGenerator.

Definition at line 1116 of file htmlgen.cpp.

void HtmlGenerator::endClassDiagram ( const ClassDiagram &  ,
const char *  ,
const char *   
) [virtual]

Implements OutputGenerator.

Definition at line 1122 of file htmlgen.cpp.

References ClassDiagram::writeImage().

void HtmlGenerator::startPageRef (  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 178 of file htmlgen.h.

void HtmlGenerator::endPageRef ( const char *  ,
const char *   
) [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 179 of file htmlgen.h.

void HtmlGenerator::startQuickIndices (  )  [virtual]

Implements OutputGenerator.

Definition at line 2051 of file htmlgen.cpp.

References Config_getBool.

void HtmlGenerator::endQuickIndices (  )  [virtual]

Implements OutputGenerator.

Definition at line 2059 of file htmlgen.cpp.

References Config_getBool.

void HtmlGenerator::writeQuickLinks ( bool  compact,
HighlightedItem  hli 
) [virtual]

Implements OutputGenerator.

Definition at line 2077 of file htmlgen.cpp.

void HtmlGenerator::startContents (  )  [virtual]

Implements OutputGenerator.

Definition at line 2067 of file htmlgen.cpp.

void HtmlGenerator::endContents (  )  [virtual]

Implements OutputGenerator.

Definition at line 2072 of file htmlgen.cpp.

void HtmlGenerator::writeNonBreakableSpace ( int   )  [virtual]

Implements BaseOutputDocInterface.

Definition at line 1612 of file htmlgen.cpp.

void HtmlGenerator::startDescTable (  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 187 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::endDescTable (  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 189 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::startDescTableTitle (  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 191 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::endDescTableTitle (  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 193 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::startDescTableData (  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 195 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::endDescTableData (  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 197 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::startDotGraph (  )  [virtual]

Implements OutputGenerator.

Definition at line 1489 of file htmlgen.cpp.

void HtmlGenerator::endDotGraph ( const DotClassGraph &  g  )  [virtual]

Implements OutputGenerator.

Definition at line 1494 of file htmlgen.cpp.

References BITMAP, Config_getBool, endHtmlLink(), Doxygen::htmlFileExtension, startHtmlLink(), theTranslator, Translator::trLegend(), and DotClassGraph::writeGraph().

void HtmlGenerator::startInclDepGraph (  )  [virtual]

Implements OutputGenerator.

Definition at line 1510 of file htmlgen.cpp.

void HtmlGenerator::endInclDepGraph ( const DotInclDepGraph &  g  )  [virtual]

Implements OutputGenerator.

Definition at line 1515 of file htmlgen.cpp.

References BITMAP, and DotInclDepGraph::writeGraph().

void HtmlGenerator::startGroupCollaboration (  )  [virtual]

Implements OutputGenerator.

Definition at line 1523 of file htmlgen.cpp.

void HtmlGenerator::endGroupCollaboration ( const DotGroupCollaboration &  g  )  [virtual]

Implements OutputGenerator.

Definition at line 1528 of file htmlgen.cpp.

References BITMAP, and DotGroupCollaboration::writeGraph().

void HtmlGenerator::startCallGraph (  )  [virtual]

Implements OutputGenerator.

Definition at line 1536 of file htmlgen.cpp.

void HtmlGenerator::endCallGraph ( const DotCallGraph &  g  )  [virtual]

Implements OutputGenerator.

Definition at line 1541 of file htmlgen.cpp.

References BITMAP, and DotCallGraph::writeGraph().

void HtmlGenerator::startDirDepGraph (  )  [virtual]

Implements OutputGenerator.

Definition at line 1549 of file htmlgen.cpp.

void HtmlGenerator::endDirDepGraph ( const DotDirDeps &  g  )  [virtual]

Implements OutputGenerator.

Definition at line 1554 of file htmlgen.cpp.

References BITMAP, and DotDirDeps::writeGraph().

void HtmlGenerator::writeGraphicalHierarchy ( const DotGfxHierarchyTable &  g  )  [virtual]

Implements OutputGenerator.

Definition at line 1562 of file htmlgen.cpp.

References DotGfxHierarchyTable::writeGraph().

void HtmlGenerator::startTextBlock ( bool   )  [inline, virtual]

Implements OutputGenerator.

Definition at line 212 of file htmlgen.h.

void HtmlGenerator::endTextBlock ( bool   )  [inline, virtual]

Implements OutputGenerator.

Definition at line 213 of file htmlgen.h.

void HtmlGenerator::lastIndexPage (  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 214 of file htmlgen.h.

void HtmlGenerator::startMemberDocPrefixItem (  )  [virtual]

Implements OutputGenerator.

Definition at line 1365 of file htmlgen.cpp.

References DBG_HTML.

void HtmlGenerator::endMemberDocPrefixItem (  )  [virtual]

Implements OutputGenerator.

Definition at line 1373 of file htmlgen.cpp.

References DBG_HTML.

void HtmlGenerator::startMemberDocName ( bool   )  [virtual]

Implements OutputGenerator.

Definition at line 1381 of file htmlgen.cpp.

References DBG_HTML.

void HtmlGenerator::endMemberDocName (  )  [virtual]

Implements OutputGenerator.

Definition at line 1391 of file htmlgen.cpp.

References DBG_HTML.

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

Implements OutputGenerator.

Definition at line 1405 of file htmlgen.cpp.

References DBG_HTML.

void HtmlGenerator::endParameterType (  )  [virtual]

Implements OutputGenerator.

Definition at line 1424 of file htmlgen.cpp.

References DBG_HTML.

void HtmlGenerator::startParameterName ( bool   )  [virtual]

Implements OutputGenerator.

Definition at line 1430 of file htmlgen.cpp.

References DBG_HTML.

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

Implements OutputGenerator.

Definition at line 1436 of file htmlgen.cpp.

References DBG_HTML.

void HtmlGenerator::startParameterList ( bool   )  [virtual]

Implements OutputGenerator.

Definition at line 1397 of file htmlgen.cpp.

References DBG_HTML.

void HtmlGenerator::endParameterList (  )  [virtual]

Implements OutputGenerator.

Definition at line 1468 of file htmlgen.cpp.

References DBG_HTML.

void HtmlGenerator::startConstraintList ( const char *   )  [virtual]

Implements OutputGenerator.

Definition at line 2180 of file htmlgen.cpp.

void HtmlGenerator::startConstraintParam (  )  [virtual]

Implements OutputGenerator.

Definition at line 2187 of file htmlgen.cpp.

void HtmlGenerator::endConstraintParam (  )  [virtual]

Implements OutputGenerator.

Definition at line 2192 of file htmlgen.cpp.

void HtmlGenerator::startConstraintType (  )  [virtual]

Implements OutputGenerator.

Definition at line 2197 of file htmlgen.cpp.

void HtmlGenerator::endConstraintType (  )  [virtual]

Implements OutputGenerator.

Definition at line 2202 of file htmlgen.cpp.

void HtmlGenerator::startConstraintDocs (  )  [virtual]

Implements OutputGenerator.

Definition at line 2207 of file htmlgen.cpp.

void HtmlGenerator::endConstraintDocs (  )  [virtual]

Implements OutputGenerator.

Definition at line 2212 of file htmlgen.cpp.

void HtmlGenerator::endConstraintList (  )  [virtual]

Implements OutputGenerator.

Definition at line 2217 of file htmlgen.cpp.

void HtmlGenerator::startFontClass ( const char *  s  )  [inline, virtual]

Implements CodeOutputInterface.

Definition at line 236 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::endFontClass (  )  [inline, virtual]

Implements CodeOutputInterface.

Definition at line 237 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::writeCodeAnchor ( const char *  anchor  )  [inline, virtual]

Implements CodeOutputInterface.

Definition at line 239 of file htmlgen.h.

References OutputGenerator::t.

void HtmlGenerator::linkableSymbol ( int  ,
const char *  ,
Definition *  ,
Definition *   
) [inline, virtual]

Implements CodeOutputInterface.

Definition at line 241 of file htmlgen.h.

void HtmlGenerator::writeSearchPage (  )  [static]

Definition at line 2082 of file htmlgen.cpp.

References Config_getBool, Config_getString, HLI_Search, QCString, substituteKeywords(), OutputGenerator::t, theTranslator, Translator::trGeneratedBy(), Translator::trSearch(), Translator::trSearchMatches(), Translator::trSearchResults(), and Translator::trSearchResultsTitle().

Referenced by generateOutput().

void HtmlGenerator::generateSectionImages (  )  [static]

Definition at line 2160 of file htmlgen.cpp.

References Config_getString, and QCString.

Referenced by generateOutput().

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


Generated on Mon Mar 31 10:59:00 2008 by  doxygen 1.5.1