Doxygen
Loading...
Searching...
No Matches
DocWord Class Referencefinal

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 DString &word)
DString 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

DString m_word

Additional Inherited Members

Protected Types inherited from DocNode
enum  RefType {
  Unknown , Anchor , Section , Table ,
  Requirement
}
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 DString & word )

Definition at line 185 of file docnode.cpp.

185 :
186 DocNode(parser,parent), m_word(word)
187{
188 //printf("new word %s url=%s\n",qPrint(word),qPrint(parser->context.searchUrl));
189 if (Doxygen::searchIndex.enabled() && !parser->context.searchUrl.empty())
190 {
191 Doxygen::searchIndex.addWord(word,false);
192 }
193}
DString::empty
bool empty() const
Returns true iff the string is empty (std::string compatible alias for isEmpty()).
Definition dstring.h:152
DocNode::DocNode
DocNode(DocParser *parser, DocNodeVariant *parent)
Definition docnode.h:84
DocNode::parser
DocParser * parser()
Definition docnode.h:97
DocNode::parent
DocNodeVariant * parent()
Definition docnode.h:89
DocParser::context
DocParserContext context
Definition docparser_p.h:152
DocWord::word
DString word() const
Definition docnode.h:156
DocWord::m_word
DString m_word
Definition docnode.h:159
Doxygen::searchIndex
static SearchIndexIntf searchIndex
Definition doxygen.h:117
SearchIndexIntf::addWord
void addWord(const DString &word, bool hiPriority)
Definition searchindex.h:157

References DocParser::context, DocNode::DocNode(), DString::empty(), m_word, DocNode::parent(), DocNode::parser(), Doxygen::searchIndex, DocParserContext::searchUrl, and word().

Member Function Documentation

◆ word()

DString DocWord::word ( ) const
inline

Definition at line 156 of file docnode.h.

156{ 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

DString 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: