Skip to content

Commit 0711d06

Browse files
committed
doc: doxygen
1 parent f555cdf commit 0711d06

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+8100
-0
lines changed

doc/config.ini

Lines changed: 2494 additions & 0 deletions
Large diffs are not rendered by default.

doc/html/annotated.html

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.13"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>ini-cpp: Class List</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectalign" style="padding-left: 0.5em;">
24+
<div id="projectname">ini-cpp
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.8.13 -->
33+
<script type="text/javascript">
34+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
35+
</script>
36+
<script type="text/javascript" src="menudata.js"></script>
37+
<script type="text/javascript" src="menu.js"></script>
38+
<script type="text/javascript">
39+
$(function() {
40+
initMenu('',true,false,'search.php','Search');
41+
$(document).ready(function() { init_search(); });
42+
});
43+
</script>
44+
<div id="main-nav"></div>
45+
</div><!-- top -->
46+
<!-- window showing the filter options -->
47+
<div id="MSearchSelectWindow"
48+
onmouseover="return searchBox.OnSearchSelectShow()"
49+
onmouseout="return searchBox.OnSearchSelectHide()"
50+
onkeydown="return searchBox.OnSearchSelectKey(event)">
51+
</div>
52+
53+
<!-- iframe showing the search results (closed by default) -->
54+
<div id="MSearchResultsWindow">
55+
<iframe src="javascript:void(0)" frameborder="0"
56+
name="MSearchResults" id="MSearchResults">
57+
</iframe>
58+
</div>
59+
60+
<div class="header">
61+
<div class="headertitle">
62+
<div class="title">Class List</div> </div>
63+
</div><!--header-->
64+
<div class="contents">
65+
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
66+
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory">
67+
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespaceinih.html" target="_self">inih</a></td><td class="desc">Yet another .ini parser for modern c++ (made for cpp17), inspired and extend from 's inih </td></tr>
68+
<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classinih_1_1INIReader.html" target="_self">INIReader</a></td><td class="desc"></td></tr>
69+
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classinih_1_1INIWriter.html" target="_self">INIWriter</a></td><td class="desc"></td></tr>
70+
</table>
71+
</div><!-- directory -->
72+
</div><!-- contents -->
73+
<!-- start footer part -->
74+
<hr class="footer"/><address class="footer"><small>
75+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
76+
<img class="footer" src="doxygen.png" alt="doxygen"/>
77+
</a> 1.8.13
78+
</small></address>
79+
</body>
80+
</html>

doc/html/bc_s.png

676 Bytes
Loading

doc/html/bdwn.png

147 Bytes
Loading

