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

Class representing a list of different code generators. More...

#include <outputlist.h>

Public Types

using OutputCodeVariant = std::variant< HtmlCodeGenerator, HtmlCodeGeneratorDefer, LatexCodeGenerator, LatexCodeGeneratorDefer, RTFCodeGenerator, RTFCodeGeneratorDefer, ManCodeGenerator, ManCodeGeneratorDefer, DocbookCodeGenerator, DocbookCodeGeneratorDefer, XMLCodeGenerator, DevNullCodeGenerator, OutputCodeDeferExtension >
 

Public Member Functions

int id () const
 
void setId (int id)
 
void add (OutputCodeVariant &&v)
 Add a code generator already wrapped in a variant type. More...
 
template<class T , class... As>
T * add (As &&... args)
 Add a code generator to the list, using a syntax similar to std::make_unique<T>()
 
template<class T >
T * get ()
 Returns a pointer to a specific generator in the list.
 
void setEnabledFiltered (OutputType o, bool enabled)
 Enable or disable a specific generator.
 
void clear ()
 
void codify (const QCString &s)
 
void writeCodeLink (CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip)
 
void writeLineNumber (const QCString &ref, const QCString &file, const QCString &anchor, int lineNumber, bool writeLineAnchor)
 
void writeTooltip (const QCString &id, const DocLinkInfo &docInfo, const QCString &decl, const QCString &desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo)
 
void startCodeLine (bool hasLineNumbers)
 
void endCodeLine ()
 
void startFontClass (const QCString &c)
 
void endFontClass ()
 
void writeCodeAnchor (const QCString &name)
 
void startCodeFragment (const QCString &style)
 
void endCodeFragment (const QCString &style)
 

Detailed Description

Class representing a list of different code generators.

It offers the same interface as the specific code generators, and will forward each method to all generators that are enabled.

Member Function Documentation

◆ add()

void OutputCodeList::add ( OutputCodeVariant &&  v)
inline

Add a code generator already wrapped in a variant type.


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