类 DocParser 继承关系图:

DocParser 的协作图:

Public 成员函数
void	pushContext ()

void	popContext ()

void	handleImg (DocNode *parent, DocNodeList &children, const HtmlAttribList &tagHtmlAttribs)

int	internalValidatingParseDoc (DocNode *parent, DocNodeList &children, const QCString &doc)

QCString	processCopyDoc (const char *data, uint &len)

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

void	checkArgumentName ()

void	checkRetvalName ()

void	checkUnOrMultipleDocumentedParams ()

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

bool	defaultHandleToken (DocNode *parent, int tok, DocNodeList &children, bool handleWord=TRUE)

void	errorHandleDefaultToken (DocNode *parent, int tok, DocNodeList &children, const QCString &txt)

void	defaultHandleTitleAndSize (const int cmd, DocNode *parent, DocNodeList &children, QCString &width, QCString &height)

int	handleStyleArgument (DocNode *parent, DocNodeList &children, const QCString &cmdName)

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

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

void	handlePendingStyleCommands (DocNode *parent, DocNodeList &children)

void	handleInitialStyleCommands (DocPara *parent, DocNodeList &children)

int	handleAHref (DocNode *parent, DocNodeList &children, const HtmlAttribList &tagHtmlAttribs)

void	handleUnclosedStyleCommands ()

void	handleLinkedWord (DocNode *parent, DocNodeList &children, bool ignoreAutoLinkFlag=FALSE)

void	handleParameterType (DocNode *parent, DocNodeList &children, const QCString &paramTypes)

DocInternalRef *	handleInternalRef (DocNode *parent)

DocAnchor *	handleAnchor (DocNode *parent)

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

Public 成员函数继承自 IDocParser
virtual	~IDocParser ()

Public 属性
std::stack< DocParserContext >	contextStack

DocParserContext	context

DocTokenizer	tokenizer

详细描述

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

成员函数说明

◆ 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).

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

 {
   if (!Config_getBool(WARN_IF_DOC_ERROR)) return;
   if (context.memberDef==0) return; // not a member
   std::string name = context.token->name.str();
   const ArgumentList &al=context.memberDef->isDocsForDefinition() ?
                          context.memberDef->argumentList() :
                          context.memberDef->declArgumentList();
   SrcLangExt lang      = context.memberDef->getLanguage();
   //printf("isDocsForDefinition()=%d\n",context.memberDef->isDocsForDefinition());
   if (al.empty()) return; // no argument list
  
   static const reg::Ex re(R"(\$?\w+\.*)");
   reg::Iterator it(name,re);
   reg::Iterator end;
   for (; it!=end ; ++it)
   {
     const auto &match = *it;
     QCString aName=match.str();
     if (lang==SrcLangExt_Fortran) aName=aName.lower();
     //printf("aName='%s'\n",qPrint(aName));
     bool found=FALSE;
     for (const Argument &a : al)
     {
       QCString argName = context.memberDef->isDefine() ? a.type : a.name;
       if (lang==SrcLangExt_Fortran) argName=argName.lower();
       argName=argName.stripWhiteSpace();
       //printf("argName='%s' aName=%s\n",qPrint(argName),qPrint(aName));
       if (argName.right(3)=="...") argName=argName.left(argName.length()-3);
       if (aName==argName)
       {
         context.paramsFound.insert(aName.str());
         found=TRUE;
         break;
       }
     }
     if (!found)
     {
       //printf("member type=%d\n",context.memberDef->memberType());
       QCString scope=context.memberDef->getScopeString();
       if (!scope.isEmpty()) scope+="::"; else scope="";
       QCString inheritedFrom = "";
       QCString docFile = context.memberDef->docFile();
       int docLine = context.memberDef->docLine();
       const MemberDef *inheritedMd = context.memberDef->inheritsDocsFrom();
       if (inheritedMd) // documentation was inherited
       {
         inheritedFrom.sprintf(" inherited from member %s at line "
             "%d in file %s",qPrint(inheritedMd->name()),
             inheritedMd->docLine(),qPrint(inheritedMd->docFile()));
         docFile = context.memberDef->getDefFileName();
         docLine = context.memberDef->getDefLine();
       }
       QCString alStr = argListToString(al);
       warn_doc_error(docFile,docLine,
           "argument '%s' of command @param "
           "is not found in the argument list of %s%s%s%s",
           qPrint(aName), qPrint(scope), qPrint(context.memberDef->name()),
           qPrint(alStr), qPrint(inheritedFrom));
     }
   }
 }

引用了 argListToString(), MemberDef::argumentList(), Config_getBool, context, MemberDef::declArgumentList(), Definition::docFile(), Definition::docLine(), ArgumentList::empty(), end(), FALSE, Definition::getDefFileName(), Definition::getDefLine(), Definition::getLanguage(), MemberDef::getScopeString(), MemberDef::inheritsDocsFrom(), MemberDef::isDefine(), MemberDef::isDocsForDefinition(), QCString::isEmpty(), QCString::left(), QCString::length(), QCString::lower(), reg::match(), DocParserContext::memberDef, TokenInfo::name, Definition::name(), DocParserContext::paramsFound, qPrint(), QCString::right(), QCString::sprintf(), SrcLangExt_Fortran, QCString::str(), QCString::stripWhiteSpace(), DocParserContext::token, TRUE , 以及 warn_doc_error().

被这些函数引用 DocParamList::parse() , 以及 DocParamList::parseXml().

◆ checkRetvalName()

void DocParser::checkRetvalName ( )

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

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

 {
   QCString name = context.token->name;
   if (!Config_getBool(WARN_IF_DOC_ERROR)) return;
   if (context.memberDef==0 || name.isEmpty()) return; // not a member or no valid name
   if (context.retvalsFound.count(name.str())==1) // only report the first double entry
   {
      warn_doc_error(context.memberDef->getDefFileName(),
                     context.memberDef->getDefLine(),
                     "%s",
                     qPrint("return value '" + name + "' of " +
                     QCString(context.memberDef->qualifiedName()) +
                     " has multiple documentation sections"));
   }
   context.retvalsFound.insert(name.str());
 }

引用了 Config_getBool, context, Definition::getDefFileName(), Definition::getDefLine(), QCString::isEmpty(), DocParserContext::memberDef, TokenInfo::name, qPrint(), MemberDef::qualifiedName(), DocParserContext::retvalsFound, QCString::str(), DocParserContext::token , 以及 warn_doc_error().

被这些函数引用 DocParamList::parse() , 以及 DocParamList::parseXml().

◆ 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.

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

 {
   if (context.memberDef && context.hasParamCommand)
   {
     const ArgumentList &al=context.memberDef->isDocsForDefinition() ?
       context.memberDef->argumentList() :
       context.memberDef->declArgumentList();
     SrcLangExt lang = context.memberDef->getLanguage();
     if (!al.empty())
     {
       ArgumentList undocParams;
       for (const Argument &a: al)
       {
         QCString argName = context.memberDef->isDefine() ? a.type : a.name;
         if (lang==SrcLangExt_Fortran) argName = argName.lower();
         argName=argName.stripWhiteSpace();
         QCString aName = argName;
         if (argName.right(3)=="...") argName=argName.left(argName.length()-3);
         if (lang==SrcLangExt_Python && (argName=="self" || argName=="cls"))
         {
           // allow undocumented self / cls parameter for Python
         }
         else if (!argName.isEmpty())
         {
           size_t count = context.paramsFound.count(argName.str());
           if (count==0 && a.docs.isEmpty())
           {
             undocParams.push_back(a);
           }
           else if (count>1 && Config_getBool(WARN_IF_DOC_ERROR))
           {
             warn_doc_error(context.memberDef->getDefFileName(),
                            context.memberDef->getDefLine(),
                            "%s",
                            qPrint("argument '" + aName +
                            "' from the argument list of " +
                            QCString(context.memberDef->qualifiedName()) +
                            " has multiple @param documentation sections"));
           }
         }
       }
       if (!undocParams.empty() && Config_getBool(WARN_IF_INCOMPLETE_DOC))
       {
         bool first=TRUE;
         QCString errMsg = "The following parameter";
         if (undocParams.size()>1) errMsg+="s";
         errMsg+=" of "+
             QCString(context.memberDef->qualifiedName()) +
             QCString(argListToString(al)) +
             (undocParams.size()>1 ? " are" : " is") + " not documented:\n";
         for (const Argument &a : undocParams)
         {
           QCString argName = context.memberDef->isDefine() ? a.type : a.name;
           if (lang==SrcLangExt_Fortran) argName = argName.lower();
           argName=argName.stripWhiteSpace();
           if (!first) errMsg+="\n";
           first=FALSE;
           errMsg+="  parameter '"+argName+"'";
         }
         warn_incomplete_doc(context.memberDef->getDefFileName(),
                             context.memberDef->getDefLine(),
                             "%s",
                             qPrint(substitute(errMsg,"%","%%")));
       }
     }
   }
 }

引用了 argListToString(), MemberDef::argumentList(), Config_getBool, context, MemberDef::declArgumentList(), ArgumentList::empty(), FALSE, Definition::getDefFileName(), Definition::getDefLine(), Definition::getLanguage(), DocParserContext::hasParamCommand, MemberDef::isDefine(), MemberDef::isDocsForDefinition(), QCString::isEmpty(), QCString::left(), QCString::length(), QCString::lower(), DocParserContext::memberDef, DocParserContext::paramsFound, ArgumentList::push_back(), qPrint(), MemberDef::qualifiedName(), QCString::right(), ArgumentList::size(), SrcLangExt_Fortran, SrcLangExt_Python, QCString::str(), QCString::stripWhiteSpace(), substitute(), TRUE, warn_doc_error() , 以及 warn_incomplete_doc().

