Doxygen
Loading...
Searching...
No Matches
OutputList Class Reference

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

#include <src/outputlist.h>

+ Collaboration diagram for OutputList:

Classes

struct  OutputGenElem
 

Public Types

using OutputGenIntfPtr = std::unique_ptr<OutputGenIntf>
 

Public Member Functions

 OutputList ()
 
 OutputList (const OutputList &ol)
 
OutputListoperator= (const OutputList &ol)
 
 OutputList (OutputList &&)=delete
 
OutputListoperator= (OutputList &&)=delete
 
 ~OutputList ()=default
 
template<class DocGenerator >
void add ()
 
const OutputCodeListcodeGenerators () const
 
OutputCodeListcodeGenerators ()
 
size_t size () const
 
void enableAll ()
 
void disableAll ()
 
void disable (OutputType o)
 
void enable (OutputType o)
 
bool isEnabled (OutputType o)
 
void disableAllBut (OutputType o)
 
void pushGeneratorState ()
 
void popGeneratorState ()
 
void generateDoc (const QCString &fileName, int startLine, const Definition *ctx, const MemberDef *md, const QCString &docStr, bool indexWords, bool isExample, const QCString &exampleName, bool singleLine, bool linkFromIndex, bool markdownSupport)
 
void startFile (const QCString &name, const QCString &manName, const QCString &title, int hierarchyLevel=0)
 
void parseText (const QCString &textStr)
 
void writeDoc (const IDocNodeAST *ast, const Definition *ctx, const MemberDef *md)
 
void startIndexSection (IndexSection is)
 
void endIndexSection (IndexSection is)
 
void writePageLink (const QCString &name, bool first)
 
void startProjectNumber ()
 
void endProjectNumber ()
 
void writeStyleInfo (int part)
 
void writeSearchInfo ()
 
void writeFooter (const QCString &navPath)
 
void endFile ()
 
void startTitleHead (const QCString &fileName)
 
void endTitleHead (const QCString &fileName, const QCString &name)
 
void startParagraph (const QCString &classDef=QCString())
 
void endParagraph ()
 
void writeString (const QCString &text)
 
void startIndexListItem ()
 
void endIndexListItem ()
 
void startIndexList ()
 
void endIndexList ()
 
void startIndexKey ()
 
void endIndexKey ()
 
void startIndexValue (bool b)
 
void endIndexValue (const QCString &name, bool b)
 
void startItemList ()
 
void endItemList ()
 
void startIndexItem (const QCString &ref, const QCString &file)
 
void endIndexItem (const QCString &ref, const QCString &file)
 
void docify (const QCString &s)
 
void writeObjectLink (const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name)
 
void startTextLink (const QCString &file, const QCString &anchor)
 
void endTextLink ()
 
void writeStartAnnoItem (const QCString &type, const QCString &file, const QCString &path, const QCString &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 QCString &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 QCString &anchor, OutputGenerator::MemberItemType type, const QCString &id=QCString())
 
void endMemberItem (OutputGenerator::MemberItemType type)
 
void startMemberTemplateParams ()
 
void endMemberTemplateParams (const QCString &anchor, const QCString &inheritId)
 
void startCompoundTemplateParams ()
 
void endCompoundTemplateParams ()
 
void startMemberGroupHeader (bool b)
 
void endMemberGroupHeader ()
 
void startMemberGroupDocs ()
 
void endMemberGroupDocs ()
 
void startMemberGroup ()
 
void endMemberGroup (bool last)
 
void insertMemberAlign (bool templ=FALSE)
 
void insertMemberAlignLeft (OutputGenerator::MemberItemType typ=OutputGenerator::MemberItemType::Normal, bool templ=FALSE)
 
void writeRuler ()
 
void writeAnchor (const QCString &fileName, const QCString &name)
 
void startEmphasis ()
 
void endEmphasis ()
 
void writeChar (char c)
 
void startMemberDoc (const QCString &clName, const QCString &memName, const QCString &anchor, const QCString &title, int memCount, int memTotal, bool showInline)
 
void endMemberDoc (bool hasArgs)
 
void startDoxyAnchor (const QCString &fName, const QCString &manName, const QCString &anchor, const QCString &name, const QCString &args)
 
void endDoxyAnchor (const QCString &fn, const QCString &anchor)
 
void addLabel (const QCString &fName, const QCString &anchor)
 
void writeLatexSpacing ()
 
void startDescForItem ()
 
void endDescForItem ()
 
void startCenter ()
 
void endCenter ()
 
void startSmall ()
 
void endSmall ()
 
void lineBreak (const QCString &style=QCString())
 
void startBold ()
 
void endBold ()
 
void startMemberDescription (const QCString &anchor, const QCString &inheritId=QCString(), bool typ=false)
 
void endMemberDescription ()
 
void startMemberDeclaration ()
 
void endMemberDeclaration (const QCString &anchor, const QCString &inheritId)
 
void writeInheritedSectionTitle (const QCString &id, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &title, const QCString &name)
 
void startExamples ()
 
void endExamples ()
 
void startIndent ()
 
void endIndent ()
 
void startSection (const QCString &lab, const QCString &title, SectionType t)
 
void endSection (const QCString &lab, SectionType t)
 
void addIndexItem (const QCString &s1, const QCString &s2)
 
void writeSynopsis ()
 
void startClassDiagram ()
 
void endClassDiagram (const ClassDiagram &d, const QCString &f, const QCString &n)
 
void startPageRef ()
 
void endPageRef (const QCString &c, const QCString &a)
 
void startQuickIndices ()
 
void endQuickIndices ()
 
void writeSplitBar (const QCString &name)
 
void writeNavigationPath (const QCString &s)
 
void writeLogo ()
 
void writeQuickLinks (HighlightedItem hli, const QCString &file)
 
void writeSummaryLink (const QCString &file, const QCString &anchor, const QCString &title, bool first)
 
void startContents ()
 
void endContents ()
 
void startPageDoc (const QCString &pageTitle)
 
void endPageDoc ()
 
void writeNonBreakableSpace (int num)
 
void startDescTable (const QCString &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 QCString &key)
 
void endParameterType ()
 
void startParameterName (bool one)
 
void endParameterName ()
 
void startParameterExtra ()
 
void endParameterExtra (bool last, bool one, bool bracket)
 
void startParameterDefVal (const char *separator)
 
void endParameterDefVal ()
 
void startParameterList (bool openBracket)
 
void endParameterList ()
 
void exceptionEntry (const QCString &prefix, bool closeBracket)
 
void startConstraintList (const QCString &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 QCString &l, bool isLast)
 
void endLabels ()
 
void writeLocalToc (const SectionRefs &refs, const LocalToc &lt)
 
void cleanup ()
 
void startPlainFile (const QCString &name)
 
void endPlainFile ()
 

Private Member Functions

void newId ()
 
void syncEnabled ()
 
void refreshCodeGenerators ()
 
template<class... Ts, class... As>
void foreach (void(OutputGenIntf::*methodPtr)(Ts...), As &&... args)
 

Private Attributes

std::vector< OutputGenElemm_outputGenList
 
OutputCodeList m_codeGenList
 
int m_id
 

Detailed Description

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

Definition at line 290 of file outputlist.h.

Member Typedef Documentation

◆ OutputGenIntfPtr

using OutputList::OutputGenIntfPtr = std::unique_ptr<OutputGenIntf>

Definition at line 293 of file outputlist.h.

Constructor & Destructor Documentation

◆ OutputList() [1/3]

OutputList::OutputList ( )

Definition at line 38 of file outputlist.cpp.

39{
40 newId();
42}
void setId(int id)
Definition outputlist.h:181
OutputCodeList m_codeGenList
Definition outputlist.h:743
void newId()

References m_codeGenList, m_id, newId(), and OutputCodeList::setId().

◆ OutputList() [2/3]

OutputList::OutputList ( const OutputList & ol)

Definition at line 44 of file outputlist.cpp.

45{
46 m_id = ol.m_id;
48}
std::vector< OutputGenElem > m_outputGenList
Definition outputlist.h:742
void refreshCodeGenerators()

References m_id, and refreshCodeGenerators().

◆ OutputList() [3/3]

OutputList::OutputList ( OutputList && )
delete

◆ ~OutputList()

OutputList::~OutputList ( )
default

Member Function Documentation

◆ add()

template<class DocGenerator >
void OutputList::add ( )
inline

Definition at line 328 of file outputlist.h.

329 {
330 m_outputGenList.emplace_back(std::make_unique<DocGenerator>());
332 }

References m_outputGenList, and refreshCodeGenerators().

Referenced by generateOutput().

◆ addIndexItem()

void OutputList::addIndexItem ( const QCString & s1,
const QCString & s2 )
inline

Definition at line 568 of file outputlist.h.

569 { foreach(&OutputGenIntf::addIndexItem,s1,s2); }
virtual void addIndexItem(const QCString &s1, const QCString &s2)=0

References OutputGenIntf::addIndexItem().

Referenced by MemberDefImpl::_writeEnumValues(), and ClassDefImpl::writeInlineDocumentation().

◆ addLabel()

void OutputList::addLabel ( const QCString & fName,
const QCString & anchor )
inline

◆ cleanup()

void OutputList::cleanup ( )
inline

Definition at line 718 of file outputlist.h.

719 { foreach(&OutputGenIntf::cleanup); }
virtual void cleanup()=0

References OutputGenIntf::cleanup().

Referenced by generateOutput().

◆ codeGenerators() [1/2]

OutputCodeList & OutputList::codeGenerators ( )
inline

Definition at line 335 of file outputlist.h.

335{ return m_codeGenList; }

References m_codeGenList.

◆ codeGenerators() [2/2]

◆ disable()

void OutputList::disable ( OutputType o)

Definition at line 115 of file outputlist.cpp.

116{
117 //printf("disable(%d)\n",o);
118 for (auto &e : m_outputGenList)
119 {
120 if (e.intf->type()==o) e.setEnabled(false);
121 }
122 syncEnabled();
123}
void syncEnabled()

References m_outputGenList, and syncEnabled().

