doxygen
Public Member Functions | List of all members
NullOutlineParser Class Reference

/dev/null outline parser More...

Inheritance diagram for NullOutlineParser:
Inheritance graph
[legend]
Collaboration diagram for NullOutlineParser:
Collaboration graph
[legend]

Public Member Functions

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

Detailed Description

/dev/null outline parser

Member Function Documentation

◆ needsPreprocessing()

bool NullOutlineParser::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.

See also
parseInput()

Implements OutlineParserInterface.

◆ parseInput()

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

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

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

Implements OutlineParserInterface.

◆ parsePrototype()

void NullOutlineParser::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.

Implements OutlineParserInterface.


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