被这些函数引用 validatingParseDoc().

◆ defaultHandleTitleAndSize()

void DocParser::defaultHandleTitleAndSize	(	const int	cmd,
		DocNode *	parent,
		DocNodeList &	children,
		QCString &	width,
		QCString &	height
	)

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

 {
   auto ns = AutoNodeStack(*this,parent);
  
   // parse title
   tokenizer.setStateTitle();
   int tok;
   while ((tok=tokenizer.lex()))
   {
     if (tok==TK_WORD && (context.token->name=="width=" || context.token->name=="height="))
     {
       // special case: no title, but we do have a size indicator
       break;
     }
     if (!defaultHandleToken(parent,tok,children))
     {
       errorHandleDefaultToken(parent,tok,children,Mappers::cmdMapper->find(cmd));
     }
   }
   // parse size attributes
   if (tok == 0)
   {
     tok=tokenizer.lex();
   }
   while (tok==TK_WHITESPACE || tok==TK_WORD) // there are values following the title
   {
     if(tok == TK_WORD)
     {
       if (context.token->name=="width=" || context.token->name=="height=")
       {
         tokenizer.setStateTitleAttrValue();
         context.token->name = context.token->name.left(context.token->name.length()-1);
       }
  
       if (context.token->name=="width")
       {
         width = context.token->chars;
       }
       else if (context.token->name=="height")
       {
         height = context.token->chars;
       }
       else
       {
         warn_doc_error(context.fileName,tokenizer.getLineNr(),"Unknown option '%s' after \\%s command, expected 'width' or 'height'",
                        qPrint(context.token->name), qPrint(Mappers::cmdMapper->find(cmd)));
         break;
       }
     }
  
     tok=tokenizer.lex();
   }
   tokenizer.setStatePara();
  
   handlePendingStyleCommands(parent,children);
 }

引用了 TokenInfo::chars, Mappers::cmdMapper, context, defaultHandleToken(), errorHandleDefaultToken(), DocParserContext::fileName, DocTokenizer::getLineNr(), handlePendingStyleCommands(), QCString::left(), QCString::length(), DocTokenizer::lex(), TokenInfo::name, qPrint(), DocTokenizer::setStatePara(), DocTokenizer::setStateTitle(), DocTokenizer::setStateTitleAttrValue(), TK_WHITESPACE, TK_WORD, DocParserContext::token, tokenizer , 以及 warn_doc_error().

被这些函数引用 DocPara::handleCommand(), DocImage::parse(), DocDotFile::parse(), DocMscFile::parse() , 以及 DocDiaFile::parse().

◆ defaultHandleToken()

