docparser.cpp 文件参考

#include <stdio.h>
#include <stdlib.h>
#include <cassert>
#include <ctype.h>
#include "qcstring.h"
#include "regex.h"
#include "doxygen.h"
#include "debug.h"
#include "util.h"
#include "pagedef.h"
#include "docparser.h"
#include "doctokenizer.h"
#include "cmdmapper.h"
#include "printdocvisitor.h"
#include "message.h"
#include "section.h"
#include "searchindex.h"
#include "language.h"
#include "portable.h"
#include "cite.h"
#include "arguments.h"
#include "vhdldocgen.h"
#include "groupdef.h"
#include "classlist.h"
#include "filedef.h"
#include "memberdef.h"
#include "namespacedef.h"
#include "reflist.h"
#include "formula.h"
#include "config.h"
#include "growbuf.h"
#include "markdown.h"
#include "htmlentity.h"
#include "emoji.h"
#include "fileinfo.h"
#include "dir.h"

docparser.cpp 的引用(Include)关系图:

浏览源代码.

类
struct	DocParserContext
	Parser's context to store all global variables. 更多...
class	DocParser
class	AutoNodeStack
struct	ActiveRowSpan
	Helper class to compute the grid for an HTML style table 更多...

宏定义
#define	TK_COMMAND_CHAR(token)   ((token)==TK_COMMAND_AT ? "@" : "\\")
#define	DBG(x)   do {} while(0)
#define	INTERNAL_ASSERT(x)   do {} while(0)
#define	CHECK_FOR_COMMAND(str, action)

类型定义
using	DefinitionStack = std::vector< const Definition * >
using	DocNodeStack = std::stack< const DocNode * >
using	DocStyleChangeStack = std::stack< const DocStyleChange * >
typedef std::vector< ActiveRowSpan >	RowSpanList
	List of ActiveRowSpan classes. 更多...

函数
std::unique_ptr< IDocParser >	createDocParser ()
static void	unescapeCRef (QCString &s)
static QCString	stripKnownExtensions (const QCString &text)
static bool	insidePRE (DocNode *n)
static bool	insideLI (DocNode *n)
static bool	insideUL (DocNode *n)
static bool	insideOL (DocNode *n)
static bool	insideTable (DocNode *n)
static void	flattenParagraphs (DocNode *root, DocNodeList &children)
static bool	findAttribute (const HtmlAttribList &tagHtmlAttribs, const char *attrName, QCString *result)
static QCString	extractCopyDocId (const char *data, uint &j, uint len)
static uint	isCopyBriefOrDetailsCmd (const char *data, uint i, uint len, bool &brief)
static uint	isVerbatimSection (const char *data, uint i, uint len, QCString &endMarker)
static uint	skipToEndMarker (const char *data, uint i, uint len, const QCString &endMarker)
DocRoot *	validatingParseDoc (IDocParser &parserIntf, const QCString &fileName, int startLine, const Definition *ctx, const MemberDef *md, const QCString &input, bool indexWords, bool isExample, const QCString &exampleName, bool singleLine, bool linkFromIndex, bool markdownSupport)
DocText *	validatingParseText (IDocParser &parserIntf, const QCString &input)
DocRef *	createRef (IDocParser &parserIntf, const QCString &target, const QCString &context)
void	docFindSections (const QCString &input, const Definition *d, const QCString &fileName)

变量
static const char *	g_sectionLevelToName []
static const std::set< std::string >	g_plantumlEngine

宏定义说明

CHECK_FOR_COMMAND

#define CHECK_FOR_COMMAND	(		str,
			action
	)

值:

   do if ((i+sizeof(str)<len) && qstrncmp(data+i+1,str,sizeof(str)-1)==0) \
   { j=i+sizeof(str); action; } while(0)

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

DBG

#define DBG

(

x

)

do {} while(0)

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

INTERNAL_ASSERT

#define INTERNAL_ASSERT

(

x

)

do {} while(0)

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

TK_COMMAND_CHAR

