DocRef Class Reference

Node representing a reference to some item. More...

#include <docparser.h>

Inheritance diagram for DocRef:

CompAccept< DocRef > DocNode List of all members.

Public Member Functions

 DocRef (DocNode *parent, const QString &target, const QString &context)
void parse ()
Kind kind () const
QString file () const
QString relPath () const
QString ref () const
QString anchor () const
QString targetTitle () const
DocNodeparent () const
bool hasLinkText () const
bool refToAnchor () const
bool refToSection () const
void accept (DocVisitor *v)

Detailed Description

Node representing a reference to some item.

Definition at line 663 of file docparser.h.


Constructor & Destructor Documentation

DocRef::DocRef ( DocNode parent,
const QString &  target,
const QString &  context 
)

Definition at line 2058 of file docparser.cpp.

References SectionInfo::Anchor, anchor(), DefinitionIntf::definitionType(), doctokenizerYYlineno, SectionInfo::fileName, MemberDef::getClassDef(), Definition::getOutputFileBase(), Definition::getReference(), Definition::getSourceFileBase(), Definition::isLinkable(), SectionInfo::label, linkToText(), MemberDef::objCMethodName(), SectionInfo::Page, QCString, SectionInfo::ref, resolveLink(), Doxygen::sectionDict, SectionInfo::title, SectionInfo::type, DefinitionIntf::TypeFile, DefinitionIntf::TypeGroup, DefinitionIntf::TypeMember, and warn_doc_error().


Member Function Documentation

void DocRef::parse (  ) 

Definition at line 2151 of file docparser.cpp.

References DBG, doctokenizerYYlex(), doctokenizerYYlineno, g_token, CompAccept< DocRef >::m_children, TokenInfo::name, TK_COMMAND, TK_HTMLTAG, TK_SYMBOL, tokToString(), and warn_doc_error().

Referenced by DocPara::handleRef(), and DocHtmlDescTitle::parse().

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

Returns the kind of node. Provides runtime type information

Implements DocNode.

Definition at line 668 of file docparser.h.

References DocNode::Kind_Ref.

QString DocRef::file (  )  const [inline]

Definition at line 669 of file docparser.h.

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

QString DocRef::relPath (  )  const [inline]

Definition at line 670 of file docparser.h.

Referenced by HtmlDocVisitor::visitPre().

QString DocRef::ref (  )  const [inline]

Definition at line 671 of file docparser.h.

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

QString DocRef::anchor (  )  const [inline]

Definition at line 672 of file docparser.h.

Referenced by DocRef(), LatexDocVisitor::visitPost(), XmlDocVisitor::visitPre(), RTFDocVisitor::visitPre(), PrintDocVisitor::visitPre(), LatexDocVisitor::visitPre(), and HtmlDocVisitor::visitPre().

QString DocRef::targetTitle (  )  const [inline]

Definition at line 673 of file docparser.h.

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

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

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

Implements DocNode.

Definition at line 674 of file docparser.h.

bool DocRef::hasLinkText (  )  const [inline]

Definition at line 675 of file docparser.h.

References CompAccept< DocRef >::m_children.

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

bool DocRef::refToAnchor (  )  const [inline]

Definition at line 676 of file docparser.h.

Referenced by PrintDocVisitor::visitPre().

bool DocRef::refToSection (  )  const [inline]

Definition at line 677 of file docparser.h.

Referenced by PrintDocVisitor::visitPre().

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

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

Parameters:
v Abstract visitor.

Implements DocNode.

Definition at line 678 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