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

OutputList Class Reference

Class representing a list of output generators that are written to in parallel. More...

#include <outputlist.h>

+ Inheritance diagram for OutputList:
+ Collaboration diagram for OutputList:

Public Member Functions

 OutputList (bool)
 
virtual ~OutputList ()
 
void add (OutputGenerator *)
 
uint count () const
 
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 generateDoc (const char *fileName, int startLine, const Definition *ctx, const MemberDef *md, const QCString &docStr, bool indexWords, bool isExample, const char *exampleName=0, bool singleLine=FALSE, bool linkFromIndex=FALSE)
 
void writeDoc (DocRoot *root, const Definition *ctx, const MemberDef *md)
 
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 writeSearchInfo ()
 
void writeFooter (const char *navPath)
 
void endFile ()
 
void startTitleHead (const char *fileName)
 
void endTitleHead (const char *fileName, const char *name)
 
void startTitle ()
 
void endTitle ()
 
void startParagraph (const char *classDef=0)
 
void endParagraph ()
 
void writeString (const char *text)
 
void startIndexListItem ()
 
void endIndexListItem ()
 
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 writeTooltip (const char *id, const DocLinkInfo &docInfo, const char *decl, const char *desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo)
 
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 (int extraLevels=0)
 
void endGroupHeader (int extraLevels=0)
 
void startItemListItem ()
 
void endItemListItem ()
 
void startMemberSections ()
 
void endMemberSections ()
 
void startHeaderSection ()
 
void endHeaderSection ()
 
void startMemberHeader (const char *anchor, int typ=2)
 
void endMemberHeader ()
 
void startMemberSubtitle ()
 
void endMemberSubtitle ()
 
void startMemberDocList ()
 
void endMemberDocList ()
 
void startMemberList ()
 
void endMemberList ()
 
void startInlineHeader ()
 
void endInlineHeader ()
 
void startAnonTypeScope (int i1)
 
void endAnonTypeScope (int i1)
 
void startMemberItem (const char *anchor, int i1, const char *id=0)
 
void endMemberItem ()
 
void startMemberTemplateParams ()
 
void endMemberTemplateParams (const char *anchor, const char *inheritId)
 
void startMemberGroupHeader (bool b)
 
void endMemberGroupHeader ()
 
void startMemberGroupDocs ()
 
void endMemberGroupDocs ()
 
void startMemberGroup ()
 
void endMemberGroup (bool last)
 
void insertMemberAlign (bool templ=FALSE)
 
void insertMemberAlignLeft (int typ=0, bool templ=FALSE)
 
void writeRuler ()
 
void writeAnchor (const char *fileName, const char *name)
 
void startCodeFragment ()
 
void endCodeFragment ()
 
void startCodeLine (bool hasLineNumbers)
 
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, int memCount, int memTotal, bool showInline)
 
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 writeLatexSpacing ()
 
void startDescription ()
 
void endDescription ()
 
void startDescItem ()
 
void endDescItem ()
 
void startDescForItem ()
 
void endDescForItem ()
 
void startSubsection ()
 
void endSubsection ()
 
void startSubsubsection ()
 
void endSubsubsection ()
 
void startCenter ()
 
void endCenter ()
 
void startSmall ()
 
void endSmall ()
 
void lineBreak (const char *style=0)
 
void startBold ()
 
void endBold ()
 
void startMemberDescription (const char *anchor, const char *inheritId=0, bool typ=false)
 
void endMemberDescription ()
 
void startMemberDeclaration ()
 
void endMemberDeclaration (const char *anchor, const char *inheritId)
 
void writeInheritedSectionTitle (const char *id, const char *ref, const char *file, const char *anchor, const char *title, const char *name)
 
void startExamples ()
 
void endExamples ()
 
void startParamList (ParamListTypes t, const char *title)
 
void endParamList ()
 
void startIndent ()
 
void endIndent ()
 
void startSection (const char *lab, const char *title, SectionType t)
 
