Parser's context to store all global variables. More...
#include <src/docparser_p.h>
Collaboration diagram for DocParserContext:Public Attributes | |
| const Definition * | scope = nullptr |
| QCString | context |
| bool | inSeeBlock = false |
| bool | xmlComment = false |
| bool | insideHtmlLink = false |
| DocNodeStack | nodeStack |
| DocStyleChangeStack | styleStack |
| DocStyleChangeStack | initialStyleStack |
| DefinitionStack | copyStack |
| QCString | fileName |
| QCString | relPath |
| bool | hasParamCommand = false |
| bool | hasReturnCommand = false |
| StringMultiSet | retvalsFound |
| StringMultiSet | paramsFound |
| const MemberDef * | memberDef = nullptr |
| bool | isExample = false |
| QCString | exampleName |
| QCString | searchUrl |
| QCString | prefix |
| SrcLangExt | lang = SrcLangExt::Cpp |
| QCString | includeFileName |
| QCString | includeFileText |
| size_t | includeFileOffset = 0 |
| size_t | includeFileLength = 0 |
| int | includeFileLine |
| bool | includeFileShowLineNo = false |
| bool | stripCodeComments = true |
| TokenInfo * | token = nullptr |
| int | lineNo = 0 |
| bool | markdownSupport = false |
Detailed Description
Parser's context to store all global variables.
Definition at line 59 of file docparser_p.h.
Member Data Documentation
◆ context
| QCString DocParserContext::context |
Definition at line 62 of file docparser_p.h.
Referenced by DocPara::handleCite(), DocPara::handleCommand(), DocPara::handleFile(), DocPara::handleInclude(), DocPara::handleIncludeOperator(), DocPara::handleInheritDoc(), DocPara::handleRef(), DocPara::handleStartCode(), DocHtmlDescTitle::parse(), validatingParseDoc(), and validatingParseText().
◆ copyStack
| DefinitionStack DocParserContext::copyStack |
Definition at line 69 of file docparser_p.h.
Referenced by DocPara::handleInheritDoc().
◆ exampleName
| QCString DocParserContext::exampleName |
Definition at line 79 of file docparser_p.h.
Referenced by DocPara::handleCommand(), DocPara::handleInclude(), DocPara::handleIncludeOperator(), DocPara::handleStartCode(), validatingParseDoc(), and validatingParseText().
◆ fileName
| QCString DocParserContext::fileName |
Definition at line 70 of file docparser_p.h.
Referenced by createRef(), DocPara::handleFile(), DocPara::handleIFile(), DocPara::handleInclude(), validatingParseDoc(), and validatingParseText().
◆ hasParamCommand
| bool DocParserContext::hasParamCommand = false |
Definition at line 73 of file docparser_p.h.
Referenced by DocPara::handleInheritDoc(), DocParamList::parse(), DocParamList::parseXml(), validatingParseDoc(), and validatingParseText().
◆ hasReturnCommand
| bool DocParserContext::hasReturnCommand = false |
Definition at line 74 of file docparser_p.h.
Referenced by DocPara::handleCommand(), DocPara::handleHtmlStartTag(), DocPara::handleInheritDoc(), DocParamList::parse(), DocParamList::parseXml(), validatingParseDoc(), and validatingParseText().
◆ includeFileLength
| size_t DocParserContext::includeFileLength = 0 |
Definition at line 87 of file docparser_p.h.
Referenced by DocInclude::parse(), DocIncOperator::parse(), validatingParseDoc(), and validatingParseText().
◆ includeFileLine
| int DocParserContext::includeFileLine |
Definition at line 88 of file docparser_p.h.
Referenced by DocInclude::parse(), and DocIncOperator::parse().
◆ includeFileName
| QCString DocParserContext::includeFileName |
Definition at line 84 of file docparser_p.h.
Referenced by DocInclude::parse(), and DocIncOperator::parse().
◆ includeFileOffset
| size_t DocParserContext::includeFileOffset = 0 |
Definition at line 86 of file docparser_p.h.
Referenced by DocInclude::parse(), DocIncOperator::parse(), validatingParseDoc(), and validatingParseText().
◆ includeFileShowLineNo
| bool DocParserContext::includeFileShowLineNo = false |
Definition at line 89 of file docparser_p.h.
Referenced by DocInclude::parse(), and DocIncOperator::parse().
◆ includeFileText
| QCString DocParserContext::includeFileText |
Definition at line 85 of file docparser_p.h.
Referenced by DocInclude::parse(), DocIncOperator::parse(), validatingParseDoc(), and validatingParseText().
◆ initialStyleStack
| DocStyleChangeStack DocParserContext::initialStyleStack |
Definition at line 68 of file docparser_p.h.
Referenced by validatingParseDoc(), and validatingParseText().
◆ inSeeBlock
| bool DocParserContext::inSeeBlock = false |
Definition at line 63 of file docparser_p.h.
Referenced by DocSimpleSect::appendLinkWord(), DocPara::handleCommand(), DocPara::handleHtmlStartTag(), validatingParseDoc(), and validatingParseText().
◆ insideHtmlLink
| bool DocParserContext::insideHtmlLink = false |
Definition at line 65 of file docparser_p.h.
Referenced by DocRef::parse(), DocTitle::parseFromString(), validatingParseDoc(), and validatingParseText().
◆ isExample
| bool DocParserContext::isExample = false |
Definition at line 78 of file docparser_p.h.
Referenced by DocPara::handleCommand(), DocPara::handleInclude(), DocPara::handleIncludeOperator(), DocPara::handleStartCode(), validatingParseDoc(), and validatingParseText().
◆ lang
| SrcLangExt DocParserContext::lang = SrcLangExt::Cpp |
Definition at line 82 of file docparser_p.h.
Referenced by validatingParseDoc(), and validatingParseText().
◆ lineNo
| int DocParserContext::lineNo = 0 |
Definition at line 93 of file docparser_p.h.
◆ markdownSupport
| bool DocParserContext::markdownSupport = false |
Definition at line 94 of file docparser_p.h.
Referenced by validatingParseDoc(), and validatingParseText().
◆ memberDef
| const MemberDef* DocParserContext::memberDef = nullptr |
Definition at line 77 of file docparser_p.h.
Referenced by DocPara::handleCommand(), DocPara::handleInheritDoc(), validatingParseDoc(), and validatingParseText().
◆ nodeStack
| DocNodeStack DocParserContext::nodeStack |
Definition at line 66 of file docparser_p.h.
Referenced by checkIfHtmlEndTagEndsAutoList(), DocPara::handleCommand(), DocPara::handleHtmlStartTag(), DocPara::handleInheritDoc(), DocPara::handleLink(), validatingParseDoc(), and validatingParseText().
◆ paramsFound
| StringMultiSet DocParserContext::paramsFound |
Definition at line 76 of file docparser_p.h.
Referenced by DocPara::handleInheritDoc(), validatingParseDoc(), and validatingParseText().
◆ prefix
| QCString DocParserContext::prefix |
Definition at line 81 of file docparser_p.h.
◆ relPath
| QCString DocParserContext::relPath |
Definition at line 71 of file docparser_p.h.
Referenced by validatingParseDoc(), and validatingParseText().
◆ retvalsFound
| StringMultiSet DocParserContext::retvalsFound |
Definition at line 75 of file docparser_p.h.
Referenced by DocPara::handleInheritDoc(), validatingParseDoc(), and validatingParseText().
◆ scope
| const Definition* DocParserContext::scope = nullptr |
Definition at line 61 of file docparser_p.h.
Referenced by DocPara::handleCommand(), DocPara::handleInheritDoc(), and validatingParseDoc().
◆ searchUrl
| QCString DocParserContext::searchUrl |
Definition at line 80 of file docparser_p.h.
Referenced by validatingParseDoc(), and validatingParseText().
◆ stripCodeComments
| bool DocParserContext::stripCodeComments = true |
Definition at line 90 of file docparser_p.h.
Referenced by DocInclude::parse(), and DocIncOperator::parse().
◆ styleStack
| DocStyleChangeStack DocParserContext::styleStack |
Definition at line 67 of file docparser_p.h.
Referenced by checkIfHtmlEndTagEndsAutoList(), DocPara::handleInheritDoc(), validatingParseDoc(), and validatingParseText().
◆ token
| TokenInfo* DocParserContext::token = nullptr |
Definition at line 92 of file docparser_p.h.
Referenced by checkIfHtmlEndTagEndsAutoList(), DocPara::handleCite(), DocPara::handleCommand(), DocPara::handleDoxyConfig(), DocPara::handleEmoji(), DocPara::handleFile(), DocPara::handleHtmlStartTag(), DocPara::handleIFile(), DocPara::handleInclude(), DocPara::handleIncludeOperator(), DocPara::handleLink(), DocPara::handleRef(), DocPara::handleSection(), DocPara::handleShowDate(), DocPara::handleStartCode(), DocPara::handleXRefItem(), DocPara::injectToken(), DocAutoList::parse(), DocHRef::parse(), DocHtmlDescData::parse(), DocHtmlDescList::parse(), DocHtmlDescTitle::parse(), DocHtmlHeader::parse(), DocHtmlList::parse(), DocHtmlRow::parse(), DocHtmlTable::parse(), DocIndexEntry::parse(), DocInternal::parse(), DocLink::parse(), DocPara::parse(), DocParamList::parse(), DocRoot::parse(), DocSecRefList::parse(), DocSection::parse(), DocText::parse(), DocSimpleSect::parseRcs(), DocHtmlList::parseXml(), DocHtmlRow::parseXml(), DocHtmlTable::parseXml(), DocParamList::parseXml(), validatingParseDoc(), and validatingParseText().
◆ xmlComment
| bool DocParserContext::xmlComment = false |
Definition at line 64 of file docparser_p.h.
Referenced by DocPara::handleHtmlStartTag(), validatingParseDoc(), and validatingParseText().
The documentation for this struct was generated from the following file:
- src/docparser_p.h
