Doxygen
DocWord类 参考

Node representing a word 更多...

#include <docparser.h>

+ 类 DocWord 继承关系图:
+ DocWord 的协作图:

Public 成员函数

 DocWord (DocParser &parser, DocNode *parent, const QCString &word)
 
QCString word () const
 
Kind kind () const override
 
void accept (DocVisitor *v) override
 
- Public 成员函数 继承自 DocNode
 DocNode (DocParser &parser)
 
virtual ~DocNode ()
 
DocNodeparent () const
 
void setParent (DocNode *parent)
 
bool isPreformatted () const
 

Private 属性

QCString m_word
 

额外继承的成员函数

- Public 类型 继承自 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, Kind_Emoji = 53, Kind_Sep = 54
}
 
- Protected 类型 继承自 DocNode
enum  RefType { Unknown, Anchor, Section, Table }
 
- Protected 成员函数 继承自 DocNode
void setInsidePreformatted (bool p)
 
- Protected 属性 继承自 DocNode
DocNodem_parent = 0
 
DocParserm_parser
 

详细描述

Node representing a word

在文件 docparser.h217 行定义.

构造及析构函数说明

◆ DocWord()

DocWord::DocWord ( DocParser parser,
DocNode parent,
const QCString word 
)

在文件 docparser.cpp1831 行定义.

1831  :
1832  DocNode(parser), m_word(word)
1833 {
1834  m_parent = parent;
1835  //printf("new word %s url=%s\n",qPrint(word),qPrint(parser.context.searchUrl));
1836  if (Doxygen::searchIndex && !parser.context.searchUrl.isEmpty())
1837  {
1839  }
1840 }

引用了 SearchIndexIntf::addWord(), DocParser::context, FALSE, QCString::isEmpty(), DocNode::m_parent, DocNode::parent(), Doxygen::searchIndex, DocParserContext::searchUrl , 以及 word().

成员函数说明

◆ accept()

void DocWord::accept ( DocVisitor v)
inlineoverridevirtual

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

参数
vAbstract visitor.

实现了 DocNode.

在文件 docparser.h223 行定义.

223 { v->visit(this); }

引用了 DocVisitor::visit().

◆ kind()

Kind DocWord::kind ( ) const
inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

在文件 docparser.h222 行定义.

222 { return Kind_Word; }

引用了 DocNode::Kind_Word.

◆ word()

类成员变量说明

◆ m_word

QCString DocWord::m_word
private

在文件 docparser.h226 行定义.

被这些函数引用 word().


该类的文档由以下文件生成:
DocParserContext::searchUrl
QCString searchUrl
Definition: docparser.cpp:120
DocParser::context
DocParserContext context
Definition: docparser.cpp:175
DocNode::Kind_Word
@ Kind_Word
Definition: docparser.h:101
DocVisitor::visit
virtual void visit(DocWord *)=0
QCString::isEmpty
bool isEmpty() const
Returns TRUE iff the string is empty
Definition: qcstring.h:144
DocWord::m_word
QCString m_word
Definition: docparser.h:226
SearchIndexIntf::addWord
virtual void addWord(const QCString &word, bool hiPriority)=0
DocWord::word
QCString word() const
Definition: docparser.h:221
Doxygen::searchIndex
static SearchIndexIntf * searchIndex
Definition: doxygen.h:105
DocNode::DocNode
DocNode(DocParser &parser)
Definition: docparser.h:157
DocNode::parent
DocNode * parent() const
Definition: docparser.h:166
DocNode::m_parent
DocNode * m_parent
Definition: docparser.h:182
FALSE
#define FALSE
Definition: qcstring.h:33