Inheritance diagram for DocParser:

Collaboration diagram for DocParser:

Classes
class	AutoSaveContext

Public Member Functions
void	handleImg (DocNodeVariant *parent, DocNodeList &children, const HtmlAttribList &tagHtmlAttribs)

Token	internalValidatingParseDoc (DocNodeVariant *parent, DocNodeList &children, const DString &doc)

DString	processCopyDoc (const char *data, size_t &len)

DString	findAndCopyImage (const DString &fileName, DocImage::Type type, bool doWarn=true)

void	checkArgumentName ()

void	checkRetvalName ()

void	checkUnOrMultipleDocumentedParams ()

bool	findDocsForMemberOrCompound (const DString &commandName, DString pDoc, DString pBrief, const Definition **pDef)

bool	defaultHandleToken (DocNodeVariant *parent, Token &tok, DocNodeList &children, bool handleWord=true)

void	errorHandleDefaultToken (DocNodeVariant *parent, Token tok, DocNodeList &children, const DString &txt)

void	defaultHandleTitleAndSize (const CommandType cmd, DocNodeVariant *parent, DocNodeList &children, DString &width, DString &height)

Token	handleStyleArgument (DocNodeVariant *parent, DocNodeList &children, const DString &cmdName)

void	handleStyleEnter (DocNodeVariant parent, DocNodeList &children, DocStyleChange::Style s, const DString &tagName, const HtmlAttribList attribs)

void	handleStyleLeave (DocNodeVariant *parent, DocNodeList &children, DocStyleChange::Style s, const DString &tagName)

void	handlePendingStyleCommands (DocNodeVariant *parent, DocNodeList &children, size_t numberOfElementsToClose=0)

void	handleInitialStyleCommands (DocNodeVariant *parent, DocNodeList &children)

Token	handleAHref (DocNodeVariant *parent, DocNodeList &children, const HtmlAttribList &tagHtmlAttribs)

void	handleUnclosedStyleCommands ()

void	handleLinkedWord (DocNodeVariant *parent, DocNodeList &children, bool ignoreAutoLinkFlag=false, bool typeLinkOnly=false)

void	handleParameterType (DocNodeVariant *parent, DocNodeList &children, const DString &paramTypes)

void	handleInternalRef (DocNodeVariant *parent, DocNodeList &children)

void	handleAnchor (DocNodeVariant *parent, DocNodeList &children)

void	handleCite (DocNodeVariant *parent, DocNodeList &children)

void	handlePrefix (DocNodeVariant *parent, DocNodeList &children)

void	handleImage (DocNodeVariant *parent, DocNodeList &children)

void	handleRef (DocNodeVariant *parent, DocNodeList &children, char cmdChar, const DString &cmdName)

void	handleIFile (char cmdChar, const DString &cmdName)

void	handleILine (char cmdChar, const DString &cmdName)

void	readTextFileByName (const DString &file, DString &text)

Public Attributes
std::stack< DocParserContext >	contextStack

DocParserContext	context

DocTokenizer	tokenizer

Member Function Documentation

◆ checkArgumentName()

void DocParser::checkArgumentName ( )

Collects the parameters found with @param command in a list context.paramsFound. If the parameter is not an actual parameter of the current member context.memberDef, then a warning is raised (unless warnings are disabled altogether).

◆ checkRetvalName()

void DocParser::checkRetvalName ( )

Collects the return values found with @retval command in a global list g_parserContext.retvalsFound.

◆ checkUnOrMultipleDocumentedParams()

void DocParser::checkUnOrMultipleDocumentedParams ( )

Checks if the parameters that have been specified using @param are indeed all parameters and that a parameter does not have multiple @param blocks. Must be called after checkArgumentName() has been called for each argument.

◆ findAndCopyImage()

DString DocParser::findAndCopyImage	(	const DString &	fileName,
		DocImage::Type	type,
		bool	doWarn = `true`
	)

search for an image in the imageNameDict and if found copies the image to the output directory (which depends on the type parameter).

◆ findDocsForMemberOrCompound()

bool DocParser::findDocsForMemberOrCompound	(	const DString &	commandName,
		DString *	pDoc,
		DString *	pBrief,
		const Definition **	pDef
	)

Looks for a documentation block with name commandName in the current context (g_parserContext.context). The resulting documentation string is put in pDoc, the definition in which the documentation was found is put in pDef.

Return values

true	if name was found.
false	if name was not found.

◆ handlePendingStyleCommands()

void DocParser::handlePendingStyleCommands	(	DocNodeVariant *	parent,
		DocNodeList &	children,
		size_t	numberOfElementsToClose = `0`
	)

Called at the end of a paragraph to close all open style changes (e.g. a without a ). The closed styles are pushed onto a stack and entered again at the start of a new paragraph.

◆ handleStyleEnter()

void DocParser::handleStyleEnter	(	DocNodeVariant *	parent,
		DocNodeList &	children,
		DocStyleChange::Style	s,
		const DString &	tagName,
		const HtmlAttribList *	attribs
	)

Called when a style change starts. For instance a <b> command is encountered.

◆ handleStyleLeave()

void DocParser::handleStyleLeave	(	DocNodeVariant *	parent,
		DocNodeList &	children,
		DocStyleChange::Style	s,
		const DString &	tagName
	)

Called when a style change ends. For instance a </b> command is encountered.

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

src/docparser_p.h
src/docparser.cpp

Classes

Public Member Functions

Public Attributes