DocParserContext结构体 参考

Parser's context to store all global variables. 更多...

DocParserContext 的协作图:

Public 属性
const Definition *	scope
QCString	context
bool	inSeeBlock
bool	xmlComment
bool	insideHtmlLink
DocNodeStack	nodeStack
DocStyleChangeStack	styleStack
DocStyleChangeStack	initialStyleStack
DefinitionStack	copyStack
QCString	fileName
QCString	relPath
bool	hasParamCommand
bool	hasReturnCommand
StringMultiSet	retvalsFound
StringMultiSet	paramsFound
const MemberDef *	memberDef
bool	isExample
QCString	exampleName
QCString	searchUrl
QCString	includeFileName
QCString	includeFileText
uint	includeFileOffset
uint	includeFileLength
int	includeFileLine
bool	includeFileShowLineNo
TokenInfo *	token
int	lineNo
bool	markdownSupport

详细描述

Parser's context to store all global variables.

在文件 docparser.cpp 第 99 行定义.

类成员变量说明

context

QCString DocParserContext::context

在文件 docparser.cpp 第 102 行定义.

被这些函数引用 DocParser::defaultHandleToken(), DocLink::DocLink(), DocParser::findDocsForMemberOrCompound(), DocPara::handleCite(), DocPara::handleCommand(), DocPara::handleFile(), DocPara::handleInclude(), DocPara::handleIncludeOperator(), DocPara::handleInheritDoc(), DocParser::handleLinkedWord(), DocPara::handleRef(), DocPara::handleStartCode(), DocHtmlDescTitle::parse(), validatingParseDoc() , 以及 validatingParseText().

copyStack

DefinitionStack DocParserContext::copyStack

在文件 docparser.cpp 第 109 行定义.

被这些函数引用 DocPara::handleInheritDoc() , 以及 DocParser::processCopyDoc().

exampleName

QCString DocParserContext::exampleName

在文件 docparser.cpp 第 119 行定义.

被这些函数引用 DocParser::defaultHandleToken(), DocPara::handleCommand(), DocPara::handleInclude(), DocPara::handleIncludeOperator(), DocPara::handleStartCode(), validatingParseDoc() , 以及 validatingParseText().

fileName

QCString DocParserContext::fileName

在文件 docparser.cpp 第 110 行定义.

被这些函数引用 DocParser::defaultHandleTitleAndSize(), DocParser::defaultHandleToken(), DocAnchor::DocAnchor(), DocCite::DocCite(), DocEmoji::DocEmoji(), DocFormula::DocFormula(), DocHtmlCaption::DocHtmlCaption(), DocLink::DocLink(), DocRef::DocRef(), DocParser::errorHandleDefaultToken(), DocParser::findAndCopyImage(), DocParser::handleAHref(), DocParser::handleAnchor(), DocPara::handleCite(), DocPara::handleCommand(), DocPara::handleEmoji(), DocPara::handleFile(), DocPara::handleHtmlEndTag(), DocPara::handleHtmlStartTag(), DocPara::handleIline(), DocPara::handleImage(), DocParser::handleImg(), DocPara::handleInclude(), DocPara::handleIncludeOperator(), DocParser::handleInternalRef(), DocPara::handleLink(), DocParser::handleLinkedWord(), DocPara::handleRef(), DocPara::handleSection(), DocPara::handleStartCode(), DocParser::handleStyleArgument(), DocParser::handleStyleLeave(), DocParser::handleUnclosedStyleCommands(), DocParser::internalValidatingParseDoc(), DocInclude::parse(), DocIncOperator::parse(), DocIndexEntry::parse(), DocDotFile::parse(), DocMscFile::parse(), DocDiaFile::parse(), DocLink::parse(), DocHRef::parse(), DocHtmlHeader::parse(), DocHtmlDescTitle::parse(), DocHtmlDescList::parse(), DocSection::parse(), DocSecRefItem::parse(), DocSecRefList::parse(), DocInternal::parse(), DocHtmlList::parse(), DocPara::parse(), DocParamList::parse(), DocHtmlCaption::parse(), DocHtmlRow::parse(), DocHtmlTable::parse(), DocText::parse(), DocRoot::parse(), DocHtmlList::parseXml(), DocParamList::parseXml(), DocHtmlRow::parseXml(), DocParser::processCopyDoc(), DocParser::readTextFileByName(), validatingParseDoc() , 以及 validatingParseText().

hasParamCommand

