doxygen
PythonOutlineParser Class Reference

Python Language parser using state-based lexical scanning. More...

#include <pyscanner.h>

Inheritance diagram for PythonOutlineParser:
[legend]
Collaboration diagram for PythonOutlineParser:
[legend]

Public Member Functions

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

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

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

Detailed Description

Python Language parser using state-based lexical scanning.

This is the Python language parser for doxygen.

◆ needsPreprocessing()

 bool PythonOutlineParser::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()

Implements OutlineParserInterface.

◆ parseInput()

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

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 PythonOutlineParser::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.

Implements OutlineParserInterface.

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