DocRoot类 参考

Root node of documentation tree 更多...

#include <docparser.h>

类 DocRoot 继承关系图:

DocRoot 的协作图:

Public 成员函数
	DocRoot (DocParser &parser, bool indent, bool sl)
Kind	kind () const override
void	parse ()
bool	indent () const
bool	singleLine () const
bool	isEmpty () const
Public 成员函数 继承自 CompAccept< DocRoot >
	CompAccept (DocParser &parser)
void	accept (DocVisitor *v) override
const DocNodeList &	children () const
DocNodeList &	children ()
Public 成员函数 继承自 DocNode
	DocNode (DocParser &parser)
virtual	~DocNode ()
DocNode *	parent () const
void	setParent (DocNode *parent)
bool	isPreformatted () const

Private 属性
bool	m_indent = false
bool	m_singleLine = false

额外继承的成员函数
Public 类型 继承自 DocNode
enum	Kind {   Kind_Root = 0, Kind_Word = 1, Kind_WhiteSpace = 2, Kind_Para = 3,   Kind_AutoList = 4, Kind_AutoListItem = 5, Kind_Symbol = 6, Kind_URL = 7,   Kind_StyleChange = 8, Kind_SimpleSect = 9, Kind_Title = 10, Kind_SimpleList = 11,   Kind_SimpleListItem = 12, Kind_Section = 13, Kind_Verbatim = 14, Kind_XRefItem = 15,   Kind_HtmlList = 16, Kind_HtmlListItem = 17, Kind_HtmlDescList = 18, Kind_HtmlDescData = 19,   Kind_HtmlDescTitle = 20, Kind_HtmlTable = 21, Kind_HtmlRow = 22, Kind_HtmlCell = 23,   Kind_HtmlCaption = 24, Kind_LineBreak = 25, Kind_HorRuler = 26, Kind_Anchor = 27,   Kind_IndexEntry = 28, Kind_Internal = 29, Kind_HRef = 30, Kind_Include = 31,   Kind_IncOperator = 32, Kind_HtmlHeader = 33, Kind_Image = 34, Kind_DotFile = 35,   Kind_Link = 36, Kind_Ref = 37, Kind_Formula = 38, Kind_SecRefItem = 39,   Kind_SecRefList = 40, Kind_SimpleSectSep = 41, Kind_LinkedWord = 42, Kind_ParamSect = 43,   Kind_ParamList = 44, Kind_InternalRef = 45, Kind_Copy = 46, Kind_Text = 47,   Kind_MscFile = 48, Kind_HtmlBlockQuote = 49, Kind_VhdlFlow = 50, Kind_ParBlock = 51,   Kind_DiaFile = 52, Kind_Emoji = 53, Kind_Sep = 54 }
Protected 类型 继承自 DocNode
enum	RefType { Unknown, Anchor, Section, Table }
Protected 成员函数 继承自 DocNode
void	setInsidePreformatted (bool p)
Protected 属性 继承自 CompAccept< DocRoot >
DocNodeList	m_children
Protected 属性 继承自 DocNode
DocNode *	m_parent = 0
DocParser &	m_parser

详细描述

Root node of documentation tree

在文件 docparser.h 第 1457 行定义.

构造及析构函数说明

DocRoot()

DocRoot::DocRoot ( DocParser &  parser, bool  indent, bool  sl  )

inline

在文件 docparser.h 第 1460 行定义.

: CompAccept<DocRoot>(parser), m_indent(indent), m_singleLine(sl) {}

成员函数说明

indent()

bool DocRoot::indent ( ) const

inline

在文件 docparser.h 第 1463 行定义.

{ return m_indent; }

引用了 m_indent.

被这些函数引用 RTFDocVisitor::visitPost() , 以及 RTFDocVisitor::visitPre().

isEmpty()

bool DocRoot::isEmpty ( ) const

inline

在文件 docparser.h 第 1465 行定义.

{ return m_children.empty(); }

引用了 CompAccept< DocRoot >::m_children.

kind()

Kind DocRoot::kind ( ) const

inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

在文件 docparser.h 第 1461 行定义.

{ return Kind_Root; }

引用了 DocNode::Kind_Root.

parse()

void DocRoot::parse

(

)

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

