Abstract interface for outline parsers. 更多...

#include <parserintf.h>

类 OutlineParserInterface 继承关系图:

Public 成员函数
virtual	~OutlineParserInterface ()

virtual void	parseInput (const QCString &fileName, const char fileBuf, const std::shared_ptr< Entry > &root, ClangTUParser clangParser)=0
	Parses a single input file with the goal to build an Entry tree. 更多...

virtual bool	needsPreprocessing (const QCString &extension) const =0
	Returns TRUE if the language identified by extension needs the C preprocessor to be run before feed the result to the input parser. 更多...

virtual void	parsePrototype (const QCString &text)=0
	Callback function called by the comment block scanner. 更多...

详细描述

Abstract interface for outline parsers.

By implementing the methods of this interface one can add a new language parser to doxygen. The parser implementation can make use of the comment block parser to parse the contents of special comment blocks.

在文件 parserintf.h 第 42 行定义.

构造及析构函数说明

◆ ~OutlineParserInterface()

virtual OutlineParserInterface::~OutlineParserInterface ( )

inlinevirtual

在文件 parserintf.h 第 45 行定义.

45 {}

成员函数说明

◆ needsPreprocessing()

virtual bool OutlineParserInterface::needsPreprocessing ( const QCString & extension ) const

pure virtual

Returns TRUE if the language identified by extension needs the C preprocessor to be run before feed the result to the input parser.

参见: parseInput()

在 PythonOutlineParser, COutlineParser, FortranOutlineParser, LexOutlineParser, NullOutlineParser, MarkdownOutlineParser , 以及 VHDLOutlineParser 内被实现.

被这些函数引用 parseFile().

◆ parseInput()

virtual void OutlineParserInterface::parseInput	(	const QCString &	fileName,
		const char *	fileBuf,
		const std::shared_ptr< Entry > &	root,
		ClangTUParser *	clangParser
	)

pure virtual

Parses a single input file with the goal to build an Entry tree.

参数

[in]	fileName	The full name of the file.
[in]	fileBuf	The contents of the file (zero terminated).
[in,out]	root	The root of the tree of Entry *nodes representing the information extracted from the file.
[in]	clangParser	The clang translation unit parser object or nullptr if disabled.

在 MarkdownOutlineParser, PythonOutlineParser, COutlineParser, FortranOutlineParser, LexOutlineParser, VHDLOutlineParser , 以及 NullOutlineParser 内被实现.

被这些函数引用 parseFile().

◆ parsePrototype()

virtual void OutlineParserInterface::parsePrototype ( const QCString & text )

pure virtual

Callback function called by the comment block scanner.

It provides a string text containing the prototype of a function or variable. The parser should parse this and store the information in the Entry node that corresponds with the node for which the comment block parser was invoked.

在 MarkdownOutlineParser, PythonOutlineParser, COutlineParser, FortranOutlineParser, LexOutlineParser, VHDLOutlineParser , 以及 NullOutlineParser 内被实现.

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

src/parserintf.h

Public 成员函数

详细描述

构造及析构函数说明

◆ ~OutlineParserInterface()

成员函数说明

◆ needsPreprocessing()

◆ parseInput()

◆ parsePrototype()