DocWord Class Reference

#include <docparser.h>

Inheritance diagram for DocWord:

Public Member Functions
	DocWord (DocNode *parent, const QCString &word)
QCString	word () const
Kind	kind () const
void	accept (DocVisitor *v)
Public Member Functions inherited from DocNode
	DocNode ()
virtual	~DocNode ()
DocNode *	parent () const
void	setParent (DocNode *parent)
bool	isPreformatted () const

Private Attributes
QCString	m_word

Additional Inherited Members
Public Types inherited from DocNode
enum	Kind {   Kind_Root = 0, Kind_Word = 1, Kind_WhiteSpace = 2, Kind_Para = 3,   Kind_AutoList = 4, Kind_AutoListItem = 5, Kind_Symbol = 6, Kind_URL = 7,   Kind_StyleChange = 8, Kind_SimpleSect = 9, Kind_Title = 10, Kind_SimpleList = 11,   Kind_SimpleListItem = 12, Kind_Section = 13, Kind_Verbatim = 14, Kind_XRefItem = 15,   Kind_HtmlList = 16, Kind_HtmlListItem = 17, Kind_HtmlDescList = 18, Kind_HtmlDescData = 19,   Kind_HtmlDescTitle = 20, Kind_HtmlTable = 21, Kind_HtmlRow = 22, Kind_HtmlCell = 23,   Kind_HtmlCaption = 24, Kind_LineBreak = 25, Kind_HorRuler = 26, Kind_Anchor = 27,   Kind_IndexEntry = 28, Kind_Internal = 29, Kind_HRef = 30, Kind_Include = 31,   Kind_IncOperator = 32, Kind_HtmlHeader = 33, Kind_Image = 34, Kind_DotFile = 35,   Kind_Link = 36, Kind_Ref = 37, Kind_Formula = 38, Kind_SecRefItem = 39,   Kind_SecRefList = 40, Kind_SimpleSectSep = 41, Kind_LinkedWord = 42, Kind_ParamSect = 43,   Kind_ParamList = 44, Kind_InternalRef = 45, Kind_Copy = 46, Kind_Text = 47,   Kind_MscFile = 48, Kind_HtmlBlockQuote = 49, Kind_VhdlFlow = 50, Kind_ParBlock = 51,   Kind_DiaFile = 52 }
Protected Member Functions inherited from DocNode
void	setInsidePreformatted (bool p)
Protected Attributes inherited from DocNode
DocNode *	m_parent

Detailed Description

Node representing a word

Definition at line 195 of file docparser.h.

Constructor & Destructor Documentation

DocWord::DocWord	(	DocNode *	parent,
		const QCString &	word
	)

Definition at line 1814 of file docparser.cpp.

References SearchIndexIntf::addWord(), g_searchUrl, DocNode::m_parent, DocNode::parent(), and Doxygen::searchIndex.

                                                     : 
      m_word(word) 
{
  m_parent = parent; 
  //printf("new word %s url=%s\n",word.data(),g_searchUrl.data());
  if (Doxygen::searchIndex && !g_searchUrl.isEmpty())
  {
    Doxygen::searchIndex->addWord(word,FALSE);
  }
}

Member Function Documentation

void DocWord::accept ( DocVisitor *  v )

inlinevirtual

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

Parameters

v	Abstract visitor.

Implements DocNode.

Definition at line 201 of file docparser.h.

References DocVisitor::visit().

{ v->visit(this); }

Kind DocWord::kind ( ) const

inlinevirtual

Returns the kind of node. Provides runtime type information

Implements DocNode.

Definition at line 200 of file docparser.h.

References DocNode::Kind_Word.

{ return Kind_Word; }

QCString DocWord::word ( ) const

inline

Definition at line 199 of file docparser.h.

References m_word.

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

{ return m_word; }

Member Data Documentation

QCString DocWord::m_word

private

Definition at line 204 of file docparser.h.

Referenced by word().

---

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

• docparser.h
• docparser.cpp