/
GreyShaman
/
simple-search-server
Обзор
Документация
Войти
/
GreyShaman
/
simple-search-server
Код
Запросы
0
Задачи
Вики
Пакеты
0
Релизы
0
Аналитика
Безопасность
master
docs/annotated.html
105 строк
14 KB
Sergey Reshetnikov
Added API docs
30 сен 2024, 15:38
30 сен 2024, 15:38
796b6b6
Код
Авторство
О чём код?
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=11"/> <meta name="generator" content="Doxygen 1.9.8"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>search-engine: Class List</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr id="projectrow"> <td id="projectalign"> <div id="projectname">search-engine<span id="projectnumber"> 0.1</span> </div> <div id="projectbrief">The Search Server engine is library of service with inverted index functionality</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.9.8 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ var searchBox = new SearchBox("searchBox", "search/",'.html'); /* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); /* @license-end */ </script> <div id="main-nav"></div> </div><!-- top --> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <div id="MSearchResults"> <div class="SRPage"> <div id="SRIndex"> <div id="SRResults"></div> <div class="SRStatus" id="Loading">Loading...</div> <div class="SRStatus" id="Searching">Searching...</div> <div class="SRStatus" id="NoMatches">No Matches</div> </div> </div> </div> </div> <div class="header"> <div class="headertitle"><div class="title">Class List</div></div> </div><!--header--> <div class="contents"> <div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory"> <div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory"> <tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">▼</span><span class="icona"><span class="icon">N</span></span><b>search_server</b></td><td class="desc"></td></tr> <tr id="row_0_0_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_0_0_" class="arrow" onclick="toggleFolder('0_0_')">▼</span><span class="icona"><span class="icon">N</span></span><b>converter_config</b></td><td class="desc"></td></tr> <tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structsearch__server_1_1converter__config_1_1ConverterConfig.html" target="_self">ConverterConfig</a></td><td class="desc"><a class="el" href="structsearch__server_1_1converter__config_1_1ConverterConfig.html" title="ConverterConfig class определяет структуру конфигурационного файла и используется для десериализации ...">ConverterConfig</a> class определяет структуру конфигурационного файла и используется для десериализации json структуры </td></tr> <tr id="row_0_1_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_0_1_" class="arrow" onclick="toggleFolder('0_1_')">▼</span><span class="icona"><span class="icon">N</span></span><b>inverted_index</b></td><td class="desc"></td></tr> <tr id="row_0_1_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structsearch__server_1_1inverted__index_1_1Entry.html" target="_self">Entry</a></td><td class="desc"><a class="el" href="structsearch__server_1_1inverted__index_1_1Entry.html" title="Entry структура для подсчёта колличества вхождения слова в документ">Entry</a> структура для подсчёта колличества вхождения слова в документ </td></tr> <tr id="row_0_1_1_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classsearch__server_1_1inverted__index_1_1InvertedIndex.html" target="_self">InvertedIndex</a></td><td class="desc"><a class="el" href="classsearch__server_1_1inverted__index_1_1InvertedIndex.html" title="InvertedIndex индексирует текст докуметов и предоставляет собранную информацию">InvertedIndex</a> индексирует текст докуметов и предоставляет собранную информацию </td></tr> <tr id="row_0_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span id="arr_0_2_" class="arrow" onclick="toggleFolder('0_2_')">▼</span><span class="icona"><span class="icon">N</span></span><b>requests_format</b></td><td class="desc"></td></tr> <tr id="row_0_2_0_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structsearch__server_1_1requests__format_1_1RequestsConfig.html" target="_self">RequestsConfig</a></td><td class="desc"><a class="el" href="structsearch__server_1_1requests__format_1_1RequestsConfig.html" title="RequestsConfig структура используется для десериализации requests.json.">RequestsConfig</a> структура используется для десериализации requests.json </td></tr> <tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structsearch__server_1_1AbsRelevance.html" target="_self">AbsRelevance</a></td><td class="desc"><a class="el" href="structsearch__server_1_1AbsRelevance.html" title="AbsRelevance структура регламентирующая абсолютную релевантность">AbsRelevance</a> структура регламентирующая абсолютную релевантность </td></tr> <tr id="row_0_4_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structsearch__server_1_1compareByWordEnries.html" target="_self">compareByWordEnries</a></td><td class="desc">CompareByWordEnries функциональный объект который используется для сравнения векторов содержащих информациию о вхождении слова в текст документов </td></tr> <tr id="row_0_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classsearch__server_1_1ConverterJSON.html" target="_self">ConverterJSON</a></td><td class="desc"><a class="el" href="classsearch__server_1_1ConverterJSON.html" title="ConverterJSON - класс для работы с JSON-файлами">ConverterJSON</a> - класс для работы с JSON-файлами </td></tr> <tr id="row_0_6_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structsearch__server_1_1RelativeRelevance.html" target="_self">RelativeRelevance</a></td><td class="desc"></td></tr> <tr id="row_0_7_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classsearch__server_1_1SearchServer.html" target="_self">SearchServer</a></td><td class="desc">позволяет определять наиболее релевантные, соответствующие поисковому запросу документы по прочитанным из файла requests.json поисковым запросам </td></tr> <tr id="row_1_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classConfigFileIsEmptyException.html" target="_self">ConfigFileIsEmptyException</a></td><td class="desc"><a class="el" href="classConfigFileIsEmptyException.html" title="ConfigFileIsEmptyException позволяет диагностировать случаи с пустым конфигурационным файлом">ConfigFileIsEmptyException</a> позволяет диагностировать случаи с пустым конфигурационным файлом </td></tr> <tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classConfigFileMissingException.html" target="_self">ConfigFileMissingException</a></td><td class="desc"><a class="el" href="classConfigFileMissingException.html" title="ConfigFileMissingException позволяет диагностировать отсутствие конфигурационного файла">ConfigFileMissingException</a> позволяет диагностировать отсутствие конфигурационного файла </td></tr> <tr id="row_3_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classConfigParserException.html" target="_self">ConfigParserException</a></td><td class="desc"><a class="el" href="classConfigParserException.html" title="ConfigParserException базовый класс для исключений связанных с процессом распознования конфигорационн...">ConfigParserException</a> базовый класс для исключений связанных с процессом распознования конфигорационного файлв </td></tr> <tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classFilesSectionMissingException.html" target="_self">FilesSectionMissingException</a></td><td class="desc"><a class="el" href="classFilesSectionMissingException.html" title="FilesSectionMissingException позволяет диагностировать отстутствие секции files в конфигурационном фа...">FilesSectionMissingException</a> позволяет диагностировать отстутствие секции files в конфигурационном файле </td></tr> <tr id="row_5_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classIncorrectVersionException.html" target="_self">IncorrectVersionException</a></td><td class="desc"><a class="el" href="classIncorrectVersionException.html" title="IncorrectVersionException позволяет диагностировать некорректность указанной версии в конфигурационно...">IncorrectVersionException</a> позволяет диагностировать некорректность указанной версии в конфигурационном файле </td></tr> <tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classNoMaxResponsesException.html" target="_self">NoMaxResponsesException</a></td><td class="desc"><a class="el" href="classNoMaxResponsesException.html" title="NoMaxResponsesException позволяет диагностировать остутствие max_reponses параметра в конфигурационно...">NoMaxResponsesException</a> позволяет диагностировать остутствие max_reponses параметра в конфигурационном файле </td></tr> </table> </div><!-- directory --> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </small></address> </body> </html>