The DocInternalRef Class Reference

Node representing an internal reference to some item. More...

Declaration

class DocInternalRef { ... }

Included Headers

#include <src/docnode.h>

Base class

class	DocCompoundNode
	Base class for nodes with children. More...

Public Constructors Index

	DocInternalRef (DocParser *parser, DocNodeVariant *parent, const QCString &target)

Public Member Functions Index

void	parse ()
QCString	file () const
QCString	relPath () const
QCString	anchor () const

Private Member Attributes Index

QCString	m_file
QCString	m_relPath
QCString	m_anchor

Description

Node representing an internal reference to some item.

Definition at line 806 of file docnode.h.

Public Constructors

DocInternalRef()

DocInternalRef::DocInternalRef (DocParser * parser, DocNodeVariant * parent, const QCString & target)

Declaration at line 809 of file docnode.h, definition at line 670 of file docnode.cpp.

670DocInternalRef::DocInternalRef(DocParser *parser,DocNodeVariant *parent,const QCString &ref)

671 : DocCompoundNode(parser,parent), m_relPath(parser->context.relPath)

672{

673 int i=ref.find('#');

674 if (i!=-1)

675 {

676 m_anchor = ref.right(static_cast<int>(ref.length())-i-1);

677 m_file = ref.left(i);

678 }

679 else

680 {

681 m_file = ref;

682 }

683}

References DocCompoundNode::DocCompoundNode, QCString::find, QCString::left, QCString::length, m_anchor, m_file, m_relPath, DocNode::parent, DocNode::parser, relPath and QCString::right.

Public Member Functions

anchor()

QCString DocInternalRef::anchor ()

inline

Definition at line 813 of file docnode.h.

813 QCString anchor() const { return m_anchor; }

Reference m_anchor.

Referenced by DocbookDocVisitor::operator(), HtmlDocVisitor::operator(), LatexDocVisitor::operator(), PerlModDocVisitor::operator(), PrintDocVisitor::operator(), RTFDocVisitor::operator() and XmlDocVisitor::operator().

file()

QCString DocInternalRef::file ()

inline

Definition at line 811 of file docnode.h.

811 QCString file() const { return m_file; }

Reference m_file.

Referenced by DocbookDocVisitor::operator(), HtmlDocVisitor::operator(), LatexDocVisitor::operator(), PerlModDocVisitor::operator(), PrintDocVisitor::operator(), RTFDocVisitor::operator() and XmlDocVisitor::operator().

parse()

void DocInternalRef::parse ()

Declaration at line 810 of file docnode.h, definition at line 685 of file docnode.cpp.

685void DocInternalRef::parse()

686{

687 AUTO_TRACE();

688 auto ns = AutoNodeStack(parser(),thisVariant());

689

690 Token tok = parser()->tokenizer.lex();

691 while (!tok.is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))

692 {

693 if (!parser()->defaultHandleToken(thisVariant(),tok,children()))

694 {

695 parser()->errorHandleDefaultToken(thisVariant(),tok,children(),"\\ref");

696 }

697 tok=parser()->tokenizer.lex();

698 }

699

700 parser()->handlePendingStyleCommands(thisVariant(),children());

701}

References AUTO_TRACE, DocCompoundNode::children, DocParser::errorHandleDefaultToken, DocParser::handlePendingStyleCommands, Token::is_any_of, DocTokenizer::lex, DocNode::parser, DocNode::thisVariant and DocParser::tokenizer.

relPath()

QCString DocInternalRef::relPath ()

inline

Definition at line 812 of file docnode.h.

812 QCString relPath() const { return m_relPath; }

Reference m_relPath.

Referenced by DocInternalRef and HtmlDocVisitor::operator().

Private Member Attributes

m_anchor

QCString DocInternalRef::m_anchor

Definition at line 818 of file docnode.h.

818 QCString m_anchor;

Referenced by anchor and DocInternalRef.

m_file

QCString DocInternalRef::m_file

Definition at line 816 of file docnode.h.

816 QCString m_file;

Referenced by DocInternalRef and file.

m_relPath

QCString DocInternalRef::m_relPath

Definition at line 817 of file docnode.h.

817 QCString m_relPath;

Referenced by DocInternalRef and relPath.

---

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

• docnode.cpp
• docnode.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.