SearchIndexIntf类 参考

#include <searchindex.h>

类 SearchIndexIntf 继承关系图:

Public 类型
enum	Kind { Internal, External }

Public 成员函数
	SearchIndexIntf (Kind k)
virtual	~SearchIndexIntf ()
virtual void	setCurrentDoc (const Definition *ctx, const QCString &anchor, bool isSourceFile)=0
virtual void	addWord (const QCString &word, bool hiPriority)=0
virtual void	write (const QCString &file)=0
Kind	kind () const

Private 属性
Kind	m_kind

详细描述

在文件 searchindex.h 第 67 行定义.

成员枚举类型说明

Kind

enum SearchIndexIntf::Kind

枚举值
Internal
External

在文件 searchindex.h 第 70 行定义.

{ Internal, External };

构造及析构函数说明

SearchIndexIntf()

SearchIndexIntf::SearchIndexIntf ( Kind  k )

inline

在文件 searchindex.h 第 71 行定义.

: m_kind(k) {}

~SearchIndexIntf()

virtual SearchIndexIntf::~SearchIndexIntf ( )

inlinevirtual

在文件 searchindex.h 第 72 行定义.

{}

成员函数说明

addWord()

virtual void SearchIndexIntf::addWord ( const QCString &  word, bool  hiPriority  )

pure virtual

在 SearchIndex , 以及 SearchIndexExternal 内被实现.

被这些函数引用 addToIndices(), HtmlGenerator::addWord(), DocLinkedWord::DocLinkedWord(), DocWord::DocWord() , 以及 VhdlDocGen::writeVHDLDeclaration().

kind()

Kind SearchIndexIntf::kind ( ) const

inline

在文件 searchindex.h 第 76 行定义.

{ return m_kind; }

引用了 m_kind.

setCurrentDoc()

virtual void SearchIndexIntf::setCurrentDoc ( const Definition *  ctx, const QCString &  anchor, bool  isSourceFile  )

pure virtual

在 SearchIndex , 以及 SearchIndexExternal 内被实现.

被这些函数引用 addToIndices(), HtmlGenerator::setCurrentDoc(), validatingParseDoc() , 以及 VhdlDocGen::writeVHDLDeclaration().

write()

virtual void SearchIndexIntf::write ( const QCString &  file )

pure virtual

在 SearchIndex , 以及 SearchIndexExternal 内被实现.

被这些函数引用 generateOutput().

类成员变量说明

m_kind

Kind SearchIndexIntf::m_kind

private

在文件 searchindex.h 第 78 行定义.

被这些函数引用 kind().

---

该类的文档由以下文件生成:

• src/searchindex.h