Output interface for code parser. 更多...

#include <outputgen.h>

类 CodeOutputInterface 继承关系图:

Public 成员函数
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

详细描述

Output interface for code parser.

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

构造及析构函数说明

◆ ~CodeOutputInterface()

virtual CodeOutputInterface::~CodeOutputInterface ( )

inlinevirtual

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

64 {}

◆ CodeOutputInterface() [1/2]

CodeOutputInterface::CodeOutputInterface ( )

inline

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

65 {}

◆ CodeOutputInterface() [2/2]

CodeOutputInterface::CodeOutputInterface ( const CodeOutputInterface & )

delete

成员函数说明

◆ addWord()

virtual void CodeOutputInterface::addWord	(	const QCString &	word,
		bool	hiPriority
	)

pure virtual

在 OutputList, HtmlGenerator, DevNullCodeDocInterface, LatexCodeGenerator, XMLCodeGenerator, DocbookGenerator, LatexGenerator, RTFGenerator, ManGenerator, DocbookCodeGenerator , 以及 HtmlCodeGenerator 内被实现.

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

◆ codify()

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

pure virtual

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.

在 LatexCodeGenerator, XMLCodeGenerator, DocbookGenerator, LatexGenerator, RTFGenerator, HtmlGenerator, ManGenerator, DocbookCodeGenerator, HtmlCodeGenerator, OutputList , 以及 DevNullCodeDocInterface 内被实现.

被这些函数引用 OutputList::codify() , 以及 FileCodeParser::parseCode().

◆ endCodeFragment()

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

pure virtual

Ends a block of code

在 LatexCodeGenerator, OutputList, RTFGenerator, DocbookGenerator, LatexGenerator, HtmlGenerator, DocbookCodeGenerator, DevNullCodeDocInterface, XMLCodeGenerator, ManGenerator , 以及 HtmlCodeGenerator 内被实现.

被这些函数引用 OutputList::endCodeFragment() , 以及 HtmlDocVisitor::visit().

◆ endCodeLine()

virtual void CodeOutputInterface::endCodeLine ( )

pure virtual

Ends a line of code started with startCodeLine()

在 DevNullCodeDocInterface, LatexCodeGenerator, XMLCodeGenerator, OutputList, RTFGenerator, ManGenerator, DocbookGenerator, LatexGenerator, HtmlGenerator, DocbookCodeGenerator , 以及 HtmlCodeGenerator 内被实现.

被这些函数引用 OutputList::endCodeLine() , 以及 FileCodeParser::parseCode().

◆ endFontClass()

virtual void CodeOutputInterface::endFontClass ( )

pure virtual

Ends a block started with startFontClass()

在 DevNullCodeDocInterface, LatexCodeGenerator, XMLCodeGenerator, OutputList, RTFGenerator, ManGenerator, DocbookGenerator, LatexGenerator, HtmlGenerator, DocbookCodeGenerator , 以及 HtmlCodeGenerator 内被实现.

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

◆ id()

virtual int CodeOutputInterface::id ( ) const

inlinevirtual

Identifier for the output file

被 OutputList , 以及 HtmlCodeGenerator 重载.

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

70 { return 0; }

被这些函数引用 TooltipManager::writeTooltips().

◆ operator=()

CodeOutputInterface& CodeOutputInterface::operator= ( const CodeOutputInterface & )

delete

◆ setCurrentDoc()

virtual void CodeOutputInterface::setCurrentDoc	(	const Definition *	context,
		const QCString &	anchor,
		bool	isSourceFile
	)

pure virtual

在 OutputList, HtmlGenerator, DevNullCodeDocInterface, LatexCodeGenerator, XMLCodeGenerator, DocbookGenerator, LatexGenerator, RTFGenerator, ManGenerator, DocbookCodeGenerator , 以及 HtmlCodeGenerator 内被实现.

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

◆ startCodeFragment()

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

pure virtual

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.

在 LatexCodeGenerator, OutputList, RTFGenerator, DocbookGenerator, LatexGenerator, HtmlGenerator, DocbookCodeGenerator, HtmlCodeGenerator, DevNullCodeDocInterface, XMLCodeGenerator , 以及 ManGenerator 内被实现.

被这些函数引用 OutputList::startCodeFragment() , 以及 HtmlDocVisitor::visit().

◆ startCodeLine()

virtual void CodeOutputInterface::startCodeLine ( bool hasLineNumbers )

pure virtual

在 DevNullCodeDocInterface, LatexCodeGenerator, XMLCodeGenerator, RTFGenerator, ManGenerator, DocbookCodeGenerator, HtmlCodeGenerator, OutputList, DocbookGenerator, LatexGenerator , 以及 HtmlGenerator 内被实现.

被这些函数引用 FileCodeParser::parseCode() , 以及 OutputList::startCodeLine().

◆ startFontClass()

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

pure virtual

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.

在 DocbookGenerator, LatexGenerator, HtmlGenerator, HtmlCodeGenerator, XMLCodeGenerator, DocbookCodeGenerator, OutputList, DevNullCodeDocInterface, LatexCodeGenerator, RTFGenerator , 以及 ManGenerator 内被实现.

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

◆ writeCodeAnchor()

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

pure virtual

Write an anchor to a source listing.

参数

name	The name of the anchor.

在 OutputList, DocbookGenerator, LatexGenerator, HtmlGenerator, HtmlCodeGenerator, DevNullCodeDocInterface, LatexCodeGenerator, XMLCodeGenerator, RTFGenerator, ManGenerator , 以及 DocbookCodeGenerator 内被实现.

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

◆ writeCodeLink()

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

pure virtual

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.

在 DevNullCodeDocInterface, LatexCodeGenerator, XMLCodeGenerator, OutputList, DocbookGenerator, LatexGenerator, RTFGenerator, HtmlGenerator, ManGenerator, DocbookCodeGenerator , 以及 HtmlCodeGenerator 内被实现.

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

◆ writeLineNumber()

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

pure virtual

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

在 OutputList, DocbookGenerator, LatexGenerator, HtmlGenerator, XMLCodeGenerator, DocbookCodeGenerator, DevNullCodeDocInterface, LatexCodeGenerator, HtmlCodeGenerator, RTFGenerator , 以及 ManGenerator 内被实现.

被这些函数引用 FileCodeParser::parseCode() , 以及 OutputList::writeLineNumber().

◆ writeTooltip()

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

pure virtual

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

在 OutputList, DocbookGenerator, LatexGenerator, HtmlGenerator, HtmlCodeGenerator, DevNullCodeDocInterface, LatexCodeGenerator, XMLCodeGenerator, RTFGenerator, ManGenerator , 以及 DocbookCodeGenerator 内被实现.

被这些函数引用 OutputList::writeTooltip() , 以及 TooltipManager::writeTooltips().

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

src/outputgen.h

Public 成员函数

详细描述

构造及析构函数说明

◆ ~CodeOutputInterface()

◆ CodeOutputInterface() [1/2]

◆ CodeOutputInterface() [2/2]

成员函数说明

◆ addWord()

◆ codify()

◆ endCodeFragment()

◆ endCodeLine()

◆ endFontClass()

◆ id()

◆ operator=()

◆ setCurrentDoc()

◆ startCodeFragment()

◆ startCodeLine()

◆ startFontClass()

◆ writeCodeAnchor()

◆ writeCodeLink()

◆ writeLineNumber()

◆ writeTooltip()