OutputList Class Reference

#include <outputlist.h>

Inheritance diagram for OutputList:

OutputDocInterface BaseOutputDocInterface CodeOutputInterface List of all members.

Public Member Functions

 OutputList (bool)
virtual ~OutputList ()
void add (const OutputGenerator *)
void disableAllBut (OutputGenerator::OutputType o)
void enableAll ()
void disableAll ()
void disable (OutputGenerator::OutputType o)
void enable (OutputGenerator::OutputType o)
bool isEnabled (OutputGenerator::OutputType o)
void pushGeneratorState ()
void popGeneratorState ()
void parseDoc (const char *fileName, int startLine, Definition *ctx, MemberDef *md, const QCString &docStr, bool indexWords, bool isExample, const char *exampleName=0, bool singleLine=FALSE, bool linkFromIndex=FALSE)
void parseText (const QCString &textStr)
void startIndexSection (IndexSections is)
void endIndexSection (IndexSections is)
void writePageLink (const char *name, bool first)
void startProjectNumber ()
void endProjectNumber ()
void writeStyleInfo (int part)
void startFile (const char *name, const char *manName, const char *title)
void writeFooter ()
void endFile ()
void startTitleHead (const char *fileName)
void endTitleHead (const char *fileName, const char *name)
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 b)
void endIndexValue (const char *name, bool b)
void startItemList ()
void endItemList ()
void startIndexItem (const char *ref, const char *file)
void endIndexItem (const char *ref, const char *file)
void docify (const char *s)
void codify (const char *s)
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 writeStartAnnoItem (const char *type, const char *file, const char *path, const char *name)
void writeEndAnnoItem (const char *name)
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 i1)
void endAnonTypeScope (int i1)
void startMemberItem (int i1)
void endMemberItem ()
void startMemberTemplateParams ()
void endMemberTemplateParams ()
void startMemberGroupHeader (bool b)
void endMemberGroupHeader ()
void startMemberGroupDocs ()
void endMemberGroupDocs ()
void startMemberGroup ()
void endMemberGroup (bool last)
void insertMemberAlign (bool templ=FALSE)
void writeRuler ()
void writeAnchor (const char *fileName, const char *name)
void startCodeFragment ()
void endCodeFragment ()
void startCodeLine ()
void endCodeLine ()
void writeLineNumber (const char *ref, const char *file, const char *anchor, int lineNumber)
void startEmphasis ()
void endEmphasis ()
void writeChar (char c)
void startMemberDoc (const char *clName, const char *memName, const char *anchor, const char *title)
void endMemberDoc (bool hasArgs)
void startDoxyAnchor (const char *fName, const char *manName, const char *anchor, const char *name, const char *args)
void endDoxyAnchor (const char *fn, const char *anchor)
void startCodeAnchor (const char *label)
void endCodeAnchor ()
void writeLatexSpacing ()
void startDescription ()
void endDescription ()
void startDescItem ()
void endDescItem ()
void startSubsection ()
void endSubsection ()
void startSubsubsection ()
void endSubsubsection ()
void startCenter ()
void endCenter ()
void startSmall ()
void endSmall ()
void lineBreak ()
void startBold ()
void endBold ()
void startMemberDescription ()
void endMemberDescription ()
void startSimpleSect (SectionTypes t, const char *file, const char *anchor, const char *title)
void endSimpleSect ()
void startParamList (ParamListTypes t, const char *title)
void endParamList ()
void writeDescItem ()
void startIndent ()
void endIndent ()
void startSection (const char *lab, const char *title, SectionInfo::SectionType t)
void endSection (const char *lab, SectionInfo::SectionType t)
void addIndexItem (const char *s1, const char *s2)
void writeSynopsis ()
void startClassDiagram ()
void endClassDiagram (const ClassDiagram &d, const char *f, const char *n)
void startPageRef ()
void endPageRef (const char *c, const char *a)
void startQuickIndices ()
void endQuickIndices ()
void writeQuickLinks (bool compact, HighlightedItem hli)
void startContents ()
void endContents ()
void writeNonBreakableSpace (int num)
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 startCallGraph ()
void endCallGraph (const DotCallGraph &g)
void startDirDepGraph ()
void endDirDepGraph (const DotDirDeps &g)
void startGroupCollaboration ()
void endGroupCollaboration (const DotGroupCollaboration &g)
void writeGraphicalHierarchy (const DotGfxHierarchyTable &g)
void startTextBlock (bool dense=FALSE)
void endTextBlock (bool paraBreak=FALSE)
void lastIndexPage ()
void startMemberDocPrefixItem ()
void endMemberDocPrefixItem ()
void startMemberDocName (bool align)
void endMemberDocName ()
void startParameterType (bool first, const char *key)
void endParameterType ()
void startParameterName (bool one)
void endParameterName (bool last, bool one, bool bracket)
void startParameterList (bool openBracket)
void endParameterList ()
void startConstraintList (const char *header)
void startConstraintParam ()
void endConstraintParam ()
void startConstraintType ()
void endConstraintType ()
void startConstraintDocs ()
void endConstraintDocs ()
void endConstraintList ()
void startFontClass (const char *c)
void endFontClass ()
void writeCodeAnchor (const char *name)
void startPlainFile (const char *name)
void endPlainFile ()
void linkableSymbol (int, const char *, Definition *, Definition *)

Detailed Description

Definition at line 45 of file outputlist.h.


Constructor & Destructor Documentation

OutputList::OutputList ( bool   ) 

Definition at line 33 of file outputlist.cpp.

OutputList::~OutputList (  )  [virtual]

Definition at line 40 of file outputlist.cpp.


Member Function Documentation

void OutputList::add ( const OutputGenerator  ) 

Definition at line 46 of file outputlist.cpp.

Referenced by generateOutput().

void OutputList::disableAllBut ( OutputGenerator::OutputType  o  )  [virtual]

Disables all output formats except format o (useful for OutputList only)

Implements OutputDocInterface.

Definition at line 51 of file outputlist.cpp.

References OutputGenerator::disableIfNot().

