DocWord Class Reference

Node representing a word. More...

#include <src/docnode.h>

Inheritance diagram for DocWord:

Collaboration diagram for DocWord:

Public Member Functions
	DocWord (DocParser *parser, DocNodeVariant *parent, const QCString &word)
QCString	word () const
Public Member Functions inherited from DocNode
	DocNode (DocParser *parser, DocNodeVariant *parent)
	~DocNode ()=default
DocNodeVariant *	parent ()
const DocNodeVariant *	parent () const
DocNodeVariant *	thisVariant ()
const DocNodeVariant *	thisVariant () const
void	setThisVariant (DocNodeVariant *thisVariant)
DocParser *	parser ()
const DocParser *	parser () const
void	setParent (DocNodeVariant *parent)
bool	isPreformatted () const

Private Attributes
QCString	m_word

Additional Inherited Members
Protected Types inherited from DocNode
enum	RefType { Unknown , Anchor , Section , Table }
Protected Member Functions inherited from DocNode
void	setInsidePreformatted (bool p)

Detailed Description

Node representing a word.

Definition at line 152 of file docnode.h.

Constructor & Destructor Documentation

DocWord()

DocWord::DocWord	(	DocParser *	parser,
		DocNodeVariant *	parent,
		const QCString &	word )

Definition at line 179 of file docnode.cpp.

                                                                              :
      DocNode(parser,parent), m_word(word)
{
  //printf("new word %s url=%s\n",qPrint(word),qPrint(parser->context.searchUrl));
  if (Doxygen::searchIndex.enabled() && !parser->context.searchUrl.isEmpty())
  {
    Doxygen::searchIndex.addWord(word,false);
  }
}

References DocNode::DocNode(), m_word, DocNode::parent(), DocNode::parser(), Doxygen::searchIndex, and word().

Member Function Documentation

word()

QCString DocWord::word ( ) const

inline

Definition at line 156 of file docnode.h.

{ return m_word; }

References m_word.

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

Member Data Documentation

m_word

QCString DocWord::m_word

private

Definition at line 159 of file docnode.h.

Referenced by DocWord(), and word().

---

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

• src/docnode.h
• src/docnode.cpp