#define TK_COMMAND_CHAR

(

token

)

((token)==TK_COMMAND_AT ? "@" : "\\")

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

类型定义说明

DefinitionStack

using DefinitionStack = std::vector<const Definition *>

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

DocNodeStack

using DocNodeStack = std::stack<const DocNode *>

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

DocStyleChangeStack

using DocStyleChangeStack = std::stack<const DocStyleChange *>

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

RowSpanList

typedef std::vector<ActiveRowSpan> RowSpanList

List of ActiveRowSpan classes.

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

函数说明

createDocParser()

std::unique_ptr<IDocParser> createDocParser

(

)

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

{
  return std::make_unique<DocParser>();
}

被这些函数引用 addPerlModDocBlock(), convertMapFile(), RTFGenerator::endIndexSection(), generateBriefDoc(), OutputList::generateDoc(), parseCommentAsText(), parseDoc(), OutputList::parseText(), replaceRef(), ConceptDefImpl::writeBriefDescription(), DirDefImpl::writeBriefDescription(), NamespaceDefImpl::writeBriefDescription(), GroupDefImpl::writeBriefDescription(), FileDefImpl::writeBriefDescription(), MemberDefImpl::writeDeclaration(), ConceptDefImpl::writeDeclarationLink(), ClassDefImpl::writeDeclarationLink(), MemberList::writePlainDeclarations() , 以及 writeXMLDocBlock().

createRef()

DocRef* createRef	(	IDocParser &	parserIntf,
		const QCString &	target,
		const QCString &	context
	)

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

{
  DocParser &parser = dynamic_cast<DocParser&>(parserIntf);
  return new DocRef(parser,0,target,context);
}

被这些函数引用 convertMapFile() , 以及 replaceRef().

docFindSections()

void docFindSections	(	const QCString &	input,
		const Definition *	d,
		const QCString &	fileName
	)

Searches for section and anchor commands in the input

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

{
  DocParser parser;
  parser.tokenizer.findSections(input,d,fileName);
}

引用了 DocTokenizer::findSections() , 以及 DocParser::tokenizer.

被这些函数引用 PageDefImpl::findSectionsInDocumentation(), MemberGroup::findSectionsInDocumentation(), ConceptDefImpl::findSectionsInDocumentation(), NamespaceDefImpl::findSectionsInDocumentation(), GroupDefImpl::findSectionsInDocumentation(), FileDefImpl::findSectionsInDocumentation(), ClassDefImpl::findSectionsInDocumentation() , 以及 MemberDefImpl::findSectionsInDocumentation().

extractCopyDocId()

static QCString extractCopyDocId ( const char *  data, uint &  j, uint  len  )

static

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

{
  uint s=j;
  uint e=j;
  int round=0;
  bool insideDQuote=FALSE;
  bool insideSQuote=FALSE;
  bool found=FALSE;
  while (j<len && !found)
  {
    if (!insideSQuote && !insideDQuote)
    {
      switch (data[j])
      {
        case '(': round++; break;
        case ')': round--; break;
        case '"': insideDQuote=TRUE; break;
        case '\'': insideSQuote=TRUE; break;
        case ' ':  // fall through
        case '\t': // fall through
        case '\n':
          found=(round==0);
          break;
      }
    }
    else if (insideSQuote) // look for single quote end
    {
      if (data[j]=='\'' && (j==0 || data[j]!='\\'))
      {
        insideSQuote=FALSE;
      }
    }
    else if (insideDQuote) // look for double quote end
    {
      if (data[j]=='"' && (j==0 || data[j]!='\\'))
      {
        insideDQuote=FALSE;
      }
    }
    if (!found) j++;
  }
  if (qstrncmp(data+j," const",6)==0)
  {
    j+=6;
  }
  else if (qstrncmp(data+j," volatile",9)==0)
  {
    j+=9;
  }
  e=j;
  QCString id(data+s,e-s);
  //printf("extractCopyDocId='%s' input='%s'\n",qPrint(id),&data[s]);
  return id;
}