bool DocParser::defaultHandleToken	(	DocNode *	parent,
		int	tok,
		DocNodeList &	children,
		bool	handleWord = `TRUE`
	)

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

 {
   DBG(("token %s at %d",DocTokenizer::tokToString(tok),tokenizer.getLineNr()));
   if (tok==TK_WORD || tok==TK_LNKWORD || tok==TK_SYMBOL || tok==TK_URL ||
       tok==TK_COMMAND_AT || tok==TK_COMMAND_BS || tok==TK_HTMLTAG
      )
   {
     DBG((" name=%s",qPrint(context.token->name)));
   }
   DBG(("\n"));
 reparsetoken:
   QCString tokenName = context.token->name;
   switch (tok)
   {
     case TK_COMMAND_AT:
         // fall through
     case TK_COMMAND_BS:
       switch (Mappers::cmdMapper->map(tokenName))
       {
         case CMD_BSLASH:
           children.push_back(std::make_unique<DocSymbol>(*this,parent,DocSymbol::Sym_BSlash));
           break;
         case CMD_AT:
           children.push_back(std::make_unique<DocSymbol>(*this,parent,DocSymbol::Sym_At));
           break;
         case CMD_LESS:
           children.push_back(std::make_unique<DocSymbol>(*this,parent,DocSymbol::Sym_Less));
           break;
         case CMD_GREATER:
           children.push_back(std::make_unique<DocSymbol>(*this,parent,DocSymbol::Sym_Greater));
           break;
         case CMD_AMP:
           children.push_back(std::make_unique<DocSymbol>(*this,parent,DocSymbol::Sym_Amp));
           break;
         case CMD_DOLLAR:
           children.push_back(std::make_unique<DocSymbol>(*this,parent,DocSymbol::Sym_Dollar));
           break;
         case CMD_HASH:
           children.push_back(std::make_unique<DocSymbol>(*this,parent,DocSymbol::Sym_Hash));
           break;
         case CMD_DCOLON:
           children.push_back(std::make_unique<DocSymbol>(*this,parent,DocSymbol::Sym_DoubleColon));
           break;
         case CMD_PERCENT:
           children.push_back(std::make_unique<DocSymbol>(*this,parent,DocSymbol::Sym_Percent));
           break;
         case CMD_NDASH:
           children.push_back(std::make_unique<DocSymbol>(*this,parent,DocSymbol::Sym_Minus));
           children.push_back(std::make_unique<DocSymbol>(*this,parent,DocSymbol::Sym_Minus));
           break;
         case CMD_MDASH:
           children.push_back(std::make_unique<DocSymbol>(*this,parent,DocSymbol::Sym_Minus));
           children.push_back(std::make_unique<DocSymbol>(*this,parent,DocSymbol::Sym_Minus));
           children.push_back(std::make_unique<DocSymbol>(*this,parent,DocSymbol::Sym_Minus));
           break;
         case CMD_QUOTE:
           children.push_back(std::make_unique<DocSymbol>(*this,parent,DocSymbol::Sym_Quot));
           break;
         case CMD_PUNT:
           children.push_back(std::make_unique<DocSymbol>(*this,parent,DocSymbol::Sym_Dot));
           break;
         case CMD_PLUS:
           children.push_back(std::make_unique<DocSymbol>(*this,parent,DocSymbol::Sym_Plus));
           break;
         case CMD_MINUS:
           children.push_back(std::make_unique<DocSymbol>(*this,parent,DocSymbol::Sym_Minus));
           break;
         case CMD_EQUAL:
           children.push_back(std::make_unique<DocSymbol>(*this,parent,DocSymbol::Sym_Equal));
           break;
         case CMD_EMPHASIS:
           {
             children.push_back(std::make_unique<DocStyleChange>(*this,parent,(uint)context.nodeStack.size(),DocStyleChange::Italic,tokenName,TRUE));
             tok=handleStyleArgument(parent,children,tokenName);
             children.push_back(std::make_unique<DocStyleChange>(*this,parent,(uint)context.nodeStack.size(),DocStyleChange::Italic,tokenName,FALSE));
             if (tok!=TK_WORD) children.push_back(std::make_unique<DocWhiteSpace>(*this,parent," "));
             if (tok==TK_NEWPARA) goto handlepara;
             else if (tok==TK_WORD || tok==TK_HTMLTAG)
             {
               DBG(("CMD_EMPHASIS: reparsing command %s\n",qPrint(context.token->name)));
               goto reparsetoken;
             }
           }
           break;
         case CMD_BOLD:
           {
             children.push_back(std::make_unique<DocStyleChange>(*this,parent,(uint)context.nodeStack.size(),DocStyleChange::Bold,tokenName,TRUE));
             tok=handleStyleArgument(parent,children,tokenName);
             children.push_back(std::make_unique<DocStyleChange>(*this,parent,(uint)context.nodeStack.size(),DocStyleChange::Bold,tokenName,FALSE));
             if (tok!=TK_WORD) children.push_back(std::make_unique<DocWhiteSpace>(*this,parent," "));
             if (tok==TK_NEWPARA) goto handlepara;
             else if (tok==TK_WORD || tok==TK_HTMLTAG)
             {
               DBG(("CMD_BOLD: reparsing command %s\n",qPrint(context.token->name)));
               goto reparsetoken;
             }
           }
           break;
         case CMD_CODE:
           {
             children.push_back(std::make_unique<DocStyleChange>(*this,parent,(uint)context.nodeStack.size(),DocStyleChange::Code,tokenName,TRUE));
             tok=handleStyleArgument(parent,children,tokenName);
             children.push_back(std::make_unique<DocStyleChange>(*this,parent,(uint)context.nodeStack.size(),DocStyleChange::Code,tokenName,FALSE));
             if (tok!=TK_WORD) children.push_back(std::make_unique<DocWhiteSpace>(*this,parent," "));
             if (tok==TK_NEWPARA) goto handlepara;
             else if (tok==TK_WORD || tok==TK_HTMLTAG)
             {
               DBG(("CMD_CODE: reparsing command %s\n",qPrint(context.token->name)));
               goto reparsetoken;
             }
           }
           break;
         case CMD_HTMLONLY:
           {
             tokenizer.setStateHtmlOnly();
             tok = tokenizer.lex();
             children.push_back(std::make_unique<DocVerbatim>(*this,parent,context.context,context.token->verb,DocVerbatim::HtmlOnly,context.isExample,context.exampleName,context.token->name=="block"));
             if (tok==0) warn_doc_error(context.fileName,tokenizer.getLineNr(),"htmlonly section ended without end marker");
             tokenizer.setStatePara();
           }
           break;
         case CMD_MANONLY:
           {
             tokenizer.setStateManOnly();
             tok = tokenizer.lex();
             children.push_back(std::make_unique<DocVerbatim>(*this,parent,context.context,context.token->verb,DocVerbatim::ManOnly,context.isExample,context.exampleName));
             if (tok==0) warn_doc_error(context.fileName,tokenizer.getLineNr(),"manonly section ended without end marker");
             tokenizer.setStatePara();
           }
           break;
         case CMD_RTFONLY:
           {
             tokenizer.setStateRtfOnly();
             tok = tokenizer.lex();
             children.push_back(std::make_unique<DocVerbatim>(*this,parent,context.context,context.token->verb,DocVerbatim::RtfOnly,context.isExample,context.exampleName));
             if (tok==0) warn_doc_error(context.fileName,tokenizer.getLineNr(),"rtfonly section ended without end marker");
             tokenizer.setStatePara();
           }
           break;
         case CMD_LATEXONLY:
           {
             tokenizer.setStateLatexOnly();
             tok = tokenizer.lex();
             children.push_back(std::make_unique<DocVerbatim>(*this,parent,context.context,context.token->verb,DocVerbatim::LatexOnly,context.isExample,context.exampleName));
             if (tok==0) warn_doc_error(context.fileName,tokenizer.getLineNr(),"latexonly section ended without end marker");
             tokenizer.setStatePara();
           }
           break;
         case CMD_XMLONLY:
           {
             tokenizer.setStateXmlOnly();
             tok = tokenizer.lex();
             children.push_back(std::make_unique<DocVerbatim>(*this,parent,context.context,context.token->verb,DocVerbatim::XmlOnly,context.isExample,context.exampleName));
             if (tok==0) warn_doc_error(context.fileName,tokenizer.getLineNr(),"xmlonly section ended without end marker");
             tokenizer.setStatePara();
           }
           break;
         case CMD_DBONLY:
           {
             tokenizer.setStateDbOnly();
             tok = tokenizer.lex();
             children.push_back(std::make_unique<DocVerbatim>(*this,parent,context.context,context.token->verb,DocVerbatim::DocbookOnly,context.isExample,context.exampleName));
             if (tok==0) warn_doc_error(context.fileName,tokenizer.getLineNr(),"docbookonly section ended without end marker");
             tokenizer.setStatePara();
           }
           break;
         case CMD_FORMULA:
           {
             children.push_back(std::make_unique<DocFormula>(*this,parent,context.token->id));
           }
           break;
         case CMD_ANCHOR:
           {
             DocAnchor *anchor = handleAnchor(parent);
             if (anchor)
             {
               children.push_back(std::unique_ptr<DocAnchor>(anchor));
             }
           }
           break;
         case CMD_INTERNALREF:
           {
             DocInternalRef *ref = handleInternalRef(parent);
             if (ref)
             {
               children.push_back(std::unique_ptr<DocInternalRef>(ref));
               ref->parse();
             }
             tokenizer.setStatePara();
           }
           break;
         case CMD_SETSCOPE:
           {
             QCString scope;
             tokenizer.setStateSetScope();
             (void)tokenizer.lex();
             scope = context.token->name;
             context.context = scope;
             //printf("Found scope='%s'\n",qPrint(scope));
             tokenizer.setStatePara();
           }
           break;
         case CMD_IMAGE:
           ((DocPara *)parent) -> handleImage("image");
           break;
         default:
           return FALSE;
       }
       break;
     case TK_HTMLTAG:
       {
         switch (Mappers::htmlTagMapper->map(tokenName))
         {
           case HTML_DIV:
             warn_doc_error(context.fileName,tokenizer.getLineNr(),"found <div> tag in heading\n");
             break;
           case HTML_PRE:
             warn_doc_error(context.fileName,tokenizer.getLineNr(),"found <pre> tag in heading\n");
             break;
           case HTML_BOLD:
             if (!context.token->endTag)
             {
               handleStyleEnter(parent,children,DocStyleChange::Bold,tokenName,&context.token->attribs);
             }
             else
             {
               handleStyleLeave(parent,children,DocStyleChange::Bold,tokenName);
             }
             break;
           case HTML_S:
             if (!context.token->endTag)
             {
               handleStyleEnter(parent,children,DocStyleChange::S,tokenName,&context.token->attribs);
             }
             else
             {
               handleStyleLeave(parent,children,DocStyleChange::S,tokenName);
             }
             break;
           case HTML_STRIKE:
             if (!context.token->endTag)
             {
               handleStyleEnter(parent,children,DocStyleChange::Strike,tokenName,&context.token->attribs);
             }
             else
             {
               handleStyleLeave(parent,children,DocStyleChange::Strike,tokenName);
             }
             break;
           case HTML_DEL:
             if (!context.token->endTag)
             {
               handleStyleEnter(parent,children,DocStyleChange::Del,tokenName,&context.token->attribs);
             }
             else
             {
               handleStyleLeave(parent,children,DocStyleChange::Del,tokenName);
             }
             break;
           case HTML_UNDERLINE:
             if (!context.token->endTag)
             {
               handleStyleEnter(parent,children,DocStyleChange::Underline,tokenName,&context.token->attribs);
             }
             else
             {
               handleStyleLeave(parent,children,DocStyleChange::Underline,tokenName);
             }
             break;
           case HTML_INS:
             if (!context.token->endTag)
             {
               handleStyleEnter(parent,children,DocStyleChange::Ins,tokenName,&context.token->attribs);
             }
             else
             {
               handleStyleLeave(parent,children,DocStyleChange::Ins,tokenName);
             }
             break;
           case HTML_CODE:
           case XML_C:
             if (!context.token->endTag)
             {
               handleStyleEnter(parent,children,DocStyleChange::Code,tokenName,&context.token->attribs);
             }
             else
             {
               handleStyleLeave(parent,children,DocStyleChange::Code,tokenName);
             }
             break;
           case HTML_EMPHASIS:
             if (!context.token->endTag)
             {
               handleStyleEnter(parent,children,DocStyleChange::Italic,tokenName,&context.token->attribs);
             }
             else
             {
               handleStyleLeave(parent,children,DocStyleChange::Italic,tokenName);
             }
             break;
           case HTML_SUB:
             if (!context.token->endTag)
             {
               handleStyleEnter(parent,children,DocStyleChange::Subscript,tokenName,&context.token->attribs);
             }
             else
             {
               handleStyleLeave(parent,children,DocStyleChange::Subscript,tokenName);
             }
             break;
           case HTML_SUP:
             if (!context.token->endTag)
             {
               handleStyleEnter(parent,children,DocStyleChange::Superscript,tokenName,&context.token->attribs);
             }
             else
             {
               handleStyleLeave(parent,children,DocStyleChange::Superscript,tokenName);
             }
             break;
           case HTML_CENTER:
             if (!context.token->endTag)
             {
               handleStyleEnter(parent,children,DocStyleChange::Center,tokenName,&context.token->attribs);
             }
             else
             {
               handleStyleLeave(parent,children,DocStyleChange::Center,tokenName);
             }
             break;
           case HTML_SMALL:
             if (!context.token->endTag)
             {
               handleStyleEnter(parent,children,DocStyleChange::Small,tokenName,&context.token->attribs);
             }
             else
             {
               handleStyleLeave(parent,children,DocStyleChange::Small,tokenName);
             }
             break;
           case HTML_IMG:
             if (!context.token->endTag)
               handleImg(parent,children,context.token->attribs);
             break;
           default:
             return FALSE;
             break;
         }
       }
       break;
     case TK_SYMBOL:
       {
         DocSymbol::SymType s = DocSymbol::decodeSymbol(tokenName);
         if (s!=DocSymbol::Sym_Unknown)
         {
           children.push_back(std::make_unique<DocSymbol>(*this,parent,s));
         }
         else
         {
           return FALSE;
         }
       }
       break;
     case TK_WHITESPACE:
     case TK_NEWPARA:
 handlepara:
       if (insidePRE(parent) || !children.empty())
       {
         children.push_back(std::make_unique<DocWhiteSpace>(*this,parent,context.token->chars));
       }
       break;
     case TK_LNKWORD:
       if (handleWord)
       {
         handleLinkedWord(parent,children);
       }
       else
         return FALSE;
       break;
     case TK_WORD:
       if (handleWord)
       {
         children.push_back(std::make_unique<DocWord>(*this,parent,context.token->name));
       }
       else
         return FALSE;
       break;
     case TK_URL:
       if (context.insideHtmlLink)
       {
         children.push_back(std::make_unique<DocWord>(*this,parent,context.token->name));
       }
       else
       {
         children.push_back(std::make_unique<DocURL>(*this,parent,context.token->name,context.token->isEMailAddr));
       }
       break;
     default:
       return FALSE;
   }
   return TRUE;
 }

被这些函数引用 defaultHandleTitleAndSize(), handleStyleArgument(), DocPara::injectToken(), DocTitle::parse(), DocVhdlFlow::parse(), DocLink::parse(), DocRef::parse(), DocInternalRef::parse(), DocHRef::parse(), DocHtmlHeader::parse(), DocHtmlDescTitle::parse(), DocSecRefItem::parse() , 以及 DocHtmlCaption::parse().

◆ errorHandleDefaultToken()

