DocParamSect Class Reference

#include <docparser.h>

Inheritance diagram for DocParamSect:

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

Public Member Functions
	DocParamSect (DocNode *parent, Type t)
int	parse (const QCString &cmdName, bool xmlContext, Direction d)
Kind	kind () const
Type	type () const
void	accept (DocVisitor *v)
bool	hasInOutSpecifier () const
bool	hasTypeSpecifier () const
Public Member Functions inherited from CompAccept< DocParamSect >
	CompAccept ()
virtual	~CompAccept ()
void	accept (DocParamSect *obj, DocVisitor *v)
const QList< DocNode > &	children () const
QList< DocNode > &	children ()
Public Member Functions inherited from DocNode
	DocNode ()
virtual	~DocNode ()
DocNode *	parent () const
void	setParent (DocNode *parent)
bool	isPreformatted () const

Private Attributes
Type	m_type
bool	m_hasInOutSpecifier
bool	m_hasTypeSpecifier

Friends
class	DocParamList

Additional Inherited Members
Protected Member Functions inherited from DocNode
void	setInsidePreformatted (bool p)
Protected Attributes inherited from CompAccept< DocParamSect >
QList< DocNode >	m_children
Protected Attributes inherited from DocNode
DocNode *	m_parent

Detailed Description

Node representing a parameter section

Definition at line 1084 of file docparser.h.

Member Enumeration Documentation

enum DocParamSect::Direction

Enumerator
In
Out
InOut
Unspecified

Definition at line 1092 of file docparser.h.

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

enum DocParamSect::Type

Enumerator
Unknown
Param
RetVal
Exception
TemplateParam

Definition at line 1088 of file docparser.h.

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

Constructor & Destructor Documentation

DocParamSect::DocParamSect ( DocNode *  parent, Type  t  )

inline

Definition at line 1096 of file docparser.h.

References DocNode::m_parent, and DocNode::parent().

      : m_type(t), m_hasInOutSpecifier(FALSE), m_hasTypeSpecifier(FALSE) 
    { m_parent = parent; }

Member Function Documentation

void DocParamSect::accept ( DocVisitor *  v )

inlinevirtual

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

Parameters

v	Abstract visitor.

Implements DocNode.

Definition at line 1102 of file docparser.h.

References CompAccept< T >::accept().

{ CompAccept<DocParamSect>::accept(this,v); }

bool DocParamSect::hasInOutSpecifier ( ) const

inline

Definition at line 1103 of file docparser.h.

References m_hasInOutSpecifier.

Referenced by RTFDocVisitor::visitPre(), LatexDocVisitor::visitPre(), HtmlDocVisitor::visitPre(), and PerlModDocVisitor::visitPre().

{ return m_hasInOutSpecifier; }

bool DocParamSect::hasTypeSpecifier ( ) const

inline

Definition at line 1104 of file docparser.h.

References m_hasTypeSpecifier.

Referenced by RTFDocVisitor::visitPre(), HtmlDocVisitor::visitPre(), and LatexDocVisitor::visitPre().

{ return m_hasTypeSpecifier; }

Kind DocParamSect::kind ( ) const

inlinevirtual

Returns the kind of node. Provides runtime type information

Implements DocNode.

Definition at line 1100 of file docparser.h.

References DocNode::Kind_ParamSect.

{ return Kind_ParamSect; }

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

Definition at line 4810 of file docparser.cpp.

References DBG, DocParamList, g_nodeStack, DocNode::Kind_ParamList, CompAccept< DocParamSect >::m_children, m_hasInOutSpecifier, m_type, DocParamList::markFirst(), DocParamList::markLast(), DocParamList::parse(), DocParamList::parseXml(), RetVal_EndParBlock, RetVal_OK, and Unspecified.

Referenced by DocPara::handleParamSection().

{
  int retval=RetVal_OK;
  DBG(("DocParamSect::parse() start\n"));
  g_nodeStack.push(this);

  if (d!=Unspecified)
  {
    m_hasInOutSpecifier=TRUE;
  }

  DocParamList *pl = new DocParamList(this,m_type,d);
  if (m_children.isEmpty())
  {
    pl->markFirst();
    pl->markLast();
  }
  else
  {
    ASSERT(m_children.getLast()->kind()==DocNode::Kind_ParamList);
    ((DocParamList *)m_children.getLast())->markLast(FALSE);
    pl->markLast();
  }
  m_children.append(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));
  DocNode *n=g_nodeStack.pop();
  ASSERT(n==this);
  return retval;
}

Type DocParamSect::type ( ) const

inline

Definition at line 1101 of file docparser.h.

References m_type.

Referenced by RTFDocVisitor::visitPost(), LatexDocVisitor::visitPost(), DocbookDocVisitor::visitPre(), RTFDocVisitor::visitPre(), HtmlDocVisitor::visitPre(), ManDocVisitor::visitPre(), LatexDocVisitor::visitPre(), XmlDocVisitor::visitPre(), PerlModDocVisitor::visitPre(), and PrintDocVisitor::visitPre().

{ return m_type; }

Friends And Related Function Documentation

friend class DocParamList

friend

Definition at line 1086 of file docparser.h.

Referenced by parse().

Member Data Documentation

bool DocParamSect::m_hasInOutSpecifier

private

Definition at line 1108 of file docparser.h.

Referenced by hasInOutSpecifier(), and parse().

bool DocParamSect::m_hasTypeSpecifier

private

Definition at line 1109 of file docparser.h.

Referenced by hasTypeSpecifier().

Type DocParamSect::m_type

private

Definition at line 1107 of file docparser.h.

Referenced by parse(), and type().

---

The documentation for this class was generated from the following files:

• docparser.h
• docparser.cpp