bool DocParserContext::hasParamCommand

在文件 docparser.cpp 第 113 行定义.

被这些函数引用 DocParser::checkUnOrMultipleDocumentedParams(), DocPara::handleInheritDoc(), DocParamList::parse(), DocParamList::parseXml(), validatingParseDoc() , 以及 validatingParseText().

hasReturnCommand

bool DocParserContext::hasReturnCommand

在文件 docparser.cpp 第 114 行定义.

被这些函数引用 DocPara::handleCommand(), DocPara::handleHtmlStartTag(), DocPara::handleInheritDoc(), DocParamList::parse(), DocParamList::parseXml(), validatingParseDoc() , 以及 validatingParseText().

includeFileLength

uint DocParserContext::includeFileLength

在文件 docparser.cpp 第 125 行定义.

被这些函数引用 DocInclude::parse(), DocIncOperator::parse(), validatingParseDoc() , 以及 validatingParseText().

includeFileLine

int DocParserContext::includeFileLine

在文件 docparser.cpp 第 126 行定义.

被这些函数引用 DocInclude::parse() , 以及 DocIncOperator::parse().

includeFileName

QCString DocParserContext::includeFileName

在文件 docparser.cpp 第 122 行定义.

被这些函数引用 DocInclude::parse() , 以及 DocIncOperator::parse().

includeFileOffset

uint DocParserContext::includeFileOffset

在文件 docparser.cpp 第 124 行定义.

被这些函数引用 DocInclude::parse(), DocIncOperator::parse(), validatingParseDoc() , 以及 validatingParseText().

includeFileShowLineNo

bool DocParserContext::includeFileShowLineNo

在文件 docparser.cpp 第 127 行定义.

被这些函数引用 DocInclude::parse() , 以及 DocIncOperator::parse().

includeFileText

QCString DocParserContext::includeFileText

在文件 docparser.cpp 第 123 行定义.

被这些函数引用 DocInclude::parse(), DocIncOperator::parse(), validatingParseDoc() , 以及 validatingParseText().

initialStyleStack

DocStyleChangeStack DocParserContext::initialStyleStack

在文件 docparser.cpp 第 108 行定义.

被这些函数引用 DocParser::handleInitialStyleCommands(), DocParser::handlePendingStyleCommands(), DocParser::handleUnclosedStyleCommands(), validatingParseDoc() , 以及 validatingParseText().

inSeeBlock

bool DocParserContext::inSeeBlock

在文件 docparser.cpp 第 103 行定义.

被这些函数引用 DocSimpleSect::appendLinkWord(), DocLink::DocLink(), DocRef::DocRef(), DocPara::handleCommand(), DocPara::handleHtmlStartTag(), DocParser::handleLinkedWord(), validatingParseDoc() , 以及 validatingParseText().

insideHtmlLink

bool DocParserContext::insideHtmlLink

在文件 docparser.cpp 第 105 行定义.

被这些函数引用 DocParser::defaultHandleToken(), DocParser::handleAHref(), DocParser::handleLinkedWord(), DocRef::parse(), validatingParseDoc() , 以及 validatingParseText().

isExample

bool DocParserContext::isExample

在文件 docparser.cpp 第 118 行定义.

被这些函数引用 DocParser::defaultHandleToken(), DocPara::handleCommand(), DocPara::handleInclude(), DocPara::handleIncludeOperator(), DocPara::handleStartCode(), validatingParseDoc() , 以及 validatingParseText().

lineNo

int DocParserContext::lineNo

在文件 docparser.cpp 第 130 行定义.

被这些函数引用 DocParser::pushContext().

markdownSupport

bool DocParserContext::markdownSupport

在文件 docparser.cpp 第 131 行定义.

被这些函数引用 DocParser::internalValidatingParseDoc() , 以及 validatingParseDoc().

memberDef

const MemberDef* DocParserContext::memberDef

在文件 docparser.cpp 第 117 行定义.

被这些函数引用 DocParser::checkArgumentName(), DocParser::checkRetvalName(), DocParser::checkUnOrMultipleDocumentedParams(), DocRef::DocRef(), DocPara::handleCommand(), DocPara::handleInheritDoc(), DocParser::handleLinkedWord(), DocXRefItem::parse(), DocVhdlFlow::parse(), validatingParseDoc() , 以及 validatingParseText().

nodeStack

DocNodeStack DocParserContext::nodeStack

在文件 docparser.cpp 第 106 行定义.

