LexOutlineParser Class Reference

Lex language parser using state-based lexical scanning. More...

#include <lexscanner.h>

Inheritance diagram for LexOutlineParser:

Collaboration diagram for LexOutlineParser:

Public Member Functions
void	parseInput (const QCString &fileName, const char *fileBuf, const std::shared_ptr< Entry > &root, ClangTUParser *clangParser) override
	Parses a single input file with the goal to build an Entry tree. More...
bool	needsPreprocessing (const QCString &) const override
	Returns TRUE if the language identified by extension needs the C preprocessor to be run before feed the result to the input parser. More...
void	parsePrototype (const QCString &) override
	Callback function called by the comment block scanner. More...

Detailed Description

Lex language parser using state-based lexical scanning.

This is the Lex language parser for doxygen.

Member Function Documentation

needsPreprocessing()

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

inlineoverridevirtual

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

See also

parseInput()

Implements OutlineParserInterface.

parseInput()

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

overridevirtual

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

Parameters

[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.

Implements OutlineParserInterface.

parsePrototype()

void LexOutlineParser::parsePrototype ( const QCString &  text )

inlineoverridevirtual

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.

Implements OutlineParserInterface.

---

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

• src/lexscanner.h