void DocParser::errorHandleDefaultToken	(	DocNode *	parent,
		int	tok,
		DocNodeList &	children,
		const QCString &	txt
	)

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

 {
   const char *cmd_start = "\\";
   switch (tok)
   {
     case TK_COMMAND_AT:
       cmd_start = "@";
       // fall through
     case TK_COMMAND_BS:
       children.push_back(std::make_unique<DocWord>(*this,parent,TK_COMMAND_CHAR(tok) + context.token->name));
       warn_doc_error(context.fileName,tokenizer.getLineNr(),"Illegal command %s as part of a %s",
        qPrint(cmd_start + context.token->name),qPrint(txt));
       break;
     case TK_SYMBOL:
       warn_doc_error(context.fileName,tokenizer.getLineNr(),"Unsupported symbol %s found found as part of a %s",
            qPrint(context.token->name), qPrint(txt));
       break;
     default:
       children.push_back(std::make_unique<DocWord>(*this,parent,context.token->name));
       warn_doc_error(context.fileName,tokenizer.getLineNr(),"Unexpected token %s found as part of a %s",
         DocTokenizer::tokToString(tok), qPrint(txt));
       break;
   }
 }

引用了 context, DocParserContext::fileName, DocTokenizer::getLineNr(), TokenInfo::name, qPrint(), TK_COMMAND_AT, TK_COMMAND_BS, TK_COMMAND_CHAR, TK_SYMBOL, DocParserContext::token, tokenizer, DocTokenizer::tokToString() , 以及 warn_doc_error().

被这些函数引用 defaultHandleTitleAndSize(), handleStyleArgument(), DocTitle::parse(), DocVhdlFlow::parse(), DocRef::parse(), DocInternalRef::parse(), DocHRef::parse(), DocHtmlHeader::parse(), DocSecRefItem::parse() , 以及 DocHtmlCaption::parse().

◆ findAndCopyImage()

QCString DocParser::findAndCopyImage	(	const QCString &	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).

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

 {
   QCString result;
   bool ambig;
   FileDef *fd = findFileDef(Doxygen::imageNameLinkedMap,fileName,ambig);
   //printf("Search for %s\n",fileName);
   if (fd)
   {
     if (ambig & doWarn)
     {
       QCString text;
       text.sprintf("image file name %s is ambiguous.\n",qPrint(fileName));
       text+="Possible candidates:\n";
       text+=showFileDefMatches(Doxygen::imageNameLinkedMap,fileName);
       warn_doc_error(context.fileName,tokenizer.getLineNr(),"%s", qPrint(text));
     }
  
     QCString inputFile = fd->absFilePath();
     FileInfo infi(inputFile.str());
     if (infi.exists())
     {
       result = fileName;
       int i;
       if ((i=result.findRev('/'))!=-1 || (i=result.findRev('\\'))!=-1)
       {
         result = result.right((int)result.length()-i-1);
       }
       //printf("fileName=%s result=%s\n",fileName,qPrint(result));
       QCString outputDir;
       switch(type)
       {
         case DocImage::Html:
           if (!Config_getBool(GENERATE_HTML)) return result;
           outputDir = Config_getString(HTML_OUTPUT);
           break;
         case DocImage::Latex:
           if (!Config_getBool(GENERATE_LATEX)) return result;
           outputDir = Config_getString(LATEX_OUTPUT);
           break;
         case DocImage::DocBook:
           if (!Config_getBool(GENERATE_DOCBOOK)) return result;
           outputDir = Config_getString(DOCBOOK_OUTPUT);
           break;
         case DocImage::Rtf:
           if (!Config_getBool(GENERATE_RTF)) return result;
           outputDir = Config_getString(RTF_OUTPUT);
           break;
         case DocImage::Xml:
           if (!Config_getBool(GENERATE_XML)) return result;
           outputDir = Config_getString(XML_OUTPUT);
           break;
       }
       QCString outputFile = outputDir+"/"+result;
       FileInfo outfi(outputFile.str());
       if (outfi.isSymLink())
       {
         Dir().remove(outputFile.str());
         warn_doc_error(context.fileName,tokenizer.getLineNr(),
             "destination of image %s is a symlink, replacing with image",
             qPrint(outputFile));
       }
       if (outputFile!=inputFile) // prevent copying to ourself
       {
         if (copyFile(inputFile,outputFile) && type==DocImage::Html)
         {
           Doxygen::indexList->addImageFile(result);
         }
       }
     }
     else
     {
       warn_doc_error(context.fileName,tokenizer.getLineNr(),
           "could not open image %s",qPrint(fileName));
     }
  
     if (type==DocImage::Latex && Config_getBool(USE_PDFLATEX) &&
         fd->name().right(4)==".eps"
        )
     { // we have an .eps image in pdflatex mode => convert it to a pdf.
       QCString outputDir = Config_getString(LATEX_OUTPUT);
       QCString baseName  = fd->name().left(fd->name().length()-4);
       QCString epstopdfArgs(4096);
       epstopdfArgs.sprintf("\"%s/%s.eps\" --outfile=\"%s/%s.pdf\"",
                            qPrint(outputDir), qPrint(baseName),
                            qPrint(outputDir), qPrint(baseName));
       Portable::sysTimerStart();
       if (Portable::system("epstopdf",epstopdfArgs)!=0)
       {
         err("Problems running epstopdf. Check your TeX installation!\n");
       }
       Portable::sysTimerStop();
       return baseName;
     }
   }
   else
   {
     result=fileName;
     if (result.left(5)!="http:" && result.left(6)!="https:" && doWarn)
     {
       warn_doc_error(context.fileName,tokenizer.getLineNr(),
            "image file %s is not found in IMAGE_PATH: "
            "assuming external image.",qPrint(fileName)
           );
     }
   }
   return result;
 }

引用了 FileDef::absFilePath(), IndexList::addImageFile(), Config_getBool, Config_getString, context, copyFile(), DocImage::DocBook, err(), FileInfo::exists(), DocParserContext::fileName, findFileDef(), QCString::findRev(), DocTokenizer::getLineNr(), DocImage::Html, Doxygen::imageNameLinkedMap, Doxygen::indexList, FileInfo::isSymLink(), DocImage::Latex, QCString::left(), QCString::length(), FileDef::name(), qPrint(), Dir::remove(), QCString::right(), DocImage::Rtf, showFileDefMatches(), QCString::sprintf(), QCString::str(), Portable::system(), Portable::sysTimerStart(), Portable::sysTimerStop(), tokenizer, warn_doc_error() , 以及 DocImage::Xml.

被这些函数引用 DocPara::handleImage() , 以及 handleImg().

◆ findDocsForMemberOrCompound()