引用了 FALSE, qstrncmp() , 以及 TRUE.

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

findAttribute()

static bool findAttribute ( const HtmlAttribList &  tagHtmlAttribs, const char *  attrName, QCString *  result  )

static

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

{
 
  for (const auto &opt : tagHtmlAttribs)
  {
    if (opt.name==attrName)
    {
      *result = opt.value;
      return TRUE;
    }
  }
  return FALSE;
}

引用了 FALSE , 以及 TRUE.

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

flattenParagraphs()

static void flattenParagraphs ( DocNode *  root, DocNodeList &  children  )

static

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

{
  DocNodeList newChildren;
  for (const auto &dn : children)
  {
    if (dn->kind()==DocNode::Kind_Para)
    {
      DocPara *para = (DocPara*)dn.get();
      // move the children of the paragraph to the end of the newChildren list
      newChildren.insert(newChildren.end(),
                         std::make_move_iterator(para->children().begin()),
                         std::make_move_iterator(para->children().end()));
    }
  }
 
  // replace the children list by the newChildren list
  children.clear();
  children.insert(children.end(),
                  std::make_move_iterator(newChildren.begin()),
                  std::make_move_iterator(newChildren.end()));
  // reparent the children
  for (const auto &cn : children)
  {
    cn->setParent(root);
  }
}

引用了 CompAccept< T >::children(), DocNode::Kind_Para , 以及 DocNode::setParent().

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

insideLI()

static bool insideLI ( DocNode *  n )

static

Returns TRUE iff node n is a child of a html list item node

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

{
  while (n)
  {
    if (n->kind()==DocNode::Kind_HtmlListItem) return TRUE;
    n=n->parent();
  }
  return FALSE;
}

引用了 FALSE, DocNode::kind(), DocNode::Kind_HtmlListItem, DocNode::parent() , 以及 TRUE.

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

insideOL()

static bool insideOL ( DocNode *  n )

static

Returns TRUE iff node n is a child of a ordered html list node

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

{
  while (n)
  {
    if (n->kind()==DocNode::Kind_HtmlList &&
        ((DocHtmlList *)n)->type()==DocHtmlList::Ordered) return TRUE;
    n=n->parent();
  }
  return FALSE;
}

引用了 FALSE, DocNode::kind(), DocNode::Kind_HtmlList, DocHtmlList::Ordered, DocNode::parent() , 以及 TRUE.

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

insidePRE()

static bool insidePRE ( DocNode *  n )

static

Returns TRUE iff node n is a child of a preformatted node

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

{
  while (n)
  {
    if (n->isPreformatted()) return TRUE;
    n=n->parent();
  }
  return FALSE;
}

引用了 FALSE, DocNode::isPreformatted(), DocNode::parent() , 以及 TRUE.

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

insideTable()

static bool insideTable ( DocNode *  n )

static

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

{
  while (n)
  {
    if (n->kind()==DocNode::Kind_HtmlTable) return TRUE;
    n=n->parent();
  }
  return FALSE;
}

引用了 FALSE, DocNode::kind(), DocNode::Kind_HtmlTable, DocNode::parent() , 以及 TRUE.

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

insideUL()

static bool insideUL ( DocNode *  n )

static

Returns TRUE iff node n is a child of a unordered html list node

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

{
  while (n)
  {
    if (n->kind()==DocNode::Kind_HtmlList &&
        ((DocHtmlList *)n)->type()==DocHtmlList::Unordered) return TRUE;
    n=n->parent();
  }
  return FALSE;
}

引用了 FALSE, DocNode::kind(), DocNode::Kind_HtmlList, DocNode::parent(), TRUE , 以及 DocHtmlList::Unordered.

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

isCopyBriefOrDetailsCmd()

static uint isCopyBriefOrDetailsCmd ( const char *  data, uint  i, uint  len, bool &  brief  )

static

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

