Doxygen
DocParBlock类 参考

Node representing an block of paragraphs 更多...

#include <docparser.h>

+ 类 DocParBlock 继承关系图:
+ DocParBlock 的协作图:

Public 成员函数

 DocParBlock (DocParser &parser, DocNode *parent)
 
int parse ()
 
Kind kind () const override
 
- Public 成员函数 继承自 CompAccept< DocParBlock >
 CompAccept (DocParser &parser)
 
void accept (DocVisitor *v) override
 
const DocNodeListchildren () const
 
DocNodeListchildren ()
 
- Public 成员函数 继承自 DocNode
 DocNode (DocParser &parser)
 
virtual ~DocNode ()
 
DocNodeparent () const
 
void setParent (DocNode *parent)
 
bool isPreformatted () const
 

额外继承的成员函数

- 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< DocParBlock >
DocNodeList m_children
 
- Protected 属性 继承自 DocNode
DocNodem_parent = 0
 
DocParserm_parser
 

详细描述

Node representing an block of paragraphs

在文件 docparser.h1070 行定义.

构造及析构函数说明

◆ DocParBlock()

DocParBlock::DocParBlock ( DocParser parser,
DocNode parent 
)
inline

在文件 docparser.h1073 行定义.

1073 : CompAccept<DocParBlock>(parser) { m_parent = parent; }

引用了 DocNode::m_parent , 以及 DocNode::parent().

成员函数说明

◆ kind()

Kind DocParBlock::kind ( ) const
inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

在文件 docparser.h1075 行定义.

1075 { return Kind_ParBlock; }

引用了 DocNode::Kind_ParBlock.

◆ parse()

int DocParBlock::parse ( )

在文件 docparser.cpp4213 行定义.

4214 {
4215  DBG(("DocParBlock::parse() start\n"));
4216  int retval=0;
4217  auto ns = AutoNodeStack(m_parser,this);
4218 
4219  // parse one or more paragraphs
4220  bool isFirst=TRUE;
4221  DocPara *par=0;
4222  do
4223  {
4224  par = new DocPara(m_parser,this);
4225  if (isFirst) { par->markFirst(); isFirst=FALSE; }
4226  m_children.push_back(std::unique_ptr<DocPara>(par));
4227  retval=par->parse();
4228  }
4229  while (retval==TK_NEWPARA);
4230  if (par) par->markLast();
4231 
4232  DBG(("DocParBlock::parse() end retval=%s\n",DocTokenizer::retvalToString(retval)));
4233  return (retval==RetVal_EndBlockQuote) ? RetVal_OK : retval;
4234 }

引用了 DBG, FALSE, CompAccept< DocParBlock >::m_children, DocNode::m_parser, DocPara::markFirst(), DocPara::markLast(), DocPara::parse(), RetVal_EndBlockQuote, RetVal_OK, DocTokenizer::retvalToString(), TK_NEWPARA , 以及 TRUE.

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


该类的文档由以下文件生成:
DocPara
Node representing a paragraph in the documentation tree
Definition: docparser.h:1178
CompAccept< DocParBlock >
RetVal_OK
@ RetVal_OK
Command starting with \
Definition: doctokenizer.h:59
DocPara::markFirst
void markFirst(bool v=TRUE)
Definition: docparser.h:1186
DocNode::Kind_ParBlock
@ Kind_ParBlock
Definition: docparser.h:151
DocTokenizer::retvalToString
static const char * retvalToString(int retval)
DocNode::m_parser
DocParser & m_parser
Definition: docparser.h:184
TRUE
#define TRUE
Definition: qcstring.h:36
DocPara::markLast
void markLast(bool v=TRUE)
Definition: docparser.h:1187
RetVal_EndBlockQuote
@ RetVal_EndBlockQuote
Definition: doctokenizer.h:79
DocPara::parse
int parse()
Definition: docparser.cpp:6579
AutoNodeStack
Definition: docparser.cpp:186
TK_NEWPARA
@ TK_NEWPARA
Definition: doctokenizer.h:54
DocNode::parent
DocNode * parent() const
Definition: docparser.h:166
DBG
#define DBG(x)
Definition: docparser.cpp:58
CompAccept< DocParBlock >::m_children
DocNodeList m_children
Definition: docparser.h:211
DocNode::m_parent
DocNode * m_parent
Definition: docparser.h:182
FALSE
#define FALSE
Definition: qcstring.h:33