Referenced by addGroupListToTitle(), endFile(), generateOutput(), ClassDef::showUsedFiles(), writeAlphabeticalIndex(), ClassDef::writeClassDiagrams(), MemberDef::writeDeclaration(), ClassSDict::writeDeclaration(), ClassDef::writeDetailedDescription(), NamespaceDef::writeDetailedDocumentation(), FileDef::writeDetailedDocumentation(), PageDef::writeDocumentation(), NamespaceDef::writeDocumentation(), MemberDef::writeDocumentation(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirRelation::writeDocumentation(), DirDef::writeDocumentation(), ClassDef::writeDocumentation(), MemberDef::writeEnumDeclaration(), writeFileIndex(), writeGraphicalClassHierarchy(), writeGraphInfo(), writeIndex(), ClassDef::writeMemberList(), NamespaceDef::writeMemberPages(), GroupDef::writeMemberPages(), FileDef::writeMemberPages(), ClassDef::writeMemberPages(), Definition::writeNavigationPath(), writePageIndex(), MemberList::writePlainDeclarations(), FileDef::writeSource(), Definition::writeSourceDef(), and VhdlDocGen::writeVHDLDeclaration().

void OutputList::enableAll (  )  [virtual]

Enables all output formats as far as they have been enabled in the config file. (useful for OutputList only)

Implements OutputDocInterface.

Definition at line 61 of file outputlist.cpp.

References OutputGenerator::enable().

Referenced by generateOutput(), ClassDef::writeClassDiagrams(), ClassDef::writeDetailedDescription(), NamespaceDef::writeDetailedDocumentation(), FileDef::writeDetailedDocumentation(), NamespaceDef::writeDocumentation(), MemberDef::writeDocumentation(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), ClassDef::writeDocumentation(), VhdlDocGen::writeFuncProcDocu(), writeGraphicalClassHierarchy(), MemberList::writePlainDeclarations(), FileDef::writeSource(), and Definition::writeSourceDef().

void OutputList::disableAll (  )  [virtual]

Disables all output formats (useful for OutputList only)

Implements OutputDocInterface.

Definition at line 71 of file outputlist.cpp.

References OutputGenerator::disable().

void OutputList::disable ( OutputGenerator::OutputType  o  )  [virtual]

Disables a specific output format (useful for OutputList only)

Implements OutputDocInterface.

Definition at line 81 of file outputlist.cpp.

References OutputGenerator::disableIf().

Referenced by ClassDef::showUsedFiles(), startTitle(), writeAnnotatedIndex(), ClassDef::writeClassDiagrams(), MemberDef::writeDeclaration(), ClassDef::writeDetailedDescription(), NamespaceDef::writeDetailedDocumentation(), GroupDef::writeDetailedDocumentation(), FileDef::writeDetailedDocumentation(), DirDef::writeDetailedDocumentation(), writeDirIndex(), PageDef::writeDocumentation(), NamespaceDef::writeDocumentation(), MemberDef::writeDocumentation(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), ClassDef::writeDocumentation(), MemberDef::writeEnumDeclaration(), writeExample(), writeExampleIndex(), writeFileIndex(), VhdlDocGen::writeFuncProcDocu(), writeGroupIndex(), writeHierarchicalIndex(), writeIndex(), VhdlDocGen::writeInlineClassLink(), NamespaceDef::writeMemberDocumentation(), GroupDef::writeMemberDocumentation(), FileDef::writeMemberDocumentation(), ClassDef::writeMemberDocumentation(), writeNamespaceIndex(), Definition::writeSourceDef(), and VhdlDocGen::writeVHDLDeclaration().

void OutputList::enable ( OutputGenerator::OutputType  o  )  [virtual]

Enables a specific output format (useful for OutputList only)

Implements OutputDocInterface.

Definition at line 91 of file outputlist.cpp.

References OutputGenerator::enableIf().

Referenced by ClassDef::writeClassDiagrams(), MemberDef::writeDeclaration(), NamespaceDef::writeDocumentation(), ClassDef::writeDocumentation(), MemberDef::writeEnumDeclaration(), VhdlDocGen::writeFuncProcDocu(), writeHierarchicalIndex(), writeIndex(), VhdlDocGen::writeInlineClassLink(), ClassDef::writeMemberDocumentation(), and VhdlDocGen::writeVHDLDeclaration().

bool OutputList::isEnabled ( OutputGenerator::OutputType  o  )  [virtual]

Check whether a specific output format is currenly enabled (useful for OutputList only)

Implements OutputDocInterface.

Definition at line 101 of file outputlist.cpp.

References OutputGenerator::isEnabled().

Referenced by MemberDef::writeDeclaration(), and VhdlDocGen::writeVHDLDeclaration().

void OutputList::pushGeneratorState (  )  [virtual]

Pushes the state of the current generator (or list of generators) on a stack.

Implements OutputDocInterface.

Definition at line 113 of file outputlist.cpp.

References OutputGenerator::pushGeneratorState().

Referenced by addGroupListToTitle(), endFile(), ClassDef::showUsedFiles(), startTitle(), writeAlphabeticalIndex(), writeAnnotatedIndex(), ClassDef::writeClassDiagrams(), MemberDef::writeDeclaration(), ClassSDict::writeDeclaration(), ClassDef::writeDetailedDescription(), NamespaceDef::writeDetailedDocumentation(), GroupDef::writeDetailedDocumentation(), FileDef::writeDetailedDocumentation(), DirDef::writeDetailedDocumentation(), writeDirIndex(), PageDef::writeDocumentation(), NamespaceDef::writeDocumentation(), MemberDef::writeDocumentation(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirRelation::writeDocumentation(), DirDef::writeDocumentation(), ClassDef::writeDocumentation(), MemberDef::writeEnumDeclaration(), writeExample(), writeExampleIndex(), writeFileIndex(), writeGraphInfo(), writeGroupIndex(), writeHierarchicalIndex(), writeIndex(), Definition::writeInlineCode(), ClassDef::writeMemberList(), NamespaceDef::writeMemberPages(), GroupDef::writeMemberPages(), FileDef::writeMemberPages(), ClassDef::writeMemberPages(), writeNamespaceIndex(), Definition::writeNavigationPath(), writePageIndex(), MemberList::writePlainDeclarations(), VhdlDocGen::writePlainVHDLDeclarations(), Definition::writeSourceDef(), and VhdlDocGen::writeVHDLDeclaration().

void OutputList::popGeneratorState (  )  [virtual]

Pops the state of the current generator (or list of generators) on a stack. Should be preceded by a call the pushGeneratorState().

Implements OutputDocInterface.

Definition at line 123 of file outputlist.cpp.

References OutputGenerator::popGeneratorState().

Referenced by addGroupListToTitle(), endFile(), endTitle(), ClassDef::showUsedFiles(), writeAlphabeticalIndex(), writeAnnotatedIndex(), ClassDef::writeClassDiagrams(), MemberDef::writeDeclaration(), ClassSDict::writeDeclaration(), ClassDef::writeDetailedDescription(), NamespaceDef::writeDetailedDocumentation(), GroupDef::writeDetailedDocumentation(), FileDef::writeDetailedDocumentation(), DirDef::writeDetailedDocumentation(), writeDirIndex(), PageDef::writeDocumentation(), NamespaceDef::writeDocumentation(), MemberDef::writeDocumentation(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirRelation::writeDocumentation(), DirDef::writeDocumentation(), ClassDef::writeDocumentation(), MemberDef::writeEnumDeclaration(), writeExample(), writeExampleIndex(), writeFileIndex(), writeGraphInfo(), writeGroupIndex(), writeHierarchicalIndex(), writeIndex(), Definition::writeInlineCode(), ClassDef::writeMemberList(), NamespaceDef::writeMemberPages(), GroupDef::writeMemberPages(), FileDef::writeMemberPages(), ClassDef::writeMemberPages(), writeNamespaceIndex(), Definition::writeNavigationPath(), writePageIndex(), MemberList::writePlainDeclarations(), Definition::writeSourceDef(), and VhdlDocGen::writeVHDLDeclaration().

void OutputList::parseDoc ( const char *  fileName,
int  startLine,
Definition ctx,
MemberDef md,
const QCString &  docStr,
bool  indexWords,
bool  isExample,
const char *  exampleName = 0,
bool  singleLine = FALSE,
bool  linkFromIndex = FALSE 
)

Definition at line 133 of file outputlist.cpp.

References Definition::getDefFileExtension(), OutputGenerator::isEnabled(), OutputGenerator::printDoc(), QCString, and validatingParseDoc().

Referenced by writeAnnotatedClassList(), NamespaceSDict::writeDeclaration(), MemberDef::writeDeclaration(), ClassSDict::writeDeclaration(), MemberList::writeDeclarations(), ClassDef::writeDetailedDescription(), NamespaceDef::writeDetailedDocumentation(), GroupDef::writeDetailedDocumentation(), FileDef::writeDetailedDocumentation(), DirDef::writeDetailedDocumentation(), PageDef::writeDocumentation(), NamespaceDef::writeDocumentation(), MemberDef::writeDocumentation(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), ClassDef::writeDocumentation(), writeFileIndex(), writeGraphInfo(), writeIndex(), writeNamespaceIndex(), MemberList::writePlainDeclarations(), writeTypeConstraints(), VhdlDocGen::writeVHDLDeclaration(), and VhdlDocGen::writeVHDLDeclarations().

void OutputList::parseText ( const QCString &  textStr  )  [virtual]

Reimplemented from BaseOutputDocInterface.

Definition at line 176 of file outputlist.cpp.

References OutputGenerator::isEnabled(), OutputGenerator::printDoc(), and validatingParseText().

Referenced by generateOutput(), ClassDef::showUsedFiles(), writeAlphabeticalIndex(), writeAnnotatedIndex(), ClassDef::writeClassDiagrams(), writeClassTree(), NamespaceSDict::writeDeclaration(), ClassSDict::writeDeclaration(), MemberList::writeDeclarations(), ClassDef::writeDetailedDescription(), NamespaceDef::writeDetailedDocumentation(), GroupDef::writeDetailedDocumentation(), FileDef::writeDetailedDocumentation(), DirDef::writeDetailedDocumentation(), writeDirIndex(), writeDirTreeNode(), NamespaceDef::writeDocumentation(), MemberList::writeDocumentation(), MemberDef::writeDocumentation(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), ClassDef::writeDocumentation(), MemberDef::writeEnumDeclaration(), writeExample(), writeExampleIndex(), writeFileIndex(), writeGraphicalClassHierarchy(), writeGraphInfo(), writeGroupIndex(), writeGroupTreeNode(), writeHierarchicalIndex(), writeIndex(), ClassDef::writeMemberList(), writeNamespaceIndex(), writePageIndex(), MemberList::writePlainDeclarations(), FileDef::writeSource(), Definition::writeSourceDef(), writeTypeConstraints(), and VhdlDocGen::writeVHDLDeclarations().

void OutputList::startIndexSection ( IndexSections  is  )  [inline]

Definition at line 74 of file outputlist.h.

References OutputGenerator::startIndexSection().

Referenced by writeIndex().

void OutputList::endIndexSection ( IndexSections  is  )  [inline]

Definition at line 76 of file outputlist.h.

References OutputGenerator::endIndexSection().

Referenced by writeIndex().

void OutputList::writePageLink ( const char *  name,
bool  first 
) [inline]

Definition at line 78 of file outputlist.h.

References OutputGenerator::writePageLink().

Referenced by writeIndex().

void OutputList::startProjectNumber (  )  [inline]

Definition at line 80 of file outputlist.h.

References OutputGenerator::startProjectNumber().

Referenced by FileDef::writeDocumentation(), and writeIndex().

void OutputList::endProjectNumber (  )  [inline]

Definition at line 82 of file outputlist.h.

References OutputGenerator::endProjectNumber().

Referenced by FileDef::writeDocumentation(), and writeIndex().

void OutputList::writeStyleInfo ( int  part  )  [inline]

Definition at line 84 of file outputlist.h.

References OutputGenerator::writeStyleInfo().

Referenced by generateOutput().

void OutputList::startFile ( const char *  name,
const char *  manName,
const char *  title 
) [inline]

Definition at line 86 of file outputlist.h.

References OutputGenerator::startFile().

Referenced by startFile(), and writeIndex().

void OutputList::writeFooter (  )  [inline]

Definition at line 88 of file outputlist.h.

References OutputGenerator::writeFooter().

Referenced by endFile().

void OutputList::endFile (  )  [inline]

Definition at line 90 of file outputlist.h.

References OutputGenerator::endFile().

Referenced by endFile().

void OutputList::startTitleHead ( const char *  fileName  )  [inline]

Definition at line 92 of file outputlist.h.

References OutputGenerator::startTitleHead().

Referenced by startTitle(), PageDef::writeDocumentation(), and writeIndex().

void OutputList::endTitleHead ( const char *  fileName,
const char *  name 
) [inline]

Definition at line 94 of file outputlist.h.

References OutputGenerator::endTitleHead().

Referenced by endTitle(), PageDef::writeDocumentation(), and writeIndex().

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

Implements BaseOutputDocInterface.

Definition at line 96 of file outputlist.h.

References BaseOutputDocInterface::startTitle().

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

Implements BaseOutputDocInterface.

Definition at line 98 of file outputlist.h.

References BaseOutputDocInterface::endTitle().

void OutputList::newParagraph (  )  [inline, virtual]

Starts a new paragraph

Implements BaseOutputDocInterface.

Definition at line 100 of file outputlist.h.

References BaseOutputDocInterface::newParagraph().

Referenced by ClassDef::writeClassDiagrams(), NamespaceSDict::writeDeclaration(), ClassDef::writeDetailedDescription(), NamespaceDef::writeDetailedDocumentation(), GroupDef::writeDetailedDocumentation(), FileDef::writeDetailedDocumentation(), DirDef::writeDetailedDocumentation(), NamespaceDef::writeDocumentation(), MemberDef::writeDocumentation(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), ClassDef::writeDocumentation(), writeGraphicalClassHierarchy(), writeHierarchicalIndex(), writeIndex(), Definition::writeInlineCode(), and writeQuickMemberIndex().

void OutputList::startParagraph (  )  [inline, virtual]

Starts a new paragraph

Implements BaseOutputDocInterface.

Definition at line 102 of file outputlist.h.

References BaseOutputDocInterface::startParagraph().

Referenced by FileDef::writeDetailedDocumentation(), MemberDef::writeDocumentation(), and Definition::writeSourceDef().

void OutputList::endParagraph (  )  [inline, virtual]

End a paragraph

Implements BaseOutputDocInterface.

Definition at line 104 of file outputlist.h.

References BaseOutputDocInterface::endParagraph().

Referenced by FileDef::writeDetailedDocumentation(), MemberDef::writeDocumentation(), and Definition::writeSourceDef().

void OutputList::writeString ( const char *  text  )  [inline, virtual]

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

Implements BaseOutputDocInterface.

Definition at line 106 of file outputlist.h.

References BaseOutputDocInterface::writeString().

Referenced by writeAlphabeticalClassList(), VhdlDocGen::writeClassType(), MemberDef::writeDeclaration(), ClassSDict::writeDeclaration(), ClassDef::writeDetailedDescription(), NamespaceDef::writeDetailedDocumentation(), FileDef::writeDetailedDocumentation(), NamespaceDef::writeDocumentation(), MemberDef::writeDocumentation(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirRelation::writeDocumentation(), DirDef::writeDocumentation(), ClassDef::writeDocumentation(), MemberList::writeDocumentationPage(), MemberDef::writeEnumDeclaration(), writeExample(), writeExampleIndex(), ClassDef::writeMemberList(), Definition::writeNavigationPath(), writePageIndex(), MemberList::writePlainDeclarations(), writeQuickMemberIndex(), NamespaceDef::writeQuickMemberLinks(), GroupDef::writeQuickMemberLinks(), FileDef::writeQuickMemberLinks(), and ClassDef::writeQuickMemberLinks().

void OutputList::startIndexList (  )  [inline]

Definition at line 108 of file outputlist.h.

References OutputGenerator::startIndexList().

Referenced by writeAnnotatedClassList(), writeFileIndex(), and writeNamespaceIndex().

void OutputList::endIndexList (  )  [inline]

Definition at line 110 of file outputlist.h.

References OutputGenerator::endIndexList().

Referenced by writeAnnotatedClassList(), writeFileIndex(), and writeNamespaceIndex().

void OutputList::startIndexKey (  )  [inline]

Definition at line 112 of file outputlist.h.

References OutputGenerator::startIndexKey().

Referenced by writeAnnotatedClassList(), writeFileIndex(), and writeNamespaceIndex().

void OutputList::endIndexKey (  )  [inline]

Definition at line 114 of file outputlist.h.

References OutputGenerator::endIndexKey().

Referenced by writeAnnotatedClassList(), writeFileIndex(), and writeNamespaceIndex().

void OutputList::startIndexValue ( bool  b  )  [inline]

Definition at line 116 of file outputlist.h.

References OutputGenerator::startIndexValue().

Referenced by writeAnnotatedClassList(), writeFileIndex(), and writeNamespaceIndex().

void OutputList::endIndexValue ( const char *  name,
bool  b 
) [inline]

Definition at line 118 of file outputlist.h.

References OutputGenerator::endIndexValue().

Referenced by writeAnnotatedClassList(), writeFileIndex(), and writeNamespaceIndex().

void OutputList::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 120 of file outputlist.h.

References BaseOutputDocInterface::startItemList().

Referenced by ClassDef::showUsedFiles(), and writeExampleIndex().

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

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

Implements BaseOutputDocInterface.

Definition at line 122 of file outputlist.h.

References BaseOutputDocInterface::endItemList().

Referenced by ClassDef::showUsedFiles(), and writeExampleIndex().

void OutputList::startIndexItem ( const char *  ref,
const char *  file 
) [inline]

Definition at line 124 of file outputlist.h.

References OutputGenerator::startIndexItem().

Referenced by writeClassTree(), writeDirTreeNode(), writeGroupTreeNode(), and writePageIndex().

void OutputList::endIndexItem ( const char *  ref,
const char *  file 
) [inline]

Definition at line 126 of file outputlist.h.

References OutputGenerator::endIndexItem().

Referenced by writeClassTree(), writeDirTreeNode(), writeGroupTreeNode(), and writePageIndex().

void OutputList::docify ( const char *  s  )  [inline, virtual]

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

Implements BaseOutputDocInterface.

Definition at line 128 of file outputlist.h.

References BaseOutputDocInterface::docify().

Referenced by addGroupListToTitle(), ClassDef::showUsedFiles(), writeAlphabeticalClassList(), ClassDef::writeClassDiagrams(), writeClassTree(), NamespaceSDict::writeDeclaration(), MemberDef::writeDeclaration(), ClassSDict::writeDeclaration(), ClassDef::writeDeclaration(), writeDirTreeNode(), MemberDef::writeDocumentation(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), ClassDef::writeDocumentation(), MemberDef::writeEnumDeclaration(), writeFileIndex(), VhdlDocGen::writeFuncProcDocu(), VhdlDocGen::writeFunctionProto(), writeGroupTreeNode(), writeIndex(), ClassDef::writeMemberList(), writePageIndex(), Definition::writePathFragment(), MemberList::writePlainDeclarations(), VhdlDocGen::writeProcedureProto(), VhdlDocGen::writeProcessProto(), Definition::writeSourceDef(), VhdlDocGen::writeVHDLDeclaration(), VhdlDocGen::writeVHDLDeclarations(), and VhdlDocGen::writeVHDLTypeDocumentation().

void OutputList::codify ( const char *  s  )  [inline, 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 130 of file outputlist.h.

References CodeOutputInterface::codify().

void OutputList::writeObjectLink ( const char *  ref,
const char *  file,
const char *  anchor,
const char *  name 
) [inline, 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 132 of file outputlist.h.

References BaseOutputDocInterface::writeObjectLink().

Referenced by addGroupListToTitle(), ClassDef::showUsedFiles(), writeAlphabeticalClassList(), writeAnnotatedClassList(), ClassDef::writeClassDiagrams(), NamespaceSDict::writeDeclaration(), ClassSDict::writeDeclaration(), ClassDef::writeDeclaration(), FileDef::writeDetailedDocumentation(), MemberDef::writeDocumentation(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), ClassDef::writeDocumentation(), writeExample(), writeExampleIndex(), writeFileIndex(), ClassDef::writeMemberList(), writeNamespaceIndex(), Definition::writePathFragment(), Definition::writeSourceDef(), and VhdlDocGen::writeVHDLTypeDocumentation().

void OutputList::writeCodeLink ( const char *  ref,
const char *  file,
const char *  anchor,
const char *  name,
const char *  tooltip 
) [inline, 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 135 of file outputlist.h.

References CodeOutputInterface::writeCodeLink().

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

Implements BaseOutputDocInterface.

Definition at line 139 of file outputlist.h.

References BaseOutputDocInterface::startTextLink().

Referenced by MemberDef::writeDeclaration(), ClassSDict::writeDeclaration(), NamespaceDef::writeDocumentation(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), ClassDef::writeDocumentation(), writeFileIndex(), writeGraphicalClassHierarchy(), writeHierarchicalIndex(), MemberList::writePlainDeclarations(), FileDef::writeSource(), and VhdlDocGen::writeVHDLDeclaration().

void OutputList::endTextLink (  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 141 of file outputlist.h.

References BaseOutputDocInterface::endTextLink().

Referenced by MemberDef::writeDeclaration(), ClassSDict::writeDeclaration(), NamespaceDef::writeDocumentation(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), ClassDef::writeDocumentation(), writeFileIndex(), writeGraphicalClassHierarchy(), writeHierarchicalIndex(), MemberList::writePlainDeclarations(), FileDef::writeSource(), and VhdlDocGen::writeVHDLDeclaration().

void OutputList::startHtmlLink ( const char *  url  )  [inline, virtual]

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

Parameters:
url The URL to link to.

Implements BaseOutputDocInterface.

Definition at line 143 of file outputlist.h.

References BaseOutputDocInterface::startHtmlLink().

void OutputList::endHtmlLink (  )  [inline, virtual]

Ends a link started by startHtmlLink().

Implements BaseOutputDocInterface.

Definition at line 145 of file outputlist.h.

References BaseOutputDocInterface::endHtmlLink().

void OutputList::writeStartAnnoItem ( const char *  type,
const char *  file,
const char *  path,
const char *  name 
) [inline]

Definition at line 147 of file outputlist.h.

References OutputGenerator::writeStartAnnoItem().

void OutputList::writeEndAnnoItem ( const char *  name  )  [inline]

Definition at line 150 of file outputlist.h.

References OutputGenerator::writeEndAnnoItem().

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

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

Implements BaseOutputDocInterface.

Definition at line 152 of file outputlist.h.

References BaseOutputDocInterface::startTypewriter().

Referenced by writeClassTree(), MemberDef::writeDeclaration(), writeDirTreeNode(), MemberDef::writeDocumentation(), FileDef::writeDocumentation(), ClassDef::writeDocumentation(), writeGroupTreeNode(), ClassDef::writeMemberList(), and writePageIndex().

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

End a section of text displayed in typewriter style.

Implements BaseOutputDocInterface.

Definition at line 154 of file outputlist.h.

References BaseOutputDocInterface::endTypewriter().

Referenced by writeClassTree(), MemberDef::writeDeclaration(), writeDirTreeNode(), MemberDef::writeDocumentation(), FileDef::writeDocumentation(), ClassDef::writeDocumentation(), writeGroupTreeNode(), ClassDef::writeMemberList(), and writePageIndex().

void OutputList::startGroupHeader (  )  [inline]

Definition at line 156 of file outputlist.h.

References OutputGenerator::startGroupHeader().

Referenced by ClassDef::writeDetailedDescription(), NamespaceDef::writeDetailedDocumentation(), GroupDef::writeDetailedDocumentation(), FileDef::writeDetailedDocumentation(), DirDef::writeDetailedDocumentation(), NamespaceDef::writeDocumentation(), MemberList::writeDocumentation(), and ClassDef::writeDocumentation().

void OutputList::endGroupHeader (  )  [inline]

Definition at line 158 of file outputlist.h.

References OutputGenerator::endGroupHeader().

Referenced by ClassDef::writeDetailedDescription(), NamespaceDef::writeDetailedDocumentation(), GroupDef::writeDetailedDocumentation(), FileDef::writeDetailedDocumentation(), DirDef::writeDetailedDocumentation(), NamespaceDef::writeDocumentation(), MemberList::writeDocumentation(), and ClassDef::writeDocumentation().

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

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

Implements BaseOutputDocInterface.

Definition at line 160 of file outputlist.h.

References BaseOutputDocInterface::writeListItem().

Referenced by ClassDef::showUsedFiles(), and writeExampleIndex().

void OutputList::startMemberSections (  )  [inline]

Definition at line 162 of file outputlist.h.

References OutputGenerator::startMemberSections().

Referenced by NamespaceDef::writeDocumentation(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), and ClassDef::writeDocumentation().

void OutputList::endMemberSections (  )  [inline]

Definition at line 164 of file outputlist.h.

References OutputGenerator::endMemberSections().

Referenced by NamespaceDef::writeDocumentation(), GroupDef::writeDocumentation(), DirDef::writeDocumentation(), and ClassDef::writeDocumentation().

void OutputList::startMemberHeader (  )  [inline]

Definition at line 166 of file outputlist.h.

References OutputGenerator::startMemberHeader().

Referenced by NamespaceSDict::writeDeclaration(), ClassSDict::writeDeclaration(), MemberList::writeDeclarations(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), and VhdlDocGen::writeVHDLDeclarations().

void OutputList::endMemberHeader (  )  [inline]

Definition at line 168 of file outputlist.h.

References OutputGenerator::endMemberHeader().

Referenced by NamespaceSDict::writeDeclaration(), ClassSDict::writeDeclaration(), MemberList::writeDeclarations(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), and VhdlDocGen::writeVHDLDeclarations().

void OutputList::startMemberSubtitle (  )  [inline]

Definition at line 170 of file outputlist.h.

References OutputGenerator::startMemberSubtitle().

Referenced by MemberList::writeDeclarations(), and VhdlDocGen::writeVHDLDeclarations().

void OutputList::endMemberSubtitle (  )  [inline]

Definition at line 172 of file outputlist.h.

References OutputGenerator::endMemberSubtitle().

Referenced by MemberList::writeDeclarations(), and VhdlDocGen::writeVHDLDeclarations().

void OutputList::startMemberDocList (  )  [inline]

Definition at line 174 of file outputlist.h.

References OutputGenerator::startMemberDocList().

Referenced by MemberList::writeDocumentation().

void OutputList::endMemberDocList (  )  [inline]

Definition at line 176 of file outputlist.h.

References OutputGenerator::endMemberDocList().

Referenced by MemberList::writeDocumentation().

void OutputList::startMemberList (  )  [inline]

Definition at line 178 of file outputlist.h.

References OutputGenerator::startMemberList().

Referenced by NamespaceSDict::writeDeclaration(), ClassSDict::writeDeclaration(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), MemberList::writePlainDeclarations(), and VhdlDocGen::writePlainVHDLDeclarations().

void OutputList::endMemberList (  )  [inline]

Definition at line 180 of file outputlist.h.

References OutputGenerator::endMemberList().

Referenced by NamespaceSDict::writeDeclaration(), ClassSDict::writeDeclaration(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), MemberList::writePlainDeclarations(), and VhdlDocGen::writePlainVHDLDeclarations().

void OutputList::startAnonTypeScope ( int  i1  )  [inline]

Definition at line 182 of file outputlist.h.

References OutputGenerator::startAnonTypeScope().

Referenced by MemberDef::writeDeclaration().

void OutputList::endAnonTypeScope ( int  i1  )  [inline]

Definition at line 184 of file outputlist.h.

References OutputGenerator::endAnonTypeScope().

Referenced by MemberDef::writeDeclaration().

void OutputList::startMemberItem ( int  i1  )  [inline]

Definition at line 186 of file outputlist.h.

References OutputGenerator::startMemberItem().

Referenced by NamespaceSDict::writeDeclaration(), MemberDef::writeDeclaration(), ClassSDict::writeDeclaration(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), MemberList::writePlainDeclarations(), and VhdlDocGen::writeVHDLDeclaration().

void OutputList::endMemberItem (  )  [inline]

Definition at line 188 of file outputlist.h.

References OutputGenerator::endMemberItem().

Referenced by NamespaceSDict::writeDeclaration(), MemberDef::writeDeclaration(), ClassSDict::writeDeclaration(), ClassDef::writeDeclaration(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), MemberList::writePlainDeclarations(), and VhdlDocGen::writeVHDLDeclaration().

void OutputList::startMemberTemplateParams (  )  [inline]

Definition at line 190 of file outputlist.h.

References OutputGenerator::startMemberTemplateParams().

Referenced by MemberDef::writeDeclaration().

void OutputList::endMemberTemplateParams (  )  [inline]

Definition at line 192 of file outputlist.h.

References OutputGenerator::endMemberTemplateParams().

Referenced by MemberDef::writeDeclaration().

void OutputList::startMemberGroupHeader ( bool  b  )  [inline]

Definition at line 194 of file outputlist.h.

References OutputGenerator::startMemberGroupHeader().

Referenced by MemberList::writeDeclarations(), and VhdlDocGen::writeVHDLDeclarations().

void OutputList::endMemberGroupHeader (  )  [inline]

Definition at line 196 of file outputlist.h.

References OutputGenerator::endMemberGroupHeader().

Referenced by MemberList::writeDeclarations(), and VhdlDocGen::writeVHDLDeclarations().

void OutputList::startMemberGroupDocs (  )  [inline]

Definition at line 198 of file outputlist.h.

References OutputGenerator::startMemberGroupDocs().

Referenced by MemberList::writeDeclarations(), and VhdlDocGen::writeVHDLDeclarations().

void OutputList::endMemberGroupDocs (  )  [inline]

Definition at line 200 of file outputlist.h.

References OutputGenerator::endMemberGroupDocs().

Referenced by MemberList::writeDeclarations(), and VhdlDocGen::writeVHDLDeclarations().

void OutputList::startMemberGroup (  )  [inline]

Definition at line 202 of file outputlist.h.

References OutputGenerator::startMemberGroup().

Referenced by MemberList::writeDeclarations(), and VhdlDocGen::writeVHDLDeclarations().

void OutputList::endMemberGroup ( bool  last  )  [inline]

Definition at line 204 of file outputlist.h.

References OutputGenerator::endMemberGroup().

Referenced by MemberList::writeDeclarations(), and VhdlDocGen::writeVHDLDeclarations().

void OutputList::insertMemberAlign ( bool  templ = FALSE  )  [inline]

Definition at line 206 of file outputlist.h.

References OutputGenerator::insertMemberAlign().

Referenced by NamespaceSDict::writeDeclaration(), MemberDef::writeDeclaration(), ClassSDict::writeDeclaration(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), MemberList::writePlainDeclarations(), and VhdlDocGen::writeVHDLDeclaration().

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

Writes a horizontal ruler to the output

Implements BaseOutputDocInterface.

Definition at line 208 of file outputlist.h.

References BaseOutputDocInterface::writeRuler().

Referenced by ClassDef::showUsedFiles(), ClassDef::writeDetailedDescription(), NamespaceDef::writeDetailedDocumentation(), GroupDef::writeDetailedDocumentation(), FileDef::writeDetailedDocumentation(), DirDef::writeDetailedDocumentation(), and MemberList::writeDocumentation().

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

Implements BaseOutputDocInterface.

Definition at line 210 of file outputlist.h.

References BaseOutputDocInterface::writeAnchor().

Referenced by ClassDef::writeDetailedDescription(), NamespaceDef::writeDetailedDocumentation(), GroupDef::writeDetailedDocumentation(), FileDef::writeDetailedDocumentation(), and DirDef::writeDetailedDocumentation().

void OutputList::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 212 of file outputlist.h.

References BaseOutputDocInterface::startCodeFragment().

Referenced by MemberDef::writeDocumentation(), Definition::writeInlineCode(), and FileDef::writeSource().

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

Ends a source code fragment

Implements BaseOutputDocInterface.

Definition at line 214 of file outputlist.h.

References BaseOutputDocInterface::endCodeFragment().

Referenced by MemberDef::writeDocumentation(), Definition::writeInlineCode(), and FileDef::writeSource().

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

Implements CodeOutputInterface.

Definition at line 216 of file outputlist.h.

References CodeOutputInterface::startCodeLine().

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

Implements CodeOutputInterface.

Definition at line 218 of file outputlist.h.

References CodeOutputInterface::endCodeLine().

void OutputList::writeLineNumber ( const char *  ref,
const char *  file,
const char *  anchor,
int  lineNumber 
) [inline, virtual]

Implements CodeOutputInterface.

Definition at line 220 of file outputlist.h.

References CodeOutputInterface::writeLineNumber().

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

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

Implements BaseOutputDocInterface.

Definition at line 223 of file outputlist.h.

References BaseOutputDocInterface::startEmphasis().

Referenced by VhdlDocGen::writeFuncProcDocu().

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

Ends a section of text displayed in italic.

Implements BaseOutputDocInterface.

Definition at line 225 of file outputlist.h.

References BaseOutputDocInterface::endEmphasis().

Referenced by VhdlDocGen::writeFuncProcDocu().

void OutputList::writeChar ( char  c  )  [inline, virtual]

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

Implements BaseOutputDocInterface.

Definition at line 227 of file outputlist.h.

References BaseOutputDocInterface::writeChar().

Referenced by MemberDef::writeDocumentation(), MemberDef::writeEnumDeclaration(), and VhdlDocGen::writeProcedureProto().

void OutputList::startMemberDoc ( const char *  clName,
const char *  memName,
const char *  anchor,
const char *  title 
) [inline]

Definition at line 229 of file outputlist.h.

References OutputGenerator::startMemberDoc().

Referenced by MemberDef::writeDocumentation().

void OutputList::endMemberDoc ( bool  hasArgs  )  [inline]

Definition at line 232 of file outputlist.h.

References OutputGenerator::endMemberDoc().

Referenced by MemberDef::writeDocumentation().

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

Definition at line 234 of file outputlist.h.

References OutputGenerator::startDoxyAnchor().

Referenced by MemberDef::writeDeclaration(), MemberDef::writeDocumentation(), and VhdlDocGen::writeVHDLDeclaration().

void OutputList::endDoxyAnchor ( const char *  fn,
const char *  anchor 
) [inline]

Definition at line 238 of file outputlist.h.

References OutputGenerator::endDoxyAnchor().

Referenced by MemberDef::writeDeclaration(), MemberDef::writeDocumentation(), and VhdlDocGen::writeVHDLDeclaration().

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

Implements CodeOutputInterface.

Definition at line 240 of file outputlist.h.

References CodeOutputInterface::startCodeAnchor().

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

Implements CodeOutputInterface.

Definition at line 242 of file outputlist.h.

References CodeOutputInterface::endCodeAnchor().

void OutputList::writeLatexSpacing (  )  [inline]

Definition at line 244 of file outputlist.h.

References OutputGenerator::writeLatexSpacing().

Referenced by MemberDef::writeDeclaration(), and MemberDef::writeDocumentation().

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

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

Implements BaseOutputDocInterface.

Definition at line 246 of file outputlist.h.

References BaseOutputDocInterface::startDescription().

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

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

Implements BaseOutputDocInterface.

Definition at line 248 of file outputlist.h.

References BaseOutputDocInterface::endDescription().

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

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

Implements BaseOutputDocInterface.

Definition at line 250 of file outputlist.h.

References BaseOutputDocInterface::startDescItem().

void OutputList::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 252 of file outputlist.h.

References BaseOutputDocInterface::endDescItem().

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

Implements BaseOutputDocInterface.

Definition at line 254 of file outputlist.h.

References BaseOutputDocInterface::startSubsection().

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

Implements BaseOutputDocInterface.

Definition at line 256 of file outputlist.h.

References BaseOutputDocInterface::endSubsection().

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

Implements BaseOutputDocInterface.

Definition at line 258 of file outputlist.h.

References BaseOutputDocInterface::startSubsubsection().

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

Implements BaseOutputDocInterface.

Definition at line 260 of file outputlist.h.

References BaseOutputDocInterface::endSubsubsection().

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

Implements BaseOutputDocInterface.

Definition at line 262 of file outputlist.h.

References BaseOutputDocInterface::startCenter().

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

Implements BaseOutputDocInterface.

Definition at line 264 of file outputlist.h.

References BaseOutputDocInterface::endCenter().

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

Implements BaseOutputDocInterface.

Definition at line 266 of file outputlist.h.

References BaseOutputDocInterface::startSmall().

Referenced by addGroupListToTitle().

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

Implements BaseOutputDocInterface.

Definition at line 268 of file outputlist.h.

References BaseOutputDocInterface::endSmall().

Referenced by addGroupListToTitle().

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

Implements BaseOutputDocInterface.

Definition at line 270 of file outputlist.h.

References BaseOutputDocInterface::lineBreak().

Referenced by addGroupListToTitle(), FileDef::writeDocumentation(), MemberDef::writeEnumDeclaration(), VhdlDocGen::writeFunctionProto(), VhdlDocGen::writeInlineClassLink(), and VhdlDocGen::writeProcedureProto().

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

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

Implements BaseOutputDocInterface.

Definition at line 272 of file outputlist.h.

References BaseOutputDocInterface::startBold().

Referenced by VhdlDocGen::writeClassType(), ClassSDict::writeDeclaration(), ClassDef::writeDeclaration(), MemberDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), MemberDef::writeEnumDeclaration(), writeFileIndex(), VhdlDocGen::writeFormatString(), VhdlDocGen::writeFunctionProto(), ClassDef::writeMemberList(), Definition::writePathFragment(), VhdlDocGen::writeProcedureProto(), VhdlDocGen::writeProcessProto(), VhdlDocGen::writeVHDLDeclaration(), and VhdlDocGen::writeVHDLTypeDocumentation().

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

End a section of text displayed in bold face.

Implements BaseOutputDocInterface.

Definition at line 274 of file outputlist.h.

References BaseOutputDocInterface::endBold().

Referenced by VhdlDocGen::writeClassType(), ClassSDict::writeDeclaration(), ClassDef::writeDeclaration(), MemberDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), MemberDef::writeEnumDeclaration(), writeFileIndex(), VhdlDocGen::writeFormatString(), VhdlDocGen::writeFunctionProto(), ClassDef::writeMemberList(), Definition::writePathFragment(), VhdlDocGen::writeProcedureProto(), VhdlDocGen::writeProcessProto(), VhdlDocGen::writeVHDLDeclaration(), and VhdlDocGen::writeVHDLTypeDocumentation().

void OutputList::startMemberDescription (  )  [inline]

Definition at line 276 of file outputlist.h.

References OutputGenerator::startMemberDescription().

Referenced by NamespaceSDict::writeDeclaration(), MemberDef::writeDeclaration(), ClassSDict::writeDeclaration(), GroupDef::writeDocumentation(), DirDef::writeDocumentation(), MemberList::writePlainDeclarations(), and VhdlDocGen::writeVHDLDeclaration().

void OutputList::endMemberDescription (  )  [inline]

Definition at line 278 of file outputlist.h.

References OutputGenerator::endMemberDescription().

Referenced by NamespaceSDict::writeDeclaration(), MemberDef::writeDeclaration(), ClassSDict::writeDeclaration(), GroupDef::writeDocumentation(), DirDef::writeDocumentation(), MemberList::writePlainDeclarations(), and VhdlDocGen::writeVHDLDeclaration().

void OutputList::startSimpleSect ( SectionTypes  t,
const char *  file,
const char *  anchor,
const char *  title 
) [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 280 of file outputlist.h.

References BaseOutputDocInterface::startSimpleSect().

Referenced by ClassDef::writeDetailedDescription(), and MemberDef::writeDocumentation().

void OutputList::endSimpleSect (  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 283 of file outputlist.h.

References BaseOutputDocInterface::endSimpleSect().

Referenced by ClassDef::writeDetailedDescription(), and MemberDef::writeDocumentation().

void OutputList::startParamList ( ParamListTypes  t,
const char *  title 
) [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 285 of file outputlist.h.

References BaseOutputDocInterface::startParamList().

Referenced by MemberDef::writeDocumentation().

void OutputList::endParamList (  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 287 of file outputlist.h.

References BaseOutputDocInterface::endParamList().

Referenced by MemberDef::writeDocumentation().

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

Implements BaseOutputDocInterface.

Definition at line 289 of file outputlist.h.

References BaseOutputDocInterface::writeDescItem().

Referenced by ClassDef::writeDetailedDescription(), and MemberDef::writeDocumentation().

void OutputList::startIndent (  )  [inline]

Definition at line 291 of file outputlist.h.

References OutputGenerator::startIndent().

Referenced by MemberDef::writeDocumentation().

void OutputList::endIndent (  )  [inline]

Definition at line 293 of file outputlist.h.

References OutputGenerator::endIndent().

Referenced by MemberDef::writeDocumentation().

void OutputList::startSection ( const char *  lab,
const char *  title,
SectionInfo::SectionType  t 
) [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 295 of file outputlist.h.

References BaseOutputDocInterface::startSection().

Referenced by PageDef::writeDocumentation(), and GroupDef::writeDocumentation().

void OutputList::endSection ( const char *  lab,
SectionInfo::SectionType  t 
) [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 297 of file outputlist.h.

References BaseOutputDocInterface::endSection().

Referenced by PageDef::writeDocumentation(), and GroupDef::writeDocumentation().

void OutputList::addIndexItem ( const char *  s1,
const char *  s2 
) [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 299 of file outputlist.h.

References BaseOutputDocInterface::addIndexItem().

Referenced by MemberDef::writeDocumentation().

void OutputList::writeSynopsis (  )  [inline]

Definition at line 301 of file outputlist.h.

References OutputGenerator::writeSynopsis().

Referenced by NamespaceDef::writeDocumentation(), FileDef::writeDocumentation(), and ClassDef::writeDocumentation().

void OutputList::startClassDiagram (  )  [inline]

Definition at line 303 of file outputlist.h.

References OutputGenerator::startClassDiagram().

Referenced by ClassDef::writeClassDiagrams().

void OutputList::endClassDiagram ( const ClassDiagram d,
const char *  f,
const char *  n 
) [inline]

Definition at line 305 of file outputlist.h.

References OutputGenerator::endClassDiagram().

Referenced by ClassDef::writeClassDiagrams().

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

Implements BaseOutputDocInterface.

Definition at line 307 of file outputlist.h.

References BaseOutputDocInterface::startPageRef().

void OutputList::endPageRef ( const char *  c,
const char *  a 
) [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 309 of file outputlist.h.

References BaseOutputDocInterface::endPageRef().

void OutputList::startQuickIndices (  )  [inline]

Definition at line 311 of file outputlist.h.

References OutputGenerator::startQuickIndices().

Referenced by startFile(), and writeIndex().

void OutputList::endQuickIndices (  )  [inline]

Definition at line 313 of file outputlist.h.

References OutputGenerator::endQuickIndices().

Referenced by startFile(), PageDef::writeDocumentation(), NamespaceDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), ClassDef::writeDocumentation(), writeIndex(), and FileDef::writeSource().

void OutputList::writeQuickLinks ( bool  compact,
HighlightedItem  hli 
) [inline]

Definition at line 315 of file outputlist.h.

References OutputGenerator::writeQuickLinks().

Referenced by startFile(), and writeIndex().

void OutputList::startContents (  )  [inline]

Definition at line 317 of file outputlist.h.

References OutputGenerator::startContents().

Referenced by startFile(), PageDef::writeDocumentation(), NamespaceDef::writeDocumentation(), FileDef::writeDocumentation(), DirDef::writeDocumentation(), ClassDef::writeDocumentation(), and writeIndex().

void OutputList::endContents (  )  [inline]

Definition at line 319 of file outputlist.h.

References OutputGenerator::endContents().

Referenced by endFile(), and FileDef::writeSource().

void OutputList::writeNonBreakableSpace ( int  num  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 321 of file outputlist.h.

References BaseOutputDocInterface::writeNonBreakableSpace().

Referenced by addGroupListToTitle(), writeAlphabeticalClassList(), MemberDef::writeDeclaration(), and MemberDef::writeDocumentation().

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

Implements BaseOutputDocInterface.

Definition at line 323 of file outputlist.h.

References BaseOutputDocInterface::startDescTable().

Referenced by MemberDef::writeDocumentation().

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

Implements BaseOutputDocInterface.

Definition at line 325 of file outputlist.h.

References BaseOutputDocInterface::endDescTable().

Referenced by MemberDef::writeDocumentation().

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

Implements BaseOutputDocInterface.

Definition at line 327 of file outputlist.h.

References BaseOutputDocInterface::startDescTableTitle().

Referenced by MemberDef::writeDocumentation().

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

Implements BaseOutputDocInterface.

Definition at line 329 of file outputlist.h.

References BaseOutputDocInterface::endDescTableTitle().

Referenced by MemberDef::writeDocumentation().

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

Implements BaseOutputDocInterface.

Definition at line 331 of file outputlist.h.

References BaseOutputDocInterface::startDescTableData().

Referenced by MemberDef::writeDocumentation().

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

Implements BaseOutputDocInterface.

Definition at line 333 of file outputlist.h.

References BaseOutputDocInterface::endDescTableData().

Referenced by MemberDef::writeDocumentation().

void OutputList::startDotGraph (  )  [inline]

Definition at line 335 of file outputlist.h.

References OutputGenerator::startDotGraph().

Referenced by ClassDef::writeClassDiagrams().

void OutputList::endDotGraph ( const DotClassGraph g  )  [inline]

Definition at line 337 of file outputlist.h.

References OutputGenerator::endDotGraph().

Referenced by ClassDef::writeClassDiagrams().

void OutputList::startInclDepGraph (  )  [inline]

Definition at line 339 of file outputlist.h.

References OutputGenerator::startInclDepGraph().

Referenced by FileDef::writeDocumentation().

void OutputList::endInclDepGraph ( const DotInclDepGraph g  )  [inline]

Definition at line 341 of file outputlist.h.

References OutputGenerator::endInclDepGraph().

Referenced by FileDef::writeDocumentation().

void OutputList::startCallGraph (  )  [inline]

Definition at line 343 of file outputlist.h.

References OutputGenerator::startCallGraph().

Referenced by MemberDef::writeDocumentation().

void OutputList::endCallGraph ( const DotCallGraph g  )  [inline]

Definition at line 345 of file outputlist.h.

References OutputGenerator::endCallGraph().

Referenced by MemberDef::writeDocumentation().

void OutputList::startDirDepGraph (  )  [inline]

Definition at line 347 of file outputlist.h.

References OutputGenerator::startDirDepGraph().

Referenced by DirDef::writeDocumentation().

void OutputList::endDirDepGraph ( const DotDirDeps g  )  [inline]

Definition at line 349 of file outputlist.h.

References OutputGenerator::endDirDepGraph().

Referenced by DirDef::writeDocumentation().

void OutputList::startGroupCollaboration (  )  [inline]

Definition at line 351 of file outputlist.h.

References OutputGenerator::startGroupCollaboration().

Referenced by GroupDef::writeDocumentation().

void OutputList::endGroupCollaboration ( const DotGroupCollaboration g  )  [inline]

Definition at line 353 of file outputlist.h.

References OutputGenerator::endGroupCollaboration().

Referenced by GroupDef::writeDocumentation().

void OutputList::writeGraphicalHierarchy ( const DotGfxHierarchyTable g  )  [inline]

Definition at line 355 of file outputlist.h.

References OutputGenerator::writeGraphicalHierarchy().

Referenced by writeGraphicalClassHierarchy().

void OutputList::startTextBlock ( bool  dense = FALSE  )  [inline]

Definition at line 357 of file outputlist.h.

References OutputGenerator::startTextBlock().

Referenced by writeAnnotatedIndex(), ClassDef::writeDetailedDescription(), NamespaceDef::writeDetailedDocumentation(), FileDef::writeDetailedDocumentation(), writeDirIndex(), PageDef::writeDocumentation(), NamespaceDef::writeDocumentation(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), ClassDef::writeDocumentation(), writeExampleIndex(), writeFileIndex(), writeGraphicalClassHierarchy(), writeGroupIndex(), writeHierarchicalIndex(), writeIndex(), writeNamespaceIndex(), and writePageIndex().

void OutputList::endTextBlock ( bool  paraBreak = FALSE  )  [inline]

Definition at line 359 of file outputlist.h.

References OutputGenerator::endTextBlock().

Referenced by writeAnnotatedIndex(), ClassDef::writeDetailedDescription(), NamespaceDef::writeDetailedDocumentation(), FileDef::writeDetailedDocumentation(), writeDirIndex(), PageDef::writeDocumentation(), NamespaceDef::writeDocumentation(), GroupDef::writeDocumentation(), FileDef::writeDocumentation(), ClassDef::writeDocumentation(), writeExampleIndex(), writeFileIndex(), writeGraphicalClassHierarchy(), writeGroupIndex(), writeHierarchicalIndex(), writeIndex(), writeNamespaceIndex(), and writePageIndex().

void OutputList::lastIndexPage (  )  [inline]

Definition at line 361 of file outputlist.h.

References OutputGenerator::lastIndexPage().

Referenced by writeIndex().

void OutputList::startMemberDocPrefixItem (  )  [inline]

Definition at line 363 of file outputlist.h.

References OutputGenerator::startMemberDocPrefixItem().

Referenced by MemberDef::writeDocumentation().

void OutputList::endMemberDocPrefixItem (  )  [inline]

Definition at line 365 of file outputlist.h.

References OutputGenerator::endMemberDocPrefixItem().

Referenced by MemberDef::writeDocumentation().

void OutputList::startMemberDocName ( bool  align  )  [inline]

Definition at line 367 of file outputlist.h.

References OutputGenerator::startMemberDocName().

Referenced by MemberDef::writeDocumentation().

void OutputList::endMemberDocName (  )  [inline]

Definition at line 369 of file outputlist.h.

References OutputGenerator::endMemberDocName().

Referenced by MemberDef::writeDocumentation().

void OutputList::startParameterType ( bool  first,
const char *  key 
) [inline]

Definition at line 371 of file outputlist.h.

References OutputGenerator::startParameterType().

Referenced by VhdlDocGen::writeFuncProcDocu().

void OutputList::endParameterType (  )  [inline]

Definition at line 373 of file outputlist.h.

References OutputGenerator::endParameterType().

void OutputList::startParameterName ( bool  one  )  [inline]

Definition at line 375 of file outputlist.h.

References OutputGenerator::startParameterName().

void OutputList::endParameterName ( bool  last,
bool  one,
bool  bracket 
) [inline]

Definition at line 377 of file outputlist.h.

References OutputGenerator::endParameterName().

Referenced by VhdlDocGen::writeFuncProcDocu().

void OutputList::startParameterList ( bool  openBracket  )  [inline]

Definition at line 379 of file outputlist.h.

References OutputGenerator::startParameterList().

Referenced by VhdlDocGen::writeFuncProcDocu().

void OutputList::endParameterList (  )  [inline]

Definition at line 381 of file outputlist.h.

References OutputGenerator::endParameterList().

Referenced by MemberDef::writeDocumentation().

void OutputList::startConstraintList ( const char *  header  )  [inline]

Definition at line 384 of file outputlist.h.

References OutputGenerator::startConstraintList().

Referenced by writeTypeConstraints().

void OutputList::startConstraintParam (  )  [inline]

Definition at line 386 of file outputlist.h.

References OutputGenerator::startConstraintParam().

Referenced by writeTypeConstraints().

void OutputList::endConstraintParam (  )  [inline]

Definition at line 388 of file outputlist.h.

References OutputGenerator::endConstraintParam().

Referenced by writeTypeConstraints().

void OutputList::startConstraintType (  )  [inline]

Definition at line 390 of file outputlist.h.

References OutputGenerator::startConstraintType().

Referenced by writeTypeConstraints().

void OutputList::endConstraintType (  )  [inline]

Definition at line 392 of file outputlist.h.

References OutputGenerator::endConstraintType().

Referenced by writeTypeConstraints().

void OutputList::startConstraintDocs (  )  [inline]

Definition at line 394 of file outputlist.h.

References OutputGenerator::startConstraintDocs().

Referenced by writeTypeConstraints().

void OutputList::endConstraintDocs (  )  [inline]

Definition at line 396 of file outputlist.h.

References OutputGenerator::endConstraintDocs().

Referenced by writeTypeConstraints().

void OutputList::endConstraintList (  )  [inline]

Definition at line 398 of file outputlist.h.

References OutputGenerator::endConstraintList().

Referenced by writeTypeConstraints().

void OutputList::startFontClass ( const char *  c  )  [inline, virtual]

Implements CodeOutputInterface.

Definition at line 400 of file outputlist.h.

References CodeOutputInterface::startFontClass().

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

Implements CodeOutputInterface.

Definition at line 402 of file outputlist.h.

References CodeOutputInterface::endFontClass().

void OutputList::writeCodeAnchor ( const char *  name  )  [inline, virtual]

Implements CodeOutputInterface.

Definition at line 404 of file outputlist.h.

References CodeOutputInterface::writeCodeAnchor().

void OutputList::startPlainFile ( const char *  name  )  [inline]

Definition at line 406 of file outputlist.h.

References OutputGenerator::isEnabled(), and OutputGenerator::startPlainFile().

void OutputList::endPlainFile (  )  [inline]

Definition at line 415 of file outputlist.h.

References OutputGenerator::endPlainFile(), and OutputGenerator::isEnabled().

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

Implements CodeOutputInterface.

Definition at line 424 of file outputlist.h.


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



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