Skip to content

Commit

Permalink
Update API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dimztimz committed Aug 8, 2024
1 parent f285fdb commit b97b278
Show file tree
Hide file tree
Showing 444 changed files with 6,157 additions and 21,153 deletions.
394 changes: 200 additions & 194 deletions api/aff__data_8hxx_source.html

Large diffs are not rendered by default.

95 changes: 29 additions & 66 deletions api/annotated.html

Large diffs are not rendered by default.

Binary file added api/bc_sd.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed api/bdwn.png
Binary file not shown.
764 changes: 382 additions & 382 deletions api/checker_8hxx_source.html

Large diffs are not rendered by default.

87 changes: 29 additions & 58 deletions api/classes.html
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!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">
<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=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<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>Nuspell: Class Index</title>
<title>nuspell: Class Index</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>
Expand All @@ -19,32 +19,33 @@
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Nuspell
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">nuspell<span id="projectnumber">&#160;5.1.6</span>
</div>
<div id="projectbrief">spell checker</div>
<div id="projectbrief">Nuspell spellchecking library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
Expand All @@ -56,62 +57,32 @@

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
<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 Index</div> </div>
<div class="headertitle"><div class="title">Class Index</div></div>
</div><!--header-->
<div class="contents">
<div class="qindex"><a class="qindex" href="#letter_A">A</a>&#160;|&#160;<a class="qindex" href="#letter_B">B</a>&#160;|&#160;<a class="qindex" href="#letter_C">C</a>&#160;|&#160;<a class="qindex" href="#letter_D">D</a>&#160;|&#160;<a class="qindex" href="#letter_E">E</a>&#160;|&#160;<a class="qindex" href="#letter_H">H</a>&#160;|&#160;<a class="qindex" href="#letter_I">I</a>&#160;|&#160;<a class="qindex" href="#letter_P">P</a>&#160;|&#160;<a class="qindex" href="#letter_R">R</a>&#160;|&#160;<a class="qindex" href="#letter_S">S</a>&#160;|&#160;<a class="qindex" href="#letter_T">T</a>&#160;|&#160;<a class="qindex" href="#letter_U">U</a>&#160;|&#160;<a class="qindex" href="#letter_W">W</a></div>
<div class="qindex"><a class="qindex" href="#letter_D">D</a></div>
<div class="classindex">
<dl class="classindex even">
<dt class="alphachar"><a name="letter_A">A</a></dt>
<dd><a class="el" href="structnuspell_1_1_aff___data.html">Aff_Data</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="structnuspell_1_1_affixing___result.html">Affixing_Result</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="structnuspell_1_1_affixing___result_3_01_t1_00_01void_01_4.html">Affixing_Result&lt; T1, void &gt;</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="structnuspell_1_1_affixing___result_3_01void_00_01void_01_4.html">Affixing_Result&lt; void, void &gt;</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="structnuspell_1_1_affixing___result___base.html">Affixing_Result_Base</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="classnuspell_1_1_at___scope___exit.html">At_Scope_Exit</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd></dl>
<dl class="classindex odd">
<dt class="alphachar"><a name="letter_B">B</a></dt>
<dd><a class="el" href="classnuspell_1_1_break___table.html">Break_Table</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd></dl>
<dl class="classindex even">
<dt class="alphachar"><a name="letter_C">C</a></dt>
<dd><a class="el" href="structnuspell_1_1_checker.html">Checker</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="structnuspell_1_1_compound___pattern.html">Compound_Pattern</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="classnuspell_1_1_compound___rule___table.html">Compound_Rule_Table</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="structnuspell_1_1_compounding___result.html">Compounding_Result</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="classnuspell_1_1_condition.html">Condition</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="structnuspell_1_1_condition___exception.html">Condition_Exception</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd></dl>
<dl class="classindex odd">
<dt class="alphachar"><a name="letter_D">D</a></dt>
<dd><a class="el" href="classnuspell_1_1_dict___finder___for___c_l_i___tool.html">Dict_Finder_For_CLI_Tool</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="classnuspell_1_1_dict___finder___for___c_l_i___tool__2.html">Dict_Finder_For_CLI_Tool_2</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="classnuspell_1_1_dictionary.html">Dictionary</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="classnuspell_1_1_dictionary___loading___error.html">Dictionary_Loading_Error</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd></dl>
<dl class="classindex even">
<dt class="alphachar"><a name="letter_E">E</a></dt>
<dd><a class="el" href="classnuspell_1_1_encoding.html">Encoding</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="classnuspell_1_1_encoding___converter.html">Encoding_Converter</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="structnuspell_1_1_extractor___of___appending___from___affix.html">Extractor_Of_Appending_From_Affix</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd></dl>
<dl class="classindex odd">
<dt class="alphachar"><a name="letter_H">H</a></dt>
<dd><a class="el" href="classnuspell_1_1_hash___multimap.html">Hash_Multimap</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd></dl>
<dl class="classindex even">
<dt class="alphachar"><a name="letter_I">I</a></dt>
<dd><a class="el" href="structnuspell_1_1identity.html">identity</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="structnuspell_1_1_idx___and___next___c_p.html">Idx_And_Next_CP</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="structnuspell_1_1_idx___and___next___c_p___valid.html">Idx_And_Next_CP_Valid</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="structnuspell_1_1_idx___and___prev___c_p.html">Idx_And_Prev_CP</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="structnuspell_1_1_idx___and___prev___c_p___valid.html">Idx_And_Prev_CP_Valid</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="classnuspell_1_1_prefix___multiset_1_1_iter___prefixes___of.html">Prefix_Multiset::Iter_Prefixes_Of</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd></dl>
<dl class="classindex odd">
<dt class="alphachar"><a name="letter_P">P</a></dt>
<dd><a class="el" href="classnuspell_1_1_phonetic___table.html">Phonetic_Table</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="structnuspell_1_1_prefix.html">Prefix</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="classnuspell_1_1_prefix___multiset.html">Prefix_Multiset</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="classnuspell_1_1_prefix___table.html">Prefix_Table</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd></dl>
<dl class="classindex even">
<dt class="alphachar"><a name="letter_R">R</a></dt>
<dd><a class="el" href="classnuspell_1_1_replacement___table.html">Replacement_Table</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="classnuspell_1_1_reversed___string___view.html">Reversed_String_View</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd></dl>
<dl class="classindex odd">
<dt class="alphachar"><a name="letter_S">S</a></dt>
<dd><a class="el" href="structnuspell_1_1_similarity___group.html">Similarity_Group</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="classnuspell_1_1_string___pair.html">String_Pair</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="structnuspell_1_1_string___reverser.html">String_Reverser</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="classnuspell_1_1_string___set.html">String_Set</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="classnuspell_1_1_subrange.html">Subrange</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="classnuspell_1_1_substr___replacer.html">Substr_Replacer</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="structnuspell_1_1_suffix.html">Suffix</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="classnuspell_1_1_suffix___table.html">Suffix_Table</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="structnuspell_1_1_suggester.html">Suggester</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd></dl>
<dl class="classindex even">
<dt class="alphachar"><a name="letter_T">T</a></dt>
<dd><a class="el" href="classnuspell_1_1_to___root___unroot___r_a_i_i.html">To_Root_Unroot_RAII</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd></dl>
<dl class="classindex odd">
<dt class="alphachar"><a name="letter_U">U</a></dt>
<dd><a class="el" href="structnuspell_1_1_u8___c_p___pos.html">U8_CP_Pos</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="classnuspell_1_1_u8___encoded___c_p.html">U8_Encoded_CP</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd></dl>
<dl class="classindex even">
<dt class="alphachar"><a name="letter_W">W</a></dt>
<dd><a class="el" href="structnuspell_1_1_write___c_p___idx__and___error.html">Write_CP_Idx_and_Error</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd></dl>
<dt class="alphachar"><a id="letter_D" name="letter_D">D</a></dt>
<dd><a class="el" href="classnuspell_1_1Dictionary.html">Dictionary</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd><dd><a class="el" href="classnuspell_1_1Dictionary__Loading__Error.html">Dictionary_Loading_Error</a> (<a class="el" href="namespacenuspell.html">nuspell</a>)</dd></dl>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
Generated by&#160;<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>
95 changes: 95 additions & 0 deletions api/classnuspell_1_1Dictionary-members.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
<!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>nuspell: Member 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">nuspell<span id="projectnumber">&#160;5.1.6</span>
</div>
<div id="projectbrief">Nuspell spellchecking library</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&amp;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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacenuspell.html">nuspell</a></li><li class="navelem"><a class="el" href="classnuspell_1_1Dictionary.html">Dictionary</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">nuspell::Dictionary Member List</div></div>
</div><!--header-->
<div class="contents">

