Doxygen
DocAutoListItem类 参考

Node representing an item of a auto list 更多...

#include <docparser.h>

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

Public 成员函数

 DocAutoListItem (DocParser &parser, DocNode *parent, int indent, int num)
 
Kind kind () const override
 
int itemNumber () const
 
int parse ()
 
- Public 成员函数 继承自 CompAccept< DocAutoListItem >
 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
 

Private 属性

int m_indent = 0
 
int m_itemNum = 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 属性 继承自 CompAccept< DocAutoListItem >
DocNodeList m_children
 
- Protected 属性 继承自 DocNode
DocNodem_parent = 0
 
DocParserm_parser
 

详细描述

Node representing an item of a auto list

在文件 docparser.h720 行定义.

构造及析构函数说明

◆ DocAutoListItem()

DocAutoListItem::DocAutoListItem ( DocParser parser,
DocNode parent,
int  indent,
int  num 
)

在文件 docparser.cpp4264 行定义.

4265  : CompAccept<DocAutoListItem>(parser), m_indent(indent), m_itemNum(num)
4266 {
4267  m_parent = parent;
4268 }

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

成员函数说明

◆ itemNumber()

int DocAutoListItem::itemNumber ( ) const
inline

在文件 docparser.h725 行定义.

725 { return m_itemNum; }

引用了 m_itemNum.

被这些函数引用 ManDocVisitor::visitPre().

◆ kind()

Kind DocAutoListItem::kind ( ) const
inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

在文件 docparser.h724 行定义.

724 { return Kind_AutoListItem; }

引用了 DocNode::Kind_AutoListItem.

◆ parse()

int DocAutoListItem::parse ( )

在文件 docparser.cpp4270 行定义.

4271 {
4272  int retval = RetVal_OK;
4273  auto ns = AutoNodeStack(m_parser,this);
4274 
4275  // first parse any number of paragraphs
4276  bool isFirst=TRUE;
4277  DocPara *lastPar=0;
4278  do
4279  {
4280  DocPara *par = new DocPara(m_parser,this);
4281  if (isFirst) { par->markFirst(); isFirst=FALSE; }
4282  retval=par->parse();
4283  if (!par->isEmpty())
4284  {
4285  m_children.push_back(std::unique_ptr<DocPara>(par));
4286  if (lastPar) lastPar->markLast(FALSE);
4287  lastPar=par;
4288  }
4289  else
4290  {
4291  delete par;
4292  }
4293  // next paragraph should be more indented than the - marker to belong
4294  // to this item
4295  } while (retval==TK_NEWPARA && m_parser.context.token->indent>m_indent);
4296  if (lastPar) lastPar->markLast();
4297 
4298  //printf("DocAutoListItem: retval=%d indent=%d\n",retval,m_parser.context.token->indent);
4299  return retval;
4300 }

引用了 DocParser::context, FALSE, TokenInfo::indent, DocPara::isEmpty(), CompAccept< DocAutoListItem >::m_children, m_indent, DocNode::m_parser, DocPara::markFirst(), DocPara::markLast(), DocPara::parse(), RetVal_OK, TK_NEWPARA, DocParserContext::token , 以及 TRUE.

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

类成员变量说明

◆ m_indent

int DocAutoListItem::m_indent = 0
private

在文件 docparser.h729 行定义.

被这些函数引用 parse().

◆ m_itemNum

int DocAutoListItem::m_itemNum = 0
private

在文件 docparser.h730 行定义.

被这些函数引用 itemNumber().


该类的文档由以下文件生成:
DocPara
Node representing a paragraph in the documentation tree
Definition: docparser.h:1178
DocParserContext::token
TokenInfo * token
Definition: docparser.cpp:129
DocParser::context
DocParserContext context
Definition: docparser.cpp:175
DocNode::Kind_AutoListItem
@ Kind_AutoListItem
Definition: docparser.h:105
CompAccept< DocAutoListItem >
RetVal_OK
@ RetVal_OK
Command starting with \
Definition: doctokenizer.h:59
DocPara::markFirst
void markFirst(bool v=TRUE)
Definition: docparser.h:1186
TokenInfo::indent
int indent
Definition: doctokenizer.h:83
DocPara::isEmpty
bool isEmpty() const
Definition: docparser.h:1185
DocAutoListItem::m_indent
int m_indent
Definition: docparser.h:729
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
DocPara::parse
int parse()
Definition: docparser.cpp:6579
DocAutoListItem::m_itemNum
int m_itemNum
Definition: docparser.h:730
AutoNodeStack
Definition: docparser.cpp:186
TK_NEWPARA
@ TK_NEWPARA
Definition: doctokenizer.h:54
DocNode::parent
DocNode * parent() const
Definition: docparser.h:166
CompAccept< DocAutoListItem >::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