Doxygen
Loading...
Searching...
No Matches
DocParserContext Struct Reference

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

#include <src/docparser_p.h>

Collaboration diagram for DocParserContext:

Public Attributes

const Definition * scope = nullptr
DString context
bool inSeeBlock = false
bool inCodeStyle = false
bool xmlComment = false
bool insideHtmlLink = false
DocNodeStack nodeStack
DocStyleChangeStack styleStack
DocStyleChangeStack initialStyleStack
DefinitionStack copyStack
DString fileName
DString relPath
bool hasParamCommand = false
bool hasReturnCommand = false
StringMultiSet retvalsFound
StringMultiSet paramsFound
int paramPosition = 0
int numParameters = 0
const MemberDef * memberDef = nullptr
bool isExample = false
DString exampleName
DString searchUrl
DString prefix
SrcLangExt lang = SrcLangExt::Cpp
DString includeFileName
DString 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
bool autolinkSupport = false

Detailed Description

Parser's context to store all global variables.

Definition at line 59 of file docparser_p.h.

Member Data Documentation

◆ autolinkSupport

bool DocParserContext::autolinkSupport = false

Definition at line 98 of file docparser_p.h.

Referenced by DocParser::handleLinkedWord(), validatingParseDoc(), validatingParseText(), and validatingParseTitle().

◆ context

DString DocParserContext::context

Definition at line 62 of file docparser_p.h.

Referenced by DocParser::defaultHandleToken(), DocLink::DocLink(), DocParser::findDocsForMemberOrCompound(), DocParser::handleCite(), DocPara::handleCommand(), DocPara::handleFile(), DocPara::handleInclude(), DocPara::handleIncludeOperator(), DocPara::handleInheritDoc(), DocParser::handleLinkedWord(), DocParser::handleRef(), DocPara::handleStartCode(), DocHtmlDescTitle::parse(), validatingParseDoc(), validatingParseText(), and validatingParseTitle().

◆ copyStack

DefinitionStack DocParserContext::copyStack

Definition at line 70 of file docparser_p.h.

Referenced by DocPara::handleInheritDoc(), and DocParser::processCopyDoc().

◆ exampleName

DString DocParserContext::exampleName

Definition at line 82 of file docparser_p.h.

Referenced by DocParser::defaultHandleToken(), DocPara::handleCommand(), DocPara::handleInclude(), DocPara::handleIncludeOperator(), DocPara::handleStartCode(), validatingParseDoc(), validatingParseText(), and validatingParseTitle().

◆ fileName

DString DocParserContext::fileName

Definition at line 71 of file docparser_p.h.

Referenced by createRef(), DocParser::defaultHandleToken(), DocAnchor::DocAnchor(), DocCite::DocCite(), DocEmoji::DocEmoji(), DocFormula::DocFormula(), DocHtmlCaption::DocHtmlCaption(), DocRef::DocRef(), DocParser::errorHandleDefaultToken(), DocParser::findAndCopyImage(), DocParser::handleAHref(), DocParser::handleAnchor(), DocParser::handleCite(), DocPara::handleFile(), DocParser::handleIFile(), DocParser::handleILine(), DocParser::handleImage(), DocParser::handleImg(), DocPara::handleInclude(), DocParser::handleInternalRef(), DocParser::handleLinkedWord(), DocParser::handlePrefix(), DocParser::handleRef(), DocParser::handleStyleArgument(), DocParser::handleStyleEnter(), DocParser::handleStyleLeave(), DocParser::handleUnclosedStyleCommands(), DocParser::internalValidatingParseDoc(), DocParamList::parse(), DocParser::processCopyDoc(), DocParser::pushContext(), DocParser::readTextFileByName(), skipSpacesForTable(), validatingParseDoc(), validatingParseText(), and validatingParseTitle().

◆ hasParamCommand

bool DocParserContext::hasParamCommand = false

Definition at line 74 of file docparser_p.h.

Referenced by DocParser::checkUnOrMultipleDocumentedParams(), DocPara::handleInheritDoc(), DocParamList::parse(), DocParamList::parseXml(), validatingParseDoc(), validatingParseText(), and validatingParseTitle().

◆ hasReturnCommand

bool DocParserContext::hasReturnCommand = false

Definition at line 75 of file docparser_p.h.

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 90 of file docparser_p.h.

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

◆ includeFileLine

int DocParserContext::includeFileLine

