Skip to main content

The DocParserContext Struct Reference

Parser's context to store all global variables. More...

Declaration​

struct DocParserContext { ... }

Included Headers​

#include <src/docparser_p.h>

Public Member Attributes Index​

const Definition *scope = nullptr
QCStringcontext
boolinSeeBlock = false
boolxmlComment = false
boolinsideHtmlLink = false
DocNodeStacknodeStack
DocStyleChangeStackstyleStack
DocStyleChangeStackinitialStyleStack
DefinitionStackcopyStack
QCStringfileName
QCStringrelPath
boolhasParamCommand = false
boolhasReturnCommand = false
StringMultiSetretvalsFound
StringMultiSetparamsFound
const MemberDef *memberDef = nullptr
boolisExample = false
QCStringexampleName
QCStringsearchUrl
QCStringprefix
SrcLangExtlang = SrcLangExt::Cpp
QCStringincludeFileName
QCStringincludeFileText
size_tincludeFileOffset = 0
size_tincludeFileLength = 0
intincludeFileLine
boolincludeFileShowLineNo = false
boolstripCodeComments = true
TokenInfo *token = nullptr
intlineNo = 0
boolmarkdownSupport = false
boolautolinkSupport = false

Description​

Parser's context to store all global variables.

Definition at line 59 of file docparser_p.h.

Public Member Attributes​

autolinkSupport​

bool DocParserContext::autolinkSupport = false

Definition at line 95 of file docparser_p.h.

95 bool autolinkSupport = false;

Referenced by validatingParseDoc, validatingParseText and validatingParseTitle.

context​

QCString DocParserContext::context

Definition at line 62 of file docparser_p.h.

62 QCString context;

Referenced by DocPara::handleCite, DocPara::handleCommand, DocPara::handleFile, DocPara::handleInclude, DocPara::handleIncludeOperator, DocPara::handleInheritDoc, DocPara::handleRef, DocPara::handleStartCode, DocHtmlDescTitle::parse, validatingParseDoc, validatingParseText and validatingParseTitle.

copyStack​

DefinitionStack DocParserContext::copyStack

Definition at line 69 of file docparser_p.h.

69 DefinitionStack copyStack;

Referenced by DocPara::handleInheritDoc.

exampleName​

QCString DocParserContext::exampleName

Definition at line 79 of file docparser_p.h.

79 QCString exampleName;

Referenced by DocPara::handleCommand, DocPara::handleInclude, DocPara::handleIncludeOperator, DocPara::handleStartCode, validatingParseDoc, validatingParseText and validatingParseTitle.

fileName​

QCString DocParserContext::fileName

Definition at line 70 of file docparser_p.h.

70 QCString fileName;

Referenced by createRef, DocPara::handleFile, DocPara::handleIFile, DocPara::handleInclude, validatingParseDoc, validatingParseText and validatingParseTitle.

hasParamCommand​

bool DocParserContext::hasParamCommand = false

Definition at line 73 of file docparser_p.h.

73 bool hasParamCommand = false;

Referenced by DocPara::handleInheritDoc, DocParamList::parse, DocParamList::parseXml, validatingParseDoc, validatingParseText and validatingParseTitle.

hasReturnCommand​

bool DocParserContext::hasReturnCommand = false

Definition at line 74 of file docparser_p.h.

74 bool hasReturnCommand = false;

Referenced by DocPara::handleCommand, DocPara::handleHtmlStartTag, DocPara::handleInheritDoc, DocParamList::parse, DocParamList::parseXml, validatingParseDoc, validatingParseText and validatingParseTitle.

includeFileLength​

size_t DocParserContext::includeFileLength = 0

Definition at line 87 of file docparser_p.h.

87 size_t includeFileLength = 0;

Referenced by DocInclude::parse, DocIncOperator::parse, validatingParseDoc, validatingParseText and validatingParseTitle.

includeFileLine​

int DocParserContext::includeFileLine

Definition at line 88 of file docparser_p.h.

88 int includeFileLine;

Referenced by DocInclude::parse and DocIncOperator::parse.

includeFileName​

QCString DocParserContext::includeFileName

Definition at line 84 of file docparser_p.h.

84 QCString includeFileName;

Referenced by DocInclude::parse and DocIncOperator::parse.

includeFileOffset​

size_t DocParserContext::includeFileOffset = 0

Definition at line 86 of file docparser_p.h.

86 size_t includeFileOffset = 0;

Referenced by DocInclude::parse, DocIncOperator::parse, validatingParseDoc, validatingParseText and validatingParseTitle.

includeFileShowLineNo​

bool DocParserContext::includeFileShowLineNo = false

Definition at line 89 of file docparser_p.h.

89 bool includeFileShowLineNo = false;

Referenced by DocInclude::parse and DocIncOperator::parse.

includeFileText​

QCString DocParserContext::includeFileText

Definition at line 85 of file docparser_p.h.

85 QCString includeFileText;

Referenced by DocInclude::parse, DocIncOperator::parse, validatingParseDoc, validatingParseText and validatingParseTitle.

