Interface used for generating documentation. 更多...

#include <outputgen.h>

类 OutputDocInterface 继承关系图:

OutputDocInterface 的协作图:

Public 成员函数
virtual	~OutputDocInterface ()

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 成员函数继承自 BaseOutputDocInterface
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

额外继承的成员函数
Public 类型继承自 BaseOutputDocInterface
enum	ParamListTypes { Param, RetVal, Exception }

enum	SectionTypes { EnumValues, Examples }

详细描述

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.

在文件 outputgen.h 第 527 行定义.

构造及析构函数说明

◆ ~OutputDocInterface()

virtual OutputDocInterface::~OutputDocInterface ( )

inlinevirtual

在文件 outputgen.h 第 530 行定义.

530 {}

成员函数说明

◆ disable()

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

pure virtual

Disables a specific output format (useful for OutputList only)

在 OutputList 内被实现.

被这些函数引用 writePageRef().

◆ disableAll()

virtual void OutputDocInterface::disableAll ( )

pure virtual

Disables all output formats (useful for OutputList only)

在 OutputList 内被实现.

◆ disableAllBut()

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

pure virtual

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

在 OutputList 内被实现.

◆ enable()

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

pure virtual

Enables a specific output format (useful for OutputList only)

在 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)

在 OutputList 内被实现.

◆ isEnabled()

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

pure virtual

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

在 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().

在 OutputList 内被实现.

被这些函数引用 writePageRef().

◆ 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.

在 OutputList 内被实现.

被这些函数引用 writePageRef().

该类的文档由以下文件生成:

src/outputgen.h

Public 成员函数

额外继承的成员函数

详细描述

构造及析构函数说明

◆ ~OutputDocInterface()

成员函数说明

◆ disable()

◆ disableAll()

◆ disableAllBut()

◆ enable()

◆ enableAll()

◆ isEnabled()

◆ popGeneratorState()

◆ pushGeneratorState()