Definition at line 91 of file docparser_p.h.

Referenced by DocInclude::parse(), and DocIncOperator::parse().

◆ includeFileName

DString DocParserContext::includeFileName

Definition at line 87 of file docparser_p.h.

Referenced by DocInclude::parse(), and DocIncOperator::parse().

◆ includeFileOffset

size_t DocParserContext::includeFileOffset = 0

Definition at line 89 of file docparser_p.h.

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

◆ includeFileShowLineNo

bool DocParserContext::includeFileShowLineNo = false

Definition at line 92 of file docparser_p.h.

Referenced by DocInclude::parse(), and DocIncOperator::parse().

◆ includeFileText

DString DocParserContext::includeFileText

Definition at line 88 of file docparser_p.h.

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

◆ inCodeStyle

bool DocParserContext::inCodeStyle = false

Definition at line 64 of file docparser_p.h.

Referenced by DocParser::handleLinkedWord(), DocParser::handleStyleEnter(), DocParser::handleStyleLeave(), validatingParseDoc(), validatingParseText(), and validatingParseTitle().

◆ initialStyleStack

DocStyleChangeStack DocParserContext::initialStyleStack

Definition at line 69 of file docparser_p.h.

Referenced by DocParser::handleInitialStyleCommands(), DocParser::handlePendingStyleCommands(), DocParser::handleUnclosedStyleCommands(), validatingParseDoc(), validatingParseText(), and validatingParseTitle().

◆ inSeeBlock

bool DocParserContext::inSeeBlock = false

Definition at line 63 of file docparser_p.h.

Referenced by DocSimpleSect::appendLinkWord(), DocLink::DocLink(), DocRef::DocRef(), DocPara::handleCommand(), DocPara::handleHtmlStartTag(), DocParser::handleLinkedWord(), DocParamList::parse(), validatingParseDoc(), validatingParseText(), and validatingParseTitle().

◆ insideHtmlLink

bool DocParserContext::insideHtmlLink = false

Definition at line 66 of file docparser_p.h.

Referenced by DocParser::defaultHandleToken(), DocParser::handleAHref(), DocParser::handleLinkedWord(), DocParser::internalValidatingParseDoc(), DocRef::parse(), DocTitle::parseFromString(), validatingParseDoc(), validatingParseText(), and validatingParseTitle().

◆ isExample

bool DocParserContext::isExample = false

Definition at line 81 of file docparser_p.h.

Referenced by DocParser::defaultHandleToken(), DocPara::handleCommand(), DocPara::handleInclude(), DocPara::handleIncludeOperator(), DocPara::handleStartCode(), validatingParseDoc(), validatingParseText(), and validatingParseTitle().

◆ lang

SrcLangExt DocParserContext::lang = SrcLangExt::Cpp

Definition at line 85 of file docparser_p.h.

Referenced by DocLink::DocLink(), DocRef::DocRef(), DocParser::handleLinkedWord(), validatingParseDoc(), validatingParseText(), and validatingParseTitle().

◆ lineNo

int DocParserContext::lineNo = 0

Definition at line 96 of file docparser_p.h.

◆ markdownSupport

bool DocParserContext::markdownSupport = false

Definition at line 97 of file docparser_p.h.

Referenced by DocParser::internalValidatingParseDoc(), validatingParseDoc(), validatingParseText(), and validatingParseTitle().

◆ memberDef

const MemberDef* DocParserContext::memberDef = nullptr

Definition at line 80 of file docparser_p.h.

Referenced by DocParser::checkArgumentName(), DocParser::checkRetvalName(), DocParser::checkUnOrMultipleDocumentedParams(), DocRef::DocRef(), DocPara::handleCommand(), DocPara::handleInheritDoc(), DocParser::handleLinkedWord(), validatingParseDoc(), validatingParseText(), and validatingParseTitle().

◆ nodeStack

DocNodeStack DocParserContext::nodeStack

Definition at line 67 of file docparser_p.h.

Referenced by AutoNodeStack::AutoNodeStack(), checkIfHtmlEndTagEndsAutoList(), DocParser::defaultHandleToken(), DocPara::handleCommand(), DocPara::handleHtmlStartTag(), DocPara::handleInheritDoc(), DocPara::handleLink(), DocParser::handlePendingStyleCommands(), DocParser::handleStyleEnter(), DocParser::handleStyleLeave(), validatingParseDoc(), validatingParseText(), validatingParseTitle(), and AutoNodeStack::~AutoNodeStack().