initialStyleStack​

DocStyleChangeStack DocParserContext::initialStyleStack

Definition at line 68 of file docparser_p.h.

68 DocStyleChangeStack initialStyleStack;

Referenced by validatingParseDoc, validatingParseText and validatingParseTitle.

inSeeBlock​

bool DocParserContext::inSeeBlock = false

Definition at line 63 of file docparser_p.h.

63 bool inSeeBlock = false;

Referenced by DocSimpleSect::appendLinkWord, DocPara::handleCommand, DocPara::handleHtmlStartTag, validatingParseDoc, validatingParseText and validatingParseTitle.

insideHtmlLink​

bool DocParserContext::insideHtmlLink = false

Definition at line 65 of file docparser_p.h.

65 bool insideHtmlLink = false;

Referenced by DocRef::parse, DocTitle::parseFromString, validatingParseDoc, validatingParseText and validatingParseTitle.

isExample​

bool DocParserContext::isExample = false

Definition at line 78 of file docparser_p.h.

78 bool isExample = false;

Referenced by DocPara::handleCommand, DocPara::handleInclude, DocPara::handleIncludeOperator, DocPara::handleStartCode, validatingParseDoc, validatingParseText and validatingParseTitle.

lang​

SrcLangExt DocParserContext::lang = SrcLangExt::Cpp

Definition at line 82 of file docparser_p.h.

82 SrcLangExt lang = SrcLangExt::Cpp;

Referenced by validatingParseDoc, validatingParseText and validatingParseTitle.

lineNo​

int DocParserContext::lineNo = 0

Definition at line 93 of file docparser_p.h.

93 int lineNo = 0;

markdownSupport​

bool DocParserContext::markdownSupport = false

Definition at line 94 of file docparser_p.h.

94 bool markdownSupport = false;

Referenced by validatingParseDoc, validatingParseText and validatingParseTitle.

memberDef​

const MemberDef* DocParserContext::memberDef = nullptr

Definition at line 77 of file docparser_p.h.

77 const MemberDef * memberDef = nullptr;

Referenced by DocPara::handleCommand, DocPara::handleInheritDoc, validatingParseDoc, validatingParseText and validatingParseTitle.

nodeStack​

DocNodeStack DocParserContext::nodeStack

Definition at line 66 of file docparser_p.h.

66 DocNodeStack nodeStack;

Referenced by checkIfHtmlEndTagEndsAutoList, DocPara::handleCommand, DocPara::handleHtmlStartTag, DocPara::handleInheritDoc, DocPara::handleLink, validatingParseDoc, validatingParseText and validatingParseTitle.

paramsFound​

StringMultiSet DocParserContext::paramsFound

Definition at line 76 of file docparser_p.h.

76 StringMultiSet paramsFound;

Referenced by DocPara::handleInheritDoc, validatingParseDoc, validatingParseText and validatingParseTitle.

prefix​

QCString DocParserContext::prefix

Definition at line 81 of file docparser_p.h.

81 QCString prefix;

relPath​

QCString DocParserContext::relPath

Definition at line 71 of file docparser_p.h.

71 QCString relPath;

Referenced by validatingParseDoc, validatingParseText and validatingParseTitle.

retvalsFound​

StringMultiSet DocParserContext::retvalsFound

Definition at line 75 of file docparser_p.h.

75 StringMultiSet retvalsFound;

Referenced by DocPara::handleInheritDoc, validatingParseDoc, validatingParseText and validatingParseTitle.

scope​

const Definition* DocParserContext::scope = nullptr

Definition at line 61 of file docparser_p.h.

61 const Definition *scope = nullptr;

Referenced by DocPara::handleCommand, DocPara::handleInheritDoc and validatingParseDoc.

searchUrl​

QCString DocParserContext::searchUrl

Definition at line 80 of file docparser_p.h.

80 QCString searchUrl;

Referenced by validatingParseDoc, validatingParseText and validatingParseTitle.

stripCodeComments​

bool DocParserContext::stripCodeComments = true

Definition at line 90 of file docparser_p.h.

90 bool stripCodeComments = true;

Referenced by DocInclude::parse and DocIncOperator::parse.

styleStack​

DocStyleChangeStack DocParserContext::styleStack

Definition at line 67 of file docparser_p.h.

67 DocStyleChangeStack styleStack;

Referenced by checkIfHtmlEndTagEndsAutoList, DocPara::handleInheritDoc, validatingParseDoc, validatingParseText and validatingParseTitle.

token​

TokenInfo* DocParserContext::token = nullptr

Definition at line 92 of file docparser_p.h.

92 TokenInfo *token = nullptr;

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, validatingParseText and validatingParseTitle.

xmlComment​

bool DocParserContext::xmlComment = false

Definition at line 64 of file docparser_p.h.

64 bool xmlComment = false;

Referenced by DocPara::handleHtmlStartTag, validatingParseDoc, validatingParseText and validatingParseTitle.

The documentation for this struct was generated from the following file:

Generated via doxygen2docusaurus by Doxygen 1.14.0.