CommentScanner类 参考

#include <commentscan.h>

Public 成员函数
	CommentScanner ()
	~CommentScanner ()
bool	parseCommentBlock (OutlineParserInterface *parser, Entry *curEntry, const QCString &comment, const QCString &fileName, int &lineNr, bool isBrief, bool isJavadocStyle, bool isInbody, Protection &prot, int &position, bool &newEntryNeeded, bool markdownEnabled)
	Invokes the comment block parser with the request to parse a single comment block. 更多...
void	initGroupInfo (Entry *entry)
void	enterFile (const QCString &fileName, int lineNr)
void	leaveFile (const QCString &fileName, int lineNr)
void	enterCompound (const QCString &fileName, int line, const QCString &name)
void	leaveCompound (const QCString &fileName, int line, const QCString &name)
void	open (Entry *e, const QCString &fileName, int line, bool implicit=false)
void	close (Entry *e, const QCString &fileName, int line, bool foundInline, bool implicit=false)

Private 属性
std::unique_ptr< Private >	p

详细描述

在文件 commentscan.h 第 28 行定义.

构造及析构函数说明

CommentScanner()

CommentScanner::CommentScanner

(

)

~CommentScanner()

CommentScanner::~CommentScanner

(

)

成员函数说明

close()

void CommentScanner::close	(	Entry *	e,
		const QCString &	fileName,
		int	line,
		bool	foundInline,
		bool	implicit = false
	)

enterCompound()

void CommentScanner::enterCompound	(	const QCString &	fileName,
		int	line,
		const QCString &	name
	)

enterFile()

void CommentScanner::enterFile	(	const QCString &	fileName,
		int	lineNr
	)

initGroupInfo()

void CommentScanner::initGroupInfo

(

Entry *

entry

)

leaveCompound()

void CommentScanner::leaveCompound	(	const QCString &	fileName,
		int	line,
		const QCString &	name
	)

leaveFile()

void CommentScanner::leaveFile	(	const QCString &	fileName,
		int	lineNr
	)

open()

void CommentScanner::open	(	Entry *	e,
		const QCString &	fileName,
		int	line,
		bool	implicit = false
	)

parseCommentBlock()

bool CommentScanner::parseCommentBlock	(	OutlineParserInterface *	parser,
		Entry *	curEntry,
		const QCString &	comment,
		const QCString &	fileName,
		int &	lineNr,
		bool	isBrief,
		bool	isJavadocStyle,
		bool	isInbody,
		Protection &	prot,
		int &	position,
		bool &	newEntryNeeded,
		bool	markdownEnabled
	)

Invokes the comment block parser with the request to parse a single comment block.

参数

[in]	parser	The language parse that invoked this function. The comment block parse may invoke ParserInterface::parsePrototype() in order to parse the argument of a @fn command.
[in]	curEntry	The Entry to which the comment block belongs. Any information (like documentation) that is found in the comment block will be stored in this entry.
[in]	comment	A string representing the actual comment block. Note that leading *'s are already stripped from the comment block.
[in]	fileName	The name of the file in which the comment is found. Mainly used for producing warnings.
[in,out]	lineNr	The line number at which the comment block was found. When the function returns it will be set to the last line parsed.
[in]	isBrief	TRUE iff this comment block represents a brief description.
[in]	isJavadocStyle	TRUE iff this comment block is in "Javadoc" style. This means that it starts as a brief description until the end of the sentences is found and then proceeds as a detailed description.
[in]	isInbody	TRUE iff this comment block is located in the body of a function.
[in,out]	prot	The protection level in which this comment block was found. Commands in the comment block may override this.
[in,out]	position	The character position within comment where the comment block starts. Typically used in case the comment block contains multiple structural commands.
[out]	newEntryNeeded	Boolean that is TRUE if the comment block parser finds that a the comment block finishes the entry and a new one needs to be started.
[in]	markdownEnabled	Indicates if markdown specific processing should be done.

返回

TRUE if the comment requires further processing. The parameter newEntryNeeded will typically be true in this case and position will indicate the offset inside the comment string where to proceed parsing. FALSE indicates no further processing is needed.

类成员变量说明

p

std::unique_ptr<Private> CommentScanner::p

private

在文件 commentscan.h 第 91 行定义.

---

该类的文档由以下文件生成:

• src/commentscan.h