The DocLinkedWord Class Reference

Node representing a word that can be linked to something. More...

Declaration

class DocLinkedWord { ... }

Included Headers

#include <src/docnode.h>

Base class

class	DocNode
	Abstract node interface with type information. More...

Public Constructors Index

	DocLinkedWord (DocParser *parser, DocNodeVariant *parent, const QCString &word, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &tooltip)

Public Member Functions Index

QCString	word () const
QCString	file () const
QCString	relPath () const
QCString	ref () const
QCString	anchor () const
QCString	tooltip () const

Private Member Attributes Index

QCString	m_word
QCString	m_ref
QCString	m_file
QCString	m_relPath
QCString	m_anchor
QCString	m_tooltip

Description

Node representing a word that can be linked to something.

Definition at line 164 of file docnode.h.

Public Constructors

DocLinkedWord()

DocLinkedWord::DocLinkedWord (DocParser * parser, DocNodeVariant * parent, const QCString & word, const QCString & ref, const QCString & file, const QCString & anchor, const QCString & tooltip)

Declaration at line 167 of file docnode.h, definition at line 192 of file docnode.cpp.

192DocLinkedWord::DocLinkedWord(DocParser *parser,DocNodeVariant *parent,const QCString &word,

193 const QCString &ref,const QCString &file,

194 const QCString &anchor,const QCString &tooltip) :

195 DocNode(parser,parent), m_word(word), m_ref(ref),

196 m_file(file), m_relPath(parser->context.relPath), m_anchor(anchor),

197 m_tooltip(tooltip)

198{

199 //printf("DocLinkedWord: new word %s url=%s tooltip='%s'\n",

200 // qPrint(word),qPrint(parser->context.searchUrl),qPrint(tooltip));

201 if (Doxygen::searchIndex.enabled() && !parser->context.searchUrl.isEmpty())

202 {

203 Doxygen::searchIndex.addWord(word,false);

204 }

205}

References anchor, DocNode::DocNode, file, m_anchor, m_file, m_ref, m_relPath, m_tooltip, m_word, DocNode::parent, DocNode::parser, ref, relPath, Doxygen::searchIndex, tooltip and word.

Public Member Functions

anchor()

QCString DocLinkedWord::anchor ()

inline

Definition at line 174 of file docnode.h.

174 QCString anchor() const { return m_anchor; }

Reference m_anchor.

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

file()

QCString DocLinkedWord::file ()

inline

Definition at line 171 of file docnode.h.

171 QCString file() const { return m_file; }

Reference m_file.

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

ref()

QCString DocLinkedWord::ref ()

inline

Definition at line 173 of file docnode.h.

173 QCString ref() const { return m_ref; }

Reference m_ref.

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

relPath()

QCString DocLinkedWord::relPath ()

inline

Definition at line 172 of file docnode.h.

172 QCString relPath() const { return m_relPath; }

Reference m_relPath.

Referenced by DocLinkedWord and HtmlDocVisitor::operator().

tooltip()

QCString DocLinkedWord::tooltip ()

inline

Definition at line 175 of file docnode.h.

175 QCString tooltip() const { return m_tooltip; }

Reference m_tooltip.

Referenced by DocLinkedWord and HtmlDocVisitor::operator().

word()

QCString DocLinkedWord::word ()

inline

Definition at line 170 of file docnode.h.

170 QCString word() const { return m_word; }

Reference m_word.

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

Private Member Attributes

m_anchor

QCString DocLinkedWord::m_anchor

Definition at line 182 of file docnode.h.

182 QCString m_anchor;

Referenced by anchor and DocLinkedWord.

m_file

QCString DocLinkedWord::m_file

Definition at line 180 of file docnode.h.

180 QCString m_file;

Referenced by DocLinkedWord and file.

m_ref

QCString DocLinkedWord::m_ref

Definition at line 179 of file docnode.h.

179 QCString m_ref;

Referenced by DocLinkedWord and ref.

m_relPath

QCString DocLinkedWord::m_relPath

Definition at line 181 of file docnode.h.

181 QCString m_relPath;

Referenced by DocLinkedWord and relPath.

m_tooltip

QCString DocLinkedWord::m_tooltip

Definition at line 183 of file docnode.h.

183 QCString m_tooltip;

Referenced by DocLinkedWord and tooltip.

m_word

QCString DocLinkedWord::m_word

Definition at line 178 of file docnode.h.

178 QCString m_word;

Referenced by DocLinkedWord and word.

---

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

• docnode.cpp
• docnode.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.