bool DocParser::findDocsForMemberOrCompound	(	const QCString &	commandName,
		QCString *	pDoc,
		QCString *	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.

返回值

TRUE	if name was found.
FALSE	if name was not found.

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

 {
   //printf("findDocsForMemberOrCompound(%s)\n",commandName);
   *pDoc="";
   *pBrief="";
   *pDef=0;
   QCString cmdArg=commandName;
   if (cmdArg.isEmpty()) return FALSE;
  
   const FileDef      *fd=0;
   const GroupDef     *gd=0;
   const PageDef      *pd=0;
   gd = Doxygen::groupLinkedMap->find(cmdArg);
   if (gd) // group
   {
     *pDoc=gd->documentation();
     *pBrief=gd->briefDescription();
     *pDef=gd;
     return TRUE;
   }
   pd = Doxygen::pageLinkedMap->find(cmdArg);
   if (pd) // page
   {
     *pDoc=pd->documentation();
     *pBrief=pd->briefDescription();
     *pDef=pd;
     return TRUE;
   }
   bool ambig;
   fd = findFileDef(Doxygen::inputNameLinkedMap,cmdArg,ambig);
   if (fd && !ambig) // file
   {
     *pDoc=fd->documentation();
     *pBrief=fd->briefDescription();
     *pDef=fd;
     return TRUE;
   }
  
   // for symbols we need to normalize the separator, so A#B, or A\B, or A.B becomes A::B
   cmdArg = substitute(cmdArg,"#","::");
   cmdArg = substitute(cmdArg,"\\","::");
   static bool extractAnonNs = Config_getBool(EXTRACT_ANON_NSPACES);
   if (extractAnonNs &&
       cmdArg.startsWith("anonymous_namespace{")
       )
   {
     size_t rightBracePos = cmdArg.find("}", static_cast<int>(qstrlen("anonymous_namespace{")));
     QCString leftPart = cmdArg.left(rightBracePos + 1);
     QCString rightPart = cmdArg.right(cmdArg.size() - rightBracePos - 1);
     rightPart = substitute(rightPart, ".", "::");
     cmdArg = leftPart + rightPart;
   }
   else
   {
     cmdArg = substitute(cmdArg,".","::");
   }
  
   int l=(int)cmdArg.length();
  
   int funcStart=cmdArg.find('(');
   if (funcStart==-1)
   {
     funcStart=l;
   }
   else
   {
     // Check for the case of operator() and the like.
     // beware of scenarios like operator()((foo)bar)
     int secondParen = cmdArg.find('(', funcStart+1);
     int leftParen   = cmdArg.find(')', funcStart+1);
     if (leftParen!=-1 && secondParen!=-1)
     {
       if (leftParen<secondParen)
       {
         funcStart=secondParen;
       }
     }
   }
  
   QCString name=removeRedundantWhiteSpace(cmdArg.left(funcStart));
   QCString args=cmdArg.right(l-funcStart);
   // try if the link is to a member
   const MemberDef    *md=0;
   const ClassDef     *cd=0;
   const NamespaceDef *nd=0;
   bool found = getDefs(
       context.context.find('.')==-1?context.context:QCString(), // find('.') is a hack to detect files
       name,
       args.isEmpty() ? QCString() : args,
       md,cd,fd,nd,gd,FALSE,0,TRUE);
   //printf("found=%d context=%s name=%s\n",found,qPrint(context.context),qPrint(name));
   if (found && md)
   {
     *pDoc=md->documentation();
     *pBrief=md->briefDescription();
     *pDef=md;
     return TRUE;
   }
  
  
   int scopeOffset=(int)context.context.length();
   do // for each scope
   {
     QCString fullName=cmdArg;
     if (scopeOffset>0)
     {
       fullName.prepend(context.context.left(scopeOffset)+"::");
     }
     //printf("Trying fullName='%s'\n",qPrint(fullName));
  
     // try class, namespace, group, page, file reference
     cd = Doxygen::classLinkedMap->find(fullName);
     if (cd) // class
     {
       *pDoc=cd->documentation();
       *pBrief=cd->briefDescription();
       *pDef=cd;
       return TRUE;
     }
     nd = Doxygen::namespaceLinkedMap->find(fullName);
     if (nd) // namespace
     {
       *pDoc=nd->documentation();
       *pBrief=nd->briefDescription();
       *pDef=nd;
       return TRUE;
     }
     if (scopeOffset==0)
     {
       scopeOffset=-1;
     }
     else
     {
       scopeOffset = context.context.findRev("::",scopeOffset-1);
       if (scopeOffset==-1) scopeOffset=0;
     }
   } while (scopeOffset>=0);
  
  
   return FALSE;
 }

引用了 Definition::briefDescription(), MemberDef::briefDescription(), Doxygen::classLinkedMap, Config_getBool, DocParserContext::context, context, Definition::documentation(), MemberDef::documentation(), FALSE, LinkedMap< T, Hash, KeyEqual, Map >::find(), QCString::find(), findFileDef(), QCString::findRev(), getDefs(), Doxygen::groupLinkedMap, Doxygen::inputNameLinkedMap, QCString::isEmpty(), QCString::left(), QCString::length(), Doxygen::namespaceLinkedMap, Doxygen::pageLinkedMap, QCString::prepend(), qstrlen(), removeRedundantWhiteSpace(), QCString::right(), QCString::size(), QCString::startsWith(), substitute() , 以及 TRUE.

被这些函数引用 processCopyDoc().

◆ handleAHref()

int DocParser::handleAHref	(	DocNode *	parent,
		DocNodeList &	children,
		const HtmlAttribList &	tagHtmlAttribs
	)

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

 {
   uint index=0;
   int retval = RetVal_OK;
   for (const auto &opt : tagHtmlAttribs)
   {
     if (opt.name=="name" || opt.name=="id") // <a name=label> or <a id=label> tag
     {
       if (!opt.value.isEmpty())
       {
         children.push_back(std::make_unique<DocAnchor>(*this,parent,opt.value,TRUE));
         break; // stop looking for other tag attribs
       }
       else
       {
         warn_doc_error(context.fileName,tokenizer.getLineNr(),"found <a> tag with name option but without value!");
       }
     }
     else if (opt.name=="href") // <a href=url>..</a> tag
     {
       // copy attributes
       HtmlAttribList attrList = tagHtmlAttribs;
       // and remove the href attribute
       attrList.erase(attrList.begin()+index);
       QCString relPath;
       if (opt.value.at(0) != '#') relPath = context.relPath;
       DocHRef *href = new DocHRef(*this,parent,attrList,opt.value,relPath,convertNameToFile(context.fileName,FALSE,TRUE));
       children.push_back(std::unique_ptr<DocHRef>(href));
       context.insideHtmlLink=TRUE;
       retval = href->parse();
       context.insideHtmlLink=FALSE;
       break;
     }
     else // unsupported option for tag a
     {
     }
     ++index;
   }
   return retval;
 }

引用了 context, convertNameToFile(), FALSE, DocParserContext::fileName, DocTokenizer::getLineNr(), DocParserContext::insideHtmlLink, DocHRef::parse(), DocParserContext::relPath, RetVal_OK, tokenizer, TRUE , 以及 warn_doc_error().

被这些函数引用 DocPara::handleHtmlStartTag(), DocHtmlHeader::parse() , 以及 DocHtmlDescTitle::parse().

◆ handleAnchor()

DocAnchor * DocParser::handleAnchor ( DocNode * parent )

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

 {
   int tok=tokenizer.lex();
   if (tok!=TK_WHITESPACE)
   {
     warn_doc_error(context.fileName,tokenizer.getLineNr(),"expected whitespace after \\%s command",
         qPrint(context.token->name));
     return 0;
   }
   tokenizer.setStateAnchor();
   tok=tokenizer.lex();
   if (tok==0)
   {
     warn_doc_error(context.fileName,tokenizer.getLineNr(),"unexpected end of comment block while parsing the "
         "argument of command %s",qPrint(context.token->name));
     return 0;
   }
   else if (tok!=TK_WORD && tok!=TK_LNKWORD)
   {
     warn_doc_error(context.fileName,tokenizer.getLineNr(),"unexpected token %s as the argument of %s",
         DocTokenizer::tokToString(tok),qPrint(context.token->name));
     return 0;
   }
   tokenizer.setStatePara();
   return new DocAnchor(*this,parent,context.token->name,FALSE);
 }

引用了 context, FALSE, DocParserContext::fileName, DocTokenizer::getLineNr(), DocTokenizer::lex(), TokenInfo::name, qPrint(), DocTokenizer::setStateAnchor(), DocTokenizer::setStatePara(), TK_LNKWORD, TK_WHITESPACE, TK_WORD, DocParserContext::token, tokenizer, DocTokenizer::tokToString() , 以及 warn_doc_error().

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

◆ handleImg()

void DocParser::handleImg	(	DocNode *	parent,
		DocNodeList &	children,
		const HtmlAttribList &	tagHtmlAttribs
	)

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

 {
   bool found=FALSE;
   uint index=0;
   for (const auto &opt : tagHtmlAttribs)
   {
     //printf("option name=%s value=%s\n",qPrint(opt.name),qPrint(opt.value));
     if (opt.name=="src" && !opt.value.isEmpty())
     {
       // copy attributes
       HtmlAttribList attrList = tagHtmlAttribs;
       // and remove the src attribute
       attrList.erase(attrList.begin()+index);
       DocImage::Type t = DocImage::Html;
       children.push_back(
           std::make_unique<DocImage>(
             *this,parent,attrList,
             findAndCopyImage(opt.value,t,false),
             t,opt.value));
       found = TRUE;
     }
     ++index;
   }
   if (!found)
   {
     warn_doc_error(context.fileName,tokenizer.getLineNr(),"IMG tag does not have a SRC attribute!\n");
   }
 }

引用了 context, FALSE, DocParserContext::fileName, findAndCopyImage(), DocTokenizer::getLineNr(), DocImage::Html, tokenizer, TRUE , 以及 warn_doc_error().

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

◆ handleInitialStyleCommands()

void DocParser::handleInitialStyleCommands	(	DocPara *	parent,
		DocNodeList &	children
	)

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

 {
   while (!context.initialStyleStack.empty())
   {
     const DocStyleChange *sc = context.initialStyleStack.top();
     handleStyleEnter(parent,children,sc->style(),sc->tagName(),&sc->attribs());
     context.initialStyleStack.pop();
   }
 }

引用了 DocStyleChange::attribs(), context, handleStyleEnter(), DocParserContext::initialStyleStack, DocStyleChange::style() , 以及 DocStyleChange::tagName().

被这些函数引用 DocPara::parse().

◆ handleInternalRef()

DocInternalRef * DocParser::handleInternalRef ( DocNode * parent )

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

 {
   //printf("CMD_INTERNALREF\n");
   int tok=tokenizer.lex();
   QCString tokenName = context.token->name;
   if (tok!=TK_WHITESPACE)
   {
     warn_doc_error(context.fileName,tokenizer.getLineNr(),"expected whitespace after \\%s command",
         qPrint(tokenName));
     return 0;
   }
   tokenizer.setStateInternalRef();
   tok=tokenizer.lex(); // get the reference id
   if (tok!=TK_WORD && tok!=TK_LNKWORD)
   {
     warn_doc_error(context.fileName,tokenizer.getLineNr(),"unexpected token %s as the argument of %s",
         DocTokenizer::tokToString(tok),qPrint(tokenName));
     return 0;
   }
   return new DocInternalRef(*this,parent,context.token->name);
 }

引用了 context, DocParserContext::fileName, DocTokenizer::getLineNr(), DocTokenizer::lex(), TokenInfo::name, qPrint(), DocTokenizer::setStateInternalRef(), TK_LNKWORD, TK_WHITESPACE, TK_WORD, DocParserContext::token, tokenizer, DocTokenizer::tokToString() , 以及 warn_doc_error().

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

◆ handleLinkedWord()

void DocParser::handleLinkedWord	(	DocNode *	parent,
		DocNodeList &	children,
		bool	ignoreAutoLinkFlag = `FALSE`
	)

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

 {
   QCString name = linkToText(SrcLangExt_Unknown,context.token->name,TRUE);
   static bool autolinkSupport = Config_getBool(AUTOLINK_SUPPORT);
   if (!autolinkSupport && !ignoreAutoLinkFlag) // no autolinking -> add as normal word
   {
     children.push_back(std::make_unique<DocWord>(*this,parent,name));
     return;
   }
  
   // ------- try to turn the word 'name' into a link
  
   const Definition *compound=0;
   const MemberDef  *member=0;
   uint len = context.token->name.length();
   ClassDef *cd=0;
   bool ambig;
   FileDef *fd = findFileDef(Doxygen::inputNameLinkedMap,context.fileName,ambig);
   //printf("handleLinkedWord(%s) context.context=%s\n",qPrint(context.token->name),qPrint(context.context));
   if (!context.insideHtmlLink &&
       (resolveRef(context.context,context.token->name,context.inSeeBlock,&compound,&member,TRUE,fd,TRUE)
        || (!context.context.isEmpty() &&  // also try with global scope
            resolveRef("",context.token->name,context.inSeeBlock,&compound,&member,FALSE,0,TRUE))
       )
      )
   {
     //printf("resolveRef %s = %p (linkable?=%d)\n",qPrint(context.token->name),member,member ? member->isLinkable() : FALSE);
     if (member && member->isLinkable()) // member link
     {
       if (member->isObjCMethod())
       {
         bool localLink = context.memberDef ? member->getClassDef()==context.memberDef->getClassDef() : FALSE;
         name = member->objCMethodName(localLink,context.inSeeBlock);
       }
       children.push_back(
          std::make_unique<DocLinkedWord>(
             *this,parent,name,
             member->getReference(),
             member->getOutputFileBase(),
             member->anchor(),
             member->briefDescriptionAsTooltip()));
     }
     else if (compound->isLinkable()) // compound link
     {
       QCString anchor = compound->anchor();
       if (compound->definitionType()==Definition::TypeFile)
       {
         name=context.token->name;
       }
       else if (compound->definitionType()==Definition::TypeGroup)
       {
         name=toGroupDef(compound)->groupTitle();
       }
       children.push_back(
           std::make_unique<DocLinkedWord>(
             *this,parent,name,
             compound->getReference(),
             compound->getOutputFileBase(),
             anchor,
             compound->briefDescriptionAsTooltip()));
     }
     else if (compound->definitionType()==Definition::TypeFile &&
              (toFileDef(compound))->generateSourceFile()
             ) // undocumented file that has source code we can link to
     {
       children.push_back(
           std::make_unique<DocLinkedWord>(
              *this,parent,context.token->name,
              compound->getReference(),
              compound->getSourceFileBase(),
              "",
              compound->briefDescriptionAsTooltip()));
     }
     else // not linkable
     {
       children.push_back(std::make_unique<DocWord>(*this,parent,name));
     }
   }
   else if (!context.insideHtmlLink && len>1 && context.token->name.at(len-1)==':')
   {
     // special case, where matching Foo: fails to be an Obj-C reference,
     // but Foo itself might be linkable.
     context.token->name=context.token->name.left(len-1);
     handleLinkedWord(parent,children,ignoreAutoLinkFlag);
     children.push_back(std::make_unique<DocWord>(*this,parent,":"));
   }
   else if (!context.insideHtmlLink && (cd=getClass(context.token->name+"-p")))
   {
     // special case 2, where the token name is not a class, but could
     // be a Obj-C protocol
     children.push_back(
         std::make_unique<DocLinkedWord>(
           *this,parent,name,
           cd->getReference(),
           cd->getOutputFileBase(),
           cd->anchor(),
           cd->briefDescriptionAsTooltip()));
   }
   else // normal non-linkable word
   {
     if (context.token->name.left(1)=="#" || context.token->name.left(2)=="::")
     {
       warn_doc_error(context.fileName,tokenizer.getLineNr(),"explicit link request to '%s' could not be resolved",qPrint(name));
       children.push_back(std::make_unique<DocWord>(*this,parent,context.token->name));
     }
     else
     {
       children.push_back(std::make_unique<DocWord>(*this,parent,name));
     }
   }
 }

引用了 MemberDef::anchor(), Definition::anchor(), ClassDef::anchor(), QCString::at(), Definition::briefDescriptionAsTooltip(), Config_getBool, DocParserContext::context, context, Definition::definitionType(), FALSE, DocParserContext::fileName, findFileDef(), getClass(), MemberDef::getClassDef(), DocTokenizer::getLineNr(), MemberDef::getOutputFileBase(), ClassDef::getOutputFileBase(), Definition::getOutputFileBase(), MemberDef::getReference(), ClassDef::getReference(), Definition::getReference(), Definition::getSourceFileBase(), GroupDef::groupTitle(), Doxygen::inputNameLinkedMap, DocParserContext::inSeeBlock, DocParserContext::insideHtmlLink, QCString::isEmpty(), MemberDef::isLinkable(), Definition::isLinkable(), MemberDef::isObjCMethod(), QCString::left(), QCString::length(), linkToText(), DocParserContext::memberDef, TokenInfo::name, MemberDef::objCMethodName(), qPrint(), resolveRef(), SrcLangExt_Unknown, toFileDef(), toGroupDef(), DocParserContext::token, tokenizer, TRUE, Definition::TypeFile, Definition::TypeGroup , 以及 warn_doc_error().

被这些函数引用 defaultHandleToken(), DocPara::handleHtmlStartTag(), handleParameterType(), DocPara::parse(), DocParamList::parse() , 以及 DocParamList::parseXml().

◆ handleParameterType()

void DocParser::handleParameterType	(	DocNode *	parent,
		DocNodeList &	children,
		const QCString &	paramTypes
	)

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

 {
   QCString name = context.token->name; // save token name
   QCString name1;
   int p=0,i,ii;
   while ((i=paramTypes.find('|',p))!=-1)
   {
     name1 = paramTypes.mid(p,i-p);
     ii=name1.find('[');
     context.token->name=ii!=-1 ? name1.mid(0,ii) : name1; // take part without []
     handleLinkedWord(parent,children);
     if (ii!=-1) children.push_back(std::make_unique<DocWord>(*this,parent,name1.mid(ii))); // add [] part
     p=i+1;
     children.push_back(std::make_unique<DocSeparator>(*this,parent,"|"));
   }
   name1 = paramTypes.mid(p);
   ii=name1.find('[');
   context.token->name=ii!=-1 ? name1.mid(0,ii) : name1;
   handleLinkedWord(parent,children);
   if (ii!=-1) children.push_back(std::make_unique<DocWord>(*this,parent,name1.mid(ii)));
   context.token->name = name; // restore original token name
 }

引用了 context, QCString::find(), handleLinkedWord(), QCString::mid(), TokenInfo::name , 以及 DocParserContext::token.

被这些函数引用 DocParamList::parse().

◆ handlePendingStyleCommands()

void DocParser::handlePendingStyleCommands	(	DocNode *	parent,
		DocNodeList &	children
	)

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.

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

 {
   if (!context.styleStack.empty())
   {
     const DocStyleChange *sc = context.styleStack.top();
     while (sc && sc->position()>=context.nodeStack.size())
     { // there are unclosed style modifiers in the paragraph
       children.push_back(std::make_unique<DocStyleChange>(*this,parent,(uint)context.nodeStack.size(),sc->style(),sc->tagName(),FALSE));
       context.initialStyleStack.push(sc);
       context.styleStack.pop();
       sc = !context.styleStack.empty() ? context.styleStack.top() : 0;
     }
   }
 }

引用了 context, FALSE, DocParserContext::initialStyleStack, DocParserContext::nodeStack, DocStyleChange::position(), DocStyleChange::style(), DocParserContext::styleStack , 以及 DocStyleChange::tagName().

被这些函数引用 defaultHandleTitleAndSize(), DocTitle::parse(), DocVhdlFlow::parse(), DocLink::parse(), DocRef::parse(), DocInternalRef::parse(), DocHRef::parse(), DocHtmlHeader::parse(), DocHtmlDescTitle::parse(), DocSecRefItem::parse(), DocPara::parse() , 以及 DocHtmlCaption::parse().

◆ handleStyleArgument()

int DocParser::handleStyleArgument	(	DocNode *	parent,
		DocNodeList &	children,
		const QCString &	cmdName
	)

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

 {
   DBG(("handleStyleArgument(%s)\n",qPrint(cmdName)));
   QCString saveCmdName = cmdName;
   int tok=tokenizer.lex();
   if (tok!=TK_WHITESPACE)
   {
     warn_doc_error(context.fileName,tokenizer.getLineNr(),"expected whitespace after \\%s command",
         qPrint(saveCmdName));
     return tok;
   }
   while ((tok=tokenizer.lex()) &&
           tok!=TK_WHITESPACE &&
           tok!=TK_NEWPARA &&
           tok!=TK_LISTITEM &&
           tok!=TK_ENDLIST
         )
   {
     static const reg::Ex specialChar(R"([.,|()\[\]:;?])");
     if (tok==TK_WORD && context.token->name.length()==1 &&
         reg::match(context.token->name.str(),specialChar))
     {
       // special character that ends the markup command
       return tok;
     }
     if (!defaultHandleToken(parent,tok,children))
     {
       switch (tok)
       {
         case TK_HTMLTAG:
           if (insideLI(parent) && Mappers::htmlTagMapper->map(context.token->name) && context.token->endTag)
           { // ignore </li> as the end of a style command
             continue;
           }
           DBG(("handleStyleArgument(%s) end tok=%s\n",qPrint(saveCmdName), DocTokenizer::tokToString(tok)));
           return tok;
           break;
         default:
           errorHandleDefaultToken(parent,tok,children,"\\" + saveCmdName + " command");
           break;
       }
       break;
     }
   }
   DBG(("handleStyleArgument(%s) end tok=%s\n",qPrint(saveCmdName), DocTokenizer::tokToString(tok)));
   return (tok==TK_NEWPARA || tok==TK_LISTITEM || tok==TK_ENDLIST
          ) ? tok : RetVal_OK;
 }

引用了 context, DBG, defaultHandleToken(), TokenInfo::endTag, errorHandleDefaultToken(), DocParserContext::fileName, DocTokenizer::getLineNr(), Mappers::htmlTagMapper, insideLI(), QCString::length(), DocTokenizer::lex(), reg::match(), TokenInfo::name, qPrint(), RetVal_OK, QCString::str(), TK_ENDLIST, TK_HTMLTAG, TK_LISTITEM, TK_NEWPARA, TK_WHITESPACE, TK_WORD, DocParserContext::token, tokenizer, DocTokenizer::tokToString() , 以及 warn_doc_error().

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

◆ handleStyleEnter()

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

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

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

 {
   DBG(("HandleStyleEnter\n"));
   DocStyleChange *sc= new DocStyleChange(*this,parent,(uint)context.nodeStack.size(),s,tagName,TRUE,attribs);
   children.push_back(std::unique_ptr<DocStyleChange>(sc));
   context.styleStack.push(sc);
 }

引用了 context, DBG, DocParserContext::nodeStack, DocParserContext::styleStack , 以及 TRUE.

被这些函数引用 defaultHandleToken(), DocPara::handleHtmlStartTag() , 以及 handleInitialStyleCommands().

◆ handleStyleLeave()

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

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

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

 {
   DBG(("HandleStyleLeave\n"));
   QCString tagNameLower = QCString(tagName).lower();
   if (context.styleStack.empty() ||                            // no style change
       context.styleStack.top()->style()!=s ||                  // wrong style change
       context.styleStack.top()->tagName()!=tagNameLower ||     // wrong style change
       context.styleStack.top()->position()!=context.nodeStack.size() // wrong position
      )
   {
     if (context.styleStack.empty())
     {
       warn_doc_error(context.fileName,tokenizer.getLineNr(),"found </%s> tag without matching <%s>",
           qPrint(tagName),qPrint(tagName));
     }
     else if (context.styleStack.top()->tagName()!=tagNameLower)
     {
       warn_doc_error(context.fileName,tokenizer.getLineNr(),"found </%s> tag while expecting </%s>",
           qPrint(tagName),qPrint(context.styleStack.top()->tagName()));
     }
     else if (context.styleStack.top()->style()!=s)
     {
       warn_doc_error(context.fileName,tokenizer.getLineNr(),"found </%s> tag while expecting </%s>",
           qPrint(tagName),qPrint(context.styleStack.top()->tagName()));
     }
     else
     {
       warn_doc_error(context.fileName,tokenizer.getLineNr(),"found </%s> at different nesting level (%zu) than expected (%d)",
           qPrint(tagName),context.nodeStack.size(),context.styleStack.top()->position());
     }
   }
   else // end the section
   {
     children.push_back(
         std::make_unique<DocStyleChange>(
           *this,parent,(uint)context.nodeStack.size(),s,context.styleStack.top()->tagName(),FALSE));
     context.styleStack.pop();
   }
 }

引用了 context, DBG, FALSE, DocParserContext::fileName, DocTokenizer::getLineNr(), QCString::lower(), DocParserContext::nodeStack, qPrint(), DocParserContext::styleStack, tokenizer , 以及 warn_doc_error().

被这些函数引用 defaultHandleToken() , 以及 DocPara::handleHtmlEndTag().

◆ handleUnclosedStyleCommands()

void DocParser::handleUnclosedStyleCommands ( )

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

 {
   if (!context.initialStyleStack.empty())
   {
     const DocStyleChange *sc = context.initialStyleStack.top();
     context.initialStyleStack.pop();
     handleUnclosedStyleCommands();
     warn_doc_error(context.fileName,tokenizer.getLineNr(),
              "end of comment block while expecting "
              "command </%s>",qPrint(sc->tagName()));
   }
 }

引用了 context, DocParserContext::fileName, DocTokenizer::getLineNr(), DocParserContext::initialStyleStack, qPrint(), DocStyleChange::tagName(), tokenizer , 以及 warn_doc_error().

被这些函数引用 DocText::parse() , 以及 DocRoot::parse().

◆ internalValidatingParseDoc()

int DocParser::internalValidatingParseDoc	(	DocNode *	parent,
		DocNodeList &	children,
		const QCString &	doc
	)

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

 {
   int retval = RetVal_OK;
  
   if (doc.isEmpty()) return retval;
  
   tokenizer.init(doc.data(),context.fileName,context.markdownSupport);
  
   // first parse any number of paragraphs
   bool isFirst=TRUE;
   DocPara *lastPar=0;
   if (!children.empty() && children.back()->kind()==DocNode::Kind_Para)
   { // last child item was a paragraph
     lastPar = (DocPara*)children.back().get();
     isFirst=FALSE;
   }
   do
   {
     DocPara *par = new DocPara(*this,parent);
     if (isFirst) { par->markFirst(); isFirst=FALSE; }
     retval=par->parse();
     if (!par->isEmpty())
     {
       children.push_back(std::unique_ptr<DocNode>(par));
       if (lastPar) lastPar->markLast(FALSE);
       lastPar=par;
     }
     else
     {
       delete par;
     }
   } while (retval==TK_NEWPARA);
   if (lastPar) lastPar->markLast();
  
   //printf("internalValidateParsingDoc: %p: isFirst=%d isLast=%d\n",
   //   lastPar,lastPar?lastPar->isFirst():-1,lastPar?lastPar->isLast():-1);
  
   return retval;
 }

引用了 context, QCString::data(), FALSE, DocParserContext::fileName, DocTokenizer::init(), QCString::isEmpty(), DocPara::isEmpty(), DocNode::Kind_Para, DocParserContext::markdownSupport, DocPara::markFirst(), DocPara::markLast(), DocPara::parse(), RetVal_OK, TK_NEWPARA, tokenizer , 以及 TRUE.

被这些函数引用 DocPara::handleInclude(), DocPara::handleInheritDoc(), DocXRefItem::parse(), DocRef::parse() , 以及 DocSimpleSect::parseRcs().

◆ popContext()

void DocParser::popContext ( )

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

 {
   auto &ctx = contextStack.top();
   context = ctx;
   tokenizer.setLineNr(ctx.lineNo);
   context.token = ctx.token;
   tokenizer.replaceToken(context.token);
   contextStack.pop();
   tokenizer.popContext();
  
   //QCString indent;
   //indent.fill(' ',contextStack.size()*2+2);
   //printf("%sdocParserPopContext() count=%zu\n",qPrint(indent),context.nodeStack.size());
 }

引用了 context, contextStack, DocTokenizer::popContext(), DocTokenizer::replaceToken(), DocTokenizer::setLineNr(), DocParserContext::token , 以及 tokenizer.

被这些函数引用 DocPara::handleInclude(), DocPara::handleInheritDoc(), DocXRefItem::parse(), DocRef::parse(), DocSimpleSect::parseRcs(), validatingParseDoc() , 以及 validatingParseText().

◆ processCopyDoc()

QCString DocParser::processCopyDoc	(	const char *	data,
		uint &	len
	)

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

 {
   //printf("processCopyDoc start '%s'\n",data);
   GrowBuf buf;
   uint i=0;
   while (i<len)
   {
     char c = data[i];
     if (c=='@' || c=='\\') // look for a command
     {
       bool isBrief=TRUE;
       uint j=isCopyBriefOrDetailsCmd(data,i,len,isBrief);
       if (j>0)
       {
         // skip whitespace
         while (j<len && (data[j]==' ' || data[j]=='\t')) j++;
         // extract the argument
         QCString id = extractCopyDocId(data,j,len);
         const Definition *def = 0;
         QCString doc,brief;
         //printf("resolving docs='%s'\n",qPrint(id));
         if (findDocsForMemberOrCompound(id,&doc,&brief,&def))
         {
           //printf("found it def=%p brief='%s' doc='%s' isBrief=%d\n",def,qPrint(brief),qPrint(doc),isBrief);
           auto it = std::find(context.copyStack.begin(),context.copyStack.end(),def);
           if (it==context.copyStack.end()) // definition not parsed earlier
           {
             context.copyStack.push_back(def);
             if (isBrief)
             {
               uint l=brief.length();
               buf.addStr(processCopyDoc(brief.data(),l));
             }
             else
             {
               uint l=doc.length();
               buf.addStr(processCopyDoc(doc.data(),l));
             }
             context.copyStack.pop_back();
           }
           else
           {
             warn_doc_error(context.fileName,tokenizer.getLineNr(),
                  "Found recursive @copy%s or @copydoc relation for argument '%s'.\n",
                  isBrief?"brief":"details",qPrint(id));
           }
         }
         else
         {
           warn_doc_error(context.fileName,tokenizer.getLineNr(),
                "@copy%s or @copydoc target '%s' not found", isBrief?"brief":"details",
                qPrint(id));
         }
         // skip over command
         i=j;
       }
       else
       {
         QCString endMarker;
         uint k = isVerbatimSection(data,i,len,endMarker);
         if (k>0)
         {
           int orgPos = i;
           i=skipToEndMarker(data,k,len,endMarker);
           buf.addStr(data+orgPos,i-orgPos);
         }
         else
         {
           buf.addChar(c);
           i++;
         }
       }
     }
     else // not a command, just copy
     {
       buf.addChar(c);
       i++;
     }
   }
   len = buf.getPos();
   buf.addChar(0);
   return buf.get();
 }

引用了 GrowBuf::addChar(), GrowBuf::addStr(), context, DocParserContext::copyStack, QCString::data(), extractCopyDocId(), DocParserContext::fileName, findDocsForMemberOrCompound(), GrowBuf::get(), DocTokenizer::getLineNr(), GrowBuf::getPos(), isCopyBriefOrDetailsCmd(), isVerbatimSection(), QCString::length(), qPrint(), skipToEndMarker(), tokenizer, TRUE , 以及 warn_doc_error().

被这些函数引用 validatingParseDoc().

◆ pushContext()

void DocParser::pushContext ( )

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

 {
   //QCString indent;
   //indent.fill(' ',contextStack.size()*2+2);
   //printf("%sdocParserPushContext() count=%zu\n",qPrint(indent),context.nodeStack.size());
  
   tokenizer.pushContext();
   contextStack.push(DocParserContext());
   auto &ctx = contextStack.top();
   ctx = context;
   ctx.lineNo = tokenizer.getLineNr();
   context.token = tokenizer.newToken();
 }

引用了 context, contextStack, DocTokenizer::getLineNr(), DocParserContext::lineNo, DocTokenizer::newToken(), DocTokenizer::pushContext(), DocParserContext::token , 以及 tokenizer.

被这些函数引用 DocPara::handleInclude(), DocPara::handleInheritDoc(), DocXRefItem::parse(), DocRef::parse(), DocSimpleSect::parseRcs(), validatingParseDoc() , 以及 validatingParseText().

◆ readTextFileByName()

void DocParser::readTextFileByName	(	const QCString &	file,
		QCString &	text
	)

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

 {
   if (Portable::isAbsolutePath(file))
   {
     FileInfo fi(file.str());
     if (fi.exists())
     {
       text = fileToString(file,Config_getBool(FILTER_SOURCE_FILES));
       return;
     }
   }
   const StringVector &examplePathList = Config_getList(EXAMPLE_PATH);
   for (const auto &s : examplePathList)
   {
     std::string absFileName = s+(Portable::pathSeparator()+file).str();
     FileInfo fi(absFileName);
     if (fi.exists())
     {
       text = fileToString(QCString(absFileName),Config_getBool(FILTER_SOURCE_FILES));
       return;
     }
   }
  
   // as a fallback we also look in the exampleNameDict
   bool ambig;
   FileDef *fd = findFileDef(Doxygen::exampleNameLinkedMap,file,ambig);
   if (fd)
   {
     text = fileToString(fd->absFilePath(),Config_getBool(FILTER_SOURCE_FILES));
     if (ambig)
     {
       warn_doc_error(context.fileName,tokenizer.getLineNr(),"included file name %s is ambiguous"
            "Possible candidates:\n%s",qPrint(file),
            qPrint(showFileDefMatches(Doxygen::exampleNameLinkedMap,file))
           );
     }
   }
   else
   {
     warn_doc_error(context.fileName,tokenizer.getLineNr(),"included file %s is not found. "
            "Check your EXAMPLE_PATH",qPrint(file));
   }
 }

引用了 FileDef::absFilePath(), Config_getBool, Config_getList, context, Doxygen::exampleNameLinkedMap, FileInfo::exists(), DocParserContext::fileName, fileToString(), findFileDef(), DocTokenizer::getLineNr(), Portable::isAbsolutePath(), Portable::pathSeparator(), qPrint(), showFileDefMatches(), QCString::str(), tokenizer , 以及 warn_doc_error().

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

类成员变量说明

◆ context

DocParserContext DocParser::context

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

被这些函数引用 DocSimpleSect::appendLinkWord(), AutoNodeStack::AutoNodeStack(), checkArgumentName(), checkRetvalName(), checkUnOrMultipleDocumentedParams(), defaultHandleTitleAndSize(), defaultHandleToken(), DocAnchor::DocAnchor(), DocCite::DocCite(), DocDiaFile::DocDiaFile(), DocDotFile::DocDotFile(), DocEmoji::DocEmoji(), DocFormula::DocFormula(), DocHtmlCaption::DocHtmlCaption(), DocLink::DocLink(), DocLinkedWord::DocLinkedWord(), DocMscFile::DocMscFile(), DocRef::DocRef(), DocWord::DocWord(), errorHandleDefaultToken(), findAndCopyImage(), findDocsForMemberOrCompound(), handleAHref(), handleAnchor(), DocPara::handleCite(), DocPara::handleCommand(), DocPara::handleEmoji(), DocPara::handleFile(), DocPara::handleHtmlEndTag(), DocPara::handleHtmlStartTag(), DocPara::handleIline(), DocPara::handleImage(), handleImg(), DocPara::handleInclude(), DocPara::handleIncludeOperator(), DocPara::handleInheritDoc(), handleInitialStyleCommands(), handleInternalRef(), DocPara::handleLink(), handleLinkedWord(), handleParameterType(), handlePendingStyleCommands(), DocPara::handleRef(), DocPara::handleSection(), DocPara::handleStartCode(), handleStyleArgument(), handleStyleEnter(), handleStyleLeave(), handleUnclosedStyleCommands(), DocPara::handleXRefItem(), DocPara::injectToken(), internalValidatingParseDoc(), DocInclude::parse(), DocIncOperator::parse(), DocIndexEntry::parse(), DocAutoList::parse(), DocAutoListItem::parse(), DocXRefItem::parse(), DocDotFile::parse(), DocMscFile::parse(), DocDiaFile::parse(), DocVhdlFlow::parse(), DocLink::parse(), DocRef::parse(), DocHRef::parse(), DocHtmlHeader::parse(), DocHtmlDescTitle::parse(), DocHtmlDescList::parse(), DocSection::parse(), DocSecRefItem::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(), popContext(), processCopyDoc(), pushContext(), readTextFileByName(), validatingParseDoc(), validatingParseText() , 以及 AutoNodeStack::~AutoNodeStack().

◆ contextStack

std::stack< DocParserContext > DocParser::contextStack

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

被这些函数引用 popContext() , 以及 pushContext().

◆ tokenizer

DocTokenizer DocParser::tokenizer

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

被这些函数引用 defaultHandleTitleAndSize(), defaultHandleToken(), DocAnchor::DocAnchor(), DocCite::DocCite(), DocEmoji::DocEmoji(), docFindSections(), DocFormula::DocFormula(), DocHtmlCaption::DocHtmlCaption(), DocLink::DocLink(), DocRef::DocRef(), errorHandleDefaultToken(), findAndCopyImage(), handleAHref(), handleAnchor(), DocPara::handleCite(), DocPara::handleCommand(), DocPara::handleEmoji(), DocPara::handleFile(), DocPara::handleHtmlEndTag(), DocPara::handleHtmlStartTag(), DocPara::handleIline(), DocPara::handleImage(), handleImg(), DocPara::handleInclude(), DocPara::handleIncludeOperator(), handleInternalRef(), DocPara::handleLink(), handleLinkedWord(), DocPara::handleRef(), DocPara::handleSection(), DocPara::handleStartCode(), handleStyleArgument(), handleStyleLeave(), handleUnclosedStyleCommands(), DocPara::handleXRefItem(), internalValidatingParseDoc(), DocInclude::parse(), DocIncOperator::parse(), DocIndexEntry::parse(), DocAutoList::parse(), DocTitle::parse(), DocDotFile::parse(), DocMscFile::parse(), DocDiaFile::parse(), DocVhdlFlow::parse(), DocLink::parse(), DocRef::parse(), DocInternalRef::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(), DocHtmlTable::parseXml(), popContext(), processCopyDoc(), pushContext(), readTextFileByName(), validatingParseDoc() , 以及 validatingParseText().

该类的文档由以下文件生成:

src/docparser.cpp

Public 成员函数

Public 属性

详细描述

成员函数说明

◆ checkArgumentName()

◆ checkRetvalName()

◆ checkUnOrMultipleDocumentedParams()

◆ defaultHandleTitleAndSize()

◆ defaultHandleToken()

◆ errorHandleDefaultToken()

◆ findAndCopyImage()

◆ findDocsForMemberOrCompound()

◆ handleAHref()

◆ handleAnchor()

◆ handleImg()

◆ handleInitialStyleCommands()

◆ handleInternalRef()

◆ handleLinkedWord()

◆ handleParameterType()

◆ handlePendingStyleCommands()

◆ handleStyleArgument()

◆ handleStyleEnter()

◆ handleStyleLeave()

◆ handleUnclosedStyleCommands()

◆ internalValidatingParseDoc()

◆ popContext()

◆ processCopyDoc()

◆ pushContext()

◆ readTextFileByName()

类成员变量说明

◆ context

◆ contextStack

◆ tokenizer