Doxygen
BaseOutputDocInterface类 参考abstract

Base Interface used for generating output outside of the comment blocks. 更多...

#include <outputgen.h>

+ 类 BaseOutputDocInterface 继承关系图:
+ BaseOutputDocInterface 的协作图:

Public 类型

enum  ParamListTypes { Param, RetVal, Exception }
 
enum  SectionTypes { EnumValues, Examples }
 

Public 成员函数

virtual ~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 成员函数 继承自 CodeOutputInterface
virtual ~CodeOutputInterface ()
 
 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
 

详细描述

Base Interface used for generating output outside of the comment blocks.

This abstract class is used by output generation functions to generate the output for a specific format, or a list of formats (see OutputList). This interface contains functions that generate fragments of the output.

在文件 outputgen.h161 行定义.

成员枚举类型说明

◆ ParamListTypes

枚举值
Param 
RetVal 
Exception 

在文件 outputgen.h165 行定义.

165 { Param, RetVal, Exception };

◆ SectionTypes

枚举值
EnumValues 
Examples 

在文件 outputgen.h166 行定义.

166  { /*See, Return, Author, Version,
167  Since, Date, Bug, Note,
168  Warning, Par, Deprecated, Pre,
169  Post, Invar, Remark, Attention,
170  Todo, Test, RCS, */
171  EnumValues,
172  Examples
173  };

构造及析构函数说明

◆ ~BaseOutputDocInterface()

virtual BaseOutputDocInterface::~BaseOutputDocInterface ( )
inlinevirtual

在文件 outputgen.h164 行定义.

164 {}

成员函数说明

◆ addIndexItem()

virtual void BaseOutputDocInterface::addIndexItem ( const QCString s1,
const QCString s2 
)
pure virtual

◆ docify()

virtual void BaseOutputDocInterface::docify ( const QCString s)
pure virtual

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

DocbookGenerator, LatexGenerator, HtmlGenerator, RTFGenerator, ManGenerator , 以及 OutputList 内被实现.

被这些函数引用 OutputList::docify(), generateFileRef(), generateLink(), writePageRef() , 以及 TextGeneratorOLImpl::writeString().

◆ endBold()

virtual void BaseOutputDocInterface::endBold ( )
pure virtual

End a section of text displayed in bold face.

OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.

被这些函数引用 OutputList::endBold().

◆ endCenter()

virtual void BaseOutputDocInterface::endCenter ( )
pure virtual

◆ endDescForItem()

virtual void BaseOutputDocInterface::endDescForItem ( )
pure virtual

◆ endDescItem()

virtual void BaseOutputDocInterface::endDescItem ( )
pure virtual

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

OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.

被这些函数引用 OutputList::endDescItem().

◆ endDescription()

virtual void BaseOutputDocInterface::endDescription ( )
pure virtual

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

OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.

被这些函数引用 OutputList::endDescription().

◆ endDescTable()

virtual void BaseOutputDocInterface::endDescTable ( )
pure virtual

◆ endDescTableData()

virtual void BaseOutputDocInterface::endDescTableData ( )
pure virtual

◆ endDescTableRow()

virtual void BaseOutputDocInterface::endDescTableRow ( )
pure virtual

◆ endDescTableTitle()

virtual void BaseOutputDocInterface::endDescTableTitle ( )
pure virtual

◆ endEmphasis()

virtual void BaseOutputDocInterface::endEmphasis ( )
pure virtual

Ends a section of text displayed in italic.

OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.

被这些函数引用 OutputList::endEmphasis().

◆ endExamples()

virtual void BaseOutputDocInterface::endExamples ( )
pure virtual

◆ endHtmlLink()

virtual void BaseOutputDocInterface::endHtmlLink ( )
pure virtual

Ends a link started by startHtmlLink().

DocbookGenerator, LatexGenerator, HtmlGenerator, OutputList, RTFGenerator , 以及 ManGenerator 内被实现.

被这些函数引用 OutputList::endHtmlLink().

◆ endItemList()

virtual void BaseOutputDocInterface::endItemList ( )
pure virtual

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

DocbookGenerator, LatexGenerator, HtmlGenerator, OutputList, RTFGenerator , 以及 ManGenerator 内被实现.

