DocRoot Class Reference

Root node of documentation tree. More...

#include <docparser.h>

Inheritance diagram for DocRoot:

CompAccept< DocRoot > DocNode List of all members.

Public Member Functions

 DocRoot (bool indent, bool sl)
Kind kind () const
DocNodeparent () const
void accept (DocVisitor *v)
void parse ()
bool indent () const
bool singleLine () const

Detailed Description

Root node of documentation tree.

Definition at line 1228 of file docparser.h.


Constructor & Destructor Documentation

DocRoot::DocRoot ( bool  indent,
bool  sl 
) [inline]

Definition at line 1231 of file docparser.h.


Member Function Documentation

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

Returns the kind of node. Provides runtime type information

Implements DocNode.

Definition at line 1232 of file docparser.h.

References DocNode::Kind_Root.

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

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

Implements DocNode.

Definition at line 1233 of file docparser.h.

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

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

Parameters:
v Abstract visitor.

Implements DocNode.

Definition at line 1234 of file docparser.h.

References CompAccept< T >::accept().

Referenced by validatingParseDoc().

void DocRoot::parse (  ) 

Definition at line 5902 of file docparser.cpp.

References DBG, doctokenizerYYlineno, doctokenizerYYsetStatePara(), g_token, DocPara::isEmpty(), CompAccept< DocRoot >::m_children, DocPara::markFirst(), DocPara::markLast(), DocInternal::parse(), DocSection::parse(), DocPara::parse(), RetVal_Internal, RetVal_Paragraph, RetVal_Section, RetVal_Subsection, RetVal_Subsubsection, Doxygen::sectionDict, TokenInfo::sectionId, TK_LISTITEM, and warn_doc_error().

Referenced by validatingParseDoc().

bool DocRoot::indent (  )  const [inline]

Definition at line 1236 of file docparser.h.

Referenced by RTFDocVisitor::visitPost(), and RTFDocVisitor::visitPre().

bool DocRoot::singleLine (  )  const [inline]

Definition at line 1237 of file docparser.h.

Referenced by RTFDocVisitor::visitPost().


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