<p>This is the complete list of members for <a class="el" href="classnuspell_1_1Dictionary.html">nuspell::Dictionary</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classnuspell_1_1Dictionary.html#a023bb1ec24982a91194fcc0124ff5b38">load_aff_dic</a>(std::istream &amp;aff, std::istream &amp;dic) -&gt; void</td><td class="entry"><a class="el" href="classnuspell_1_1Dictionary.html">nuspell::Dictionary</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classnuspell_1_1Dictionary.html#af7390f6c43f1524315ee936ef4b7c9e4">load_aff_dic</a>(const std::filesystem::path &amp;aff_path) -&gt; void</td><td class="entry"><a class="el" href="classnuspell_1_1Dictionary.html">nuspell::Dictionary</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classnuspell_1_1Dictionary.html#a4ca78d0ea6e30b78a1e8f9b454787cae">load_from_aff_dic</a>(std::istream &amp;aff, std::istream &amp;dic) -&gt; Dictionary</td><td class="entry"><a class="el" href="classnuspell_1_1Dictionary.html">nuspell::Dictionary</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classnuspell_1_1Dictionary.html#a1eb6c013c721cbfbafff9e224cede31c">load_from_path</a>(const std::string &amp;file_path_without_extension) -&gt; Dictionary</td><td class="entry"><a class="el" href="classnuspell_1_1Dictionary.html">nuspell::Dictionary</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classnuspell_1_1Dictionary.html#a0dcf39d974b82a2e6192c3efe52ada29">spell</a>(std::string_view word) const -&gt; bool</td><td class="entry"><a class="el" href="classnuspell_1_1Dictionary.html">nuspell::Dictionary</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="classnuspell_1_1Dictionary.html#a2482e995c1615a95a09df12d709fc0b1">suggest</a>(std::string_view word, std::vector&lt; std::string &gt; &amp;out) const -&gt; void</td><td class="entry"><a class="el" href="classnuspell_1_1Dictionary.html">nuspell::Dictionary</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>
Loading

0 comments on commit b97b278

Please sign in to comment.