DocSimpleSect Class Reference

#include <docparser.h>

Inheritance diagram for DocSimpleSect:

CompAccept< DocSimpleSect > DocNode List of all members.

Public Types

enum  Type {
  Unknown, See, Return, Author,
  Authors, Version, Since, Date,
  Note, Warning, Pre, Post,
  Invar, Remark, Attention, User,
  Rcs
}

Public Member Functions

 DocSimpleSect (DocNode *parent, Type t)
virtual ~DocSimpleSect ()
Kind kind () const
Type type () const
QCString typeString () const
DocNodeparent () const
void accept (DocVisitor *v)
int parse (bool userTitle)
int parseRcs ()
int parseXml ()
void appendLinkWord (const QString &word)

Detailed Description

Node representing a simple section

Definition at line 910 of file docparser.h.


Member Enumeration Documentation

enum DocSimpleSect::Type

Enumerator:
Unknown 
See 
Return 
Author 
Authors 
Version 
Since 
Date 
Note 
Warning 
Pre 
Post 
Invar 
Remark 
Attention 
User 
Rcs 

Definition at line 913 of file docparser.h.


Constructor & Destructor Documentation

DocSimpleSect::DocSimpleSect ( DocNode parent,
Type  t 
)

Definition at line 3745 of file docparser.cpp.

DocSimpleSect::~DocSimpleSect (  )  [virtual]

Definition at line 3751 of file docparser.cpp.


Member Function Documentation

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

Returns the kind of node. Provides runtime type information

Implements DocNode.

Definition at line 920 of file docparser.h.

References DocNode::Kind_SimpleSect.

Type DocSimpleSect::type (  )  const [inline]

Definition at line 921 of file docparser.h.

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

QCString DocSimpleSect::typeString (  )  const

Definition at line 3880 of file docparser.cpp.

References Attention, Author, Authors, Date, Invar, Note, Post, Pre, Rcs, Remark, Return, See, Since, Unknown, User, Version, and Warning.

Referenced by HtmlDocVisitor::visitPre().

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

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

Implements DocNode.

Definition at line 923 of file docparser.h.

void DocSimpleSect::accept ( DocVisitor v  )  [virtual]

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

Parameters:
v Abstract visitor.

Implements DocNode.

Definition at line 3756 of file docparser.cpp.

References DocNode::accept(), DocTitle::accept(), CompAccept< DocSimpleSect >::m_children, and DocVisitor::visitPre().

int DocSimpleSect::parse ( bool  userTitle  ) 

Definition at line 3766 of file docparser.cpp.

References DBG, DocNode::Kind_Para, CompAccept< DocSimpleSect >::m_children, DocPara::markFirst(), DocPara::markLast(), DocPara::parse(), and DocTitle::parse().

Referenced by DocPara::handleSimpleSection().

int DocSimpleSect::parseRcs (  ) 

Definition at line 3801 of file docparser.cpp.

References DBG, g_token, CompAccept< DocSimpleSect >::m_children, TokenInfo::name, DocTitle::parseFromString(), RetVal_OK, and TokenInfo::text.

Referenced by DocPara::parse().

int DocSimpleSect::parseXml (  ) 

Definition at line 3820 of file docparser.cpp.

References DBG, DocNode::Kind_Para, CompAccept< DocSimpleSect >::m_children, DocPara::markFirst(), DocPara::markLast(), DocPara::parse(), RetVal_CloseXml, and RetVal_OK.

Referenced by DocPara::handleSimpleSection().

void DocSimpleSect::appendLinkWord ( const QString &  word  ) 

Definition at line 3858 of file docparser.cpp.

References DocPara::injectToken(), DocNode::Kind_Para, CompAccept< DocSimpleSect >::m_children, TK_LNKWORD, TK_WHITESPACE, and TK_WORD.

Referenced by DocPara::handleHtmlStartTag().


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



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