DocParamSect Class Reference

#include <docparser.h>

Inheritance diagram for DocParamSect:

CompAccept< DocParamSect > DocNode List of all members.

Public Types

enum  Type {
  Unknown, Param, RetVal, Exception,
  TemplateParam
}
enum  Direction { In = 1, Out = 2, InOut = 3, Unspecified = 0 }

Public Member Functions

 DocParamSect (DocNode *parent, Type t)
int parse (const QString &cmdName, bool xmlContext, Direction d)
Kind kind () const
Type type () const
DocNodeparent () const
void accept (DocVisitor *v)

Detailed Description

Node representing a parameter section

Definition at line 937 of file docparser.h.


Member Enumeration Documentation

enum DocParamSect::Type

Enumerator:
Unknown 
Param 
RetVal 
Exception 
TemplateParam 

Definition at line 940 of file docparser.h.

enum DocParamSect::Direction

Enumerator:
In 
Out 
InOut 
Unspecified 

Definition at line 944 of file docparser.h.


Constructor & Destructor Documentation

DocParamSect::DocParamSect ( DocNode parent,
Type  t 
) [inline]

Definition at line 948 of file docparser.h.


Member Function Documentation

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

Definition at line 4031 of file docparser.cpp.

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

Referenced by DocPara::handleParamSection().

Kind DocParamSect::kind (  )  const [inline, virtual]

Returns the kind of node. Provides runtime type information

Implements DocNode.

Definition at line 951 of file docparser.h.

References DocNode::Kind_ParamSect.

Type DocParamSect::type (  )  const [inline]

Definition at line 952 of file docparser.h.

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

DocNode* DocParamSect::parent (  )  const [inline, virtual]

Returns the parent of this node or 0 for the root node.

Implements DocNode.

Definition at line 953 of file docparser.h.

void DocParamSect::accept ( DocVisitor v  )  [inline, virtual]

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

Parameters:
v Abstract visitor.

Implements DocNode.

Definition at line 954 of file docparser.h.

References CompAccept< T >::accept().


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



Generated on Mon Mar 31 10:58:58 2008 by  doxygen 1.5.1