DocParamList Class Reference

Node representing a parameter list. More...

#include <docparser.h>

Inheritance diagram for DocParamList:

DocNode List of all members.

Public Member Functions

 DocParamList (DocNode *parent, DocParamSect::Type t, DocParamSect::Direction d)
virtual ~DocParamList ()
Kind kind () const
DocNodeparent () const
const QList< DocNode > & parameters ()
DocParamSect::Type type () const
DocParamSect::Direction direction () const
void markFirst (bool b=TRUE)
void markLast (bool b=TRUE)
bool isFirst () const
bool isLast () const
void accept (DocVisitor *v)
int parse (const QString &cmdName)
int parseXml (const QString &paramName)

Detailed Description

Node representing a parameter list.

Definition at line 1008 of file docparser.h.


Constructor & Destructor Documentation

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

Definition at line 1011 of file docparser.h.

virtual DocParamList::~DocParamList (  )  [inline, virtual]

Definition at line 1014 of file docparser.h.


Member Function Documentation

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

Returns the kind of node. Provides runtime type information

Implements DocNode.

Definition at line 1015 of file docparser.h.

References DocNode::Kind_ParamList.

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

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

Implements DocNode.

Definition at line 1016 of file docparser.h.

const QList<DocNode>& DocParamList::parameters (  )  [inline]

Definition at line 1017 of file docparser.h.

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

DocParamSect::Type DocParamList::type (  )  const [inline]

Definition at line 1018 of file docparser.h.

DocParamSect::Direction DocParamList::direction (  )  const [inline]

Definition at line 1019 of file docparser.h.

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

void DocParamList::markFirst ( bool  b = TRUE  )  [inline]

Definition at line 1020 of file docparser.h.

Referenced by DocParamSect::parse().

void DocParamList::markLast ( bool  b = TRUE  )  [inline]

Definition at line 1021 of file docparser.h.

Referenced by DocParamSect::parse().

bool DocParamList::isFirst (  )  const [inline]

Definition at line 1022 of file docparser.h.

bool DocParamList::isLast (  )  const [inline]

Definition at line 1023 of file docparser.h.

Referenced by ManDocVisitor::visitPost().

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

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

Parameters:
v Abstract visitor.

Implements DocNode.

Definition at line 1024 of file docparser.h.

References DocNode::accept(), DocVisitor::visitPost(), and DocVisitor::visitPre().

int DocParamList::parse ( const QString &  cmdName  ) 

Definition at line 3907 of file docparser.cpp.

References DBG, doctokenizerYYlex(), doctokenizerYYlineno, doctokenizerYYsetStatePara(), doctokenizerYYsetStateParam(), g_token, DocPara::markFirst(), DocPara::markLast(), TokenInfo::name, DocParamSect::Param, DocPara::parse(), DocParamSect::RetVal, RetVal_OK, TK_WHITESPACE, TK_WORD, and warn_doc_error().

Referenced by DocParamSect::parse().

int DocParamList::parseXml ( const QString &  paramName  ) 

Definition at line 3961 of file docparser.cpp.

References DBG, doctokenizerYYlineno, g_token, Mappers::htmlTagMapper, DocPara::isEmpty(), Mapper::map(), DocPara::markFirst(), DocPara::markLast(), TokenInfo::name, DocParamSect::Param, DocPara::parse(), DocParamSect::RetVal, RetVal_CloseXml, RetVal_OK, warn_doc_error(), XML_EXCEPTION, XML_PARAM, and XML_TYPEPARAM.

Referenced by DocParamSect::parse().


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