C-like language parser using state-based lexical scanning. 更多...

#include <scanner.h>

类 COutlineParser 继承关系图:

COutlineParser 的协作图:

Public 成员函数
	COutlineParser ()

virtual	~COutlineParser ()

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

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

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

Public 成员函数继承自 OutlineParserInterface
virtual	~OutlineParserInterface ()

Private 属性
std::unique_ptr< Private >	p

详细描述

C-like language parser using state-based lexical scanning.

This is the language parser for doxygen. It is somewhat fuzzy and supports C++ and various languages that are closely related to C++, such as C, C#, Objective-C, Java, PHP, and IDL.

在文件 scanner.h 第 29 行定义.

构造及析构函数说明

◆ COutlineParser()

COutlineParser::COutlineParser ( )

◆ ~COutlineParser()

virtual COutlineParser::~COutlineParser ( )

virtual

成员函数说明

◆ needsPreprocessing()

bool COutlineParser::needsPreprocessing ( const QCString & extension ) const

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

实现了 OutlineParserInterface.

◆ parseInput()

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

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.

实现了 OutlineParserInterface.

◆ parsePrototype()

void COutlineParser::parsePrototype ( const QCString & text )

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.

实现了 OutlineParserInterface.