DocParamSect类 参考

Node representing a parameter section 更多...

#include <docparser.h>

类 DocParamSect 继承关系图:

DocParamSect 的协作图:

Public 类型
enum	Type {   Unknown, Param, RetVal, Exception,   TemplateParam }
enum	Direction { In =1, Out =2, InOut =3, Unspecified =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 }

Public 成员函数
	DocParamSect (DocParser &parser, DocNode *parent, Type t)
int	parse (const QCString &cmdName, bool xmlContext, Direction d)
Kind	kind () const override
Type	type () const
bool	hasInOutSpecifier () const
bool	hasTypeSpecifier () const
Public 成员函数 继承自 CompAccept< DocParamSect >
	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 属性
Type	m_type = Unknown
bool	m_hasInOutSpecifier = false
bool	m_hasTypeSpecifier = false

友元
class	DocParamList

额外继承的成员函数
Protected 类型 继承自 DocNode
enum	RefType { Unknown, Anchor, Section, Table }
Protected 成员函数 继承自 DocNode
void	setInsidePreformatted (bool p)
Protected 属性 继承自 CompAccept< DocParamSect >
DocNodeList	m_children
Protected 属性 继承自 DocNode
DocNode *	m_parent = 0
DocParser &	m_parser

详细描述

Node representing a parameter section

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

成员枚举类型说明

Direction

enum DocParamSect::Direction

枚举值
In
Out
InOut
Unspecified

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

    {
       In=1, Out=2, InOut=3, Unspecified=0
    };

Type

enum DocParamSect::Type

枚举值
Unknown
Param
RetVal
Exception
TemplateParam

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

    {
       Unknown, Param, RetVal, Exception, TemplateParam
    };

构造及析构函数说明

DocParamSect()

DocParamSect::DocParamSect ( DocParser &  parser, DocNode *  parent, Type  t  )

inline

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

      : CompAccept<DocParamSect>(parser), m_type(t), m_hasInOutSpecifier(FALSE), m_hasTypeSpecifier(FALSE)
    { m_parent = parent; }

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

成员函数说明

hasInOutSpecifier()

bool DocParamSect::hasInOutSpecifier ( ) const

inline

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

{ return m_hasInOutSpecifier; }

引用了 m_hasInOutSpecifier.

被这些函数引用 HtmlDocVisitor::visitPre(), DocbookDocVisitor::visitPre(), LatexDocVisitor::visitPre(), RTFDocVisitor::visitPre() , 以及 PerlModDocVisitor::visitPre().

hasTypeSpecifier()

bool DocParamSect::hasTypeSpecifier ( ) const

inline

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

{ return m_hasTypeSpecifier; }

引用了 m_hasTypeSpecifier.

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

kind()

Kind DocParamSect::kind ( ) const

inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

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

{ return Kind_ParamSect; }

引用了 DocNode::Kind_ParamSect.

parse()

int DocParamSect::parse	(	const QCString &	cmdName,
		bool	xmlContext,
		Direction	d
	)

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

{
  int retval=RetVal_OK;
  DBG(("DocParamSect::parse() start\n"));
  auto ns = AutoNodeStack(m_parser,this);
 
  if (d!=Unspecified)
  {
    m_hasInOutSpecifier=TRUE;
  }
 
  DocParamList *pl = new DocParamList(m_parser,this,m_type,d);
  if (m_children.empty())
  {
    pl->markFirst();
    pl->markLast();
  }
  else
  {
    ASSERT(m_children.back()->kind()==DocNode::Kind_ParamList);
    ((DocParamList *)m_children.back().get())->markLast(FALSE);
    pl->markLast();
  }
  m_children.push_back(std::unique_ptr<DocParamList>(pl));
  if (xmlContext)
  {
    retval = pl->parseXml(cmdName);
  }
  else
  {
    retval = pl->parse(cmdName);
  }
  if (retval==RetVal_EndParBlock)
  {
    retval = RetVal_OK;
  }
 
  DBG(("DocParamSect::parse() end retval=%d\n",retval));
  return retval;
}

引用了 ASSERT, DBG, DocParamList, FALSE, DocNode::Kind_ParamList, CompAccept< DocParamSect >::m_children, m_hasInOutSpecifier, DocNode::m_parser, m_type, DocParamList::markFirst(), DocParamList::markLast(), DocParamList::parse(), DocParamList::parseXml(), RetVal_EndParBlock, RetVal_OK, TRUE , 以及 Unspecified.

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

type()

Type DocParamSect::type ( ) const

inline

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

{ return m_type; }

引用了 m_type.

被这些函数引用 LatexDocVisitor::visitPost(), RTFDocVisitor::visitPost(), HtmlDocVisitor::visitPre(), DocbookDocVisitor::visitPre(), LatexDocVisitor::visitPre(), RTFDocVisitor::visitPre(), ManDocVisitor::visitPre(), XmlDocVisitor::visitPre() , 以及 PerlModDocVisitor::visitPre().

友元及相关函数文档

DocParamList

friend class DocParamList

friend

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

被这些函数引用 parse().

类成员变量说明

m_hasInOutSpecifier

bool DocParamSect::m_hasInOutSpecifier = false

private

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

被这些函数引用 hasInOutSpecifier() , 以及 parse().

m_hasTypeSpecifier

bool DocParamSect::m_hasTypeSpecifier = false

private

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

被这些函数引用 hasTypeSpecifier().

m_type

Type DocParamSect::m_type = Unknown

private

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

被这些函数引用 parse() , 以及 type().

---

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

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