doxygen
Public Member Functions | List of all members
OutputDocInterface Class Referenceabstract

Interface used for generating documentation. More...

#include <outputgen.h>

Inheritance diagram for OutputDocInterface:
Inheritance graph
[legend]
Collaboration diagram for OutputDocInterface:
Collaboration graph
[legend]

Public Member Functions

virtual void disableAllBut (OutputGenerator::OutputType o)=0
 
virtual void enableAll ()=0
 
virtual void disableAll ()=0
 
virtual void disable (OutputGenerator::OutputType o)=0
 
virtual void enable (OutputGenerator::OutputType o)=0
 
virtual bool isEnabled (OutputGenerator::OutputType o)=0
 
virtual void pushGeneratorState ()=0
 
virtual void popGeneratorState ()=0
 
- Public Member Functions inherited from BaseOutputDocInterface
virtual void parseText (const QCString &)
 
virtual void startItemList ()=0
 
virtual void startItemListItem ()=0
 
virtual void endItemListItem ()=0
 
virtual void endItemList ()=0
 
virtual void docify (const QCString &s)=0
 
virtual void writeChar (char c)=0
 
virtual void writeString (const QCString &text)=0
 
virtual void startParagraph (const QCString &classDef)=0
 
virtual void endParagraph ()=0
 
virtual void writeObjectLink (const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name)=0
 
virtual void startHtmlLink (const QCString &url)=0
 
virtual void endHtmlLink ()=0
 
virtual void startBold ()=0
 
virtual void endBold ()=0
 
virtual void startTypewriter ()=0
 
virtual void endTypewriter ()=0
 
virtual void startEmphasis ()=0
 
virtual void endEmphasis ()=0
 
virtual void writeRuler ()=0
 
virtual void startDescription ()=0
 
virtual void endDescription ()=0
 
virtual void startDescItem ()=0
 
virtual void startDescForItem ()=0
 
virtual void endDescForItem ()=0
 
virtual void endDescItem ()=0
 
virtual void startCenter ()=0
 
virtual void endCenter ()=0
 
virtual void startSmall ()=0
 
virtual void endSmall ()=0
 
virtual void startExamples ()=0
 
virtual void endExamples ()=0
 
virtual void startParamList (ParamListTypes t, const QCString &title)=0
 
virtual void endParamList ()=0
 
virtual void startTitle ()=0
 
virtual void endTitle ()=0
 
virtual void writeAnchor (const QCString &fileName, const QCString &name)=0
 
virtual void startSection (const QCString &, const QCString &, SectionType)=0
 
virtual void endSection (const QCString &, SectionType)=0
 
virtual void lineBreak (const QCString &style)=0
 
virtual void addIndexItem (const QCString &s1, const QCString &s2)=0
 
virtual void writeNonBreakableSpace (int)=0
 
virtual void startDescTable (const QCString &title)=0
 
virtual void endDescTable ()=0
 
virtual void startDescTableRow ()=0
 
virtual void endDescTableRow ()=0
 
virtual void startDescTableTitle ()=0
 
virtual void endDescTableTitle ()=0
 
virtual void startDescTableData ()=0
 
virtual void endDescTableData ()=0
 
virtual void startTextLink (const QCString &file, const QCString &anchor)=0
 
virtual void endTextLink ()=0
 
virtual void startPageRef ()=0
 
virtual void endPageRef (const QCString &, const QCString &)=0
 
virtual void startSubsection ()=0
 
virtual void endSubsection ()=0
 
virtual void startSubsubsection ()=0
 
virtual void endSubsubsection ()=0
 
- Public Member Functions inherited from CodeOutputInterface
 CodeOutputInterface (const CodeOutputInterface &)=delete
 
CodeOutputInterfaceoperator= (const CodeOutputInterface &)=delete
 
virtual int id () const
 Identifier for the output file.
 
virtual void codify (const QCString &s)=0
 
virtual void writeCodeLink (CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip)=0
 
virtual void writeLineNumber (const QCString &ref, const QCString &file, const QCString &anchor, int lineNumber, bool writeLineAnchor)=0
 
virtual void writeTooltip (const QCString &id, const DocLinkInfo &docInfo, const QCString &decl, const QCString &desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo)=0
 
virtual void startCodeLine (bool hasLineNumbers)=0
 
virtual void endCodeLine ()=0
 
virtual void startFontClass (const QCString &clsName)=0
 
virtual void endFontClass ()=0
 
virtual void writeCodeAnchor (const QCString &name)=0
 
virtual void setCurrentDoc (const Definition *context, const QCString &anchor, bool isSourceFile)=0
 
virtual void addWord (const QCString &word, bool hiPriority)=0
 
virtual void startCodeFragment (const QCString &style)=0
 
virtual void endCodeFragment (const QCString &style)=0
 

Additional Inherited Members

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

Detailed Description

Interface used for generating documentation.

This abstract class is used by several functions to generate the output for a specific format. This interface contains some state saving and changing functions for dealing with format specific output.

Member Function Documentation

◆ disable()

virtual void OutputDocInterface::disable ( OutputGenerator::OutputType  o)
pure virtual

Disables a specific output format (useful for OutputList only)

Implemented in OutputList.

◆ disableAll()

virtual void OutputDocInterface::disableAll ( )
pure virtual

Disables all output formats (useful for OutputList only)

Implemented in OutputList.

◆ disableAllBut()

virtual void OutputDocInterface::disableAllBut ( OutputGenerator::OutputType  o)
pure virtual

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

Implemented in OutputList.

◆ enable()

virtual void OutputDocInterface::enable ( OutputGenerator::OutputType  o)
pure virtual

Enables a specific output format (useful for OutputList only)

Implemented in OutputList.

◆ enableAll()

virtual void OutputDocInterface::enableAll ( )
pure virtual

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

Implemented in OutputList.

◆ isEnabled()

virtual bool OutputDocInterface::isEnabled ( OutputGenerator::OutputType  o)
pure virtual

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

Implemented in OutputList.

◆ popGeneratorState()

virtual void OutputDocInterface::popGeneratorState ( )
pure virtual

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

Implemented in OutputList.

◆ pushGeneratorState()

virtual void OutputDocInterface::pushGeneratorState ( )
pure 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.

Implemented in OutputList.


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