DevNullCodeDocInterface类 参考

Class implementing CodeOutputInterface by throwing away everything. 更多...

类 DevNullCodeDocInterface 继承关系图:

DevNullCodeDocInterface 的协作图:

Public 成员函数
virtual void	codify (const QCString &) override
virtual void	writeCodeLink (CodeSymbolType, const QCString &, const QCString &, const QCString &, const QCString &, const QCString &) override
virtual void	writeTooltip (const QCString &, const DocLinkInfo &, const QCString &, const QCString &, const SourceLinkInfo &, const SourceLinkInfo &) override
virtual void	writeLineNumber (const QCString &, const QCString &, const QCString &, int, bool) override
virtual void	startCodeLine (bool) override
virtual void	endCodeLine () override
virtual void	startFontClass (const QCString &) override
virtual void	endFontClass () override
virtual void	writeCodeAnchor (const QCString &) override
virtual void	setCurrentDoc (const Definition *, const QCString &, bool) override
virtual void	addWord (const QCString &, bool) override
virtual void	startCodeFragment (const QCString &) override
virtual void	endCodeFragment (const QCString &) override
Public 成员函数 继承自 CodeOutputInterface
virtual	~CodeOutputInterface ()
	CodeOutputInterface ()
	CodeOutputInterface (const CodeOutputInterface &)=delete
CodeOutputInterface &	operator= (const CodeOutputInterface &)=delete
virtual int	id () const
	Identifier for the output file 更多...

详细描述

Class implementing CodeOutputInterface by throwing away everything.

在文件 filedef.cpp 第 199 行定义.

成员函数说明

addWord()

virtual void DevNullCodeDocInterface::addWord ( const QCString &  , bool    )

inlineoverridevirtual

实现了 CodeOutputInterface.

在文件 filedef.cpp 第 218 行定义.

{}

codify()

virtual void DevNullCodeDocInterface::codify ( const QCString &  s )

inlineoverridevirtual

Writes an code fragment to the output. This function should keep spaces visible, should break lines at a newline and should convert tabs to the right number of spaces.

实现了 CodeOutputInterface.

在文件 filedef.cpp 第 202 行定义.

{}

endCodeFragment()

virtual void DevNullCodeDocInterface::endCodeFragment ( const QCString &  style )

inlineoverridevirtual

Ends a block of code

实现了 CodeOutputInterface.

在文件 filedef.cpp 第 220 行定义.

{}

endCodeLine()

virtual void DevNullCodeDocInterface::endCodeLine ( )

inlineoverridevirtual

Ends a line of code started with startCodeLine()

实现了 CodeOutputInterface.

在文件 filedef.cpp 第 213 行定义.

{}

endFontClass()

virtual void DevNullCodeDocInterface::endFontClass ( )

inlineoverridevirtual

Ends a block started with startFontClass()

实现了 CodeOutputInterface.

在文件 filedef.cpp 第 215 行定义.

{}

setCurrentDoc()

virtual void DevNullCodeDocInterface::setCurrentDoc ( const Definition *  , const QCString &  , bool    )

inlineoverridevirtual

实现了 CodeOutputInterface.

在文件 filedef.cpp 第 217 行定义.

{}

startCodeFragment()

virtual void DevNullCodeDocInterface::startCodeFragment ( const QCString &  style )

inlineoverridevirtual

Starts a source code fragment. The fragment will be fed to the code parser (see code.h) for syntax highlighting and cross-referencing. The fragment ends by a call to endCodeFragment()

参数

style

The kind of code fragment.

实现了 CodeOutputInterface.

在文件 filedef.cpp 第 219 行定义.

{}

startCodeLine()

virtual void DevNullCodeDocInterface::startCodeLine ( bool  )

inlineoverridevirtual

实现了 CodeOutputInterface.

在文件 filedef.cpp 第 212 行定义.

{}

startFontClass()

virtual void DevNullCodeDocInterface::startFontClass ( const QCString &  clsName )

inlineoverridevirtual

Starts a block with a certain meaning. Used for syntax highlighting, which elements of the same type are rendered using the same 'font class'.

参数

clsName

The category name.

实现了 CodeOutputInterface.

在文件 filedef.cpp 第 214 行定义.

{}

writeCodeAnchor()

virtual void DevNullCodeDocInterface::writeCodeAnchor ( const QCString &  name )

inlineoverridevirtual

Write an anchor to a source listing.

参数

name	The name of the anchor.

实现了 CodeOutputInterface.

在文件 filedef.cpp 第 216 行定义.

{}

writeCodeLink()

virtual void DevNullCodeDocInterface::writeCodeLink ( CodeSymbolType  type, const QCString &  ref, const QCString &  file, const QCString &  anchor, const QCString &  name, const QCString &  tooltip  )

inlineoverridevirtual

Writes a link to an object in a code fragment.

参数

type	The type of symbol, used for semantic syntax highlighting, may be Default is no info is available.
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.
tooltip	The tooltip to display when the mouse is on the link.

实现了 CodeOutputInterface.

在文件 filedef.cpp 第 203 行定义.

                                                          {}

writeLineNumber()

virtual void DevNullCodeDocInterface::writeLineNumber ( const QCString &  ref, const QCString &  file, const QCString &  anchor, int  lineNumber, bool  writeLineAnchor  )

inlineoverridevirtual

Writes the line number of a source listing

参数

ref	External reference (when imported from a tag file)
file	The file part of the URL pointing to the docs.
anchor	The anchor part of the URL pointing to the docs.
lineNumber	The line number to write
writeLineAnchor	Indicates if an anchor for the line number needs to be written

实现了 CodeOutputInterface.

在文件 filedef.cpp 第 210 行定义.

                                                                     {}

writeTooltip()

virtual void DevNullCodeDocInterface::writeTooltip ( const QCString &  id, const DocLinkInfo &  docInfo, const QCString &  decl, const QCString &  desc, const SourceLinkInfo &  defInfo, const SourceLinkInfo &  declInfo  )

inlineoverridevirtual

Writes a tool tip definition

参数

id	unique identifier for the tooltip
docInfo	Info about the symbol's documentation.
decl	full declaration of the symbol (for functions)
desc	brief description for the symbol
defInfo	Info about the symbol's definition in the source code
declInfo	Info about the symbol's declaration in the source code

实现了 CodeOutputInterface.

在文件 filedef.cpp 第 207 行定义.

                                        {}

---

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

• src/filedef.cpp