Doxygen
LexOutlineParser类 参考

Lex language parser using state-based lexical scanning. 更多...

#include <lexscanner.h>

+ 类 LexOutlineParser 继承关系图:
+ LexOutlineParser 的协作图:

Public 成员函数

 LexOutlineParser ()
 
 ~LexOutlineParser ()
 
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< Privatep
 

详细描述

Lex language parser using state-based lexical scanning.

This is the Lex language parser for doxygen.

在文件 lexscanner.h27 行定义.

构造及析构函数说明

◆ LexOutlineParser()

LexOutlineParser::LexOutlineParser ( )

◆ ~LexOutlineParser()

LexOutlineParser::~LexOutlineParser ( )

成员函数说明

◆ needsPreprocessing()

bool LexOutlineParser::needsPreprocessing ( const QCString extension) const
inlinevirtual

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.

在文件 lexscanner.h51 行定义.

◆ parseInput()

void LexOutlineParser::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]fileNameThe full name of the file.
[in]fileBufThe contents of the file (zero terminated).
[in,out]rootThe root of the tree of Entry *nodes representing the information extracted from the file.
[in]clangParserThe clang translation unit parser object or nullptr if disabled.

实现了 OutlineParserInterface.

◆ parsePrototype()

void LexOutlineParser::parsePrototype ( const QCString text)
inlinevirtual

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.

在文件 lexscanner.h52 行定义.

类成员变量说明

◆ p

std::unique_ptr<Private> LexOutlineParser::p
private

在文件 lexscanner.h55 行定义.


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