◆ numParameters

int DocParserContext::numParameters = 0

Definition at line 79 of file docparser_p.h.

Referenced by DocParser::checkArgumentName(), DocParser::checkUnOrMultipleDocumentedParams(), and validatingParseDoc().

◆ paramPosition

int DocParserContext::paramPosition = 0

Definition at line 78 of file docparser_p.h.

Referenced by DocParser::checkUnOrMultipleDocumentedParams(), DocPara::handleCommand(), and validatingParseDoc().

◆ paramsFound

StringMultiSet DocParserContext::paramsFound

Definition at line 77 of file docparser_p.h.

Referenced by DocParser::checkArgumentName(), DocParser::checkUnOrMultipleDocumentedParams(), DocPara::handleInheritDoc(), validatingParseDoc(), validatingParseText(), and validatingParseTitle().

◆ prefix

DString DocParserContext::prefix

Definition at line 84 of file docparser_p.h.

Referenced by DocLink::DocLink(), DocRef::DocRef(), and DocParser::handlePrefix().

◆ relPath

DString DocParserContext::relPath

Definition at line 72 of file docparser_p.h.

Referenced by DocCite::DocCite(), DocDiaFile::DocDiaFile(), DocDotFile::DocDotFile(), DocLink::DocLink(), DocMermaidFile::DocMermaidFile(), DocMscFile::DocMscFile(), DocPlantUmlFile::DocPlantUmlFile(), DocRef::DocRef(), DocParser::handleAHref(), validatingParseDoc(), validatingParseText(), and validatingParseTitle().

◆ retvalsFound

StringMultiSet DocParserContext::retvalsFound

Definition at line 76 of file docparser_p.h.

Referenced by DocParser::checkRetvalName(), DocPara::handleInheritDoc(), validatingParseDoc(), validatingParseText(), and validatingParseTitle().

◆ scope

const Definition* DocParserContext::scope = nullptr

Definition at line 61 of file docparser_p.h.

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

◆ searchUrl

DString DocParserContext::searchUrl

Definition at line 83 of file docparser_p.h.

Referenced by DocLinkedWord::DocLinkedWord(), DocWord::DocWord(), validatingParseDoc(), validatingParseText(), and validatingParseTitle().

◆ stripCodeComments

bool DocParserContext::stripCodeComments = true

Definition at line 93 of file docparser_p.h.

Referenced by DocInclude::parse(), and DocIncOperator::parse().

◆ styleStack

DocStyleChangeStack DocParserContext::styleStack

Definition at line 68 of file docparser_p.h.

Referenced by checkIfHtmlEndTagEndsAutoList(), DocPara::handleInheritDoc(), DocParser::handlePendingStyleCommands(), DocParser::handleStyleArgument(), DocParser::handleStyleEnter(), DocParser::handleStyleLeave(), validatingParseDoc(), validatingParseText(), and validatingParseTitle().

◆ token

TokenInfo* DocParserContext::token = nullptr

Definition at line 95 of file docparser_p.h.

Referenced by DocParser::checkArgumentName(), checkIfHtmlEndTagEndsAutoList(), DocParser::checkRetvalName(), DocParser::defaultHandleTitleAndSize(), DocParser::defaultHandleToken(), DocParser::errorHandleDefaultToken(), DocParser::handleAnchor(), DocParser::handleCite(), DocPara::handleCommand(), DocPara::handleDoxyConfig(), DocPara::handleEmoji(), DocPara::handleFile(), DocPara::handleHtmlStartTag(), DocParser::handleIFile(), DocParser::handleImage(), DocPara::handleInclude(), DocPara::handleIncludeOperator(), DocParser::handleInternalRef(), DocPara::handleLink(), DocParser::handleLinkedWord(), DocParser::handleParameterType(), DocParser::handlePrefix(), DocParser::handleRef(), DocPara::handleSection(), DocPara::handleShowDate(), DocPara::handleStartCode(), DocParser::handleStyleArgument(), 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(), DocParser::popContext(), DocParser::pushContext(), skipSpacesForTable(), validatingParseDoc(), validatingParseText(), and validatingParseTitle().

◆ xmlComment

bool DocParserContext::xmlComment = false

Definition at line 65 of file docparser_p.h.

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

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