被这些函数引用 OutputList::endItemList().

◆ endItemListItem()

virtual void BaseOutputDocInterface::endItemListItem ( )
pure virtual

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

LatexGenerator, OutputList, HtmlGenerator, DocbookGenerator, ManGenerator , 以及 RTFGenerator 内被实现.

被这些函数引用 OutputList::endItemListItem().

◆ endPageRef()

virtual void BaseOutputDocInterface::endPageRef ( const QCString ,
const QCString  
)
pure virtual

◆ endParagraph()

virtual void BaseOutputDocInterface::endParagraph ( )
pure virtual

Ends a paragraph

DocbookGenerator, LatexGenerator, HtmlGenerator, OutputList, RTFGenerator , 以及 ManGenerator 内被实现.

被这些函数引用 OutputList::endParagraph().

◆ endParamList()

virtual void BaseOutputDocInterface::endParamList ( )
pure virtual

◆ endSection()

virtual void BaseOutputDocInterface::endSection ( const QCString ,
SectionType   
)
pure virtual

◆ endSmall()

virtual void BaseOutputDocInterface::endSmall ( )
pure virtual

◆ endSubsection()

virtual void BaseOutputDocInterface::endSubsection ( )
pure virtual

◆ endSubsubsection()

virtual void BaseOutputDocInterface::endSubsubsection ( )
pure virtual

◆ endTextLink()

virtual void BaseOutputDocInterface::endTextLink ( )
pure virtual

◆ endTitle()

virtual void BaseOutputDocInterface::endTitle ( )
pure virtual

◆ endTypewriter()

virtual void BaseOutputDocInterface::endTypewriter ( )
pure virtual

End a section of text displayed in typewriter style.

DocbookGenerator, LatexGenerator, OutputList, HtmlGenerator, RTFGenerator , 以及 ManGenerator 内被实现.

被这些函数引用 OutputList::endTypewriter().

◆ lineBreak()

virtual void BaseOutputDocInterface::lineBreak ( const QCString style)
pure virtual

◆ parseText()

virtual void BaseOutputDocInterface::parseText ( const QCString )
inlinevirtual

OutputList 重载.

在文件 outputgen.h175 行定义.

175 {}

◆ startBold()

virtual void BaseOutputDocInterface::startBold ( )
pure virtual

Changes the text font to bold face. The bold section ends with endBold()

OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.

被这些函数引用 OutputList::startBold().

◆ startCenter()

virtual void BaseOutputDocInterface::startCenter ( )
pure virtual

◆ startDescForItem()

virtual void BaseOutputDocInterface::startDescForItem ( )
pure virtual

◆ startDescItem()

virtual void BaseOutputDocInterface::startDescItem ( )
pure virtual

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

OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.

被这些函数引用 OutputList::startDescItem().

◆ startDescription()

virtual void BaseOutputDocInterface::startDescription ( )
pure virtual

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

OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.

被这些函数引用 OutputList::startDescription().

◆ startDescTable()

virtual void BaseOutputDocInterface::startDescTable ( const QCString title)
pure virtual

◆ startDescTableData()

virtual void BaseOutputDocInterface::startDescTableData ( )
pure virtual

◆ startDescTableRow()

virtual void BaseOutputDocInterface::startDescTableRow ( )
pure virtual

◆ startDescTableTitle()

virtual void BaseOutputDocInterface::startDescTableTitle ( )
pure virtual

◆ startEmphasis()

virtual void BaseOutputDocInterface::startEmphasis ( )
pure virtual

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

OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.

被这些函数引用 OutputList::startEmphasis().

◆ startExamples()

virtual void BaseOutputDocInterface::startExamples ( )
pure virtual

◆ startHtmlLink()

virtual void BaseOutputDocInterface::startHtmlLink ( const QCString url)
pure virtual

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

参数
urlThe URL to link to.

LatexGenerator, HtmlGenerator, OutputList, RTFGenerator, ManGenerator , 以及 DocbookGenerator 内被实现.

被这些函数引用 OutputList::startHtmlLink().

◆ startItemList()

virtual void BaseOutputDocInterface::startItemList ( )
pure virtual

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

DocbookGenerator, LatexGenerator, HtmlGenerator, OutputList, RTFGenerator , 以及 ManGenerator 内被实现.

