NullOutlineParser Class Reference

/dev/null outline parser More...

Inheritance diagram for NullOutlineParser:

Collaboration diagram for NullOutlineParser:

Public Member Functions
void	parseInput (const DString &, const char *, const std::shared_ptr< Entry > &, ClangTUParser *) override
	Parses a single input file with the goal to build an Entry tree.
bool	needsPreprocessing (const DString &) 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.
void	parsePrototype (const DString &) override
	Callback function called by the comment block scanner.

Detailed Description

/dev/null outline parser

Definition at line 11448 of file doxygen.cpp.

Member Function Documentation

needsPreprocessing()

bool NullOutlineParser::needsPreprocessing ( const DString & 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.

Definition at line 11452 of file doxygen.cpp.

{ return false; }

parseInput()

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

inlineoverridevirtual

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.

Definition at line 11451 of file doxygen.cpp.

{}

parsePrototype()

void NullOutlineParser::parsePrototype ( const DString & 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.

Definition at line 11453 of file doxygen.cpp.

{}

---

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

• src/doxygen.cpp