DocLink Class Reference

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

#include <docparser.h>

Inheritance diagram for DocLink:

CompAccept< DocLink > DocNode List of all members.

Public Member Functions

 DocLink (DocNode *parent, const QString &target)
QString parse (bool, bool isXmlLink=FALSE)
Kind kind () const
QString file () const
QString relPath () const
QString ref () const
QString anchor () const
DocNodeparent () const
void accept (DocVisitor *v)

Detailed Description

Node representing a link to some item.

Definition at line 640 of file docparser.h.


Constructor & Destructor Documentation

DocLink::DocLink ( DocNode parent,
const QString &  target 
)

Definition at line 2199 of file docparser.cpp.

References anchor(), DefinitionIntf::definitionType(), doctokenizerYYlineno, Definition::getOutputFileBase(), Definition::getReference(), Definition::getSourceFileBase(), Definition::isLinkable(), QCString, resolveLink(), DefinitionIntf::TypeFile, and warn_doc_error().


Member Function Documentation

QString DocLink::parse ( bool  ,
bool  isXmlLink = FALSE 
)

Definition at line 2236 of file docparser.cpp.

References CMD_ENDLINK, Mappers::cmdMapper, DBG, doctokenizerYYlex(), doctokenizerYYlineno, g_token, CompAccept< DocLink >::m_children, TokenInfo::name, TK_COMMAND, TK_HTMLTAG, TK_LNKWORD, TK_SYMBOL, TK_WORD, tokToString(), and warn_doc_error().

Referenced by DocPara::handleHtmlStartTag(), DocPara::handleLink(), and DocHtmlDescTitle::parse().

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

Returns the kind of node. Provides runtime type information

Implements DocNode.

Definition at line 645 of file docparser.h.

References DocNode::Kind_Link.

QString DocLink::file (  )  const [inline]

Definition at line 646 of file docparser.h.

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

QString DocLink::relPath (  )  const [inline]

Definition at line 647 of file docparser.h.

Referenced by HtmlDocVisitor::visitPre().

QString DocLink::ref (  )  const [inline]

Definition at line 648 of file docparser.h.

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

QString DocLink::anchor (  )  const [inline]

Definition at line 649 of file docparser.h.

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

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

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

Implements DocNode.

Definition at line 650 of file docparser.h.

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

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

Parameters:
v Abstract visitor.

Implements DocNode.

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