被这些函数引用 OutputList::startItemList().

◆ startItemListItem()

virtual void BaseOutputDocInterface::startItemListItem ( )
pure virtual

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

LatexGenerator, OutputList, HtmlGenerator, DocbookGenerator, ManGenerator , 以及 RTFGenerator 内被实现.

被这些函数引用 OutputList::startItemListItem().

◆ startPageRef()

virtual void BaseOutputDocInterface::startPageRef ( )
pure virtual

◆ startParagraph()

virtual void BaseOutputDocInterface::startParagraph ( const QCString classDef)
pure virtual

Starts a new paragraph

Starts a new paragraph

OutputList, LatexGenerator, HtmlGenerator, RTFGenerator, ManGenerator , 以及 DocbookGenerator 内被实现.

被这些函数引用 OutputList::startParagraph().

◆ startParamList()

virtual void BaseOutputDocInterface::startParamList ( ParamListTypes  t,
const QCString title 
)
pure virtual

◆ startSection()

virtual void BaseOutputDocInterface::startSection ( const QCString ,
const QCString ,
SectionType   
)
pure virtual

◆ startSmall()

virtual void BaseOutputDocInterface::startSmall ( )
pure virtual

◆ startSubsection()

virtual void BaseOutputDocInterface::startSubsection ( )
pure virtual

◆ startSubsubsection()

virtual void BaseOutputDocInterface::startSubsubsection ( )
pure virtual

◆ startTextLink()

virtual void BaseOutputDocInterface::startTextLink ( const QCString file,
const QCString anchor 
)
pure virtual

◆ startTitle()

virtual void BaseOutputDocInterface::startTitle ( )
pure virtual

◆ startTypewriter()

virtual void BaseOutputDocInterface::startTypewriter ( )
pure virtual

Changes the text font to fixed size. The section ends with endTypewriter()

DocbookGenerator, LatexGenerator, HtmlGenerator, OutputList, RTFGenerator , 以及 ManGenerator 内被实现.

被这些函数引用 OutputList::startTypewriter().

◆ writeAnchor()

virtual void BaseOutputDocInterface::writeAnchor ( const QCString fileName,
const QCString name 
)
pure virtual

◆ writeChar()

virtual void BaseOutputDocInterface::writeChar ( char  c)
pure virtual

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

DocbookGenerator, OutputList, HtmlGenerator, LatexGenerator, RTFGenerator , 以及 ManGenerator 内被实现.

被这些函数引用 OutputList::writeChar().

◆ writeNonBreakableSpace()

virtual void BaseOutputDocInterface::writeNonBreakableSpace ( int  )
pure virtual

◆ writeObjectLink()

virtual void BaseOutputDocInterface::writeObjectLink ( const QCString ref,
const QCString file,
const QCString anchor,
const QCString name 
)
pure virtual

Writes a link to an object in the documentation.

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

LatexGenerator, HtmlGenerator, OutputList, RTFGenerator, ManGenerator , 以及 DocbookGenerator 内被实现.

被这些函数引用 generateFileRef(), generateLink(), TextGeneratorOLImpl::writeLink() , 以及 OutputList::writeObjectLink().

◆ writeRuler()

virtual void BaseOutputDocInterface::writeRuler ( )
pure virtual

Writes a horizontal ruler to the output

OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, ManGenerator , 以及 RTFGenerator 内被实现.

被这些函数引用 OutputList::writeRuler().

◆ writeString()

virtual void BaseOutputDocInterface::writeString ( const QCString text)
pure virtual

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

LatexGenerator, HtmlGenerator, OutputList, RTFGenerator, ManGenerator , 以及 DocbookGenerator 内被实现.

被这些函数引用 OutputList::writeString().


该类的文档由以下文件生成:
BaseOutputDocInterface::Exception
@ Exception
Definition: outputgen.h:165
BaseOutputDocInterface::Param
@ Param
Definition: outputgen.h:165
BaseOutputDocInterface::Examples
@ Examples
Definition: outputgen.h:172
BaseOutputDocInterface::EnumValues
@ EnumValues
Definition: outputgen.h:171
BaseOutputDocInterface::RetVal
@ RetVal
Definition: outputgen.h:165