被这些函数引用 AutoNodeStack::AutoNodeStack(), DocParser::defaultHandleToken(), DocPara::handleCommand(), DocPara::handleHtmlStartTag(), DocPara::handleInheritDoc(), DocParser::handlePendingStyleCommands(), DocParser::handleStyleEnter(), DocParser::handleStyleLeave(), DocPara::parse(), validatingParseDoc(), validatingParseText() , 以及 AutoNodeStack::~AutoNodeStack().

paramsFound

StringMultiSet DocParserContext::paramsFound

在文件 docparser.cpp 第 116 行定义.

被这些函数引用 DocParser::checkArgumentName(), DocParser::checkUnOrMultipleDocumentedParams(), DocPara::handleInheritDoc(), validatingParseDoc() , 以及 validatingParseText().

relPath

QCString DocParserContext::relPath

在文件 docparser.cpp 第 111 行定义.

被这些函数引用 DocCite::DocCite(), DocDiaFile::DocDiaFile(), DocDotFile::DocDotFile(), DocLink::DocLink(), DocMscFile::DocMscFile(), DocRef::DocRef(), DocParser::handleAHref(), validatingParseDoc() , 以及 validatingParseText().

retvalsFound

StringMultiSet DocParserContext::retvalsFound

在文件 docparser.cpp 第 115 行定义.

被这些函数引用 DocParser::checkRetvalName(), DocPara::handleInheritDoc(), validatingParseDoc() , 以及 validatingParseText().

scope

const Definition* DocParserContext::scope

在文件 docparser.cpp 第 101 行定义.

被这些函数引用 DocPara::handleCommand(), DocPara::handleInheritDoc() , 以及 validatingParseDoc().

searchUrl

QCString DocParserContext::searchUrl

在文件 docparser.cpp 第 120 行定义.

被这些函数引用 DocLinkedWord::DocLinkedWord(), DocWord::DocWord(), validatingParseDoc() , 以及 validatingParseText().

styleStack

DocStyleChangeStack DocParserContext::styleStack

在文件 docparser.cpp 第 107 行定义.

被这些函数引用 DocPara::handleInheritDoc(), DocParser::handlePendingStyleCommands(), DocParser::handleStyleEnter(), DocParser::handleStyleLeave(), validatingParseDoc() , 以及 validatingParseText().

token

TokenInfo* DocParserContext::token

在文件 docparser.cpp 第 129 行定义.

被这些函数引用 DocParser::checkArgumentName(), DocParser::checkRetvalName(), DocParser::defaultHandleTitleAndSize(), DocParser::defaultHandleToken(), DocParser::errorHandleDefaultToken(), DocParser::handleAnchor(), DocPara::handleCite(), DocPara::handleCommand(), DocPara::handleEmoji(), DocPara::handleFile(), DocPara::handleHtmlStartTag(), DocPara::handleImage(), DocPara::handleInclude(), DocPara::handleIncludeOperator(), DocParser::handleInternalRef(), DocPara::handleLink(), DocParser::handleLinkedWord(), DocParser::handleParameterType(), DocPara::handleRef(), DocPara::handleSection(), DocPara::handleStartCode(), DocParser::handleStyleArgument(), DocPara::handleXRefItem(), DocPara::injectToken(), DocIndexEntry::parse(), DocAutoList::parse(), DocAutoListItem::parse(), DocLink::parse(), DocHRef::parse(), DocHtmlHeader::parse(), DocHtmlDescTitle::parse(), DocHtmlDescList::parse(), DocSection::parse(), DocSecRefList::parse(), DocInternal::parse(), DocHtmlList::parse(), DocPara::parse(), DocParamList::parse(), DocHtmlDescData::parse(), DocHtmlCell::parse(), DocHtmlCaption::parse(), DocHtmlRow::parse(), DocHtmlTable::parse(), DocText::parse(), DocRoot::parse(), DocSimpleSect::parseRcs(), DocHtmlList::parseXml(), DocParamList::parseXml(), DocHtmlCell::parseXml(), DocHtmlRow::parseXml(), DocHtmlTable::parseXml(), DocParser::popContext() , 以及 DocParser::pushContext().

xmlComment

bool DocParserContext::xmlComment

在文件 docparser.cpp 第 104 行定义.

被这些函数引用 DocPara::handleHtmlStartTag(), DocPara::handleStartCode(), validatingParseDoc() , 以及 validatingParseText().

---

该结构体的文档由以下文件生成:

• src/docparser.cpp