XML scanner. More...

#include <xmlcode.h>

Inheritance diagram for XMLCodeParser:

Collaboration diagram for XMLCodeParser:

Public Member Functions
void	parseCode (OutputCodeList &codeOutIntf, const QCString &scopeName, const QCString &input, SrcLangExt, bool isExampleBlock, const QCString &exampleName=QCString(), const FileDef fileDef=nullptr, int startLine=-1, int endLine=-1, bool inlineFragment=FALSE, const MemberDef memberDef=nullptr, bool showLineNumbers=TRUE, const Definition *searchCtx=nullptr, bool collectXRefs=TRUE) override
	Parses a source file or fragment with the goal to produce highlighted and cross-referenced output. More...

void	resetCodeParserState () override
	Resets the state of the code parser. More...

Detailed Description

XML scanner.

Only support syntax highlighting of code at the moment.

Member Function Documentation

void XMLCodeParser::parseCode	(	OutputCodeList &	codeOutList,
		const QCString &	scopeName,
		const QCString &	input,
		SrcLangExt	lang,
		bool	isExampleBlock,
		const QCString &	exampleName = `QCString()`,
		const FileDef *	fileDef = `nullptr`,
		int	startLine = `-1`,
		int	endLine = `-1`,
		bool	inlineFragment = `FALSE`,
		const MemberDef *	memberDef = `nullptr`,
		bool	showLineNumbers = `TRUE`,
		const Definition *	searchCtx = `nullptr`,
		bool	collectXRefs = `TRUE`
	)

overridevirtual

Parses a source file or fragment with the goal to produce highlighted and cross-referenced output.

Parameters

[in]	codeOutList	interface for writing the result.
[in]	scopeName	Name of scope to which the code belongs.
[in]	input	Actual code in the form of a string
[in]	lang	The programming language of the code fragment.
[in]	isExampleBlock	TRUE iff the code is part of an example.
[in]	exampleName	Name of the example.
[in]	fileDef	File definition to which the code is associated.
[in]	startLine	Starting line in case of a code fragment.
[in]	endLine	Ending line of the code fragment.
[in]	inlineFragment	Code fragment that is to be shown inline as part of the documentation.
[in]	memberDef	Member definition to which the code is associated (non null in case of an inline fragment for a member).
[in]	showLineNumbers	if set to TRUE and also fileDef is not 0, line numbers will be added to the source fragment
[in]	searchCtx	context under which search data has to be stored.
[in]	collectXRefs	collect cross-reference relations.

void XMLCodeParser::resetCodeParserState ( )

overridevirtual

Resets the state of the code parser.

Since multiple code fragments can together form a single example, an explicit function is used to reset the code parser state.

The documentation for this class was generated from the following file: