Doxygen
DocSimpleList类 参考

Node representing a simple list 更多...

#include <docparser.h>

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

Public 成员函数

 DocSimpleList (DocParser &parser, DocNode *parent)
 
Kind kind () const override
 
int parse ()
 
- Public 成员函数 继承自 CompAccept< DocSimpleList >
 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< DocSimpleList >
DocNodeList m_children
 
- Protected 属性 继承自 DocNode
DocNodem_parent = 0
 
DocParserm_parser
 

详细描述

Node representing a simple list

在文件 docparser.h1082 行定义.

构造及析构函数说明

◆ DocSimpleList()

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

在文件 docparser.h1085 行定义.

1085 : CompAccept<DocSimpleList>(parser) { m_parent = parent; }

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

成员函数说明

◆ kind()

Kind DocSimpleList::kind ( ) const
inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

在文件 docparser.h1086 行定义.

1086 { return Kind_SimpleList; }

引用了 DocNode::Kind_SimpleList.

◆ parse()

int DocSimpleList::parse ( )

在文件 docparser.cpp4249 行定义.

4250 {
4251  auto ns = AutoNodeStack(m_parser,this);
4252  int rv;
4253  do
4254  {
4256  m_children.push_back(std::unique_ptr<DocSimpleListItem>(li));
4257  rv=li->parse();
4258  } while (rv==RetVal_ListItem);
4259  return (rv!=TK_NEWPARA) ? rv : RetVal_OK;
4260 }

引用了 CompAccept< DocSimpleList >::m_children, DocNode::m_parser, DocSimpleListItem::parse(), RetVal_ListItem, RetVal_OK , 以及 TK_NEWPARA.

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


该类的文档由以下文件生成:
CompAccept< DocSimpleList >
RetVal_OK
@ RetVal_OK
Command starting with \
Definition: doctokenizer.h:59
DocNode::Kind_SimpleList
@ Kind_SimpleList
Definition: docparser.h:111
DocNode::m_parser
DocParser & m_parser
Definition: docparser.h:184
RetVal_ListItem
@ RetVal_ListItem
Definition: doctokenizer.h:61
DocSimpleListItem::parse
int parse()
Definition: docparser.cpp:4238
AutoNodeStack
Definition: docparser.cpp:186
DocSimpleListItem
Node representing a simple list item
Definition: docparser.h:1266
TK_NEWPARA
@ TK_NEWPARA
Definition: doctokenizer.h:54
DocNode::parent
DocNode * parent() const
Definition: docparser.h:166
CompAccept< DocSimpleList >::m_children
DocNodeList m_children
Definition: docparser.h:211
DocNode::m_parent
DocNode * m_parent
Definition: docparser.h:182