void endSection (const char *lab, 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 writeSplitBar (const char *name)
 
void writeNavigationPath (const char *s)
 
void writeLogo ()
 
void writeQuickLinks (bool compact, HighlightedItem hli, const char *file)
 
void writeSummaryLink (const char *file, const char *anchor, const char *title, bool first)
 
void startContents ()
 
void endContents ()
 
void startPageDoc (const char *pageTitle)
 
void endPageDoc ()
 
void writeNonBreakableSpace (int num)
 
void startDescTable (const char *title)
 
void endDescTable ()
 
void startDescTableRow ()
 
void endDescTableRow ()
 
void startDescTableTitle ()
 
void endDescTableTitle ()
 
void startDescTableData ()
 
void endDescTableData ()
 
void startDotGraph ()
 
void endDotGraph (DotClassGraph &g)
 
void startInclDepGraph ()
 
void endInclDepGraph (DotInclDepGraph &g)
 
void startCallGraph ()
 
void endCallGraph (DotCallGraph &g)
 
void startDirDepGraph ()
 
void endDirDepGraph (DotDirDeps &g)
 
void startGroupCollaboration ()
 
void endGroupCollaboration (DotGroupCollaboration &g)
 
void writeGraphicalHierarchy (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 exceptionEntry (const char *prefix, bool closeBracket)
 
void startConstraintList (const char *header)
 
void startConstraintParam ()
 
void endConstraintParam ()
 
void startConstraintType ()
 
void endConstraintType ()
 
void startConstraintDocs ()
 
void endConstraintDocs ()
 
void endConstraintList ()
 
void startMemberDocSimple (bool b)
 
void endMemberDocSimple (bool b)
 
void startInlineMemberType ()
 
void endInlineMemberType ()
 
void startInlineMemberName ()
 
void endInlineMemberName ()
 
void startInlineMemberDoc ()
 
void endInlineMemberDoc ()
 
void startLabels ()
 
void writeLabel (const char *l, bool isLast)
 
void endLabels ()
 
void startFontClass (const char *c)
 
void endFontClass ()
 
void writeCodeAnchor (const char *name)
 
void setCurrentDoc (const Definition *context, const char *anchor, bool isSourceFile)
 
void addWord (const char *word, bool hiPriority)
 
void startPlainFile (const char *name)
 
void endPlainFile ()
 
- Public Member Functions inherited from OutputDocInterface
virtual ~OutputDocInterface ()
 
- Public Member Functions inherited from BaseOutputDocInterface
virtual ~BaseOutputDocInterface ()
 
- Public Member Functions inherited from CodeOutputInterface
virtual ~CodeOutputInterface ()
 

Private Member Functions

void debug ()
 
void clear ()
 
template<typename T , class... Ts, class... As>
void forall (void(T::*methodPtr)(Ts...), As &&... args)
 
 OutputList (const OutputList &ol)
 

Private Attributes

std::vector< std::unique_ptr< OutputGenerator > > m_outputs
 

Additional Inherited Members

- Public Types inherited from BaseOutputDocInterface
enum  ParamListTypes { Param, RetVal, Exception }
 
enum  SectionTypes { EnumValues, Examples }
 

Detailed Description

Class representing a list of output generators that are written to in parallel.

Definition at line 37 of file outputlist.h.

Constructor & Destructor Documentation

◆ OutputList() [1/2]

OutputList::OutputList ( bool  )

Definition at line 33 of file outputlist.cpp.

◆ ~OutputList()

OutputList::~OutputList ( )
virtual

Definition at line 38 of file outputlist.cpp.

◆ OutputList() [2/2]

OutputList::OutputList ( const OutputList ol)
private

Member Function Documentation

◆ add()

void OutputList::add ( OutputGenerator og)

Definition at line 43 of file outputlist.cpp.

References m_outputs.

Referenced by generateOutput().

◆ addIndexItem()

void OutputList::addIndexItem ( const char *  s1,
const char *  s2 
)
inlinevirtual

◆ addWord()

void OutputList::addWord ( const char *  word,
bool  hiPriority 
)
inlinevirtual

Implements CodeOutputInterface.

Definition at line 470 of file outputlist.h.

References CodeOutputInterface::addWord(), and forall().

◆ clear()

void OutputList::clear ( )
private

◆ codify()

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

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

Implements CodeOutputInterface.

Definition at line 127 of file outputlist.h.

References CodeOutputInterface::codify(), and forall().

◆ count()

uint OutputList::count ( ) const
inline

Definition at line 44 of file outputlist.h.

References m_outputs.

Referenced by generateDoc(), generateOutput(), and parseText().

◆ debug()

void OutputList::debug ( )
private

◆ disable()

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

Disables a specific output format (useful for OutputList only)

Implements OutputDocInterface.

Definition at line 72 of file outputlist.cpp.

References m_outputs.

Referenced by MemberDefImpl::_writeCallerGraph(), MemberDefImpl::_writeCallGraph(), DefinitionImpl::_writeSourceRefList(), endIndexHierarchy(), generateExampleDocs(), ClassDefImpl::showUsedFiles(), startIndexHierarchy(), NamespaceDefImpl::startMemberDocumentation(), GroupDefImpl::startMemberDocumentation(), FileDefImpl::startMemberDocumentation(), ClassDefImpl::startMemberDocumentation(), startTitle(), writeAnnotatedClassList(), writeAnnotatedExceptionIndex(), writeAnnotatedIndex(), writeAnnotatedInterfaceIndex(), writeAnnotatedStructIndex(), DirDefImpl::writeBriefDescription(), NamespaceDefImpl::writeBriefDescription(), GroupDefImpl::writeBriefDescription(), FileDefImpl::writeBriefDescription(), ClassDefImpl::writeBriefDescription(), writeClassHierarchy(), ClassDefImpl::writeCollaborationGraph(), MemberDefImpl::writeDeclaration(), writeDefArgumentList(), DirDefImpl::writeDetailedDescription(), NamespaceDefImpl::writeDetailedDescription(), GroupDefImpl::writeDetailedDescription(), FileDefImpl::writeDetailedDescription(), ClassDefImpl::writeDetailedDescription(), ClassDefImpl::writeDetailedDocumentationBody(), DirDefImpl::writeDirectoryGraph(), writeDirHierarchy(), DirDefImpl::writeDocumentation(), PageDefImpl::writeDocumentation(), GroupDefImpl::writeDocumentation(), MemberList::writeDocumentation(), FileDefImpl::writeDocumentation(), MemberDefImpl::writeDocumentation(), MemberDefImpl::writeEnumDeclaration(), writeExample(), writeExampleIndex(), writeFileIndex(), VhdlDocGen::writeFuncProcDocu(), GroupDefImpl::writeGroupGraph(), writeGroupHierarchy(), writeGroupIndex(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), FileDefImpl::writeIncludedByGraph(), FileDefImpl::writeIncludeFiles(), ClassDefImpl::writeIncludeFiles(), FileDefImpl::writeIncludeGraph(), writeIndex(), ClassDefImpl::writeInheritanceGraph(), FileDefImpl::writeInlineClasses(), VhdlDocGen::writeInlineClassLink(), ClassDefImpl::writeInlineDocumentation(), ClassDefImpl::writeMoreLink(), writeNamespaceIndex(), FileDefImpl::writeSource(), DefinitionImpl::writeSourceDef(), and VhdlDocGen::writeVHDLDeclaration().

◆ disableAll()

void OutputList::disableAll ( )
virtual

Disables all output formats (useful for OutputList only)

Implements OutputDocInterface.

Definition at line 64 of file outputlist.cpp.

References m_outputs.

Referenced by PageDefImpl::writeDocumentation(), MemberDefImpl::writeDocumentation(), and PageDefImpl::writePageDocumentation().

◆ disableAllBut()

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

Create a new output generator. This can later by appended to the current one using append().

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

Implements OutputDocInterface.

Definition at line 48 of file outputlist.cpp.

References m_outputs.

Referenced by MemberDefImpl::_writeEnumValues(), ClassDefImpl::addClassAttributes(), NamespaceDefImpl::addNamespaceAttributes(), endFile(), endFileWithNavPath(), generateDirDocs(), recursivelyAddGroupListToTitle(), ClassDefImpl::showUsedFiles(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedExceptionIndex(), writeAnnotatedIndex(), writeAnnotatedInterfaceIndex(), writeAnnotatedStructIndex(), NamespaceDefImpl::writeAuthorSection(), GroupDefImpl::writeAuthorSection(), FileDefImpl::writeAuthorSection(), ClassDefImpl::writeAuthorSection(), DirDefImpl::writeBriefDescription(), NamespaceDefImpl::writeBriefDescription(), GroupDefImpl::writeBriefDescription(), FileDefImpl::writeBriefDescription(), ClassDefImpl::writeBriefDescription(), writeClassMemberIndexFiltered(), MemberDefImpl::writeDeclaration(), MemberList::writeDeclarations(), DirDefImpl::writeDetailedDescription(), NamespaceDefImpl::writeDetailedDescription(), GroupDefImpl::writeDetailedDescription(), FileDefImpl::writeDetailedDescription(), ClassDefImpl::writeDetailedDescription(), DirDefImpl::writeDocumentation(), PageDefImpl::writeDocumentation(), GroupDefImpl::writeDocumentation(), FileDefImpl::writeDocumentation(), DirRelation::writeDocumentation(), MemberDefImpl::writeDocumentation(), MemberDefImpl::writeEnumDeclaration(), writeFileIndex(), DirDefImpl::writeFileList(), writeFileMemberIndexFiltered(), writeGraphicalClassHierarchy(), writeGraphicalExceptionHierarchy(), writeGraphicalInterfaceHierarchy(), writeGraphInfo(), writeGroupIndex(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), FileDefImpl::writeIncludeFiles(), ClassDefImpl::writeIncludeFiles(), writeIndex(), ClassDefImpl::writeInheritanceGraph(), ClassDefImpl::writeInheritedMemberDeclarations(), ClassDefImpl::writeInlineDocumentation(), ClassDefImpl::writeMemberList(), NamespaceDefImpl::writeMemberPages(), GroupDefImpl::writeMemberPages(), FileDefImpl::writeMemberPages(), ClassDefImpl::writeMemberPages(), ClassDefImpl::writeMoreLink(), writeNamespaceIndex(), writeNamespaceMemberIndexFiltered(), DefinitionImpl::writeNavigationPath(), PageDefImpl::writePageDocumentation(), writePageIndex(), MemberList::writePlainDeclarations(), writeSingleFileIndex(), DefinitionImpl::writeSourceDef(), FileDefImpl::writeSourceLink(), FileDefImpl::writeSummaryLinks(), NamespaceDefImpl::writeSummaryLinks(), GroupDefImpl::writeSummaryLinks(), ClassDefImpl::writeSummaryLinks(), DefinitionImpl::writeToc(), writeUserGroupStubPage(), and VhdlDocGen::writeVHDLDeclaration().

◆ docify()

void OutputList::docify ( const char *  s)
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 125 of file outputlist.h.

References BaseOutputDocInterface::docify(), and forall().

Referenced by MemberDefImpl::_writeEnumValues(), MemberDefImpl::_writeGroupInclude(), DefinitionImpl::_writeSourceRefList(), generateExampleDocs(), ClassDefImpl::showUsedFiles(), startFonts(), writeAlphabeticalClassList(), writeAnnotatedClassList(), NamespaceDefImpl::writeBriefDescription(), writeClassLinkForMember(), writeClassTree(), writeClassTreeForList(), NamespaceSDict::writeDeclaration(), ClassDefImpl::writeDeclaration(), MemberDefImpl::writeDeclaration(), ClassDefImpl::writeDeclarationLink(), writeDefArgumentList(), writeDirTreeNode(), FileDefImpl::writeDocumentation(), MemberDefImpl::writeDocumentation(), MemberDefImpl::writeEnumDeclaration(), writeExceptionListImpl(), writeFileLinkForMember(), DirDefImpl::writeFileList(), GroupDefImpl::writeFiles(), VhdlDocGen::writeFormatString(), VhdlDocGen::writeFuncProcDocu(), VhdlDocGen::writeFunctionProto(), writeGroupTreeNode(), FileDefImpl::writeIncludeFiles(), ClassDefImpl::writeIncludeFiles(), ClassDefImpl::writeIncludeFilesForSlice(), ClassDefImpl::writeInheritanceGraph(), writeInheritanceSpecifier(), MemberDefImpl::writeLink(), MemberDefImpl::writeMemberDocSimple(), ClassDefImpl::writeMemberList(), ClassDefImpl::writeMoreLink(), writeNamespaceLinkForMember(), GroupDefImpl::writePageDocumentation(), writePartialFilePath(), MemberList::writePlainDeclarations(), VhdlDocGen::writeProcedureProto(), VhdlDocGen::writeProcessProto(), writeSingleFileIndex(), DefinitionImpl::writeSourceDef(), VhdlDocGen::writeStringLink(), writeTemplatePrefix(), writeTemplateSpec(), writeUCFLink(), VhdlDocGen::writeVHDLDeclaration(), VhdlDocGen::writeVHDLDeclarations(), VhdlDocGen::writeVhdlLink(), and VhdlDocGen::writeVHDLTypeDocumentation().

◆ enable()

◆ enableAll()

◆ endAnonTypeScope()

void OutputList::endAnonTypeScope ( int  i1)
inline

Definition at line 194 of file outputlist.h.

References OutputGenerator::endAnonTypeScope(), and forall().

Referenced by MemberDefImpl::writeDeclaration().

◆ endBold()

◆ endCallGraph()

void OutputList::endCallGraph ( DotCallGraph g)
inline

◆ endCenter()

void OutputList::endCenter ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 277 of file outputlist.h.

References BaseOutputDocInterface::endCenter(), and forall().

◆ endClassDiagram()

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

Definition at line 324 of file outputlist.h.

References OutputGenerator::endClassDiagram(), and forall().

Referenced by ClassDefImpl::writeInheritanceGraph().

◆ endCodeFragment()

void OutputList::endCodeFragment ( )
inlinevirtual

◆ endCodeLine()

void OutputList::endCodeLine ( )
inlinevirtual

Ends a line of code started with startCodeLine()

Implements CodeOutputInterface.

Definition at line 230 of file outputlist.h.

References CodeOutputInterface::endCodeLine(), and forall().

◆ endConstraintDocs()

void OutputList::endConstraintDocs ( )
inline

Definition at line 433 of file outputlist.h.

References OutputGenerator::endConstraintDocs(), and forall().

Referenced by writeTypeConstraints().

◆ endConstraintList()

void OutputList::endConstraintList ( )
inline

Definition at line 435 of file outputlist.h.

References OutputGenerator::endConstraintList(), and forall().

Referenced by writeTypeConstraints().

◆ endConstraintParam()

void OutputList::endConstraintParam ( )
inline

Definition at line 425 of file outputlist.h.

References OutputGenerator::endConstraintParam(), and forall().

Referenced by writeTypeConstraints().

◆ endConstraintType()

void OutputList::endConstraintType ( )
inline

Definition at line 429 of file outputlist.h.

References OutputGenerator::endConstraintType(), and forall().

Referenced by writeTypeConstraints().

◆ endContents()

◆ endDescForItem()

void OutputList::endDescForItem ( )
inlinevirtual

◆ endDescItem()

void OutputList::endDescItem ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 261 of file outputlist.h.

References BaseOutputDocInterface::endDescItem(), and forall().

◆ endDescription()

void OutputList::endDescription ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 257 of file outputlist.h.

References BaseOutputDocInterface::endDescription(), and forall().

◆ endDescTable()

void OutputList::endDescTable ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 356 of file outputlist.h.

References BaseOutputDocInterface::endDescTable(), and forall().

Referenced by MemberDefImpl::_writeEnumValues().

◆ endDescTableData()

void OutputList::endDescTableData ( )
inlinevirtual

◆ endDescTableRow()

void OutputList::endDescTableRow ( )
inlinevirtual

◆ endDescTableTitle()

void OutputList::endDescTableTitle ( )
inlinevirtual

◆ endDirDepGraph()

void OutputList::endDirDepGraph ( DotDirDeps g)
inline

Definition at line 384 of file outputlist.h.

References OutputGenerator::endDirDepGraph(), and forall().

Referenced by DirDefImpl::writeDirectoryGraph().

◆ endDotGraph()

void OutputList::endDotGraph ( DotClassGraph g)
inline

◆ endDoxyAnchor()

◆ endEmphasis()

void OutputList::endEmphasis ( )
inlinevirtual

Ends a section of text displayed in italic.

Implements BaseOutputDocInterface.

Definition at line 237 of file outputlist.h.

References BaseOutputDocInterface::endEmphasis(), and forall().

Referenced by writeDefArgumentList(), VhdlDocGen::writeFuncProcDocu(), and VhdlDocGen::writeVHDLDeclaration().

◆ endExamples()

void OutputList::endExamples ( )
inlinevirtual

◆ endFile()

void OutputList::endFile ( )
inline

Definition at line 85 of file outputlist.h.

References OutputGenerator::endFile(), and forall().

Referenced by endFile().

◆ endFontClass()

void OutputList::endFontClass ( )
inlinevirtual

Ends a block started with startFontClass()

Implements CodeOutputInterface.

Definition at line 464 of file outputlist.h.

References CodeOutputInterface::endFontClass(), and forall().

Referenced by startFonts().

◆ endGroupCollaboration()

void OutputList::endGroupCollaboration ( DotGroupCollaboration g)
inline

Definition at line 388 of file outputlist.h.

References OutputGenerator::endGroupCollaboration(), and forall().

Referenced by GroupDefImpl::writeGroupGraph().

◆ endGroupHeader()

◆ endHeaderSection()

void OutputList::endHeaderSection ( )
inline

◆ endHtmlLink()

void OutputList::endHtmlLink ( )
inlinevirtual

Ends a link started by startHtmlLink().

Implements BaseOutputDocInterface.

Definition at line 145 of file outputlist.h.

References BaseOutputDocInterface::endHtmlLink(), and forall().

◆ endInclDepGraph()

void OutputList::endInclDepGraph ( DotInclDepGraph g)
inline

◆ endIndent()

void OutputList::endIndent ( )
inline

◆ endIndexItem()

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

◆ endIndexKey()

void OutputList::endIndexKey ( )
inline

◆ endIndexList()

void OutputList::endIndexList ( )
inline

◆ endIndexListItem()

void OutputList::endIndexListItem ( )
inline

◆ endIndexSection()

void OutputList::endIndexSection ( IndexSections  is)
inline

Definition at line 69 of file outputlist.h.

References OutputGenerator::endIndexSection(), and forall().

Referenced by writeIndex().

◆ endIndexValue()

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

◆ endInlineHeader()

void OutputList::endInlineHeader ( )
inline

Definition at line 190 of file outputlist.h.

References OutputGenerator::endInlineHeader(), and forall().

Referenced by MemberList::writeDeclarations().

◆ endInlineMemberDoc()

void OutputList::endInlineMemberDoc ( )
inline

Definition at line 452 of file outputlist.h.

References OutputGenerator::endInlineMemberDoc(), and forall().

Referenced by MemberDefImpl::writeMemberDocSimple().

◆ endInlineMemberName()

void OutputList::endInlineMemberName ( )
inline

Definition at line 448 of file outputlist.h.

References OutputGenerator::endInlineMemberName(), and forall().

Referenced by MemberDefImpl::writeMemberDocSimple().

◆ endInlineMemberType()

void OutputList::endInlineMemberType ( )
inline

Definition at line 444 of file outputlist.h.

References OutputGenerator::endInlineMemberType(), and forall().

Referenced by MemberDefImpl::writeMemberDocSimple().

◆ endItemList()

void OutputList::endItemList ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 119 of file outputlist.h.

References BaseOutputDocInterface::endItemList(), and forall().

Referenced by endIndexHierarchy(), ClassDefImpl::showUsedFiles(), and writeExampleIndex().

◆ endItemListItem()

void OutputList::endItemListItem ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 162 of file outputlist.h.

References BaseOutputDocInterface::endItemListItem(), and forall().

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

◆ endLabels()

void OutputList::endLabels ( )
inline

◆ endMemberDeclaration()

◆ endMemberDescription()

◆ endMemberDoc()

void OutputList::endMemberDoc ( bool  hasArgs)
inline

◆ endMemberDocList()

void OutputList::endMemberDocList ( )
inline

Definition at line 182 of file outputlist.h.

References OutputGenerator::endMemberDocList(), and forall().

Referenced by MemberList::writeDocumentation().

◆ endMemberDocName()

◆ endMemberDocPrefixItem()

void OutputList::endMemberDocPrefixItem ( )
inline

Definition at line 400 of file outputlist.h.

References OutputGenerator::endMemberDocPrefixItem(), and forall().

Referenced by MemberDefImpl::writeDocumentation().

◆ endMemberDocSimple()

void OutputList::endMemberDocSimple ( bool  b)
inline

Definition at line 440 of file outputlist.h.

References OutputGenerator::endMemberDocSimple(), and forall().

Referenced by MemberList::writeSimpleDocumentation().

◆ endMemberGroup()

void OutputList::endMemberGroup ( bool  last)
inline

◆ endMemberGroupDocs()

void OutputList::endMemberGroupDocs ( )
inline

◆ endMemberGroupHeader()

void OutputList::endMemberGroupHeader ( )
inline

◆ endMemberHeader()

◆ endMemberItem()

◆ endMemberList()

◆ endMemberSections()

◆ endMemberSubtitle()

void OutputList::endMemberSubtitle ( )
inline

◆ endMemberTemplateParams()

void OutputList::endMemberTemplateParams ( const char *  anchor,
const char *  inheritId 
)
inline

Definition at line 202 of file outputlist.h.

References OutputGenerator::endMemberTemplateParams(), and forall().

Referenced by MemberDefImpl::writeDeclaration().

◆ endPageDoc()

void OutputList::endPageDoc ( )
inline

Definition at line 350 of file outputlist.h.

References OutputGenerator::endPageDoc(), and forall().

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

◆ endPageRef()

void OutputList::endPageRef ( const char *  c,
const char *  a 
)
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 328 of file outputlist.h.

References BaseOutputDocInterface::endPageRef(), and forall().

◆ endParagraph()

◆ endParameterList()

void OutputList::endParameterList ( )
inline

Definition at line 416 of file outputlist.h.

References OutputGenerator::endParameterList(), and forall().

Referenced by MemberDefImpl::writeDocumentation().

◆ endParameterName()

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

◆ endParameterType()

void OutputList::endParameterType ( )
inline

◆ endParamList()

void OutputList::endParamList ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 308 of file outputlist.h.

References BaseOutputDocInterface::endParamList(), and forall().

◆ endPlainFile()

void OutputList::endPlainFile ( )
inline

Definition at line 475 of file outputlist.h.

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

◆ endProjectNumber()

void OutputList::endProjectNumber ( )
inline

Definition at line 75 of file outputlist.h.

References OutputGenerator::endProjectNumber(), and forall().

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

◆ endQuickIndices()

◆ endSection()

void OutputList::endSection ( const char *  lab,
SectionType  t 
)
inlinevirtual

◆ endSmall()

void OutputList::endSmall ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 281 of file outputlist.h.

References BaseOutputDocInterface::endSmall(), and forall().

◆ endSubsection()

void OutputList::endSubsection ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 269 of file outputlist.h.

References BaseOutputDocInterface::endSubsection(), and forall().

◆ endSubsubsection()

void OutputList::endSubsubsection ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 273 of file outputlist.h.

References BaseOutputDocInterface::endSubsubsection(), and forall().

Referenced by writeTemplateSpec().

◆ endTextBlock()

◆ endTextLink()

◆ endTitle()

void OutputList::endTitle ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 93 of file outputlist.h.

References BaseOutputDocInterface::endTitle(), and forall().

◆ endTitleHead()

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

◆ endTypewriter()

◆ exceptionEntry()

void OutputList::exceptionEntry ( const char *  prefix,
bool  closeBracket 
)
inline

Definition at line 418 of file outputlist.h.

References OutputGenerator::exceptionEntry(), and forall().

Referenced by writeExceptionListImpl().

◆ forall()

template<typename T , class... Ts, class... As>
void OutputList::forall ( void(T::*)(Ts...)  methodPtr,
As &&...  args 
)
inlineprivate

Definition at line 487 of file outputlist.h.

References m_outputs.

Referenced by addIndexItem(), addWord(), codify(), docify(), endAnonTypeScope(), endBold(), endCallGraph(), endCenter(), endClassDiagram(), endCodeFragment(), endCodeLine(), endConstraintDocs(), endConstraintList(), endConstraintParam(), endConstraintType(), endContents(), endDescForItem(), endDescItem(), endDescription(), endDescTable(), endDescTableData(), endDescTableRow(), endDescTableTitle(), endDirDepGraph(), endDotGraph(), endDoxyAnchor(), endEmphasis(), endExamples(), endFile(), endFontClass(), endGroupCollaboration(), endGroupHeader(), endHeaderSection(), endHtmlLink(), endInclDepGraph(), endIndent(), endIndexItem(), endIndexKey(), endIndexList(), endIndexListItem(), endIndexSection(), endIndexValue(), endInlineHeader(), endInlineMemberDoc(), endInlineMemberName(), endInlineMemberType(), endItemList(), endItemListItem(), endLabels(), endMemberDeclaration(), endMemberDescription(), endMemberDoc(), endMemberDocList(), endMemberDocName(), endMemberDocPrefixItem(), endMemberDocSimple(), endMemberGroup(), endMemberGroupDocs(), endMemberGroupHeader(), endMemberHeader(), endMemberItem(), endMemberList(), endMemberSections(), endMemberSubtitle(), endMemberTemplateParams(), endPageDoc(), endPageRef(), endParagraph(), endParameterList(), endParameterName(), endParameterType(), endParamList(), endPlainFile(), endProjectNumber(), endQuickIndices(), endSection(), endSmall(), endSubsection(), endSubsubsection(), endTextBlock(), endTextLink(), endTitle(), endTitleHead(), endTypewriter(), exceptionEntry(), insertMemberAlign(), insertMemberAlignLeft(), lastIndexPage(), lineBreak(), setCurrentDoc(), startAnonTypeScope(), startBold(), startCallGraph(), startCenter(), startClassDiagram(), startCodeFragment(), startCodeLine(), startConstraintDocs(), startConstraintList(), startConstraintParam(), startConstraintType(), startContents(), startDescForItem(), startDescItem(), startDescription(), startDescTable(), startDescTableData(), startDescTableRow(), startDescTableTitle(), startDirDepGraph(), startDotGraph(), startDoxyAnchor(), startEmphasis(), startExamples(), startFile(), startFontClass(), startGroupCollaboration(), startGroupHeader(), startHeaderSection(), startHtmlLink(), startInclDepGraph(), startIndent(), startIndexItem(), startIndexKey(), startIndexList(), startIndexListItem(), startIndexSection(), startIndexValue(), startInlineHeader(), startInlineMemberDoc(), startInlineMemberName(), startInlineMemberType(), startItemList(), startItemListItem(), startLabels(), startMemberDeclaration(), startMemberDescription(), startMemberDoc(), startMemberDocList(), startMemberDocName(), startMemberDocPrefixItem(), startMemberDocSimple(), startMemberGroup(), startMemberGroupDocs(), startMemberGroupHeader(), startMemberHeader(), startMemberItem(), startMemberList(), startMemberSections(), startMemberSubtitle(), startMemberTemplateParams(), startPageDoc(), startPageRef(), startParagraph(), startParameterList(), startParameterName(), startParameterType(), startParamList(), startPlainFile(), startProjectNumber(), startQuickIndices(), startSection(), startSmall(), startSubsection(), startSubsubsection(), startTextBlock(), startTextLink(), startTitle(), startTitleHead(), startTypewriter(), writeAnchor(), writeChar(), writeCodeAnchor(), writeCodeLink(), writeEndAnnoItem(), writeFooter(), writeGraphicalHierarchy(), writeInheritedSectionTitle(), writeLabel(), writeLatexSpacing(), writeLineNumber(), writeLogo(), writeNavigationPath(), writeNonBreakableSpace(), writeObjectLink(), writePageLink(), writeQuickLinks(), writeRuler(), writeSearchInfo(), writeSplitBar(), writeStartAnnoItem(), writeString(), writeStyleInfo(), writeSummaryLink(), writeSynopsis(), and writeTooltip().

◆ generateDoc()

◆ insertMemberAlign()

◆ insertMemberAlignLeft()

void OutputList::insertMemberAlignLeft ( int  typ = 0,
bool  templ = FALSE 
)
inline

Definition at line 218 of file outputlist.h.

References forall(), and OutputGenerator::insertMemberAlignLeft().

Referenced by VhdlDocGen::writeVHDLDeclaration().

◆ isEnabled()

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

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

Implements OutputDocInterface.

Definition at line 88 of file outputlist.cpp.

References FALSE, and m_outputs.

Referenced by MemberDefImpl::writeDeclaration(), writeDefArgumentList(), FileDefImpl::writeDetailedDescription(), FileDefImpl::writeInlineClasses(), and VhdlDocGen::writeVHDLDeclaration().

◆ lastIndexPage()

void OutputList::lastIndexPage ( )
inline

Definition at line 396 of file outputlist.h.

References forall(), and OutputGenerator::lastIndexPage().

Referenced by writeIndex().

◆ lineBreak()

◆ parseText()

void OutputList::parseText ( const QCString textStr)
virtual

Reimplemented from BaseOutputDocInterface.

Definition at line 151 of file outputlist.cpp.

References count(), m_outputs, and validatingParseText().

Referenced by MemberDefImpl::_writeCallerGraph(), MemberDefImpl::_writeCallGraph(), MemberDefImpl::_writeCategoryRelation(), MemberDefImpl::_writeReimplementedBy(), MemberDefImpl::_writeReimplements(), DefinitionImpl::_writeSourceRefList(), ClassDefImpl::endMemberDeclarations(), ClassDefImpl::showUsedFiles(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedExceptionIndex(), writeAnnotatedIndex(), writeAnnotatedInterfaceIndex(), writeAnnotatedStructIndex(), NamespaceDefImpl::writeAuthorSection(), GroupDefImpl::writeAuthorSection(), FileDefImpl::writeAuthorSection(), ClassDefImpl::writeAuthorSection(), DirDefImpl::writeBriefDescription(), NamespaceDefImpl::writeBriefDescription(), GroupDefImpl::writeBriefDescription(), FileDefImpl::writeBriefDescription(), writeClassMemberIndexFiltered(), writeClassTree(), writeClassTreeForList(), ClassDefImpl::writeCollaborationGraph(), NamespaceSDict::writeDeclaration(), MemberDefImpl::writeDeclaration(), ClassDefImpl::writeDeclarationLink(), MemberList::writeDeclarations(), DirDefImpl::writeDetailedDescription(), NamespaceDefImpl::writeDetailedDescription(), GroupDefImpl::writeDetailedDescription(), FileDefImpl::writeDetailedDescription(), ClassDefImpl::writeDetailedDescription(), DirDefImpl::writeDirectoryGraph(), GroupDefImpl::writeDirs(), writeDirTreeNode(), DirDefImpl::writeDocumentation(), NamespaceDefImpl::writeDocumentation(), ClassSDict::writeDocumentation(), GroupDefImpl::writeDocumentation(), MemberList::writeDocumentation(), FileDefImpl::writeDocumentation(), DirRelation::writeDocumentation(), ClassDefImpl::writeDocumentation(), MemberDefImpl::writeDocumentation(), MemberDefImpl::writeEnumDeclaration(), writeExample(), writeExampleIndex(), writeFileIndex(), DirDefImpl::writeFileList(), writeFileMemberIndexFiltered(), GroupDefImpl::writeFiles(), writeGraphicalClassHierarchy(), writeGraphicalExceptionHierarchy(), writeGraphicalInterfaceHierarchy(), writeGraphInfo(), GroupDefImpl::writeGroupGraph(), writeGroupIndex(), writeGroupTreeNode(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), FileDefImpl::writeIncludedByGraph(), FileDefImpl::writeIncludeGraph(), writeIndex(), ClassDefImpl::writeInheritanceGraph(), ClassDefImpl::writeInlineDocumentation(), ClassDefImpl::writeMemberList(), ClassDefImpl::writeMoreLink(), writeNamespaceIndex(), writeNamespaceMemberIndexFiltered(), GroupDefImpl::writeNestedGroups(), PageDefImpl::writePageDocumentation(), writePageIndex(), MemberList::writePlainDeclarations(), writeSingleFileIndex(), FileDefImpl::writeSource(), DefinitionImpl::writeSourceDef(), FileDefImpl::writeSourceLink(), DirDefImpl::writeSubDirList(), writeTypeConstraints(), writeUserGroupStubPage(), and VhdlDocGen::writeVHDLDeclarations().

◆ popGeneratorState()

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 106 of file outputlist.cpp.

References m_outputs.

Referenced by DefinitionImpl::_writeSourceRefList(), ClassDefImpl::addClassAttributes(), NamespaceDefImpl::addNamespaceAttributes(), endFile(), endFileWithNavPath(), endIndexHierarchy(), GroupDefImpl::endMemberDocumentation(), endTitle(), generateDirDocs(), recursivelyAddGroupListToTitle(), ClassDefImpl::showUsedFiles(), startIndexHierarchy(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedClassList(), writeAnnotatedExceptionIndex(), writeAnnotatedIndex(), writeAnnotatedInterfaceIndex(), writeAnnotatedStructIndex(), NamespaceDefImpl::writeAuthorSection(), GroupDefImpl::writeAuthorSection(), FileDefImpl::writeAuthorSection(), ClassDefImpl::writeAuthorSection(), DirDefImpl::writeBriefDescription(), NamespaceDefImpl::writeBriefDescription(), GroupDefImpl::writeBriefDescription(), FileDefImpl::writeBriefDescription(), ClassDefImpl::writeBriefDescription(), writeClassHierarchy(), writeClassMemberIndexFiltered(), ClassDefImpl::writeCollaborationGraph(), MemberDefImpl::writeDeclaration(), MemberList::writeDeclarations(), writeDefArgumentList(), DirDefImpl::writeDetailedDescription(), NamespaceDefImpl::writeDetailedDescription(), GroupDefImpl::writeDetailedDescription(), FileDefImpl::writeDetailedDescription(), ClassDefImpl::writeDetailedDescription(), ClassDefImpl::writeDetailedDocumentationBody(), writeDirHierarchy(), DirDefImpl::writeDocumentation(), PageDefImpl::writeDocumentation(), GroupDefImpl::writeDocumentation(), MemberList::writeDocumentation(), FileDefImpl::writeDocumentation(), DirRelation::writeDocumentation(), MemberDefImpl::writeDocumentation(), MemberDefImpl::writeEnumDeclaration(), writeExample(), writeExampleIndex(), writeFileIndex(), DirDefImpl::writeFileList(), writeFileMemberIndexFiltered(), writeGraphInfo(), GroupDefImpl::writeGroupGraph(), writeGroupHierarchy(), writeGroupIndex(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), ClassDefImpl::writeIncludeFiles(), writeIndex(), ClassDefImpl::writeInheritanceGraph(), ClassDefImpl::writeInheritedMemberDeclarations(), DefinitionImpl::writeInlineCode(), ClassDefImpl::writeInlineDocumentation(), ClassDefImpl::writeMemberList(), NamespaceDefImpl::writeMemberPages(), GroupDefImpl::writeMemberPages(), FileDefImpl::writeMemberPages(), ClassDefImpl::writeMemberPages(), ClassDefImpl::writeMoreLink(), writeNamespaceIndex(), writeNamespaceMemberIndexFiltered(), DefinitionImpl::writeNavigationPath(), PageDefImpl::writePageDocumentation(), writePageIndex(), MemberList::writePlainDeclarations(), writeSingleFileIndex(), FileDefImpl::writeSource(), VhdlDocGen::writeSource(), DefinitionImpl::writeSourceDef(), FileDefImpl::writeSummaryLinks(), NamespaceDefImpl::writeSummaryLinks(), GroupDefImpl::writeSummaryLinks(), ClassDefImpl::writeSummaryLinks(), DefinitionImpl::writeToc(), writeUserGroupStubPage(), and VhdlDocGen::writeVHDLDeclaration().

◆ pushGeneratorState()

void OutputList::pushGeneratorState ( )
virtual

Appends the output generated by generator g to this generator.

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

Implements OutputDocInterface.

Definition at line 98 of file outputlist.cpp.

References m_outputs.

Referenced by DefinitionImpl::_writeSourceRefList(), ClassDefImpl::addClassAttributes(), NamespaceDefImpl::addNamespaceAttributes(), endFile(), endFileWithNavPath(), endIndexHierarchy(), generateDirDocs(), recursivelyAddGroupListToTitle(), ClassDefImpl::showUsedFiles(), startIndexHierarchy(), GroupDefImpl::startMemberDocumentation(), startTitle(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedClassList(), writeAnnotatedExceptionIndex(), writeAnnotatedIndex(), writeAnnotatedInterfaceIndex(), writeAnnotatedStructIndex(), NamespaceDefImpl::writeAuthorSection(), GroupDefImpl::writeAuthorSection(), FileDefImpl::writeAuthorSection(), ClassDefImpl::writeAuthorSection(), DirDefImpl::writeBriefDescription(), NamespaceDefImpl::writeBriefDescription(), GroupDefImpl::writeBriefDescription(), FileDefImpl::writeBriefDescription(), ClassDefImpl::writeBriefDescription(), writeClassHierarchy(), writeClassMemberIndexFiltered(), ClassDefImpl::writeCollaborationGraph(), MemberDefImpl::writeDeclaration(), MemberList::writeDeclarations(), writeDefArgumentList(), DirDefImpl::writeDetailedDescription(), NamespaceDefImpl::writeDetailedDescription(), GroupDefImpl::writeDetailedDescription(), FileDefImpl::writeDetailedDescription(), ClassDefImpl::writeDetailedDescription(), ClassDefImpl::writeDetailedDocumentationBody(), writeDirHierarchy(), DirDefImpl::writeDocumentation(), PageDefImpl::writeDocumentation(), GroupDefImpl::writeDocumentation(), MemberList::writeDocumentation(), FileDefImpl::writeDocumentation(), DirRelation::writeDocumentation(), MemberDefImpl::writeDocumentation(), MemberDefImpl::writeEnumDeclaration(), writeExample(), writeExampleIndex(), writeFileIndex(), DirDefImpl::writeFileList(), writeFileMemberIndexFiltered(), writeGraphInfo(), GroupDefImpl::writeGroupGraph(), writeGroupHierarchy(), writeGroupIndex(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), ClassDefImpl::writeIncludeFiles(), writeIndex(), ClassDefImpl::writeInheritanceGraph(), ClassDefImpl::writeInheritedMemberDeclarations(), DefinitionImpl::writeInlineCode(), ClassDefImpl::writeInlineDocumentation(), ClassDefImpl::writeMemberList(), NamespaceDefImpl::writeMemberPages(), GroupDefImpl::writeMemberPages(), FileDefImpl::writeMemberPages(), ClassDefImpl::writeMemberPages(), ClassDefImpl::writeMoreLink(), writeNamespaceIndex(), writeNamespaceMemberIndexFiltered(), DefinitionImpl::writeNavigationPath(), PageDefImpl::writePageDocumentation(), writePageIndex(), MemberList::writePlainDeclarations(), writeSingleFileIndex(), FileDefImpl::writeSource(), VhdlDocGen::writeSource(), DefinitionImpl::writeSourceDef(), FileDefImpl::writeSummaryLinks(), NamespaceDefImpl::writeSummaryLinks(), GroupDefImpl::writeSummaryLinks(), ClassDefImpl::writeSummaryLinks(), DefinitionImpl::writeToc(), writeUserGroupStubPage(), and VhdlDocGen::writeVHDLDeclaration().

◆ setCurrentDoc()

void OutputList::setCurrentDoc ( const Definition context,
const char *  anchor,
bool  isSourceFile 
)
inlinevirtual

Implements CodeOutputInterface.

Definition at line 468 of file outputlist.h.

References forall(), and CodeOutputInterface::setCurrentDoc().

◆ startAnonTypeScope()

void OutputList::startAnonTypeScope ( int  i1)
inline

Definition at line 192 of file outputlist.h.

References forall(), and OutputGenerator::startAnonTypeScope().

Referenced by MemberDefImpl::writeDeclaration().

◆ startBold()

◆ startCallGraph()

void OutputList::startCallGraph ( )
inline

◆ startCenter()

void OutputList::startCenter ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 275 of file outputlist.h.

References forall(), and BaseOutputDocInterface::startCenter().

◆ startClassDiagram()

void OutputList::startClassDiagram ( )
inline

Definition at line 322 of file outputlist.h.

References forall(), and OutputGenerator::startClassDiagram().

Referenced by ClassDefImpl::writeInheritanceGraph().

◆ startCodeFragment()

void OutputList::startCodeFragment ( )
inlinevirtual

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 224 of file outputlist.h.

References forall(), and BaseOutputDocInterface::startCodeFragment().

Referenced by MemberDefImpl::writeDocumentation(), DefinitionImpl::writeInlineCode(), FileDefImpl::writeSource(), and VhdlDocGen::writeSource().

◆ startCodeLine()

void OutputList::startCodeLine ( bool  hasLineNumbers)
inlinevirtual

Implements CodeOutputInterface.

Definition at line 228 of file outputlist.h.

References forall(), and CodeOutputInterface::startCodeLine().

◆ startConstraintDocs()

void OutputList::startConstraintDocs ( )
inline

Definition at line 431 of file outputlist.h.

References forall(), and OutputGenerator::startConstraintDocs().

Referenced by writeTypeConstraints().

◆ startConstraintList()

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

Definition at line 421 of file outputlist.h.

References forall(), and OutputGenerator::startConstraintList().

Referenced by writeTypeConstraints().

◆ startConstraintParam()

void OutputList::startConstraintParam ( )
inline

Definition at line 423 of file outputlist.h.

References forall(), and OutputGenerator::startConstraintParam().

Referenced by writeTypeConstraints().

◆ startConstraintType()

void OutputList::startConstraintType ( )
inline

Definition at line 427 of file outputlist.h.

References forall(), and OutputGenerator::startConstraintType().

Referenced by writeTypeConstraints().

◆ startContents()

◆ startDescForItem()

void OutputList::startDescForItem ( )
inlinevirtual

◆ startDescItem()

void OutputList::startDescItem ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 259 of file outputlist.h.

References forall(), and BaseOutputDocInterface::startDescItem().

◆ startDescription()

void OutputList::startDescription ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 255 of file outputlist.h.

References forall(), and BaseOutputDocInterface::startDescription().

◆ startDescTable()

void OutputList::startDescTable ( const char *  title)
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 354 of file outputlist.h.

References forall(), and BaseOutputDocInterface::startDescTable().

Referenced by MemberDefImpl::_writeEnumValues().

◆ startDescTableData()

void OutputList::startDescTableData ( )
inlinevirtual

◆ startDescTableRow()

void OutputList::startDescTableRow ( )
inlinevirtual

◆ startDescTableTitle()

void OutputList::startDescTableTitle ( )
inlinevirtual

◆ startDirDepGraph()

void OutputList::startDirDepGraph ( )
inline

Definition at line 382 of file outputlist.h.

References forall(), and OutputGenerator::startDirDepGraph().

Referenced by DirDefImpl::writeDirectoryGraph().

◆ startDotGraph()

void OutputList::startDotGraph ( )
inline

◆ startDoxyAnchor()

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

◆ startEmphasis()

void OutputList::startEmphasis ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 235 of file outputlist.h.

References forall(), and BaseOutputDocInterface::startEmphasis().

Referenced by writeDefArgumentList(), VhdlDocGen::writeFuncProcDocu(), and VhdlDocGen::writeVHDLDeclaration().

◆ startExamples()

void OutputList::startExamples ( )
inlinevirtual

◆ startFile()

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

◆ startFontClass()

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

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

Parameters
clsNameThe category name.

Implements CodeOutputInterface.

Definition at line 462 of file outputlist.h.

References forall(), and CodeOutputInterface::startFontClass().

Referenced by startFonts().

◆ startGroupCollaboration()

void OutputList::startGroupCollaboration ( )
inline

Definition at line 386 of file outputlist.h.

References forall(), and OutputGenerator::startGroupCollaboration().

Referenced by GroupDefImpl::writeGroupGraph().

◆ startGroupHeader()

◆ startHeaderSection()

void OutputList::startHeaderSection ( )
inline

◆ startHtmlLink()

void OutputList::startHtmlLink ( const char *  url)
inlinevirtual

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

Parameters
urlThe URL to link to.

Implements BaseOutputDocInterface.

Definition at line 143 of file outputlist.h.

References forall(), and BaseOutputDocInterface::startHtmlLink().

◆ startInclDepGraph()

void OutputList::startInclDepGraph ( )
inline

◆ startIndent()

void OutputList::startIndent ( )
inline

◆ startIndexItem()

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

◆ startIndexKey()

void OutputList::startIndexKey ( )
inline

◆ startIndexList()

void OutputList::startIndexList ( )
inline

◆ startIndexListItem()

void OutputList::startIndexListItem ( )
inline

◆ startIndexSection()

void OutputList::startIndexSection ( IndexSections  is)
inline

Definition at line 67 of file outputlist.h.

References forall(), and OutputGenerator::startIndexSection().

Referenced by writeIndex().

◆ startIndexValue()

void OutputList::startIndexValue ( bool  b)
inline

◆ startInlineHeader()

void OutputList::startInlineHeader ( )
inline

Definition at line 188 of file outputlist.h.

References forall(), and OutputGenerator::startInlineHeader().

Referenced by MemberList::writeDeclarations().

◆ startInlineMemberDoc()

void OutputList::startInlineMemberDoc ( )
inline

Definition at line 450 of file outputlist.h.

References forall(), and OutputGenerator::startInlineMemberDoc().

Referenced by MemberDefImpl::writeMemberDocSimple().

◆ startInlineMemberName()

void OutputList::startInlineMemberName ( )
inline

◆ startInlineMemberType()

void OutputList::startInlineMemberType ( )
inline

◆ startItemList()

void OutputList::startItemList ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 117 of file outputlist.h.

References forall(), and BaseOutputDocInterface::startItemList().

Referenced by ClassDefImpl::showUsedFiles(), startIndexHierarchy(), and writeExampleIndex().

◆ startItemListItem()

void OutputList::startItemListItem ( )
inlinevirtual

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 forall(), and BaseOutputDocInterface::startItemListItem().

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

◆ startLabels()

void OutputList::startLabels ( )
inline

◆ startMemberDeclaration()

◆ startMemberDescription()

◆ startMemberDoc()

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

◆ startMemberDocList()

void OutputList::startMemberDocList ( )
inline

Definition at line 180 of file outputlist.h.

References forall(), and OutputGenerator::startMemberDocList().

Referenced by MemberList::writeDocumentation().

◆ startMemberDocName()

void OutputList::startMemberDocName ( bool  align)
inline

◆ startMemberDocPrefixItem()

void OutputList::startMemberDocPrefixItem ( )
inline

◆ startMemberDocSimple()

void OutputList::startMemberDocSimple ( bool  b)
inline

◆ startMemberGroup()

void OutputList::startMemberGroup ( )
inline

◆ startMemberGroupDocs()

void OutputList::startMemberGroupDocs ( )
inline

◆ startMemberGroupHeader()

void OutputList::startMemberGroupHeader ( bool  b)
inline

◆ startMemberHeader()

◆ startMemberItem()

◆ startMemberList()

◆ startMemberSections()

◆ startMemberSubtitle()

void OutputList::startMemberSubtitle ( )
inline

◆ startMemberTemplateParams()

void OutputList::startMemberTemplateParams ( )
inline

◆ startPageDoc()

void OutputList::startPageDoc ( const char *  pageTitle)
inline

Definition at line 348 of file outputlist.h.

References forall(), and OutputGenerator::startPageDoc().

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

◆ startPageRef()

void OutputList::startPageRef ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 326 of file outputlist.h.

References forall(), and BaseOutputDocInterface::startPageRef().

◆ startParagraph()

◆ startParameterList()

void OutputList::startParameterList ( bool  openBracket)
inline

◆ startParameterName()

void OutputList::startParameterName ( bool  one)
inline

◆ startParameterType()

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

◆ startParamList()

void OutputList::startParamList ( ParamListTypes  t,
const char *  title 
)
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 306 of file outputlist.h.

References forall(), and BaseOutputDocInterface::startParamList().

◆ startPlainFile()

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

Definition at line 473 of file outputlist.h.

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

◆ startProjectNumber()

void OutputList::startProjectNumber ( )
inline

Definition at line 73 of file outputlist.h.

References forall(), and OutputGenerator::startProjectNumber().

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

◆ startQuickIndices()

void OutputList::startQuickIndices ( )
inline

◆ startSection()

void OutputList::startSection ( const char *  lab,
const char *  title,
SectionType  t 
)
inlinevirtual

◆ startSmall()

void OutputList::startSmall ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 279 of file outputlist.h.

References forall(), and BaseOutputDocInterface::startSmall().

◆ startSubsection()

void OutputList::startSubsection ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 267 of file outputlist.h.

References forall(), and BaseOutputDocInterface::startSubsection().

◆ startSubsubsection()

void OutputList::startSubsubsection ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 271 of file outputlist.h.

References forall(), and BaseOutputDocInterface::startSubsubsection().

Referenced by writeTemplateSpec().

◆ startTextBlock()

◆ startTextLink()

◆ startTitle()

void OutputList::startTitle ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 91 of file outputlist.h.

References forall(), and BaseOutputDocInterface::startTitle().

◆ startTitleHead()

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

◆ startTypewriter()

◆ writeAnchor()

◆ writeChar()

void OutputList::writeChar ( char  c)
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 239 of file outputlist.h.

References forall(), and BaseOutputDocInterface::writeChar().

Referenced by MemberDefImpl::writeEnumDeclaration(), and VhdlDocGen::writeProcedureProto().

◆ writeCodeAnchor()

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

Write an anchor to a source listing.

Parameters
nameThe name of the anchor.

Implements CodeOutputInterface.

Definition at line 466 of file outputlist.h.

References forall(), and CodeOutputInterface::writeCodeAnchor().

◆ writeCodeLink()

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

Writes a link to an object in a code fragment.

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

Implements CodeOutputInterface.

Definition at line 132 of file outputlist.h.

References forall(), and CodeOutputInterface::writeCodeLink().

◆ writeDoc()

◆ writeEndAnnoItem()

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

Definition at line 150 of file outputlist.h.

References forall(), and OutputGenerator::writeEndAnnoItem().

◆ writeFooter()

void OutputList::writeFooter ( const char *  navPath)
inline

Definition at line 83 of file outputlist.h.

References forall(), and OutputGenerator::writeFooter().

Referenced by endFile().

◆ writeGraphicalHierarchy()

void OutputList::writeGraphicalHierarchy ( DotGfxHierarchyTable g)
inline

◆ writeInheritedSectionTitle()

void OutputList::writeInheritedSectionTitle ( const char *  id,
const char *  ref,
const char *  file,
const char *  anchor,
const char *  title,
const char *  name 
)
inline

Definition at line 297 of file outputlist.h.

References forall(), and OutputGenerator::writeInheritedSectionTitle().

Referenced by MemberList::writeDeclarations().

◆ writeLabel()

void OutputList::writeLabel ( const char *  l,
bool  isLast 
)
inline

◆ writeLatexSpacing()

void OutputList::writeLatexSpacing ( )
inline

Definition at line 253 of file outputlist.h.

References forall(), and OutputGenerator::writeLatexSpacing().

Referenced by MemberDefImpl::writeDeclaration().

◆ writeLineNumber()

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

Writes the line number of a source listing

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

Implements CodeOutputInterface.

Definition at line 232 of file outputlist.h.

References forall(), and CodeOutputInterface::writeLineNumber().

◆ writeLogo()

void OutputList::writeLogo ( )
inline

Definition at line 338 of file outputlist.h.

References forall(), and OutputGenerator::writeLogo().

◆ writeNavigationPath()

void OutputList::writeNavigationPath ( const char *  s)
inline

Definition at line 336 of file outputlist.h.

References forall(), and OutputGenerator::writeNavigationPath().

Referenced by DefinitionImpl::writeNavigationPath().

◆ writeNonBreakableSpace()

void OutputList::writeNonBreakableSpace ( int  num)
inlinevirtual

◆ writeObjectLink()

void OutputList::writeObjectLink ( const char *  ref,
const char *  file,
const char *  anchor,
const char *  name 
)
inlinevirtual

Writes a link to an object in the documentation.

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

Implements BaseOutputDocInterface.

Definition at line 129 of file outputlist.h.

References forall(), and BaseOutputDocInterface::writeObjectLink().

Referenced by MemberDefImpl::_writeCategoryRelation(), MemberDefImpl::_writeGroupInclude(), MemberDefImpl::_writeReimplementedBy(), MemberDefImpl::_writeReimplements(), DefinitionImpl::_writeSourceRefList(), recursivelyAddGroupListToTitle(), ClassDefImpl::showUsedFiles(), writeAlphabeticalClassList(), writeAnnotatedClassList(), writeClassLinkForMember(), NamespaceSDict::writeDeclaration(), ClassDefImpl::writeDeclaration(), ClassDefImpl::writeDeclarationLink(), FileDefImpl::writeDetailedDescription(), GroupDefImpl::writeDirs(), writeExample(), writeExampleIndex(), writeFileLinkForMember(), DirDefImpl::writeFileList(), GroupDefImpl::writeFiles(), FileDefImpl::writeIncludeFiles(), ClassDefImpl::writeIncludeFiles(), ClassDefImpl::writeIncludeFilesForSlice(), ClassDefImpl::writeInheritanceGraph(), writeLink(), MemberDefImpl::writeLink(), MemberDefImpl::writeMemberDocSimple(), ClassDefImpl::writeMemberList(), writeNamespaceIndex(), writeNamespaceLinkForMember(), GroupDefImpl::writeNestedGroups(), writePartialDirPath(), writePartialFilePath(), writeSingleFileIndex(), DefinitionImpl::writeSourceDef(), DirDefImpl::writeSubDirList(), VhdlDocGen::writeVHDLDeclaration(), and VhdlDocGen::writeVhdlLink().

◆ writePageLink()

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

Definition at line 71 of file outputlist.h.

References forall(), and OutputGenerator::writePageLink().

Referenced by writeIndex().

◆ writeQuickLinks()

void OutputList::writeQuickLinks ( bool  compact,
HighlightedItem  hli,
const char *  file 
)
inline

◆ writeRuler()

◆ writeSearchInfo()

void OutputList::writeSearchInfo ( )
inline

◆ writeSplitBar()

void OutputList::writeSplitBar ( const char *  name)
inline

◆ writeStartAnnoItem()

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 forall(), and OutputGenerator::writeStartAnnoItem().

◆ writeString()

void OutputList::writeString ( const char *  text)
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 99 of file outputlist.h.

References forall(), and BaseOutputDocInterface::writeString().

Referenced by MemberDefImpl::_writeEnumValues(), DefinitionImpl::_writeSourceRefList(), endFile(), endFileWithNavPath(), endQuickIndexItem(), endQuickIndexList(), recursivelyAddGroupListToTitle(), startQuickIndexItem(), startQuickIndexList(), writeAlphabeticalClassList(), writeAnnotatedClassList(), writeAnnotatedExceptionIndex(), writeAnnotatedIndex(), writeAnnotatedInterfaceIndex(), writeAnnotatedStructIndex(), ClassDefImpl::writeAuthorSection(), DirDefImpl::writeBriefDescription(), NamespaceDefImpl::writeBriefDescription(), GroupDefImpl::writeBriefDescription(), FileDefImpl::writeBriefDescription(), ClassDefImpl::writeBriefDescription(), writeClassLinkForMember(), writeClassMemberIndexFiltered(), VhdlDocGen::writeClassType(), MemberDefImpl::writeDeclaration(), ClassDefImpl::writeDeclarationLink(), DirDefImpl::writeDetailedDescription(), NamespaceDefImpl::writeDetailedDescription(), GroupDefImpl::writeDetailedDescription(), FileDefImpl::writeDetailedDescription(), ClassDefImpl::writeDetailedDocumentationBody(), PageDefImpl::writeDocumentation(), DirRelation::writeDocumentation(), MemberDefImpl::writeDocumentation(), MemberList::writeDocumentationPage(), MemberDefImpl::writeEnumDeclaration(), writeExample(), writeExampleIndex(), writeFileIndex(), writeFileLinkForMember(), writeFileMemberIndexFiltered(), writeGroupIndex(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), ClassDefImpl::writeInlineDocumentation(), MemberDefImpl::writeMemberDocSimple(), ClassDefImpl::writeMemberList(), ClassDefImpl::writeMoreLink(), writeNamespaceIndex(), writeNamespaceLinkForMember(), writeNamespaceMemberIndexFiltered(), PageDefImpl::writePageDocumentation(), writePageIndex(), writePartialDirPath(), writePartialFilePath(), MemberList::writePlainDeclarations(), writeQuickMemberIndex(), NamespaceDefImpl::writeQuickMemberLinks(), GroupDefImpl::writeQuickMemberLinks(), FileDefImpl::writeQuickMemberLinks(), ClassDefImpl::writeQuickMemberLinks(), FileDefImpl::writeSummaryLinks(), NamespaceDefImpl::writeSummaryLinks(), GroupDefImpl::writeSummaryLinks(), ClassDefImpl::writeSummaryLinks(), writeTemplateSpec(), DefinitionImpl::writeToc(), writeUCFLink(), and writeUserGroupStubPage().

◆ writeStyleInfo()

void OutputList::writeStyleInfo ( int  part)
inline

Definition at line 77 of file outputlist.h.

References forall(), and OutputGenerator::writeStyleInfo().

Referenced by generateOutput().

◆ writeSummaryLink()

void OutputList::writeSummaryLink ( const char *  file,
const char *  anchor,
const char *  title,
bool  first 
)
inline

◆ writeSynopsis()

◆ writeTooltip()

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

Writes a tool tip definition

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

Implements CodeOutputInterface.

Definition at line 136 of file outputlist.h.

References forall(), and CodeOutputInterface::writeTooltip().

Member Data Documentation

◆ m_outputs


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