{
  int j=0;
  if (i==0 || (data[i-1]!='@' && data[i-1]!='\\')) // not an escaped command
  {
    CHECK_FOR_COMMAND("copybrief",brief=TRUE);    // @copybrief or \copybrief
    CHECK_FOR_COMMAND("copydetails",brief=FALSE); // @copydetails or \copydetails
  }
  return j;
}

引用了 CHECK_FOR_COMMAND, FALSE , 以及 TRUE.

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

isVerbatimSection()

static uint isVerbatimSection ( const char *  data, uint  i, uint  len, QCString &  endMarker  )

static

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

{
  int j=0;
  if (i==0 || (data[i-1]!='@' && data[i-1]!='\\')) // not an escaped command
  {
    CHECK_FOR_COMMAND("dot",endMarker="enddot");
    CHECK_FOR_COMMAND("code",endMarker="endcode");
    CHECK_FOR_COMMAND("msc",endMarker="endmsc");
    CHECK_FOR_COMMAND("verbatim",endMarker="endverbatim");
    CHECK_FOR_COMMAND("latexonly",endMarker="endlatexonly");
    CHECK_FOR_COMMAND("htmlonly",endMarker="endhtmlonly");
    CHECK_FOR_COMMAND("xmlonly",endMarker="endxmlonly");
    CHECK_FOR_COMMAND("rtfonly",endMarker="endrtfonly");
    CHECK_FOR_COMMAND("manonly",endMarker="endmanonly");
    CHECK_FOR_COMMAND("docbookonly",endMarker="enddocbookonly");
    CHECK_FOR_COMMAND("startuml",endMarker="enduml");
  }
  //printf("isVerbatimSection(%s)=%d)\n",qPrint(QCString(&data[i]).left(10)),j);
  return j;
}

引用了 CHECK_FOR_COMMAND.

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

skipToEndMarker()

static uint skipToEndMarker ( const char *  data, uint  i, uint  len, const QCString &  endMarker  )

static

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

{
  while (i<len)
  {
    if ((data[i]=='@' || data[i]=='\\') &&  // start of command character
        (i==0 || (data[i-1]!='@' && data[i-1]!='\\'))) // that is not escaped
    {
      if (i+endMarker.length()+1<=len && qstrncmp(data+i+1,endMarker.data(),endMarker.length())==0)
      {
        return i+endMarker.length()+1;
      }
    }
    i++;
  }
  // oops no endmarker found...
  return i<len ? i+1 : len;
}

引用了 QCString::data(), QCString::length() , 以及 qstrncmp().

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

stripKnownExtensions()

static QCString stripKnownExtensions ( const QCString &  text )

static

Strips known html and tex extensions from text.

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

{
  QCString result=text;
  if (result.right(4)==".tex")
  {
    result=result.left(result.length()-4);
  }
  else if (result.right(Doxygen::htmlFileExtension.length())==
         QCString(Doxygen::htmlFileExtension))
  {
    result=result.left(result.length()-Doxygen::htmlFileExtension.length());
  }
  return result;
}

引用了 Doxygen::htmlFileExtension, QCString::left(), QCString::length() , 以及 QCString::right().

被这些函数引用 DocLink::DocLink(), DocRef::DocRef() , 以及 DocSecRefItem::parse().

unescapeCRef()

static void unescapeCRef ( QCString &  s )

static

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

{
  QCString result;
  const char *p = s.data();
  if (p)
  {
    char c;
    while ((c=*p++))
    {
      if (c=='{') c='<'; else if (c=='}') c='>';
      result+=c;
    }
  }
 
  result=substitute(result,"&lt;","<");
  result=substitute(result,"&gt;",">");
  s = result;
}

引用了 QCString::data() , 以及 substitute().

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

validatingParseDoc()

DocRoot* validatingParseDoc	(	IDocParser &	parser,
		const QCString &	fileName,
		int	startLine,
		const Definition *	context,
		const MemberDef *	md,
		const QCString &	input,
		bool	indexWords,
		bool	isExample,
		const QCString &	exampleName,
		bool	singleLine,
		bool	linkFromIndex,
		bool	markdownSupport
	)