Referenced by MemberDefImpl::_writeCallerGraph(), MemberDefImpl::_writeCallGraph(), endIndexHierarchy(), generateExampleDocs(), ClassDefImpl::showUsedFiles(), startIndexHierarchy(), ClassDefImpl::startMemberDocumentation(), FileDefImpl::startMemberDocumentation(), GroupDefImpl::startMemberDocumentation(), ModuleDefImpl::startMemberDocumentation(), NamespaceDefImpl::startMemberDocumentation(), startTitle(), writeAnnotatedClassList(), writeAnnotatedIndexGeneric(), ClassDefImpl::writeBriefDescription(), ConceptDefImpl::writeBriefDescription(), DirDefImpl::writeBriefDescription(), FileDefImpl::writeBriefDescription(), GroupDefImpl::writeBriefDescription(), ModuleDefImpl::writeBriefDescription(), NamespaceDefImpl::writeBriefDescription(), writeClassHierarchy(), ClassDefImpl::writeCollaborationGraph(), writeConceptIndex(), MemberDefImpl::writeDeclaration(), ClassDefImpl::writeDetailedDescription(), ConceptDefImpl::writeDetailedDescription(), DirDefImpl::writeDetailedDescription(), FileDefImpl::writeDetailedDescription(), GroupDefImpl::writeDetailedDescription(), ModuleDefImpl::writeDetailedDescription(), NamespaceDefImpl::writeDetailedDescription(), ClassDefImpl::writeDetailedDocumentationBody(), DirDefImpl::writeDirectoryGraph(), writeDirHierarchy(), DirDefImpl::writeDocumentation(), FileDefImpl::writeDocumentation(), GroupDefImpl::writeDocumentation(), MemberDefImpl::writeDocumentation(), MemberList::writeDocumentation(), ModuleDefImpl::writeDocumentation(), PageDefImpl::writeDocumentation(), MemberDefImpl::writeEnumDeclaration(), writeExampleIndex(), writeExamples(), writeFileIndex(), DirDefImpl::writeFileList(), VhdlDocGen::writeFuncProcDocu(), GroupDefImpl::writeGroupGraph(), writeGroupHierarchy(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), FileDefImpl::writeIncludedByGraph(), ClassDefImpl::writeIncludeFiles(), ConceptDefImpl::writeIncludeFiles(), FileDefImpl::writeIncludeFiles(), FileDefImpl::writeIncludeGraph(), writeIndex(), ClassDefImpl::writeInheritanceGraph(), FileDefImpl::writeInlineClasses(), VhdlDocGen::writeInlineClassLink(), ClassDefImpl::writeInlineDocumentation(), MemberDefImpl::writeMemberDocSimple(), writeModuleIndex(), writeModuleList(), ClassDefImpl::writeMoreLink(), writeNamespaceIndex(), PageDefImpl::writePageDocumentation(), writePageRef(), FileDefImpl::writeSourceHeader(), DirDefImpl::writeSubDirList(), writeTopicIndex(), and VhdlDocGen::writeVHDLDeclaration().

◆ disableAll()

void OutputList::disableAll ( )

Definition at line 105 of file outputlist.cpp.

106{
107 //printf("enableAll()\n");
108 for (auto &e : m_outputGenList)
109 {
110 e.setEnabled(false);
111 }
112 syncEnabled();
113}

References m_outputGenList, and syncEnabled().

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

◆ disableAllBut()

void OutputList::disableAllBut ( OutputType o)

Definition at line 85 of file outputlist.cpp.

86{
87 //printf("disableAllBut(%d)\n",o);
88 for (auto &e : m_outputGenList)
89 {
90 if (e.intf->type()!=o) e.setEnabled(false);
91 }
93}

References m_outputGenList, and syncEnabled().