doc/html/classes.html

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.13"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>ini-cpp: Class Index</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectalign" style="padding-left: 0.5em;">
24+
<div id="projectname">ini-cpp
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.8.13 -->
33+
<script type="text/javascript">
34+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
35+
</script>
36+
<script type="text/javascript" src="menudata.js"></script>
37+
<script type="text/javascript" src="menu.js"></script>
38+
<script type="text/javascript">
39+
$(function() {
40+
initMenu('',true,false,'search.php','Search');
41+
$(document).ready(function() { init_search(); });
42+
});
43+
</script>
44+
<div id="main-nav"></div>
45+
</div><!-- top -->
46+
<!-- window showing the filter options -->
47+
<div id="MSearchSelectWindow"
48+
onmouseover="return searchBox.OnSearchSelectShow()"
49+
onmouseout="return searchBox.OnSearchSelectHide()"
50+
onkeydown="return searchBox.OnSearchSelectKey(event)">
51+
</div>
52+
53+
<!-- iframe showing the search results (closed by default) -->
54+
<div id="MSearchResultsWindow">
55+
<iframe src="javascript:void(0)" frameborder="0"
56+
name="MSearchResults" id="MSearchResults">
57+
</iframe>
58+
</div>
59+
60+
<div class="header">
61+
<div class="headertitle">
62+
<div class="title">Class Index</div> </div>
63+
</div><!--header-->
64+
<div class="contents">
65+
<div class="qindex"><a class="qindex" href="#letter_i">i</a></div>
66+
<table class="classindex">
67+
<tr><td rowspan="2" valign="bottom"><a name="letter_i"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;i&#160;&#160;</div></td></tr></table>
68+
</td><td valign="top"><a class="el" href="classinih_1_1INIWriter.html">INIWriter</a> (<a class="el" href="namespaceinih.html">inih</a>)&#160;&#160;&#160;</td><td></td></tr>
69+
<tr><td></td><td></td></tr>
70+
<tr><td valign="top"><a class="el" href="classinih_1_1INIReader.html">INIReader</a> (<a class="el" href="namespaceinih.html">inih</a>)&#160;&#160;&#160;</td><td></td><td></td></tr>
71+
<tr><td></td><td></td><td></td></tr>
72+
</table>
73+
<div class="qindex"><a class="qindex" href="#letter_i">i</a></div>
74+
</div><!-- contents -->
75+
<!-- start footer part -->
76+
<hr class="footer"/><address class="footer"><small>
77+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
78+
<img class="footer" src="doxygen.png" alt="doxygen"/>
79+
</a> 1.8.13
80+
</small></address>
81+
</body>
82+
</html>
Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.13"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>ini-cpp: Member List</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectalign" style="padding-left: 0.5em;">
24+
<div id="projectname">ini-cpp
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.8.13 -->
33+
<script type="text/javascript">
34+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
35+
</script>
36+
<script type="text/javascript" src="menudata.js"></script>
37+
<script type="text/javascript" src="menu.js"></script>
38+
<script type="text/javascript">
39+
$(function() {
40+
initMenu('',true,false,'search.php','Search');
41+
$(document).ready(function() { init_search(); });
42+
});
43+
</script>
44+
<div id="main-nav"></div>
45+
<!-- window showing the filter options -->
46+
<div id="MSearchSelectWindow"
47+
onmouseover="return searchBox.OnSearchSelectShow()"
48+
onmouseout="return searchBox.OnSearchSelectHide()"
49+
onkeydown="return searchBox.OnSearchSelectKey(event)">
50+
</div>
51+
52+
<!-- iframe showing the search results (closed by default) -->
53+
<div id="MSearchResultsWindow">
54+
<iframe src="javascript:void(0)" frameborder="0"
55+
name="MSearchResults" id="MSearchResults">
56+
</iframe>
57+
</div>
58+
59+
<div id="nav-path" class="navpath">
60+
<ul>
61+
<li class="navelem"><a class="el" href="namespaceinih.html">inih</a></li><li class="navelem"><a class="el" href="classinih_1_1INIReader.html">INIReader</a></li> </ul>
62+
</div>
63+
</div><!-- top -->
64+
<div class="header">
65+
<div class="headertitle">
66+
<div class="title">inih::INIReader Member List</div> </div>
67+
</div><!--header-->
68+
<div class="contents">
69+
70+
<p>This is the complete list of members for <a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a>, including all inherited members.</p>
71+
<table class="directory">
72+
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>_error</b> (defined in <a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a>)</td><td class="entry"><a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
73+
<tr bgcolor="#f0f0f0"><td class="entry"><b>_values</b> (defined in <a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a>)</td><td class="entry"><a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
74+
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>BoolConverter</b>(std::string s) const (defined in <a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a>)</td><td class="entry"><a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
75+
<tr bgcolor="#f0f0f0"><td class="entry"><b>Converter</b>(const std::string &amp;s) const (defined in <a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a>)</td><td class="entry"><a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
76+
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>Get</b>(std::string section) const (defined in <a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a>)</td><td class="entry"><a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
77+
<tr><td class="entry"><a class="el" href="classinih_1_1INIReader.html#aa6e6cf2858a796f9de76f800d0434949">Get</a>(const std::string &amp;section, const std::string &amp;name) const</td><td class="entry"><a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
78+
<tr class="even"><td class="entry"><a class="el" href="classinih_1_1INIReader.html#a00082355d324016ffcdd416ca56a7d13">Get</a>(const std::string &amp;section, const std::string &amp;name, T &amp;&amp;default_v) const</td><td class="entry"><a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
79+
<tr><td class="entry"><a class="el" href="classinih_1_1INIReader.html#aa09019b4bc6205d37f6c5a837dc21262">GetVector</a>(const std::string &amp;section, const std::string &amp;name) const</td><td class="entry"><a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
80+
<tr class="even"><td class="entry"><a class="el" href="classinih_1_1INIReader.html#afc8f853da847f1dcf7f2c137aa358683">GetVector</a>(const std::string &amp;section, const std::string &amp;name, const std::vector&lt; T &gt; &amp;default_v) const</td><td class="entry"><a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
81+
<tr bgcolor="#f0f0f0"><td class="entry"><b>INIReader</b>() (defined in <a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a>)</td><td class="entry"><a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
82+
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>INIReader</b>(std::string filename) (defined in <a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a>)</td><td class="entry"><a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
83+
<tr bgcolor="#f0f0f0"><td class="entry"><b>INIReader</b>(FILE *file) (defined in <a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a>)</td><td class="entry"><a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
84+
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>InsertEntry</b>(const std::string &amp;section, const std::string &amp;name, const T &amp;v) (defined in <a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a>)</td><td class="entry"><a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
85+
<tr bgcolor="#f0f0f0"><td class="entry"><b>InsertEntry</b>(const std::string &amp;section, const std::string &amp;name, const std::vector&lt; T &gt; &amp;vs) (defined in <a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a>)</td><td class="entry"><a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
86+
<tr class="even"><td class="entry"><a class="el" href="classinih_1_1INIReader.html#af277b96c36b8872e7578468e02067997">Keys</a>(std::string section) const</td><td class="entry"><a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
87+
<tr bgcolor="#f0f0f0"><td class="entry"><b>ParseError</b>() const (defined in <a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a>)</td><td class="entry"><a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
88+
<tr class="even"><td class="entry"><a class="el" href="classinih_1_1INIReader.html#a6d34dd183d98acf8a33204ecde93811d">Sections</a>() const</td><td class="entry"><a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
89+
<tr bgcolor="#f0f0f0"><td class="entry"><b>UpdateEntry</b>(const std::string &amp;section, const std::string &amp;name, const T &amp;v) (defined in <a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a>)</td><td class="entry"><a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
90+
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>UpdateEntry</b>(const std::string &amp;section, const std::string &amp;name, const std::vector&lt; T &gt; &amp;vs) (defined in <a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a>)</td><td class="entry"><a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
91+
<tr bgcolor="#f0f0f0"><td class="entry"><b>V2String</b>(const T &amp;v) const (defined in <a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a>)</td><td class="entry"><a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
92+
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>ValueHandler</b>(void *user, const char *section, const char *name, const char *value) (defined in <a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a>)</td><td class="entry"><a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">static</span></td></tr>
93+
<tr bgcolor="#f0f0f0"><td class="entry"><b>Vec2String</b>(const std::vector&lt; T &gt; &amp;v) const (defined in <a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a>)</td><td class="entry"><a class="el" href="classinih_1_1INIReader.html">inih::INIReader</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
94+
</table></div><!-- contents -->
95+
<!-- start footer part -->
96+
<hr class="footer"/><address class="footer"><small>
97+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
98+
<img class="footer" src="doxygen.png" alt="doxygen"/>
99+
</a> 1.8.13
100+
</small></address>
101+
</body>
102+
</html>

0 commit comments

Comments
 (0)