DocSection Class Reference

Node representing a normal section. More...

#include <docparser.h>

Inheritance diagram for DocSection:

CompAccept< DocSection > DocNode List of all members.

Public Member Functions

 DocSection (DocNode *parent, int level, const QString &id)
Kind kind () const
int level () const
QString title () const
QString anchor () const
QString id () const
QString file () const
DocNodeparent () const
void accept (DocVisitor *v)
int parse ()

Detailed Description

Node representing a normal section.

Definition at line 801 of file docparser.h.


Constructor & Destructor Documentation

DocSection::DocSection ( DocNode parent,
int  level,
const QString &  id 
) [inline]

Definition at line 804 of file docparser.h.

Referenced by parse().


Member Function Documentation

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

Returns the kind of node. Provides runtime type information

Implements DocNode.

Definition at line 806 of file docparser.h.

References DocNode::Kind_Section.

int DocSection::level (  )  const [inline]

Definition at line 807 of file docparser.h.

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

QString DocSection::title (  )  const [inline]

Definition at line 808 of file docparser.h.

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

QString DocSection::anchor (  )  const [inline]

Definition at line 809 of file docparser.h.

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

QString DocSection::id (  )  const [inline]

Definition at line 810 of file docparser.h.

QString DocSection::file (  )  const [inline]

Definition at line 811 of file docparser.h.

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

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

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

Implements DocNode.

Definition at line 812 of file docparser.h.

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

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

Parameters:
v Abstract visitor.

Implements DocNode.

Definition at line 813 of file docparser.h.

References CompAccept< T >::accept().

int DocSection::parse (  ) 

Definition at line 5693 of file docparser.cpp.

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

Referenced by DocRoot::parse(), parse(), and DocInternal::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