Doxygen
|
Base Interface used for generating output outside of the comment blocks. 更多...
#include <outputgen.h>
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 | |
CodeOutputInterface & | operator= (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.h 第 161 行定义.
|
inlinevirtual |
在文件 outputgen.h 第 164 行定义.
|
pure virtual |
在 OutputList, LatexGenerator, HtmlGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::addIndexItem().
|
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().
|
pure virtual |
End a section of text displayed in bold face.
在 OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::endBold().
|
pure virtual |
在 OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::endCenter().
|
pure virtual |
在 OutputList, LatexGenerator, HtmlGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::endDescForItem().
|
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().
|
pure virtual |
Ends a description list: e.g. </dl>
in HTML
在 OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::endDescription().
|
pure virtual |
在 OutputList, HtmlGenerator, LatexGenerator, RTFGenerator, ManGenerator , 以及 DocbookGenerator 内被实现.
被这些函数引用 OutputList::endDescTable().
|
pure virtual |
在 OutputList, HtmlGenerator, LatexGenerator, RTFGenerator, ManGenerator , 以及 DocbookGenerator 内被实现.
被这些函数引用 OutputList::endDescTableData().
|
pure virtual |
在 OutputList, HtmlGenerator, LatexGenerator, RTFGenerator, ManGenerator , 以及 DocbookGenerator 内被实现.
被这些函数引用 OutputList::endDescTableRow().
|
pure virtual |
在 OutputList, HtmlGenerator, LatexGenerator, RTFGenerator, ManGenerator , 以及 DocbookGenerator 内被实现.
被这些函数引用 OutputList::endDescTableTitle().
|
pure virtual |
Ends a section of text displayed in italic.
在 OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::endEmphasis().
|
pure virtual |
在 OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::endExamples().
|
pure virtual |
Ends a link started by startHtmlLink().
在 DocbookGenerator, LatexGenerator, HtmlGenerator, OutputList, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::endHtmlLink().
|
pure virtual |
Ends a bullet list: e.g. </ul>
in html
在 DocbookGenerator, LatexGenerator, HtmlGenerator, OutputList, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::endItemList().
|
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().
|
pure virtual |
在 OutputList, LatexGenerator, HtmlGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::endPageRef() , 以及 writePageRef().
|
pure virtual |
Ends a paragraph
在 DocbookGenerator, LatexGenerator, HtmlGenerator, OutputList, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::endParagraph().
|
pure virtual |
在 OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::endParamList().
|
pure virtual |
在 OutputList, LatexGenerator, HtmlGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::endSection().
|
pure virtual |
在 OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::endSmall().
|
pure virtual |
在 OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::endSubsection().
|
pure virtual |
在 OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::endSubsubsection().
|
pure virtual |
在 DocbookGenerator, LatexGenerator, HtmlGenerator, OutputList, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::endTextLink().
|
pure virtual |
在 DocbookGenerator, LatexGenerator, HtmlGenerator, OutputList, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::endTitle().
|
pure virtual |
End a section of text displayed in typewriter style.
在 DocbookGenerator, LatexGenerator, OutputList, HtmlGenerator, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::endTypewriter().
|
pure virtual |
在 OutputList, LatexGenerator, RTFGenerator, HtmlGenerator, DocbookGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::lineBreak() , 以及 TextGeneratorOLImpl::writeBreak().
|
inlinevirtual |
|
pure virtual |
Changes the text font to bold face. The bold section ends with endBold()
在 OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::startBold().
|
pure virtual |
在 OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::startCenter().
|
pure virtual |
在 OutputList, LatexGenerator, HtmlGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::startDescForItem().
|
pure virtual |
Starts an item of a description list: e.g. <dt>
in HTML.
在 OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::startDescItem().
|
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().
|
pure virtual |
在 OutputList, HtmlGenerator, LatexGenerator, RTFGenerator, ManGenerator , 以及 DocbookGenerator 内被实现.
被这些函数引用 OutputList::startDescTable().
|
pure virtual |
在 OutputList, HtmlGenerator, LatexGenerator, RTFGenerator, ManGenerator , 以及 DocbookGenerator 内被实现.
被这些函数引用 OutputList::startDescTableData().
|
pure virtual |
在 OutputList, HtmlGenerator, LatexGenerator, RTFGenerator, ManGenerator , 以及 DocbookGenerator 内被实现.
被这些函数引用 OutputList::startDescTableRow().
|
pure virtual |
在 OutputList, HtmlGenerator, LatexGenerator, RTFGenerator, ManGenerator , 以及 DocbookGenerator 内被实现.
被这些函数引用 OutputList::startDescTableTitle().
|
pure virtual |
Changes the text font to italic. The italic section ends with endEmphasis()
在 OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::startEmphasis().
|
pure virtual |
在 OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::startExamples().
|
pure virtual |
Starts a (link to an) URL found in the documentation.
url | The URL to link to. |
在 LatexGenerator, HtmlGenerator, OutputList, RTFGenerator, ManGenerator , 以及 DocbookGenerator 内被实现.
被这些函数引用 OutputList::startHtmlLink().
|
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().
|
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().
|
pure virtual |
在 OutputList, LatexGenerator, HtmlGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::startPageRef() , 以及 writePageRef().
|
pure virtual |
Starts a new paragraph
Starts a new paragraph
在 OutputList, LatexGenerator, HtmlGenerator, RTFGenerator, ManGenerator , 以及 DocbookGenerator 内被实现.
被这些函数引用 OutputList::startParagraph().
|
pure virtual |
在 LatexGenerator, ManGenerator, HtmlGenerator, RTFGenerator, OutputList , 以及 DocbookGenerator 内被实现.
被这些函数引用 OutputList::startParamList().
|
pure virtual |
在 OutputList, LatexGenerator, HtmlGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::startSection().
|
pure virtual |
在 OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::startSmall().
|
pure virtual |
在 OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::startSubsection().
|
pure virtual |
在 OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::startSubsubsection().
|
pure virtual |
在 HtmlGenerator, OutputList, RTFGenerator, DocbookGenerator, LatexGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::startTextLink().
|
pure virtual |
在 DocbookGenerator, LatexGenerator, HtmlGenerator, OutputList, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::startTitle().
|
pure virtual |
Changes the text font to fixed size. The section ends with endTypewriter()
在 DocbookGenerator, LatexGenerator, HtmlGenerator, OutputList, RTFGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::startTypewriter().
|
pure virtual |
在 OutputList, LatexGenerator, RTFGenerator, HtmlGenerator, DocbookGenerator , 以及 ManGenerator 内被实现.
被这些函数引用 OutputList::writeAnchor().
|
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().
|
pure virtual |
|
pure virtual |
Writes a link to an object in the documentation.
ref | If this is non-zero, the object is to be found in an external documentation file. |
file | The file in which the object is located. |
anchor | The anchor uniquely identifying the object within the file. |
name | The text to display as a placeholder for the link. |
在 LatexGenerator, HtmlGenerator, OutputList, RTFGenerator, ManGenerator , 以及 DocbookGenerator 内被实现.
被这些函数引用 generateFileRef(), generateLink(), TextGeneratorOLImpl::writeLink() , 以及 OutputList::writeObjectLink().
|
pure virtual |
Writes a horizontal ruler to the output
在 OutputList, HtmlGenerator, LatexGenerator, DocbookGenerator, ManGenerator , 以及 RTFGenerator 内被实现.
被这些函数引用 OutputList::writeRuler().
|
pure virtual |
Writes an ASCII string to the output, without converting special characters.
在 LatexGenerator, HtmlGenerator, OutputList, RTFGenerator, ManGenerator , 以及 DocbookGenerator 内被实现.
被这些函数引用 OutputList::writeString().