Referenced by MemberDefImpl::_writeEnumValues(), ClassDefImpl::addClassAttributes(), ConceptDefImpl::addConceptAttributes(), NamespaceDefImpl::addNamespaceAttributes(), endFile(), endFileWithNavPath(), generateDirDocs(), recursivelyAddGroupListToTitle(), ClassDefImpl::showUsedFiles(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedIndexGeneric(), ClassDefImpl::writeAuthorSection(), ConceptDefImpl::writeAuthorSection(), FileDefImpl::writeAuthorSection(), GroupDefImpl::writeAuthorSection(), ModuleDefImpl::writeAuthorSection(), NamespaceDefImpl::writeAuthorSection(), ClassDefImpl::writeBriefDescription(), ConceptDefImpl::writeBriefDescription(), DirDefImpl::writeBriefDescription(), FileDefImpl::writeBriefDescription(), GroupDefImpl::writeBriefDescription(), ModuleDefImpl::writeBriefDescription(), NamespaceDefImpl::writeBriefDescription(), writeClassMemberIndexFiltered(), writeConceptIndex(), MemberDefImpl::writeDeclaration(), ClassDefImpl::writeDetailedDescription(), ConceptDefImpl::writeDetailedDescription(), DirDefImpl::writeDetailedDescription(), FileDefImpl::writeDetailedDescription(), GroupDefImpl::writeDetailedDescription(), ModuleDefImpl::writeDetailedDescription(), NamespaceDefImpl::writeDetailedDescription(), DirDefImpl::writeDocumentation(), DirRelation::writeDocumentation(), FileDefImpl::writeDocumentation(), GroupDefImpl::writeDocumentation(), ModuleDefImpl::writeDocumentation(), PageDefImpl::writeDocumentation(), MemberDefImpl::writeEnumDeclaration(), writeFileIndex(), DirDefImpl::writeFileList(), writeFileMemberIndexFiltered(), writeGraphicalClassHierarchy(), writeGraphicalExceptionHierarchy(), writeGraphicalInterfaceHierarchy(), writeGraphInfo(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), ClassDefImpl::writeIncludeFiles(), ConceptDefImpl::writeIncludeFiles(), FileDefImpl::writeIncludeFiles(), writeIndex(), ClassDefImpl::writeInheritanceGraph(), ClassDefImpl::writeInlineDocumentation(), ClassDefImpl::writeMemberList(), ClassDefImpl::writeMemberPages(), FileDefImpl::writeMemberPages(), GroupDefImpl::writeMemberPages(), NamespaceDefImpl::writeMemberPages(), writeModuleIndex(), writeModuleMemberIndexFiltered(), ClassDefImpl::writeMoreLink(), writeNamespaceIndex(), writeNamespaceMemberIndexFiltered(), DefinitionImpl::writeNavigationPath(), PageDefImpl::writePageDocumentation(), writePageIndex(), MemberList::writePlainDeclarations(), writeSingleFileIndex(), FileDefImpl::writeSourceHeader(), FileDefImpl::writeSourceLink(), DirDefImpl::writeSubDirList(), ClassDefImpl::writeSummaryLinks(), FileDefImpl::writeSummaryLinks(), GroupDefImpl::writeSummaryLinks(), ModuleDefImpl::writeSummaryLinks(), NamespaceDefImpl::writeSummaryLinks(), writeTopicIndex(), writeUserGroupStubPage(), and VhdlDocGen::writeVHDLDeclaration().

◆ docify()

void OutputList::docify ( const QCString & s)
inline

Definition at line 415 of file outputlist.h.

416 { foreach(&OutputGenIntf::docify,s); }
virtual void docify(const QCString &s)=0

References OutputGenIntf::docify().

Referenced by MemberDefImpl::_writeEnumValues(), MemberDefImpl::_writeGroupInclude(), DefinitionImpl::_writeSourceRefList(), MemberDefImpl::_writeTemplatePrefix(), generateExampleDocs(), generateFileRef(), ClassDefImpl::showUsedFiles(), writeAlphabeticalClassList(), writeAnnotatedClassList(), NamespaceDefImpl::writeBriefDescription(), writeClassTreeForList(), writeClassTreeToOutput(), ClassDefImpl::writeDeclaration(), MemberDefImpl::writeDeclaration(), NamespaceLinkedRefMap::writeDeclaration(), ClassDefImpl::writeDeclarationLink(), ConceptDefImpl::writeDeclarationLink(), ModuleDefImpl::writeDeclarationLink(), writeDefArgumentList(), writeDirTreeNode(), FileDefImpl::writeDocumentation(), MemberDefImpl::writeDocumentation(), MemberDefImpl::writeEnumDeclaration(), writeExceptionListImpl(), ModuleDefImpl::writeExports(), DirDefImpl::writeFileList(), GroupDefImpl::writeFiles(), ModuleDefImpl::writeFiles(), VhdlDocGen::writeFormatString(), VhdlDocGen::writeFuncProcDocu(), VhdlDocGen::writeFunctionProto(), writeGroupTreeNode(), ClassDefImpl::writeIncludeFiles(), ConceptDefImpl::writeIncludeFiles(), FileDefImpl::writeIncludeFiles(), ClassDefImpl::writeIncludeFilesForSlice(), ClassDefImpl::writeInheritanceGraph(), writeInheritanceSpecifier(), MemberDefImpl::writeLink(), MemberDefImpl::writeMemberDocSimple(), ClassDefImpl::writeMemberList(), writeMemberList(), writeModuleTreeNode(), ClassDefImpl::writeMoreLink(), GroupDefImpl::writePageDocumentation(), writePageRef(), writePartialFilePath(), MemberList::writePlainDeclarations(), VhdlDocGen::writeProcedureProto(), VhdlDocGen::writeProcessProto(), writeSingleFileIndex(), TextGeneratorOLImpl::writeString(), VhdlDocGen::writeStringLink(), ClassDefImpl::writeTemplateSpec(), writeUCFLink(), VhdlDocGen::writeVHDLDeclaration(), VhdlDocGen::writeVHDLDeclarations(), VhdlDocGen::writeVhdlLink(), and VhdlDocGen::writeVHDLTypeDocumentation().

◆ enable()

void OutputList::enable ( OutputType o)

◆ enableAll()

◆ endAnonTypeScope()

void OutputList::endAnonTypeScope ( int i1)
inline

Definition at line 469 of file outputlist.h.

470 { foreach(&OutputGenIntf::endAnonTypeScope,i1); }
virtual void endAnonTypeScope(int i1)=0

References OutputGenIntf::endAnonTypeScope().

Referenced by MemberDefImpl::writeDeclaration().

◆ endBold()

◆ endCallGraph()

void OutputList::endCallGraph ( DotCallGraph & g)
inline

Definition at line 630 of file outputlist.h.

631 { foreach(&OutputGenIntf::endCallGraph,g); }
virtual void endCallGraph(DotCallGraph &g)=0

References OutputGenIntf::endCallGraph().

Referenced by MemberDefImpl::_writeCallerGraph(), and MemberDefImpl::_writeCallGraph().

◆ endCenter()

void OutputList::endCenter ( )
inline

Definition at line 531 of file outputlist.h.

532 { foreach(&OutputGenIntf::endCenter); }
virtual void endCenter()=0

References OutputGenIntf::endCenter().

◆ endClassDiagram()

void OutputList::endClassDiagram ( const ClassDiagram & d,
const QCString & f,
const QCString & n )
inline

Definition at line 574 of file outputlist.h.

575 { foreach(&OutputGenIntf::endClassDiagram,d,f,n); }
virtual void endClassDiagram(const ClassDiagram &d, const QCString &f, const QCString &n)=0

References OutputGenIntf::endClassDiagram().

Referenced by ClassDefImpl::writeInheritanceGraph().

◆ endCompoundTemplateParams()

void OutputList::endCompoundTemplateParams ( )
inline

Definition at line 481 of file outputlist.h.

virtual void endCompoundTemplateParams()=0

References OutputGenIntf::endCompoundTemplateParams().

Referenced by ClassDefImpl::writeTemplateSpec().

◆ endConstraintDocs()

void OutputList::endConstraintDocs ( )
inline

Definition at line 690 of file outputlist.h.

virtual void endConstraintDocs()=0

References OutputGenIntf::endConstraintDocs().

Referenced by writeTypeConstraints().

◆ endConstraintList()

void OutputList::endConstraintList ( )
inline

Definition at line 692 of file outputlist.h.

virtual void endConstraintList()=0

References OutputGenIntf::endConstraintList().

Referenced by writeTypeConstraints().

◆ endConstraintParam()

void OutputList::endConstraintParam ( )
inline

Definition at line 682 of file outputlist.h.

virtual void endConstraintParam()=0

References OutputGenIntf::endConstraintParam().

Referenced by writeTypeConstraints().

◆ endConstraintType()

void OutputList::endConstraintType ( )
inline

Definition at line 686 of file outputlist.h.

virtual void endConstraintType()=0

References OutputGenIntf::endConstraintType().

Referenced by writeTypeConstraints().

◆ endContents()

◆ endDescForItem()

void OutputList::endDescForItem ( )
inline

◆ endDescTable()

void OutputList::endDescTable ( )
inline

Definition at line 606 of file outputlist.h.

607 { foreach(&OutputGenIntf::endDescTable); }
virtual void endDescTable()=0

References OutputGenIntf::endDescTable().

Referenced by MemberDefImpl::_writeEnumValues().

◆ endDescTableData()

void OutputList::endDescTableData ( )
inline

Definition at line 618 of file outputlist.h.

virtual void endDescTableData()=0

References OutputGenIntf::endDescTableData().

Referenced by MemberDefImpl::_writeEnumValues().

◆ endDescTableRow()

void OutputList::endDescTableRow ( )
inline

Definition at line 610 of file outputlist.h.

611 { foreach(&OutputGenIntf::endDescTableRow); }
virtual void endDescTableRow()=0

References OutputGenIntf::endDescTableRow().

Referenced by MemberDefImpl::_writeEnumValues().

◆ endDescTableTitle()

void OutputList::endDescTableTitle ( )
inline

Definition at line 614 of file outputlist.h.

virtual void endDescTableTitle()=0

References OutputGenIntf::endDescTableTitle().

Referenced by MemberDefImpl::_writeEnumValues().

◆ endDirDepGraph()

void OutputList::endDirDepGraph ( DotDirDeps & g)
inline

Definition at line 634 of file outputlist.h.

635 { foreach(&OutputGenIntf::endDirDepGraph,g); }
virtual void endDirDepGraph(DotDirDeps &g)=0

References OutputGenIntf::endDirDepGraph().

Referenced by DirDefImpl::writeDirectoryGraph().

◆ endDotGraph()

void OutputList::endDotGraph ( DotClassGraph & g)
inline

Definition at line 622 of file outputlist.h.

623 { foreach(&OutputGenIntf::endDotGraph,g); }
virtual void endDotGraph(DotClassGraph &g)=0

References OutputGenIntf::endDotGraph().

Referenced by ClassDefImpl::writeCollaborationGraph(), and ClassDefImpl::writeInheritanceGraph().

◆ endDoxyAnchor()

void OutputList::endDoxyAnchor ( const QCString & fn,
const QCString & anchor )
inline

◆ endEmphasis()

void OutputList::endEmphasis ( )
inline

Definition at line 505 of file outputlist.h.

506 { foreach(&OutputGenIntf::endEmphasis); }
virtual void endEmphasis()=0

References OutputGenIntf::endEmphasis().

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

◆ endExamples()

void OutputList::endExamples ( )
inline

Definition at line 558 of file outputlist.h.

559 { foreach(&OutputGenIntf::endExamples); }
virtual void endExamples()=0

References OutputGenIntf::endExamples().

Referenced by MemberDefImpl::_writeExamples(), and ClassDefImpl::writeDetailedDocumentationBody().

◆ endFile()

void OutputList::endFile ( )
inline

Definition at line 379 of file outputlist.h.

380 { foreach(&OutputGenIntf::endFile); }
virtual void endFile()=0

References OutputGenIntf::endFile().

Referenced by endFile().

◆ endGroupCollaboration()

void OutputList::endGroupCollaboration ( DotGroupCollaboration & g)
inline

Definition at line 638 of file outputlist.h.

virtual void endGroupCollaboration(DotGroupCollaboration &g)=0

References OutputGenIntf::endGroupCollaboration().

Referenced by GroupDefImpl::writeGroupGraph().

◆ endGroupHeader()

◆ endHeaderSection()

void OutputList::endHeaderSection ( )
inline

◆ endInclDepGraph()

void OutputList::endInclDepGraph ( DotInclDepGraph & g)
inline

Definition at line 626 of file outputlist.h.

627 { foreach(&OutputGenIntf::endInclDepGraph,g); }
virtual void endInclDepGraph(DotInclDepGraph &g)=0

References OutputGenIntf::endInclDepGraph().

Referenced by FileDefImpl::writeIncludedByGraph(), and FileDefImpl::writeIncludeGraph().

◆ endIndent()

void OutputList::endIndent ( )
inline

Definition at line 562 of file outputlist.h.

563 { foreach(&OutputGenIntf::endIndent); }
virtual void endIndent()=0

References OutputGenIntf::endIndent().

Referenced by MemberDefImpl::writeDocumentation(), and ClassDefImpl::writeInlineDocumentation().

◆ endIndexItem()

void OutputList::endIndexItem ( const QCString & ref,
const QCString & file )
inline

Definition at line 413 of file outputlist.h.

414 { foreach(&OutputGenIntf::endIndexItem,ref,file); }
virtual void endIndexItem(const QCString &ref, const QCString &file)=0

References OutputGenIntf::endIndexItem().

Referenced by writeClassTreeForList(), writeClassTreeToOutput(), writeDirTreeNode(), writeGroupTreeNode(), and writeModuleTreeNode().

◆ endIndexKey()

void OutputList::endIndexKey ( )
inline

◆ endIndexList()

void OutputList::endIndexList ( )
inline

◆ endIndexListItem()

void OutputList::endIndexListItem ( )
inline

◆ endIndexSection()

void OutputList::endIndexSection ( IndexSection is)
inline

Definition at line 365 of file outputlist.h.

366 { foreach(&OutputGenIntf::endIndexSection,is); }
virtual void endIndexSection(IndexSection is)=0

References OutputGenIntf::endIndexSection().

Referenced by writeIndex().

◆ endIndexValue()

void OutputList::endIndexValue ( const QCString & name,
bool b )
inline

Definition at line 405 of file outputlist.h.

406 { foreach(&OutputGenIntf::endIndexValue,name,b); }
virtual void endIndexValue(const QCString &name, bool b)=0

References OutputGenIntf::endIndexValue().

Referenced by writeAnnotatedClassList(), writeConceptIndex(), writeNamespaceIndex(), and writeSingleFileIndex().

◆ endInlineHeader()

void OutputList::endInlineHeader ( )
inline

Definition at line 465 of file outputlist.h.

466 { foreach(&OutputGenIntf::endInlineHeader); }
virtual void endInlineHeader()=0

References OutputGenIntf::endInlineHeader().

Referenced by MemberList::writeDeclarations().

◆ endInlineMemberDoc()

void OutputList::endInlineMemberDoc ( )
inline

Definition at line 708 of file outputlist.h.

virtual void endInlineMemberDoc()=0

References OutputGenIntf::endInlineMemberDoc().

Referenced by MemberDefImpl::writeMemberDocSimple().

◆ endInlineMemberName()

void OutputList::endInlineMemberName ( )
inline

Definition at line 704 of file outputlist.h.

virtual void endInlineMemberName()=0

References OutputGenIntf::endInlineMemberName().

Referenced by MemberDefImpl::writeMemberDocSimple().

◆ endInlineMemberType()

void OutputList::endInlineMemberType ( )
inline

Definition at line 700 of file outputlist.h.

virtual void endInlineMemberType()=0

References OutputGenIntf::endInlineMemberType().

Referenced by MemberDefImpl::writeMemberDocSimple().

◆ endItemList()

void OutputList::endItemList ( )
inline

◆ endItemListItem()

void OutputList::endItemListItem ( )
inline

Definition at line 437 of file outputlist.h.

438 { foreach(&OutputGenIntf::endItemListItem); }
virtual void endItemListItem()=0

References OutputGenIntf::endItemListItem().

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

◆ endLabels()

◆ endMemberDeclaration()

◆ endMemberDescription()

◆ endMemberDoc()

void OutputList::endMemberDoc ( bool hasArgs)
inline

Definition at line 513 of file outputlist.h.

514 { foreach(&OutputGenIntf::endMemberDoc,hasArgs); }
virtual void endMemberDoc(bool hasArgs)=0

References OutputGenIntf::endMemberDoc().

Referenced by MemberDefImpl::writeDocumentation(), and ClassDefImpl::writeInlineDocumentation().

◆ endMemberDocList()

void OutputList::endMemberDocList ( )
inline

Definition at line 457 of file outputlist.h.

virtual void endMemberDocList()=0

References OutputGenIntf::endMemberDocList().

Referenced by MemberList::writeDocumentation().

◆ endMemberDocName()

void OutputList::endMemberDocName ( )
inline

◆ endMemberDocPrefixItem()

void OutputList::endMemberDocPrefixItem ( )
inline

Definition at line 650 of file outputlist.h.

virtual void endMemberDocPrefixItem()=0

References OutputGenIntf::endMemberDocPrefixItem().

Referenced by MemberDefImpl::writeDocumentation().

◆ endMemberDocSimple()

void OutputList::endMemberDocSimple ( bool b)
inline

Definition at line 696 of file outputlist.h.

697 { foreach(&OutputGenIntf::endMemberDocSimple,b); }
virtual void endMemberDocSimple(bool b)=0

References OutputGenIntf::endMemberDocSimple().

Referenced by MemberList::writeSimpleDocumentation().

◆ endMemberGroup()

void OutputList::endMemberGroup ( bool last)
inline

Definition at line 493 of file outputlist.h.

494 { foreach(&OutputGenIntf::endMemberGroup,last); }
virtual void endMemberGroup(bool last)=0

References OutputGenIntf::endMemberGroup().

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

◆ endMemberGroupDocs()

void OutputList::endMemberGroupDocs ( )
inline

Definition at line 489 of file outputlist.h.

virtual void endMemberGroupDocs()=0

References OutputGenIntf::endMemberGroupDocs().

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

◆ endMemberGroupHeader()

void OutputList::endMemberGroupHeader ( )
inline

◆ endMemberHeader()

◆ endMemberItem()

◆ endMemberList()

◆ endMemberSections()

◆ endMemberSubtitle()

void OutputList::endMemberSubtitle ( )
inline

Definition at line 453 of file outputlist.h.

virtual void endMemberSubtitle()=0

References OutputGenIntf::endMemberSubtitle().

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

◆ endMemberTemplateParams()

void OutputList::endMemberTemplateParams ( const QCString & anchor,
const QCString & inheritId )
inline

Definition at line 477 of file outputlist.h.

478 { foreach(&OutputGenIntf::endMemberTemplateParams,anchor,inheritId); }
virtual void endMemberTemplateParams(const QCString &anchor, const QCString &inheritId)=0

References OutputGenIntf::endMemberTemplateParams().

Referenced by MemberDefImpl::writeDeclaration().

◆ endPageDoc()

void OutputList::endPageDoc ( )
inline

Definition at line 600 of file outputlist.h.

601 { foreach(&OutputGenIntf::endPageDoc); }
virtual void endPageDoc()=0

References OutputGenIntf::endPageDoc().

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

◆ endPageRef()

void OutputList::endPageRef ( const QCString & c,
const QCString & a )
inline

Definition at line 578 of file outputlist.h.

579 { foreach(&OutputGenIntf::endPageRef,c,a); }
virtual void endPageRef(const QCString &c, const QCString &a)=0

References OutputGenIntf::endPageRef().

Referenced by writePageRef().

◆ endParagraph()

◆ endParameterDefVal()

void OutputList::endParameterDefVal ( )
inline

Definition at line 670 of file outputlist.h.

virtual void endParameterDefVal()=0

References OutputGenIntf::endParameterDefVal().

Referenced by writeDefArgumentList().

◆ endParameterExtra()

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

Definition at line 666 of file outputlist.h.

667 { foreach(&OutputGenIntf::endParameterExtra,last,one,bracket); }
virtual void endParameterExtra(bool last, bool one, bool bracket)=0

References OutputGenIntf::endParameterExtra().

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

◆ endParameterList()

void OutputList::endParameterList ( )
inline

Definition at line 674 of file outputlist.h.

virtual void endParameterList()=0

References OutputGenIntf::endParameterList().

Referenced by MemberDefImpl::writeDocumentation().

◆ endParameterName()

void OutputList::endParameterName ( )
inline

◆ endParameterType()

void OutputList::endParameterType ( )
inline

◆ endPlainFile()

void OutputList::endPlainFile ( )
inline

Definition at line 722 of file outputlist.h.

723 { foreach(&OutputGenIntf::endPlainFile); }
virtual void endPlainFile()=0

References OutputGenIntf::endPlainFile().

◆ endProjectNumber()

void OutputList::endProjectNumber ( )
inline

Definition at line 371 of file outputlist.h.

virtual void endProjectNumber()=0

References OutputGenIntf::endProjectNumber().

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

◆ endQuickIndices()

◆ endSection()

void OutputList::endSection ( const QCString & lab,
SectionType t )
inline

Definition at line 566 of file outputlist.h.

567 { foreach(&OutputGenIntf::endSection,lab,t); }
virtual void endSection(const QCString &lab, SectionType t)=0

References OutputGenIntf::endSection().

Referenced by PageDefImpl::writeDocumentation(), writeMemberList(), and GroupDefImpl::writePageDocumentation().

◆ endSmall()

void OutputList::endSmall ( )
inline

Definition at line 535 of file outputlist.h.

536 { foreach(&OutputGenIntf::endSmall); }
virtual void endSmall()=0

References OutputGenIntf::endSmall().

◆ endTextBlock()

◆ endTextLink()

◆ endTitleHead()

void OutputList::endTitleHead ( const QCString & fileName,
const QCString & name )
inline

Definition at line 383 of file outputlist.h.

384 { foreach(&OutputGenIntf::endTitleHead,fileName,name); }
virtual void endTitleHead(const QCString &fileName, const QCString &name)=0

References OutputGenIntf::endTitleHead().

Referenced by endTitle(), GroupDefImpl::writeDocumentation(), ModuleDefImpl::writeDocumentation(), PageDefImpl::writeDocumentation(), and writeIndex().

◆ endTypewriter()

◆ exceptionEntry()

void OutputList::exceptionEntry ( const QCString & prefix,
bool closeBracket )
inline

Definition at line 676 of file outputlist.h.

677 { foreach(&OutputGenIntf::exceptionEntry,prefix,closeBracket); }
constexpr auto prefix
Definition anchor.cpp:44
virtual void exceptionEntry(const QCString &prefix, bool closeBracket)=0

References OutputGenIntf::exceptionEntry(), and prefix.

Referenced by writeExceptionListImpl().

◆ foreach()

template<class... Ts, class... As>
void OutputList::foreach ( void(OutputGenIntf::* methodPtr )(Ts...),
As &&... args )
inlineprivate

Definition at line 731 of file outputlist.h.

732 {
733 for (auto &e : m_outputGenList)
734 {
735 if (e.enabled)
736 {
737 (e.intf.get()->*methodPtr)(std::forward<As>(args)...);
738 }
739 }
740 }

References m_outputGenList.

◆ generateDoc()

void OutputList::generateDoc ( const QCString & fileName,
int startLine,
const Definition * ctx,
const MemberDef * md,
const QCString & docStr,
bool indexWords,
bool isExample,
const QCString & exampleName,
bool singleLine,
bool linkFromIndex,
bool markdownSupport )

Definition at line 168 of file outputlist.cpp.

174{
175 if (docStr.isEmpty()) return;
176
177 auto count=std::count_if(m_outputGenList.begin(),m_outputGenList.end(),
178 [](const auto &e) { return e.enabled; });
179 if (count>0)
180 {
181 // we want to validate irrespective of the number of output formats
182 // specified as:
183 // - when only XML format there should be warnings as well (XML has its own write routines)
184 // - no formats there should be warnings as well
185 auto parser { createDocParser() };
186 auto ast { validatingParseDoc(*parser.get(),
187 fileName,startLine,
188 ctx,md,docStr,indexWords,isExample,exampleName,
189 singleLine,linkFromIndex,markdownSupport) };
190 if (ast) writeDoc(ast.get(),ctx,md);
191 }
192}
void writeDoc(const IDocNodeAST *ast, const Definition *ctx, const MemberDef *md)
Definition outputlist.h:361
bool isEmpty() const
Returns TRUE iff the string is empty.
Definition qcstring.h:143
IDocParserPtr createDocParser()
factory function to create a parser
Definition docparser.cpp:54
IDocNodeASTPtr validatingParseDoc(IDocParser &parserIntf, const QCString &fileName, int startLine, const Definition *ctx, const MemberDef *md, const QCString &input, bool indexWords, bool isExample, const QCString &exampleName, bool singleLine, bool linkFromIndex, bool markdownSupport)

References createDocParser(), QCString::isEmpty(), m_outputGenList, validatingParseDoc(), and writeDoc().

Referenced by MemberDefImpl::_writeEnumValues(), generateExampleDocs(), writeAnnotatedClassList(), ClassDefImpl::writeBriefDescription(), writeConceptIndex(), NamespaceLinkedRefMap::writeDeclaration(), MemberList::writeDeclarations(), ConceptDefImpl::writeDetailedDescription(), DirDefImpl::writeDetailedDescription(), FileDefImpl::writeDetailedDescription(), GroupDefImpl::writeDetailedDescription(), ModuleDefImpl::writeDetailedDescription(), NamespaceDefImpl::writeDetailedDescription(), ClassDefImpl::writeDetailedDocumentationBody(), GroupDefImpl::writeDirs(), MemberDefImpl::writeDocumentation(), PageDefImpl::writeDocumentation(), ModuleDefImpl::writeExports(), DirDefImpl::writeFileList(), GroupDefImpl::writeFiles(), ModuleDefImpl::writeFiles(), writeGraphInfo(), writeIndex(), MemberDefImpl::writeMemberDocSimple(), writeNamespaceIndex(), GroupDefImpl::writeNestedGroups(), GroupDefImpl::writePageDocumentation(), PageDefImpl::writePageDocumentation(), writeSingleFileIndex(), DirDefImpl::writeSubDirList(), writeTypeConstraints(), VhdlDocGen::writeVHDLDeclaration(), and VhdlDocGen::writeVHDLDeclarations().

◆ insertMemberAlign()

◆ insertMemberAlignLeft()

void OutputList::insertMemberAlignLeft ( OutputGenerator::MemberItemType typ = OutputGenerator::MemberItemType::Normal,
bool templ = FALSE )
inline

Definition at line 497 of file outputlist.h.

498 { foreach(&OutputGenIntf::insertMemberAlignLeft,typ,templ); }
virtual void insertMemberAlignLeft(OutputGenerator::MemberItemType typ=OutputGenerator::MemberItemType::Normal, bool templ=FALSE)=0

References OutputGenIntf::insertMemberAlignLeft().

Referenced by VhdlDocGen::writeVHDLDeclaration().

◆ isEnabled()

bool OutputList::isEnabled ( OutputType o)

Definition at line 135 of file outputlist.cpp.

136{
137 for (const auto &e : m_outputGenList)
138 {
139 if (e.intf->type()==o) { return e.enabled; }
140 }
141 return false;
142}

References m_outputGenList.

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

◆ lastIndexPage()

void OutputList::lastIndexPage ( )
inline

Definition at line 646 of file outputlist.h.

647 { foreach(&OutputGenIntf::lastIndexPage); }
virtual void lastIndexPage()=0

References OutputGenIntf::lastIndexPage().

Referenced by writeIndex().

◆ lineBreak()

◆ newId()

void OutputList::newId ( )
private

Definition at line 71 of file outputlist.cpp.

72{
73 m_id = ++g_outId;
74}
static AtomicInt g_outId

References g_outId, and m_id.

Referenced by OutputList(), and startFile().

◆ operator=() [1/2]

OutputList & OutputList::operator= ( const OutputList & ol)

Definition at line 50 of file outputlist.cpp.

51{
52 if (this!=&ol)
53 {
54 m_id = ol.m_id;
57 }
58 return *this;
59}

References m_id, m_outputGenList, and refreshCodeGenerators().

◆ operator=() [2/2]

OutputList & OutputList::operator= ( OutputList && )
delete

◆ parseText()

void OutputList::parseText ( const QCString & textStr)

Definition at line 201 of file outputlist.cpp.

202{
203
204 auto count=std::count_if(m_outputGenList.begin(),m_outputGenList.end(),
205 [](const auto &e) { return e.enabled; });
206
207 if (count>0)
208 {
209 // we want to validate irrespective of the number of output formats
210 // specified as:
211 // - when only XML format there should be warnings as well (XML has its own write routines)
212 // - no formats there should be warnings as well
213 auto parser { createDocParser() };
214 auto ast { validatingParseText(*parser.get(), textStr) };
215
216 if (ast) writeDoc(ast.get(),nullptr,nullptr);
217 }
218}
IDocNodeASTPtr validatingParseText(IDocParser &parserIntf, const QCString &input)

References createDocParser(), m_outputGenList, validatingParseText(), and writeDoc().

Referenced by MemberDefImpl::_writeCallerGraph(), MemberDefImpl::_writeCallGraph(), MemberDefImpl::_writeCategoryRelation(), MemberDefImpl::_writeMultiLineInitializer(), MemberDefImpl::_writeReimplements(), DefinitionImpl::_writeSourceRefList(), ClassDefImpl::endMemberDeclarations(), ClassDefImpl::showUsedFiles(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedIndexGeneric(), ClassDefImpl::writeAuthorSection(), ConceptDefImpl::writeAuthorSection(), FileDefImpl::writeAuthorSection(), GroupDefImpl::writeAuthorSection(), ModuleDefImpl::writeAuthorSection(), NamespaceDefImpl::writeAuthorSection(), ConceptDefImpl::writeBriefDescription(), DirDefImpl::writeBriefDescription(), FileDefImpl::writeBriefDescription(), GroupDefImpl::writeBriefDescription(), ModuleDefImpl::writeBriefDescription(), NamespaceDefImpl::writeBriefDescription(), writeClassMemberIndexFiltered(), writeClassTreeForList(), writeClassTreeToOutput(), ClassDefImpl::writeCollaborationGraph(), writeConceptIndex(), MemberDefImpl::writeDeclaration(), NamespaceLinkedRefMap::writeDeclaration(), ClassDefImpl::writeDeclarationLink(), ConceptDefImpl::writeDeclarationLink(), ModuleDefImpl::writeDeclarationLink(), MemberList::writeDeclarations(), ConceptDefImpl::writeDefinition(), ClassDefImpl::writeDetailedDescription(), ConceptDefImpl::writeDetailedDescription(), DirDefImpl::writeDetailedDescription(), FileDefImpl::writeDetailedDescription(), GroupDefImpl::writeDetailedDescription(), ModuleDefImpl::writeDetailedDescription(), NamespaceDefImpl::writeDetailedDescription(), DirDefImpl::writeDirectoryGraph(), GroupDefImpl::writeDirs(), writeDirTreeNode(), ClassDefImpl::writeDocumentation(), ClassLinkedRefMap::writeDocumentation(), ConceptDefImpl::writeDocumentation(), DirDefImpl::writeDocumentation(), DirRelation::writeDocumentation(), FileDefImpl::writeDocumentation(), GroupDefImpl::writeDocumentation(), MemberList::writeDocumentation(), ModuleDefImpl::writeDocumentation(), NamespaceDefImpl::writeDocumentation(), PageDefImpl::writeDocumentation(), MemberDefImpl::writeEnumDeclaration(), writeExampleIndex(), ModuleDefImpl::writeExports(), writeFileIndex(), DirDefImpl::writeFileList(), writeFileMemberIndexFiltered(), GroupDefImpl::writeFiles(), ModuleDefImpl::writeFiles(), writeGraphicalClassHierarchy(), writeGraphicalExceptionHierarchy(), writeGraphicalInterfaceHierarchy(), writeGraphInfo(), GroupDefImpl::writeGroupGraph(), writeGroupTreeNode(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), FileDefImpl::writeIncludedByGraph(), FileDefImpl::writeIncludeGraph(), writeIndex(), ClassDefImpl::writeInheritanceGraph(), ClassDefImpl::writeInlineDocumentation(), writeMarkerList(), ClassDefImpl::writeMemberList(), writeModuleIndex(), writeModuleMemberIndexFiltered(), writeModuleTreeNode(), ClassDefImpl::writeMoreLink(), writeNamespaceIndex(), writeNamespaceMemberIndexFiltered(), GroupDefImpl::writeNestedGroups(), writePageIndex(), MemberList::writePlainDeclarations(), writeSingleFileIndex(), DefinitionImpl::writeSourceDef(), FileDefImpl::writeSourceHeader(), FileDefImpl::writeSourceLink(), DirDefImpl::writeSubDirList(), writeTopicIndex(), writeTypeConstraints(), writeUserGroupStubPage(), and VhdlDocGen::writeVHDLDeclarations().

◆ popGeneratorState()

void OutputList::popGeneratorState ( )

Definition at line 154 of file outputlist.cpp.

155{
156 //printf("popGeneratorState()\n");
157 for (auto &e : m_outputGenList)
158 {
159 if (!e.enabledStack.empty())
160 {
161 e.enabled = e.enabledStack.top();
162 e.enabledStack.pop();
163 }
164 }
165 syncEnabled();
166}

References m_outputGenList, and syncEnabled().

Referenced by ClassDefImpl::addClassAttributes(), ConceptDefImpl::addConceptAttributes(), NamespaceDefImpl::addNamespaceAttributes(), endFile(), endFileWithNavPath(), endIndexHierarchy(), GroupDefImpl::endMemberDocumentation(), endTitle(), generateDirDocs(), recursivelyAddGroupListToTitle(), ClassDefImpl::showUsedFiles(), startIndexHierarchy(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedClassList(), writeAnnotatedIndexGeneric(), ClassDefImpl::writeAuthorSection(), ConceptDefImpl::writeAuthorSection(), FileDefImpl::writeAuthorSection(), GroupDefImpl::writeAuthorSection(), ModuleDefImpl::writeAuthorSection(), NamespaceDefImpl::writeAuthorSection(), ClassDefImpl::writeBriefDescription(), ConceptDefImpl::writeBriefDescription(), DirDefImpl::writeBriefDescription(), FileDefImpl::writeBriefDescription(), GroupDefImpl::writeBriefDescription(), ModuleDefImpl::writeBriefDescription(), NamespaceDefImpl::writeBriefDescription(), writeClassHierarchy(), writeClassMemberIndexFiltered(), ClassDefImpl::writeCollaborationGraph(), writeConceptIndex(), MemberDefImpl::writeDeclaration(), ClassDefImpl::writeDetailedDescription(), ConceptDefImpl::writeDetailedDescription(), DirDefImpl::writeDetailedDescription(), FileDefImpl::writeDetailedDescription(), GroupDefImpl::writeDetailedDescription(), ModuleDefImpl::writeDetailedDescription(), NamespaceDefImpl::writeDetailedDescription(), ClassDefImpl::writeDetailedDocumentationBody(), writeDirHierarchy(), DirDefImpl::writeDocumentation(), DirRelation::writeDocumentation(), FileDefImpl::writeDocumentation(), GroupDefImpl::writeDocumentation(), MemberDefImpl::writeDocumentation(), MemberList::writeDocumentation(), ModuleDefImpl::writeDocumentation(), PageDefImpl::writeDocumentation(), MemberDefImpl::writeEnumDeclaration(), writeExampleIndex(), writeExamples(), writeFileIndex(), DirDefImpl::writeFileList(), writeFileMemberIndexFiltered(), writeGraphInfo(), GroupDefImpl::writeGroupGraph(), writeGroupHierarchy(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), ClassDefImpl::writeIncludeFiles(), ConceptDefImpl::writeIncludeFiles(), writeIndex(), ClassDefImpl::writeInheritanceGraph(), DefinitionImpl::writeInlineCode(), ClassDefImpl::writeInlineDocumentation(), ClassDefImpl::writeMemberList(), ClassDefImpl::writeMemberPages(), FileDefImpl::writeMemberPages(), GroupDefImpl::writeMemberPages(), NamespaceDefImpl::writeMemberPages(), writeModuleIndex(), writeModuleList(), writeModuleMemberIndexFiltered(), ClassDefImpl::writeMoreLink(), writeNamespaceIndex(), writeNamespaceMemberIndexFiltered(), DefinitionImpl::writeNavigationPath(), PageDefImpl::writePageDocumentation(), writePageIndex(), writePageRef(), MemberList::writePlainDeclarations(), writeSingleFileIndex(), VhdlDocGen::writeSource(), FileDefImpl::writeSourceHeader(), DirDefImpl::writeSubDirList(), ClassDefImpl::writeSummaryLinks(), FileDefImpl::writeSummaryLinks(), GroupDefImpl::writeSummaryLinks(), ModuleDefImpl::writeSummaryLinks(), NamespaceDefImpl::writeSummaryLinks(), writeTopicIndex(), writeUserGroupStubPage(), and VhdlDocGen::writeVHDLDeclaration().

◆ pushGeneratorState()

void OutputList::pushGeneratorState ( )

Definition at line 144 of file outputlist.cpp.

145{
146 //printf("pushGeneratorState()\n");
147 for (auto &e : m_outputGenList)
148 {
149 e.enabledStack.push(e.enabled);
150 }
151 syncEnabled();
152}

References m_outputGenList, and syncEnabled().

Referenced by ClassDefImpl::addClassAttributes(), ConceptDefImpl::addConceptAttributes(), NamespaceDefImpl::addNamespaceAttributes(), endFile(), endFileWithNavPath(), endIndexHierarchy(), generateDirDocs(), recursivelyAddGroupListToTitle(), ClassDefImpl::showUsedFiles(), startIndexHierarchy(), GroupDefImpl::startMemberDocumentation(), startTitle(), writeAlphabeticalExceptionIndex(), writeAlphabeticalIndex(), writeAlphabeticalInterfaceIndex(), writeAlphabeticalStructIndex(), writeAnnotatedClassList(), writeAnnotatedIndexGeneric(), ClassDefImpl::writeAuthorSection(), ConceptDefImpl::writeAuthorSection(), FileDefImpl::writeAuthorSection(), GroupDefImpl::writeAuthorSection(), ModuleDefImpl::writeAuthorSection(), NamespaceDefImpl::writeAuthorSection(), ClassDefImpl::writeBriefDescription(), ConceptDefImpl::writeBriefDescription(), DirDefImpl::writeBriefDescription(), FileDefImpl::writeBriefDescription(), GroupDefImpl::writeBriefDescription(), ModuleDefImpl::writeBriefDescription(), NamespaceDefImpl::writeBriefDescription(), writeClassHierarchy(), writeClassMemberIndexFiltered(), ClassDefImpl::writeCollaborationGraph(), writeConceptIndex(), MemberDefImpl::writeDeclaration(), ClassDefImpl::writeDetailedDescription(), ConceptDefImpl::writeDetailedDescription(), DirDefImpl::writeDetailedDescription(), FileDefImpl::writeDetailedDescription(), GroupDefImpl::writeDetailedDescription(), ModuleDefImpl::writeDetailedDescription(), NamespaceDefImpl::writeDetailedDescription(), ClassDefImpl::writeDetailedDocumentationBody(), writeDirHierarchy(), DirDefImpl::writeDocumentation(), DirRelation::writeDocumentation(), FileDefImpl::writeDocumentation(), GroupDefImpl::writeDocumentation(), MemberDefImpl::writeDocumentation(), MemberList::writeDocumentation(), ModuleDefImpl::writeDocumentation(), PageDefImpl::writeDocumentation(), MemberDefImpl::writeEnumDeclaration(), writeExampleIndex(), writeExamples(), writeFileIndex(), DirDefImpl::writeFileList(), writeFileMemberIndexFiltered(), writeGraphInfo(), GroupDefImpl::writeGroupGraph(), writeGroupHierarchy(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), ClassDefImpl::writeIncludeFiles(), ConceptDefImpl::writeIncludeFiles(), writeIndex(), ClassDefImpl::writeInheritanceGraph(), DefinitionImpl::writeInlineCode(), ClassDefImpl::writeInlineDocumentation(), ClassDefImpl::writeMemberList(), ClassDefImpl::writeMemberPages(), FileDefImpl::writeMemberPages(), GroupDefImpl::writeMemberPages(), NamespaceDefImpl::writeMemberPages(), writeModuleIndex(), writeModuleList(), writeModuleMemberIndexFiltered(), ClassDefImpl::writeMoreLink(), writeNamespaceIndex(), writeNamespaceMemberIndexFiltered(), DefinitionImpl::writeNavigationPath(), PageDefImpl::writePageDocumentation(), writePageIndex(), writePageRef(), MemberList::writePlainDeclarations(), writeSingleFileIndex(), VhdlDocGen::writeSource(), FileDefImpl::writeSourceHeader(), DirDefImpl::writeSubDirList(), ClassDefImpl::writeSummaryLinks(), FileDefImpl::writeSummaryLinks(), GroupDefImpl::writeSummaryLinks(), ModuleDefImpl::writeSummaryLinks(), NamespaceDefImpl::writeSummaryLinks(), writeTopicIndex(), writeUserGroupStubPage(), and VhdlDocGen::writeVHDLDeclaration().

◆ refreshCodeGenerators()

void OutputList::refreshCodeGenerators ( )
private

Definition at line 61 of file outputlist.cpp.

62{
64 for (auto &e : m_outputGenList)
65 {
66 e.intf->addCodeGen(m_codeGenList);
67 }
69}

References OutputCodeList::clear(), m_codeGenList, m_id, m_outputGenList, and OutputCodeList::setId().

Referenced by add(), operator=(), and OutputList().

◆ size()

size_t OutputList::size ( ) const
inline

Definition at line 337 of file outputlist.h.

337{ return m_outputGenList.size(); }

References m_outputGenList.

Referenced by generateOutput().

◆ startAnonTypeScope()

void OutputList::startAnonTypeScope ( int i1)
inline

Definition at line 467 of file outputlist.h.

468 { foreach(&OutputGenIntf::startAnonTypeScope,i1); }
virtual void startAnonTypeScope(int i1)=0

References OutputGenIntf::startAnonTypeScope().

Referenced by MemberDefImpl::writeDeclaration().

◆ startBold()

◆ startCallGraph()

void OutputList::startCallGraph ( )
inline

Definition at line 628 of file outputlist.h.

629 { foreach(&OutputGenIntf::startCallGraph); }
virtual void startCallGraph()=0

References OutputGenIntf::startCallGraph().

Referenced by MemberDefImpl::_writeCallerGraph(), and MemberDefImpl::_writeCallGraph().

◆ startCenter()

void OutputList::startCenter ( )
inline

Definition at line 529 of file outputlist.h.

530 { foreach(&OutputGenIntf::startCenter); }
virtual void startCenter()=0

References OutputGenIntf::startCenter().

◆ startClassDiagram()

void OutputList::startClassDiagram ( )
inline

Definition at line 572 of file outputlist.h.

virtual void startClassDiagram()=0

References OutputGenIntf::startClassDiagram().

Referenced by ClassDefImpl::writeInheritanceGraph().

◆ startCompoundTemplateParams()

void OutputList::startCompoundTemplateParams ( )
inline

Definition at line 479 of file outputlist.h.

virtual void startCompoundTemplateParams()=0

References OutputGenIntf::startCompoundTemplateParams().

Referenced by ClassDefImpl::writeTemplateSpec().

◆ startConstraintDocs()

void OutputList::startConstraintDocs ( )
inline

Definition at line 688 of file outputlist.h.

virtual void startConstraintDocs()=0

References OutputGenIntf::startConstraintDocs().

Referenced by writeTypeConstraints().

◆ startConstraintList()

void OutputList::startConstraintList ( const QCString & header)
inline

Definition at line 678 of file outputlist.h.

679 { foreach(&OutputGenIntf::startConstraintList,header); }
virtual void startConstraintList(const QCString &header)=0

References OutputGenIntf::startConstraintList().

Referenced by writeTypeConstraints().

◆ startConstraintParam()

void OutputList::startConstraintParam ( )
inline

Definition at line 680 of file outputlist.h.

virtual void startConstraintParam()=0

References OutputGenIntf::startConstraintParam().

Referenced by writeTypeConstraints().

◆ startConstraintType()

void OutputList::startConstraintType ( )
inline

Definition at line 684 of file outputlist.h.

virtual void startConstraintType()=0

References OutputGenIntf::startConstraintType().

Referenced by writeTypeConstraints().

◆ startContents()

◆ startDescForItem()

void OutputList::startDescForItem ( )
inline

◆ startDescTable()

void OutputList::startDescTable ( const QCString & title)
inline

Definition at line 604 of file outputlist.h.

605 { foreach(&OutputGenIntf::startDescTable,title); }
virtual void startDescTable(const QCString &title)=0

References OutputGenIntf::startDescTable().

Referenced by MemberDefImpl::_writeEnumValues().

◆ startDescTableData()

void OutputList::startDescTableData ( )
inline

Definition at line 616 of file outputlist.h.

virtual void startDescTableData()=0

References OutputGenIntf::startDescTableData().

Referenced by MemberDefImpl::_writeEnumValues().

◆ startDescTableRow()

void OutputList::startDescTableRow ( )
inline

Definition at line 608 of file outputlist.h.

virtual void startDescTableRow()=0

References OutputGenIntf::startDescTableRow().

Referenced by MemberDefImpl::_writeEnumValues().

◆ startDescTableTitle()

void OutputList::startDescTableTitle ( )
inline

Definition at line 612 of file outputlist.h.

virtual void startDescTableTitle()=0

References OutputGenIntf::startDescTableTitle().

Referenced by MemberDefImpl::_writeEnumValues().

◆ startDirDepGraph()

void OutputList::startDirDepGraph ( )
inline

Definition at line 632 of file outputlist.h.

virtual void startDirDepGraph()=0

References OutputGenIntf::startDirDepGraph().

Referenced by DirDefImpl::writeDirectoryGraph().

◆ startDotGraph()

void OutputList::startDotGraph ( )
inline

◆ startDoxyAnchor()

void OutputList::startDoxyAnchor ( const QCString & fName,
const QCString & manName,
const QCString & anchor,
const QCString & name,
const QCString & args )
inline

Definition at line 515 of file outputlist.h.

518 { foreach(&OutputGenIntf::startDoxyAnchor,fName,manName,anchor,name,args); }
virtual void startDoxyAnchor(const QCString &fName, const QCString &manName, const QCString &anchor, const QCString &name, const QCString &args)=0

References OutputGenIntf::startDoxyAnchor().

Referenced by MemberDefImpl::_writeEnumValues(), MemberDefImpl::writeDeclaration(), MemberDefImpl::writeDocumentation(), MemberDefImpl::writeMemberDocSimple(), MemberList::writePlainDeclarations(), and VhdlDocGen::writeVHDLDeclaration().

◆ startEmphasis()

void OutputList::startEmphasis ( )
inline

Definition at line 503 of file outputlist.h.

504 { foreach(&OutputGenIntf::startEmphasis); }
virtual void startEmphasis()=0

References OutputGenIntf::startEmphasis().

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

◆ startExamples()

void OutputList::startExamples ( )
inline

◆ startFile()

void OutputList::startFile ( const QCString & name,
const QCString & manName,
const QCString & title,
int hierarchyLevel = 0 )

Definition at line 194 of file outputlist.cpp.

195{
196 newId();
198 foreach(&OutputGenIntf::startFile,name,manName,title,m_id,hierarchyLevel);
199}
virtual void startFile(const QCString &name, const QCString &manName, const QCString &title, int id, int hierarchyLevel)=0

References m_codeGenList, m_id, newId(), OutputCodeList::setId(), and OutputGenIntf::startFile().

Referenced by startFile(), writeClassMemberIndexFiltered(), writeFileMemberIndexFiltered(), writeIndex(), writeModuleMemberIndexFiltered(), and writeNamespaceMemberIndexFiltered().

◆ startGroupCollaboration()

void OutputList::startGroupCollaboration ( )
inline

Definition at line 636 of file outputlist.h.

virtual void startGroupCollaboration()=0

References OutputGenIntf::startGroupCollaboration().

Referenced by GroupDefImpl::writeGroupGraph().

◆ startGroupHeader()

◆ startHeaderSection()

void OutputList::startHeaderSection ( )
inline

◆ startInclDepGraph()

void OutputList::startInclDepGraph ( )
inline

Definition at line 624 of file outputlist.h.

virtual void startInclDepGraph()=0

References OutputGenIntf::startInclDepGraph().

Referenced by FileDefImpl::writeIncludedByGraph(), and FileDefImpl::writeIncludeGraph().

◆ startIndent()

void OutputList::startIndent ( )
inline

Definition at line 560 of file outputlist.h.

561 { foreach(&OutputGenIntf::startIndent); }
virtual void startIndent()=0

References OutputGenIntf::startIndent().

Referenced by MemberDefImpl::writeDocumentation(), and ClassDefImpl::writeInlineDocumentation().

◆ startIndexItem()

void OutputList::startIndexItem ( const QCString & ref,
const QCString & file )
inline

Definition at line 411 of file outputlist.h.

412 { foreach(&OutputGenIntf::startIndexItem,ref,file); }
virtual void startIndexItem(const QCString &ref, const QCString &file)=0

References OutputGenIntf::startIndexItem().

Referenced by writeClassTreeForList(), writeClassTreeToOutput(), writeDirTreeNode(), writeGroupTreeNode(), and writeModuleTreeNode().

◆ startIndexKey()

void OutputList::startIndexKey ( )
inline

◆ startIndexList()

void OutputList::startIndexList ( )
inline

◆ startIndexListItem()

void OutputList::startIndexListItem ( )
inline

◆ startIndexSection()

void OutputList::startIndexSection ( IndexSection is)
inline

Definition at line 363 of file outputlist.h.

364 { foreach(&OutputGenIntf::startIndexSection,is); }
virtual void startIndexSection(IndexSection is)=0

References OutputGenIntf::startIndexSection().

Referenced by writeIndex().

◆ startIndexValue()

void OutputList::startIndexValue ( bool b)
inline

Definition at line 403 of file outputlist.h.

404 { foreach(&OutputGenIntf::startIndexValue,b); }
virtual void startIndexValue(bool b)=0

References OutputGenIntf::startIndexValue().

Referenced by writeAnnotatedClassList(), writeConceptIndex(), writeNamespaceIndex(), and writeSingleFileIndex().

◆ startInlineHeader()

void OutputList::startInlineHeader ( )
inline

Definition at line 463 of file outputlist.h.

virtual void startInlineHeader()=0

References OutputGenIntf::startInlineHeader().

Referenced by MemberList::writeDeclarations().

◆ startInlineMemberDoc()

void OutputList::startInlineMemberDoc ( )
inline

Definition at line 706 of file outputlist.h.

virtual void startInlineMemberDoc()=0

References OutputGenIntf::startInlineMemberDoc().

Referenced by MemberDefImpl::writeMemberDocSimple().

◆ startInlineMemberName()

void OutputList::startInlineMemberName ( )
inline

Definition at line 702 of file outputlist.h.

virtual void startInlineMemberName()=0

References OutputGenIntf::startInlineMemberName().

Referenced by MemberDefImpl::writeMemberDocSimple().

◆ startInlineMemberType()

void OutputList::startInlineMemberType ( )
inline

Definition at line 698 of file outputlist.h.

virtual void startInlineMemberType()=0

References OutputGenIntf::startInlineMemberType().

Referenced by MemberDefImpl::writeMemberDocSimple().

◆ startItemList()

void OutputList::startItemList ( )
inline

◆ startItemListItem()

void OutputList::startItemListItem ( )
inline

Definition at line 435 of file outputlist.h.

virtual void startItemListItem()=0

References OutputGenIntf::startItemListItem().

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

◆ startLabels()

◆ startMemberDeclaration()

◆ startMemberDescription()

◆ startMemberDoc()

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

Definition at line 509 of file outputlist.h.

512 { foreach(&OutputGenIntf::startMemberDoc,clName,memName,anchor,title,memCount,memTotal,showInline); }
virtual void startMemberDoc(const QCString &clName, const QCString &memName, const QCString &anchor, const QCString &title, int memCount, int memTotal, bool showInline)=0

References OutputGenIntf::startMemberDoc().

Referenced by MemberDefImpl::writeDocumentation(), and ClassDefImpl::writeInlineDocumentation().

◆ startMemberDocList()

void OutputList::startMemberDocList ( )
inline

Definition at line 455 of file outputlist.h.

virtual void startMemberDocList()=0

References OutputGenIntf::startMemberDocList().

Referenced by MemberList::writeDocumentation().

◆ startMemberDocName()

void OutputList::startMemberDocName ( bool align)
inline

Definition at line 652 of file outputlist.h.

virtual void startMemberDocName(bool align)=0
static QCString align(const DocHtmlCell &cell)

References align(), and OutputGenIntf::startMemberDocName().

Referenced by MemberDefImpl::writeDocumentation(), and ClassDefImpl::writeInlineDocumentation().

◆ startMemberDocPrefixItem()

void OutputList::startMemberDocPrefixItem ( )
inline

Definition at line 648 of file outputlist.h.

virtual void startMemberDocPrefixItem()=0

References OutputGenIntf::startMemberDocPrefixItem().

Referenced by MemberDefImpl::writeDocumentation().

◆ startMemberDocSimple()

void OutputList::startMemberDocSimple ( bool b)
inline

Definition at line 694 of file outputlist.h.

virtual void startMemberDocSimple(bool b)=0

References OutputGenIntf::startMemberDocSimple().

Referenced by MemberList::writeSimpleDocumentation().

◆ startMemberGroup()

void OutputList::startMemberGroup ( )
inline

Definition at line 491 of file outputlist.h.

virtual void startMemberGroup()=0

References OutputGenIntf::startMemberGroup().

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

◆ startMemberGroupDocs()

void OutputList::startMemberGroupDocs ( )
inline

◆ startMemberGroupHeader()

void OutputList::startMemberGroupHeader ( bool b)
inline

Definition at line 483 of file outputlist.h.

virtual void startMemberGroupHeader(bool b)=0

References OutputGenIntf::startMemberGroupHeader().

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

◆ startMemberHeader()

◆ startMemberItem()

◆ startMemberList()

◆ startMemberSections()

◆ startMemberSubtitle()

void OutputList::startMemberSubtitle ( )
inline

◆ startMemberTemplateParams()

void OutputList::startMemberTemplateParams ( )
inline

Definition at line 475 of file outputlist.h.

virtual void startMemberTemplateParams()=0

References OutputGenIntf::startMemberTemplateParams().

Referenced by MemberDefImpl::writeDeclaration().

◆ startPageDoc()

void OutputList::startPageDoc ( const QCString & pageTitle)
inline

Definition at line 598 of file outputlist.h.

599 { foreach(&OutputGenIntf::startPageDoc, pageTitle); }
virtual void startPageDoc(const QCString &pageTitle)=0

References OutputGenIntf::startPageDoc().

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

◆ startPageRef()

void OutputList::startPageRef ( )
inline

Definition at line 576 of file outputlist.h.

577 { foreach(&OutputGenIntf::startPageRef); }
virtual void startPageRef()=0

References OutputGenIntf::startPageRef().

Referenced by writePageRef().

◆ startParagraph()

◆ startParameterDefVal()

void OutputList::startParameterDefVal ( const char * separator)
inline

Definition at line 668 of file outputlist.h.

669 { foreach(&OutputGenIntf::startParameterDefVal,separator); }
virtual void startParameterDefVal(const char *separator)=0

References OutputGenIntf::startParameterDefVal().

Referenced by writeDefArgumentList().

◆ startParameterExtra()

void OutputList::startParameterExtra ( )
inline

◆ startParameterList()

void OutputList::startParameterList ( bool openBracket)
inline

Definition at line 672 of file outputlist.h.

673 { foreach(&OutputGenIntf::startParameterList,openBracket); }
virtual void startParameterList(bool openBracket)=0

References OutputGenIntf::startParameterList().

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

◆ startParameterName()

void OutputList::startParameterName ( bool one)
inline

Definition at line 660 of file outputlist.h.

661 { foreach(&OutputGenIntf::startParameterName,one); }
virtual void startParameterName(bool one)=0

References OutputGenIntf::startParameterName().

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

◆ startParameterType()

void OutputList::startParameterType ( bool first,
const QCString & key )
inline

Definition at line 656 of file outputlist.h.

657 { foreach(&OutputGenIntf::startParameterType,first,key); }
virtual void startParameterType(bool first, const QCString &key)=0

References OutputGenIntf::startParameterType().

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

◆ startPlainFile()

void OutputList::startPlainFile ( const QCString & name)
inline

Definition at line 720 of file outputlist.h.

721 { foreach(&OutputGenIntf::startPlainFile,name); }
virtual void startPlainFile(const QCString &name)=0

References OutputGenIntf::startPlainFile().

◆ startProjectNumber()

void OutputList::startProjectNumber ( )
inline

Definition at line 369 of file outputlist.h.

virtual void startProjectNumber()=0

References OutputGenIntf::startProjectNumber().

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

◆ startQuickIndices()

◆ startSection()

void OutputList::startSection ( const QCString & lab,
const QCString & title,
SectionType t )
inline

Definition at line 564 of file outputlist.h.

565 { foreach(&OutputGenIntf::startSection,lab,title,t); }
virtual void startSection(const QCString &lab, const QCString &title, SectionType t)=0

References OutputGenIntf::startSection().

Referenced by writeMemberList(), and GroupDefImpl::writePageDocumentation().

◆ startSmall()

void OutputList::startSmall ( )
inline

Definition at line 533 of file outputlist.h.

534 { foreach(&OutputGenIntf::startSmall); }
virtual void startSmall()=0

References OutputGenIntf::startSmall().

◆ startTextBlock()

◆ startTextLink()

◆ startTitleHead()

void OutputList::startTitleHead ( const QCString & fileName)
inline

Definition at line 381 of file outputlist.h.

382 { foreach(&OutputGenIntf::startTitleHead,fileName); }
virtual void startTitleHead(const QCString &fileName)=0

References OutputGenIntf::startTitleHead().

Referenced by startTitle(), GroupDefImpl::writeDocumentation(), ModuleDefImpl::writeDocumentation(), PageDefImpl::writeDocumentation(), and writeIndex().

◆ startTypewriter()

◆ syncEnabled()

void OutputList::syncEnabled ( )
private

Definition at line 76 of file outputlist.cpp.

77{
78 for (const auto &e : m_outputGenList)
79 {
80 //printf("output %d isEnabled=%d\n",og->type(),og->isEnabled());
81 m_codeGenList.setEnabledFiltered(e.intf->type(),e.enabled);
82 }
83}
void setEnabledFiltered(OutputType o, bool enabled)
Enable or disable a specific generator.
Definition outputlist.h:208

References m_codeGenList, m_outputGenList, and OutputCodeList::setEnabledFiltered().

Referenced by disable(), disableAll(), disableAllBut(), enable(), enableAll(), popGeneratorState(), and pushGeneratorState().

◆ writeAnchor()

◆ writeChar()

void OutputList::writeChar ( char c)
inline

Definition at line 507 of file outputlist.h.

508 { foreach(&OutputGenIntf::writeChar,c); }
virtual void writeChar(char c)=0

References OutputGenIntf::writeChar().

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

◆ writeDoc()

◆ writeFooter()

void OutputList::writeFooter ( const QCString & navPath)
inline

Definition at line 377 of file outputlist.h.

378 { foreach(&OutputGenIntf::writeFooter,navPath); }
virtual void writeFooter(const QCString &navPath)=0

References OutputGenIntf::writeFooter().

Referenced by endFile().

◆ writeGraphicalHierarchy()

void OutputList::writeGraphicalHierarchy ( DotGfxHierarchyTable & g)
inline

Definition at line 640 of file outputlist.h.

virtual void writeGraphicalHierarchy(DotGfxHierarchyTable &g)=0

References OutputGenIntf::writeGraphicalHierarchy().

Referenced by writeGraphicalClassHierarchy(), writeGraphicalExceptionHierarchy(), and writeGraphicalInterfaceHierarchy().

◆ writeInheritedSectionTitle()

void OutputList::writeInheritedSectionTitle ( const QCString & id,
const QCString & ref,
const QCString & file,
const QCString & anchor,
const QCString & title,
const QCString & name )
inline

Definition at line 551 of file outputlist.h.

555 file,anchor,title,name); }
virtual void writeInheritedSectionTitle(const QCString &id, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &title, const QCString &name)=0

References OutputGenIntf::writeInheritedSectionTitle().

Referenced by MemberList::writeDeclarations().

◆ writeLabel()

void OutputList::writeLabel ( const QCString & l,
bool isLast )
inline

◆ writeLatexSpacing()

void OutputList::writeLatexSpacing ( )
inline

Definition at line 523 of file outputlist.h.

virtual void writeLatexSpacing()=0

References OutputGenIntf::writeLatexSpacing().

Referenced by MemberDefImpl::writeDeclaration().

◆ writeLocalToc()

void OutputList::writeLocalToc ( const SectionRefs & refs,
const LocalToc & lt )
inline

Definition at line 716 of file outputlist.h.

717 { foreach(&OutputGenIntf::writeLocalToc,refs,lt); }
virtual void writeLocalToc(const SectionRefs &refs, const LocalToc &lt)=0

References OutputGenIntf::writeLocalToc().

Referenced by DefinitionImpl::writeToc().

◆ writeLogo()

void OutputList::writeLogo ( )
inline

Definition at line 588 of file outputlist.h.

589 { foreach(&OutputGenIntf::writeLogo); }
virtual void writeLogo()=0

References OutputGenIntf::writeLogo().

◆ writeNavigationPath()

void OutputList::writeNavigationPath ( const QCString & s)
inline

Definition at line 586 of file outputlist.h.

virtual void writeNavigationPath(const QCString &s)=0

References OutputGenIntf::writeNavigationPath().

Referenced by DefinitionImpl::writeNavigationPath().

◆ writeNonBreakableSpace()

void OutputList::writeNonBreakableSpace ( int num)
inline

◆ writeObjectLink()

void OutputList::writeObjectLink ( const QCString & ref,
const QCString & file,
const QCString & anchor,
const QCString & name )
inline

Definition at line 417 of file outputlist.h.

419 { foreach(&OutputGenIntf::writeObjectLink,ref,file,anchor,name); }
virtual void writeObjectLink(const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name)=0

References OutputGenIntf::writeObjectLink().

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

◆ writePageLink()

void OutputList::writePageLink ( const QCString & name,
bool first )
inline

Definition at line 367 of file outputlist.h.

368 { foreach(&OutputGenIntf::writePageLink,name,first); }
virtual void writePageLink(const QCString &name, bool first)=0

References OutputGenIntf::writePageLink().

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

◆ writeQuickLinks()

void OutputList::writeQuickLinks ( HighlightedItem hli,
const QCString & file )
inline

Definition at line 590 of file outputlist.h.

591 { foreach(&OutputGenIntf::writeQuickLinks,hli,file); }
virtual void writeQuickLinks(HighlightedItem hli, const QCString &file)=0

References OutputGenIntf::writeQuickLinks().

Referenced by startFile(), writeClassMemberIndexFiltered(), writeFileMemberIndexFiltered(), writeIndex(), writeModuleMemberIndexFiltered(), and writeNamespaceMemberIndexFiltered().

◆ writeRuler()

◆ writeSearchInfo()

◆ writeSplitBar()

void OutputList::writeSplitBar ( const QCString & name)
inline

◆ writeStartAnnoItem()

void OutputList::writeStartAnnoItem ( const QCString & type,
const QCString & file,
const QCString & path,
const QCString & name )
inline

Definition at line 424 of file outputlist.h.

426 { foreach(&OutputGenIntf::writeStartAnnoItem,type,file,path,name); }
virtual void writeStartAnnoItem(const QCString &type, const QCString &file, const QCString &path, const QCString &name)=0

References OutputGenIntf::writeStartAnnoItem().

◆ writeString()

void OutputList::writeString ( const QCString & text)
inline

Definition at line 389 of file outputlist.h.

390 { foreach(&OutputGenIntf::writeString,text); }
virtual void writeString(const QCString &text)=0

References OutputGenIntf::writeString().

Referenced by MemberDefImpl::_writeEnumValues(), DefinitionImpl::_writeSourceRefList(), endFile(), endFileWithNavPath(), endQuickIndexItem(), endQuickIndexList(), recursivelyAddGroupListToTitle(), startQuickIndexItem(), startQuickIndexList(), writeAlphabeticalClassList(), writeAnnotatedClassList(), writeAnnotatedIndexGeneric(), ClassDefImpl::writeAuthorSection(), ClassDefImpl::writeBriefDescription(), ConceptDefImpl::writeBriefDescription(), DirDefImpl::writeBriefDescription(), FileDefImpl::writeBriefDescription(), GroupDefImpl::writeBriefDescription(), ModuleDefImpl::writeBriefDescription(), NamespaceDefImpl::writeBriefDescription(), writeClassLinkForMember(), writeClassMemberIndexFiltered(), VhdlDocGen::writeClassType(), writeConceptIndex(), MemberDefImpl::writeDeclaration(), ClassDefImpl::writeDeclarationLink(), ConceptDefImpl::writeDeclarationLink(), ModuleDefImpl::writeDeclarationLink(), ConceptDefImpl::writeDetailedDescription(), DirDefImpl::writeDetailedDescription(), FileDefImpl::writeDetailedDescription(), GroupDefImpl::writeDetailedDescription(), ModuleDefImpl::writeDetailedDescription(), NamespaceDefImpl::writeDetailedDescription(), ClassDefImpl::writeDetailedDocumentationBody(), DirRelation::writeDocumentation(), GroupDefImpl::writeDocumentation(), MemberDefImpl::writeDocumentation(), ModuleDefImpl::writeDocumentation(), PageDefImpl::writeDocumentation(), MemberList::writeDocumentationPage(), MemberDefImpl::writeEnumDeclaration(), writeExamples(), writeFileIndex(), writeFileLinkForMember(), DirDefImpl::writeFileList(), writeFileMemberIndexFiltered(), writeHierarchicalExceptionIndex(), writeHierarchicalIndex(), writeHierarchicalInterfaceIndex(), writeIndex(), ClassDefImpl::writeInlineDocumentation(), MemberDefImpl::writeMemberDocSimple(), ClassDefImpl::writeMemberList(), writeModuleIndex(), writeModuleLinkForMember(), writeModuleMemberIndexFiltered(), ClassDefImpl::writeMoreLink(), writeNamespaceIndex(), writeNamespaceLinkForMember(), writeNamespaceMemberIndexFiltered(), PageDefImpl::writePageDocumentation(), writePageIndex(), writePartialDirPath(), writePartialFilePath(), MemberList::writePlainDeclarations(), writeQuickMemberIndex(), ClassDefImpl::writeQuickMemberLinks(), FileDefImpl::writeQuickMemberLinks(), GroupDefImpl::writeQuickMemberLinks(), NamespaceDefImpl::writeQuickMemberLinks(), FileDefImpl::writeSourceHeader(), DirDefImpl::writeSubDirList(), ClassDefImpl::writeSummaryLinks(), FileDefImpl::writeSummaryLinks(), GroupDefImpl::writeSummaryLinks(), ModuleDefImpl::writeSummaryLinks(), NamespaceDefImpl::writeSummaryLinks(), writeTopicIndex(), writeUCFLink(), and writeUserGroupStubPage().

◆ writeStyleInfo()

void OutputList::writeStyleInfo ( int part)
inline

Definition at line 373 of file outputlist.h.

374 { foreach(&OutputGenIntf::writeStyleInfo,part); }
virtual void writeStyleInfo(int part)=0

References OutputGenIntf::writeStyleInfo().

Referenced by generateOutput().

◆ writeSummaryLink()

void OutputList::writeSummaryLink ( const QCString & file,
const QCString & anchor,
const QCString & title,
bool first )
inline

Definition at line 592 of file outputlist.h.

593 { foreach(&OutputGenIntf::writeSummaryLink,file,anchor,title,first); }
virtual void writeSummaryLink(const QCString &file, const QCString &anchor, const QCString &title, bool first)=0

References OutputGenIntf::writeSummaryLink().

Referenced by ClassDefImpl::writeSummaryLinks(), FileDefImpl::writeSummaryLinks(), GroupDefImpl::writeSummaryLinks(), ModuleDefImpl::writeSummaryLinks(), and NamespaceDefImpl::writeSummaryLinks().

◆ writeSynopsis()

Member Data Documentation

◆ m_codeGenList

OutputCodeList OutputList::m_codeGenList
private

◆ m_id

int OutputList::m_id
private

◆ m_outputGenList


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