Main entry point for the documentation parser.

参数

parser	The parser object created via createDocParser()
fileName	File in which the documentation block is found (or the name of the example file in case isExample is TRUE).
startLine	Line at which the documentation block is found.
context	Class or namespace to which this block belongs.
md	Member definition to which the documentation belongs. Can be 0.
input	String representation of the documentation block.
indexWords	Indicates whether or not words should be put in the search index.
isExample	TRUE if the documentation belongs to an example.
exampleName	Base name of the example file (0 if isExample is FALSE).
singleLine	Output should be presented on a single line, so without starting a new paragraph at the end.
linkFromIndex	TRUE if the documentation is generated from an index page. In this case context is not used to determine the relative path when making a link.
markdownSupport	TRUE if the input needs to take markdown markup into account.

返回

Root node of the abstract syntax tree. Ownership of the pointer is handed over to the caller.

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

{
  DocParser &parser = dynamic_cast<DocParser&>(parserIntf);
  //printf("validatingParseDoc(%s,%s)=[%s]\n",ctx?qPrint(ctx->name()):"<none>",
  //                                     md?qPrint(md->name()):"<none>",
  //                                     input);
  //printf("========== validating %s at line %d\n",qPrint(fileName),startLine);
  //printf("---------------- input --------------------\n%s\n----------- end input -------------------\n",qPrint(input));
  //parser.context.token = new TokenInfo;
 
  // store parser state so we can re-enter this function if needed
  //bool fortranOpt = Config_getBool(OPTIMIZE_FOR_FORTRAN);
  parser.pushContext();
 
  if (ctx && ctx!=Doxygen::globalScope &&
      (ctx->definitionType()==Definition::TypeClass ||
       ctx->definitionType()==Definition::TypeNamespace
      )
     )
  {
    parser.context.context = ctx->name();
  }
  else if (ctx && ctx->definitionType()==Definition::TypePage)
  {
    const Definition *scope = (toPageDef(ctx))->getPageScope();
    if (scope && scope!=Doxygen::globalScope) parser.context.context = scope->name();
  }
  else if (ctx && ctx->definitionType()==Definition::TypeGroup)
  {
    const Definition *scope = (toGroupDef(ctx))->getGroupScope();
    if (scope && scope!=Doxygen::globalScope) parser.context.context = scope->name();
  }
  else
  {
    parser.context.context = "";
  }
  parser.context.scope = ctx;
 
  if (indexWords && Doxygen::searchIndex)
  {
    if (md)
    {
      parser.context.searchUrl=md->getOutputFileBase();
      Doxygen::searchIndex->setCurrentDoc(md,md->anchor(),FALSE);
    }
    else if (ctx)
    {
      parser.context.searchUrl=ctx->getOutputFileBase();
      Doxygen::searchIndex->setCurrentDoc(ctx,ctx->anchor(),FALSE);
    }
  }
  else
  {
    parser.context.searchUrl="";
  }
 
  parser.context.fileName = fileName;
  parser.context.relPath = (!linkFromIndex && ctx) ?
               QCString(relativePathToRoot(ctx->getOutputFileBase())) :
               QCString("");
  //printf("ctx->name=%s relPath=%s\n",qPrint(ctx->name()),qPrint(parser.context.relPath));
  parser.context.memberDef = md;
  while (!parser.context.nodeStack.empty()) parser.context.nodeStack.pop();
  while (!parser.context.styleStack.empty()) parser.context.styleStack.pop();
  while (!parser.context.initialStyleStack.empty()) parser.context.initialStyleStack.pop();
  parser.context.inSeeBlock = FALSE;
  parser.context.xmlComment = FALSE;
  parser.context.insideHtmlLink = FALSE;
  parser.context.includeFileText = "";
  parser.context.includeFileOffset = 0;
  parser.context.includeFileLength = 0;
  parser.context.isExample = isExample;
  parser.context.exampleName = exampleName;
  parser.context.hasParamCommand = FALSE;
  parser.context.hasReturnCommand = FALSE;
  parser.context.retvalsFound.clear();
  parser.context.paramsFound.clear();
  parser.context.markdownSupport = markdownSupport;
 
  //printf("Starting comment block at %s:%d\n",qPrint(parser.context.fileName),startLine);
  parser.tokenizer.setLineNr(startLine);
  uint ioLen = input.length();
  QCString inpStr = parser.processCopyDoc(input.data(),ioLen);
  if (inpStr.isEmpty() || inpStr.at(inpStr.length()-1)!='\n')
  {
    inpStr+='\n';
  }
  //printf("processCopyDoc(in='%s' out='%s')\n",input,qPrint(inpStr));
  parser.tokenizer.init(inpStr.data(),parser.context.fileName,markdownSupport);
 
  // build abstract syntax tree
  DocRoot *root = new DocRoot(parser,md!=0,singleLine);
  root->parse();
 
 
  if (Debug::isFlagSet(Debug::PrintTree))
  {
    // pretty print the result
    PrintDocVisitor *v = new PrintDocVisitor;
    root->accept(v);
    delete v;
  }
 
  parser.checkUnOrMultipleDocumentedParams();
  if (parser.context.memberDef) parser.context.memberDef->detectUndocumentedParams(parser.context.hasParamCommand,parser.context.hasReturnCommand);
 
  // TODO: These should be called at the end of the program.
  //parser.tokenizer.cleanup();
  //Mappers::cmdMapper->freeInstance();
  //Mappers::htmlTagMapper->freeInstance();
 
  // restore original parser state
  parser.popContext();
 
  //printf(">>>>>> end validatingParseDoc(%s,%s)\n",ctx?qPrint(ctx->name()):"<none>",
  //                                     md?qPrint(md->name()):"<none>");
 
  return root;
}

