The searchindex.h File Reference

Web server based search engine. More...

Included Headers

#include <memory> #include <vector> #include <map> #include <unordered_map> #include <string> #include <array> #include <variant> #include "qcstring.h" #include "growbuf.h"

Classes Index

struct	SIData_CurrentDoc
struct	SIData_Word
class	SearchIndex
	Writes search index for doxygen provided server based search engine that uses PHP. More...
struct	URL
struct	URLInfo
class	IndexWord
class	SearchIndexExternal
	Writes search index that should be used with an externally provided search engine, e.g. More...
struct	SearchDocEntry
class	SearchIndexIntf
	Abstract proxy interface for non-javascript based search indices. More...

Functions Index

void	initSearchIndexer ()
void	finalizeSearchIndexer ()

Description

Web server based search engine.

Comes in two flavors: internal (via generated index) or external (via doxyindexer + doxysearch)

Functions

finalizeSearchIndexer()

void finalizeSearchIndexer ()

Cleanup the search indexer

Declaration at line 41 of file searchindex.h, definition at line 551 of file searchindex.cpp.

551void finalizeSearchIndexer()

552{

553 Doxygen::searchIndex.setKind(SearchIndexIntf::Disabled);

554}

References SearchIndexIntf::Disabled and Doxygen::searchIndex.

Referenced by generateOutput.

initSearchIndexer()

void initSearchIndexer ()

Initialize the search indexer

Declaration at line 39 of file searchindex.h, definition at line 540 of file searchindex.cpp.

540void initSearchIndexer()

541{

542 bool searchEngine = Config_getBool(SEARCHENGINE);

543 bool serverBasedSearch = Config_getBool(SERVER_BASED_SEARCH);

544 bool externalSearch = Config_getBool(EXTERNAL_SEARCH);

545 if (searchEngine && serverBasedSearch)

546 {

547 Doxygen::searchIndex.setKind(externalSearch ? SearchIndexIntf::External : SearchIndexIntf::Internal);

548 }

549}

References Config_getBool, SearchIndexIntf::External, SearchIndexIntf::Internal and Doxygen::searchIndex.

Referenced by parseInput.

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.