The OutlineParserInterface Class Reference

Abstract interface for outline parsers. More...

Declaration

class OutlineParserInterface { ... }

Included Headers

#include <src/parserintf.h>

Derived Classes

class	COutlineParser
	C-like language parser using state-based lexical scanning. More...
class	FortranOutlineParser
	Fortran language parser using state-based lexical scanning. More...
class	LexOutlineParser
	Lex language parser using state-based lexical scanning. More...
class	MarkdownOutlineParser
class	NullOutlineParser
	/dev/null outline parser More...
class	PythonOutlineParser
	Python Language parser using state-based lexical scanning. More...
class	VHDLOutlineParser
	VHDL parser using state-based lexical scanning. More...

Public Member Functions Index

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

Description

Abstract interface for outline parsers.

By implementing the methods of this interface one can add a new language parser to doxygen. The parser implementation can make use of the comment block parser to parse the contents of special comment blocks.

Definition at line 41 of file parserintf.h.

Public Member Functions

needsPreprocessing()

virtual bool OutlineParserInterface::needsPreprocessing (const QCString & extension)

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()

Definition at line 64 of file parserintf.h.

Reference needsPreprocessing.

Referenced by needsPreprocessing and parseFile.

parseInput()

virtual void OutlineParserInterface::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.

Parameters

[in] fileName	The full name of the file.
[in] fileBuf	The contents of the file (zero terminated).
[inout] 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.

Definition at line 54 of file parserintf.h.

Reference parseInput.

Referenced by parseFile and parseInput.

parsePrototype()

virtual void OutlineParserInterface::parsePrototype (const QCString & text)

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.

Definition at line 72 of file parserintf.h.

Reference parsePrototype.

Referenced by parsePrototype.

---

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

• parserintf.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.