引用了 CompAccept< T >::accept(), MemberDef::anchor(), Definition::anchor(), QCString::at(), DocParser::checkUnOrMultipleDocumentedParams(), DocParserContext::context, DocParser::context, QCString::data(), Definition::definitionType(), MemberDef::detectUndocumentedParams(), DocParserContext::exampleName, FALSE, DocParserContext::fileName, MemberDef::getOutputFileBase(), Definition::getOutputFileBase(), Doxygen::globalScope, DocParserContext::hasParamCommand, DocParserContext::hasReturnCommand, DocParserContext::includeFileLength, DocParserContext::includeFileOffset, DocParserContext::includeFileText, DocTokenizer::init(), DocParserContext::initialStyleStack, DocParserContext::inSeeBlock, DocParserContext::insideHtmlLink, QCString::isEmpty(), DocParserContext::isExample, Debug::isFlagSet(), QCString::length(), DocParserContext::markdownSupport, DocParserContext::memberDef, Definition::name(), DocParserContext::nodeStack, DocParserContext::paramsFound, DocRoot::parse(), DocParser::popContext(), Debug::PrintTree, DocParser::processCopyDoc(), DocParser::pushContext(), relativePathToRoot(), DocParserContext::relPath, DocParserContext::retvalsFound, DocParserContext::scope, Doxygen::searchIndex, DocParserContext::searchUrl, SearchIndexIntf::setCurrentDoc(), DocTokenizer::setLineNr(), DocParserContext::styleStack, toGroupDef(), DocParser::tokenizer, toPageDef(), Definition::TypeClass, Definition::TypeGroup, Definition::TypeNamespace, Definition::TypePage , 以及 DocParserContext::xmlComment.

被这些函数引用 addPerlModDocBlock(), generateBriefDoc(), OutputList::generateDoc(), parseCommentAsText(), parseDoc(), ConceptDefImpl::writeBriefDescription(), DirDefImpl::writeBriefDescription(), NamespaceDefImpl::writeBriefDescription(), GroupDefImpl::writeBriefDescription(), FileDefImpl::writeBriefDescription(), MemberDefImpl::writeDeclaration(), ConceptDefImpl::writeDeclarationLink(), ClassDefImpl::writeDeclarationLink(), MemberList::writePlainDeclarations() , 以及 writeXMLDocBlock().

