CLanguageScanner Class Reference

This is the language parser for doxygen. It is somewhat fuzzy and supports C++ and various languages that are closely related to C++, such as C, C#, Objective-C, Java, PHP, and IDL.

Constructor & Destructor Documentation

virtual CLanguageScanner::~CLanguageScanner ( ) [inline, virtual]

Definition at line 32 of file scanner.h.

Member Function Documentation

void CLanguageScanner::parseInput	(	const char *	fileName,
		const char *	fileBuf,
		Entry *	root
	)			`[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.

Implements ParserInterface.

bool CLanguageScanner::needsPreprocessing ( const QCString & extension ) [virtual]

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

void CLanguageScanner::parseCode	(	CodeOutputInterface &	codeOutIntf,
		const char *	scopeName,
		const QCString &	input,
		bool	isExampleBlock,
		const char *	exampleName = `0`,
		FileDef *	fileDef = `0`,
		int	startLine = `-1`,
		int	endLine = `-1`,
		bool	inlineFragment = `FALSE`,
		MemberDef *	memberDef = `0`
	)			`[virtual]`

Parses a source file or fragment with the goal to produce highlighted and cross-referenced output.

Parameters:

`[in]`	codeOutIntf	Abstract interface for writing the result.
`[in]`	scopeName	Name of scope to which the code belongs.
`[in]`	input	Actual code in the form of a string
`[in]`	isExampleBlock	TRUE iff the code is part of an example.
`[in]`	exampleName	Name of the example.
`[in]`	fileDef	File definition to which the code is associated.
`[in]`	startLine	Starting line in case of a code fragment.
`[in]`	endLine	Ending line of the code fragment.
`[in]`	inlineFragment	Code fragment that is to be shown inline as part of the documentation.
`[in]`	memberDef	Member definition to which the code is associated (non null in case of an inline fragment for a member).

Implements ParserInterface.

void CLanguageScanner::resetCodeParserState ( ) [virtual]

Resets the state of the code parser. Since multiple code fragments can together form a single example, an explicit function is used to reset the code parser state.

See also:: parseCode()

Implements ParserInterface.

void CLanguageScanner::parsePrototype ( const char * 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 ParserInterface.


Public Member Functions
virtual	~CLanguageScanner ()
void	parseInput (const char fileName, const char fileBuf, Entry *root)
bool	needsPreprocessing (const QCString &extension)
void	parseCode (CodeOutputInterface &codeOutIntf, const char scopeName, const QCString &input, bool isExampleBlock, const char exampleName=0, FileDef fileDef=0, int startLine=-1, int endLine=-1, bool inlineFragment=FALSE, MemberDef memberDef=0)
void	resetCodeParserState ()
void	parsePrototype (const char *text)

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation