Classes | Public Types | Public Member Functions | List of all members
OutputList Class Reference

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

#include <outputlist.h>

Public Types

using OutputGenVariant = std::variant< HtmlGenerator, LatexGenerator, ManGenerator, RTFGenerator, DocbookGenerator >

Public Member Functions

 OutputList (const OutputList &ol)
OutputListoperator= (const OutputList &ol)
 OutputList (OutputList &&)=delete
OutputListoperator= (OutputList &&)=delete
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)
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 startTitle ()
void endTitle ()
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 startHtmlLink (const QCString &url)
void endHtmlLink ()
void writeStartAnnoItem (const QCString &type, const QCString &file, const QCString &path, const QCString &name)
void writeEndAnnoItem (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 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 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 startParamList (OutputGenerator::ParamListTypes t, const QCString &title)
void endParamList ()
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 (bool compact, 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 (bool last, bool one, bool bracket)
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 ()

Detailed Description

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

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