{
  DBG(("DocRoot::parse() start\n"));
  auto ns = AutoNodeStack(m_parser,this);
  m_parser.tokenizer.setStatePara();
  int retval=0;
 
  // first parse any number of paragraphs
  bool isFirst=TRUE;
  DocPara *lastPar=0;
  do
  {
    DocPara *par = new DocPara(m_parser,this);
    if (isFirst) { par->markFirst(); isFirst=FALSE; }
    retval=par->parse();
    if (!par->isEmpty() || !par->attribs().empty())
    {
      m_children.push_back(std::unique_ptr<DocPara>(par));
      lastPar=par;
    }
    else
    {
      delete par;
    }
    if (retval==RetVal_Paragraph)
    {
      if (!m_parser.context.token->sectionId.startsWith("autotoc_md"))
      {
         warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"found paragraph command (id: '%s') outside of subsubsection context!",qPrint(m_parser.context.token->sectionId));
      }
      while (retval==RetVal_Paragraph)
      {
        if (!m_parser.context.token->sectionId.isEmpty())
        {
          const SectionInfo *sec=SectionManager::instance().find(m_parser.context.token->sectionId);
          if (sec)
          {
            DocSection *s=new DocSection(m_parser,this,
                std::min(4+Doxygen::subpageNestingLevel,5),m_parser.context.token->sectionId);
            m_children.push_back(std::unique_ptr<DocSection>(s));
            retval = s->parse();
          }
          else
          {
            warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Invalid paragraph id '%s'; ignoring paragraph",qPrint(m_parser.context.token->sectionId));
            retval = 0;
          }
        }
        else
        {
          warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Missing id for paragraph; ignoring paragraph");
          retval = 0;
        }
      }
    }
    if (retval==RetVal_Subsubsection)
    {
      if (!(m_parser.context.token->sectionId.startsWith("autotoc_md")))
        warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"found subsubsection command (id: '%s') outside of subsection context!",qPrint(m_parser.context.token->sectionId));
      while (retval==RetVal_Subsubsection)
      {
        if (!m_parser.context.token->sectionId.isEmpty())
        {
          const SectionInfo *sec=SectionManager::instance().find(m_parser.context.token->sectionId);
          if (sec)
          {
            DocSection *s=new DocSection(m_parser,this,
                std::min(3+Doxygen::subpageNestingLevel,5),m_parser.context.token->sectionId);
            m_children.push_back(std::unique_ptr<DocSection>(s));
            retval = s->parse();
          }
          else
          {
            warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Invalid subsubsection id '%s'; ignoring subsubsection",qPrint(m_parser.context.token->sectionId));
            retval = 0;
          }
        }
        else
        {
          warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Missing id for subsubsection; ignoring subsubsection");
          retval = 0;
        }
      }
    }
    if (retval==RetVal_Subsection)
    {
      if (!m_parser.context.token->sectionId.startsWith("autotoc_md"))
      {
        warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"found subsection command (id: '%s') outside of section context!",qPrint(m_parser.context.token->sectionId));
      }
      while (retval==RetVal_Subsection)
      {
        if (!m_parser.context.token->sectionId.isEmpty())
        {
          const SectionInfo *sec=SectionManager::instance().find(m_parser.context.token->sectionId);
          if (sec)
          {
            DocSection *s=new DocSection(m_parser,this,
                std::min(2+Doxygen::subpageNestingLevel,5),m_parser.context.token->sectionId);
            m_children.push_back(std::unique_ptr<DocSection>(s));
            retval = s->parse();
          }
          else
          {
            warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Invalid subsection id '%s'; ignoring subsection",qPrint(m_parser.context.token->sectionId));
            retval = 0;
          }
        }
        else
        {
          warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Missing id for subsection; ignoring subsection");
          retval = 0;
        }
      }
    }
    if (retval==TK_LISTITEM)
    {
      warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Invalid list item found");
    }
    if (retval==RetVal_Internal)
    {
      DocInternal *in = new DocInternal(m_parser,this);
      m_children.push_back(std::unique_ptr<DocInternal>(in));
      retval = in->parse(1);
    }
  } while (retval!=0 && retval!=RetVal_Section);
  if (lastPar) lastPar->markLast();
 
  //printf("DocRoot::parse() retval=%d %d\n",retval,RetVal_Section);
  // then parse any number of level1 sections
  while (retval==RetVal_Section)
  {
    if (!m_parser.context.token->sectionId.isEmpty())
    {
      const SectionInfo *sec=SectionManager::instance().find(m_parser.context.token->sectionId);
      if (sec)
      {
        DocSection *s=new DocSection(m_parser,this,
            std::min(1+Doxygen::subpageNestingLevel,5),m_parser.context.token->sectionId);
        m_children.push_back(std::unique_ptr<DocSection>(s));
        retval = s->parse();
      }
      else
      {
        warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Invalid section id '%s'; ignoring section",qPrint(m_parser.context.token->sectionId));
        retval = 0;
      }
    }
    else
    {
      warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Missing id for section; ignoring section");
      retval = 0;
    }
  }
 
  m_parser.handleUnclosedStyleCommands();
 
  DBG(("DocRoot::parse() end\n"));
}

引用了 DocPara::attribs(), DocParser::context, DBG, FALSE, DocParserContext::fileName, LinkedMap< T, Hash, KeyEqual, Map >::find(), DocTokenizer::getLineNr(), DocParser::handleUnclosedStyleCommands(), SectionManager::instance(), QCString::isEmpty(), DocPara::isEmpty(), CompAccept< DocRoot >::m_children, DocNode::m_parser, DocPara::markFirst(), DocPara::markLast(), DocSection::parse(), DocInternal::parse(), DocPara::parse(), qPrint(), RetVal_Internal, RetVal_Paragraph, RetVal_Section, RetVal_Subsection, RetVal_Subsubsection, TokenInfo::sectionId, DocTokenizer::setStatePara(), QCString::startsWith(), Doxygen::subpageNestingLevel, TK_LISTITEM, DocParserContext::token, DocParser::tokenizer, TRUE , 以及 warn_doc_error().

被这些函数引用 validatingParseDoc().

singleLine()

bool DocRoot::singleLine ( ) const

inline

在文件 docparser.h 第 1464 行定义.

{ return m_singleLine; }

引用了 m_singleLine.

被这些函数引用 RTFDocVisitor::visitPost().

类成员变量说明

m_indent

bool DocRoot::m_indent = false

private

在文件 docparser.h 第 1468 行定义.

被这些函数引用 indent().

m_singleLine

bool DocRoot::m_singleLine = false

private

在文件 docparser.h 第 1469 行定义.

被这些函数引用 singleLine().

---

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

• src/docparser.h
• src/docparser.cpp