Doxygen
DocSimpleListItem类 参考

Node representing a simple list item 更多...

#include <docparser.h>

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

Public 成员函数

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

Private 属性

DocParam_paragraph = 0
 

额外继承的成员函数

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

详细描述

Node representing a simple list item

在文件 docparser.h1266 行定义.

构造及析构函数说明

◆ DocSimpleListItem()

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

在文件 docparser.h1269 行定义.

1269  :
1270  DocNode(parser) { m_paragraph=new DocPara(parser,this); m_parent = parent; }

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

◆ ~DocSimpleListItem()

virtual DocSimpleListItem::~DocSimpleListItem ( )
inlinevirtual

在文件 docparser.h1272 行定义.

1272 { delete m_paragraph; }

引用了 m_paragraph.

成员函数说明

◆ accept()

void DocSimpleListItem::accept ( DocVisitor v)
inlineoverridevirtual

Acceptor function for node visitors. Part of the visitor pattern.

参数
vAbstract visitor.

实现了 DocNode.

在文件 docparser.h1274 行定义.

1275  {
1276  v->visitPre(this);
1277  m_paragraph->accept(v);
1278  v->visitPost(this);
1279  }

引用了 CompAccept< T >::accept(), m_paragraph, DocVisitor::visitPost() , 以及 DocVisitor::visitPre().

◆ kind()

Kind DocSimpleListItem::kind ( ) const
inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

在文件 docparser.h1273 行定义.

1273 { return Kind_SimpleListItem; }

引用了 DocNode::Kind_SimpleListItem.

◆ parse()

int DocSimpleListItem::parse ( )

在文件 docparser.cpp4238 行定义.

4239 {
4240  auto ns = AutoNodeStack(m_parser,this);
4241  int rv=m_paragraph->parse();
4243  m_paragraph->markLast();
4244  return rv;
4245 }

引用了 m_paragraph, DocNode::m_parser, DocPara::markFirst(), DocPara::markLast() , 以及 DocPara::parse().

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

类成员变量说明

◆ m_paragraph

DocPara* DocSimpleListItem::m_paragraph = 0
private

在文件 docparser.h1282 行定义.

被这些函数引用 accept(), DocSimpleListItem(), parse() , 以及 ~DocSimpleListItem().


该类的文档由以下文件生成:
DocPara
Node representing a paragraph in the documentation tree
Definition: docparser.h:1178
DocPara::markFirst
void markFirst(bool v=TRUE)
Definition: docparser.h:1186
CompAccept::accept
void accept(DocVisitor *v) override
Definition: docparser.h:200
DocNode::m_parser
DocParser & m_parser
Definition: docparser.h:184
DocNode::Kind_SimpleListItem
@ Kind_SimpleListItem
Definition: docparser.h:112
DocPara::markLast
void markLast(bool v=TRUE)
Definition: docparser.h:1187
DocPara::parse
int parse()
Definition: docparser.cpp:6579
DocVisitor::visitPost
virtual void visitPost(DocAutoList *)=0
DocSimpleListItem::m_paragraph
DocPara * m_paragraph
Definition: docparser.h:1282
AutoNodeStack
Definition: docparser.cpp:186
DocNode::DocNode
DocNode(DocParser &parser)
Definition: docparser.h:157
DocNode::parent
DocNode * parent() const
Definition: docparser.h:166
DocVisitor::visitPre
virtual void visitPre(DocAutoList *)=0
DocNode::m_parent
DocNode * m_parent
Definition: docparser.h:182