validatingParseText()

DocText* validatingParseText	(	IDocParser &	parser,
		const QCString &	input
	)

Main entry point for parsing simple text fragments. These fragments are limited to words, whitespace and symbols.

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

{
  DocParser &parser = dynamic_cast<DocParser&>(parserIntf);
  // store parser state so we can re-enter this function if needed
  parser.pushContext();
 
  //printf("------------ input ---------\n%s\n"
  //       "------------ end input -----\n",input);
  //parser.context.token = new TokenInfo;
  parser.context.context = "";
  parser.context.fileName = "<parseText>";
  parser.context.relPath = "";
  parser.context.memberDef = 0;
  while (!parser.context.nodeStack.empty()) parser.context.nodeStack.pop();
  while (!parser.context.styleStack.empty()) parser.context.styleStack.pop();
  while (!parser.context.initialStyleStack.empty()) parser.context.initialStyleStack.pop();
  parser.context.inSeeBlock = FALSE;
  parser.context.xmlComment = FALSE;
  parser.context.insideHtmlLink = FALSE;
  parser.context.includeFileText = "";
  parser.context.includeFileOffset = 0;
  parser.context.includeFileLength = 0;
  parser.context.isExample = FALSE;
  parser.context.exampleName = "";
  parser.context.hasParamCommand = FALSE;
  parser.context.hasReturnCommand = FALSE;
  parser.context.retvalsFound.clear();
  parser.context.paramsFound.clear();
  parser.context.searchUrl="";
 
  DocText *txt = new DocText(parser);
 
  if (!input.isEmpty())
  {
    parser.tokenizer.setLineNr(1);
    parser.tokenizer.init(input.data(),parser.context.fileName,Config_getBool(MARKDOWN_SUPPORT));
 
    // build abstract syntax tree
    txt->parse();
 
    if (Debug::isFlagSet(Debug::PrintTree))
    {
      // pretty print the result
      PrintDocVisitor *v = new PrintDocVisitor;
      txt->accept(v);
      delete v;
    }
  }
 
  // restore original parser state
  parser.popContext();
  return txt;
}

引用了 CompAccept< T >::accept(), Config_getBool, DocParserContext::context, DocParser::context, QCString::data(), DocParserContext::exampleName, FALSE, DocParserContext::fileName, DocParserContext::hasParamCommand, DocParserContext::hasReturnCommand, DocParserContext::includeFileLength, DocParserContext::includeFileOffset, DocParserContext::includeFileText, DocTokenizer::init(), DocParserContext::initialStyleStack, DocParserContext::inSeeBlock, DocParserContext::insideHtmlLink, QCString::isEmpty(), DocParserContext::isExample, Debug::isFlagSet(), DocParserContext::memberDef, DocParserContext::nodeStack, DocParserContext::paramsFound, DocText::parse(), DocParser::popContext(), Debug::PrintTree, DocParser::pushContext(), DocParserContext::relPath, DocParserContext::retvalsFound, DocParserContext::searchUrl, DocTokenizer::setLineNr(), DocParserContext::styleStack, DocParser::tokenizer , 以及 DocParserContext::xmlComment.

被这些函数引用 RTFGenerator::endIndexSection() , 以及 OutputList::parseText().

变量说明

g_plantumlEngine

const std::set<std::string> g_plantumlEngine

static

初始值:

{
  "uml", "bpm", "wire", "dot", "ditaa",
  "salt", "math", "latex", "gantt", "mindmap",
  "wbs", "yaml", "creole", "json", "flow",
  "board", "git"
}

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

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

g_sectionLevelToName

const char* g_sectionLevelToName[]

static

初始值:

=
{
  "page",
  "section",
  "subsection",
  "subsubsection",
  "paragraph",
  "subparagraph"
}

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

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