Skip to content

Commit

Permalink
Docs - Update libnick
Browse files Browse the repository at this point in the history
  • Loading branch information
@nlogozzo
nlogozzo committed Dec 27, 2024
1 parent a64f13e commit 7f21557
Show file tree
Hide file tree
Showing 348 changed files with 2,745 additions and 1,048 deletions.
2 changes: 1 addition & 1 deletion docs/libnick/README_8md.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">libnick<span id="projectnumber">&#160;2024.12.0</span>
<div id="projectname">libnick<span id="projectnumber">&#160;2024.12.1</span>
</div>
<div id="projectbrief">A cross-platform base for native Nickvision applications.</div>
</td>
Expand Down
125 changes: 125 additions & 0 deletions docs/libnick/addressfamily_8h.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
<!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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libnick: include/network/addressfamily.h File Reference</title>
<link rel="icon" href="libnick-r.png" type="image/x-icon" />
<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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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">libnick<span id="projectnumber">&#160;2024.12.1</span>
</div>
<div id="projectbrief">A cross-platform base for native Nickvision applications.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_dafb25a37831a87d2e2e8b780f24e872.html">network</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle"><div class="title">addressfamily.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;sys/socket.h&gt;</code><br />
</div>
<p><a href="addressfamily_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceNickvision.html">Nickvision</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceNickvision_1_1Network.html">Nickvision::Network</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:adb113c10efcff2761ebd0c8598f0f3de" id="r_adb113c10efcff2761ebd0c8598f0f3de"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceNickvision_1_1Network.html#adb113c10efcff2761ebd0c8598f0f3de">Nickvision::Network::AddressFamily</a> { <a class="el" href="namespaceNickvision_1_1Network.html#adb113c10efcff2761ebd0c8598f0f3dea6ec1bd1ea6a5d67a63b20c8f6172bddd">Nickvision::Network::Unix</a> = AF_UNIX
, <a class="el" href="namespaceNickvision_1_1Network.html#adb113c10efcff2761ebd0c8598f0f3dea42a9137a05a60eb752dcdf982e717626">Nickvision::Network::IPv4</a> = AF_INET
}</td></tr>
<tr class="memdesc:adb113c10efcff2761ebd0c8598f0f3de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of address that can be used by a socket. <a href="namespaceNickvision_1_1Network.html#adb113c10efcff2761ebd0c8598f0f3de">More...</a><br /></td></tr>
<tr class="separator:adb113c10efcff2761ebd0c8598f0f3de"><td class="memSeparator" colspan="2">&#160;</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.12.0
</small></address>
</div><!-- doc-content -->
</body>
</html>
134 changes: 134 additions & 0 deletions docs/libnick/addressfamily_8h_source.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
<!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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libnick: include/network/addressfamily.h Source File</title>
<link rel="icon" href="libnick-r.png" type="image/x-icon" />
<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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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">libnick<span id="projectnumber">&#160;2024.12.1</span>
</div>
<div id="projectbrief">A cross-platform base for native Nickvision applications.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_dafb25a37831a87d2e2e8b780f24e872.html">network</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="headertitle"><div class="title">addressfamily.h</div></div>
</div><!--header-->
<div class="contents">
<a href="addressfamily_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef ADDRESSFAMILY_H</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define ADDRESSFAMILY_H</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#ifdef _WIN32</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;Winsock2.h&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;sys/socket.h&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="foldopen" id="foldopen00010" data-start="{" data-end="}">
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"><a class="line" href="namespaceNickvision_1_1Network.html"> 10</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceNickvision_1_1Network.html">Nickvision::Network</a></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span>{</div>
<div class="foldopen" id="foldopen00015" data-start="{" data-end="};">
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="namespaceNickvision_1_1Network.html#adb113c10efcff2761ebd0c8598f0f3de"> 15</a></span> <span class="keyword">enum class</span> <a class="code hl_enumeration" href="namespaceNickvision_1_1Network.html#adb113c10efcff2761ebd0c8598f0f3de">AddressFamily</a></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> {</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#ifdef _WIN32</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> Pipe,</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <a class="code hl_enumvalue" href="namespaceNickvision_1_1Network.html#adb113c10efcff2761ebd0c8598f0f3dea6ec1bd1ea6a5d67a63b20c8f6172bddd">Unix</a> = AF_UNIX,</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <a class="code hl_enumvalue" href="namespaceNickvision_1_1Network.html#adb113c10efcff2761ebd0c8598f0f3dea42a9137a05a60eb752dcdf982e717626">IPv4</a> = AF_INET</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> };</div>
</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span>}</div>
</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#endif </span><span class="comment">//ADDRESSFAMILY_H</span></div>
<div class="ttc" id="anamespaceNickvision_1_1Network_html"><div class="ttname"><a href="namespaceNickvision_1_1Network.html">Nickvision::Network</a></div><div class="ttdef"><b>Definition</b> addressfamily.h:11</div></div>
<div class="ttc" id="anamespaceNickvision_1_1Network_html_adb113c10efcff2761ebd0c8598f0f3de"><div class="ttname"><a href="namespaceNickvision_1_1Network.html#adb113c10efcff2761ebd0c8598f0f3de">Nickvision::Network::AddressFamily</a></div><div class="ttdeci">AddressFamily</div><div class="ttdoc">Type of address that can be used by a socket.</div><div class="ttdef"><b>Definition</b> addressfamily.h:16</div></div>
<div class="ttc" id="anamespaceNickvision_1_1Network_html_adb113c10efcff2761ebd0c8598f0f3dea42a9137a05a60eb752dcdf982e717626"><div class="ttname"><a href="namespaceNickvision_1_1Network.html#adb113c10efcff2761ebd0c8598f0f3dea42a9137a05a60eb752dcdf982e717626">Nickvision::Network::AddressFamily::IPv4</a></div><div class="ttdeci">@ IPv4</div></div>
<div class="ttc" id="anamespaceNickvision_1_1Network_html_adb113c10efcff2761ebd0c8598f0f3dea6ec1bd1ea6a5d67a63b20c8f6172bddd"><div class="ttname"><a href="namespaceNickvision_1_1Network.html#adb113c10efcff2761ebd0c8598f0f3dea6ec1bd1ea6a5d67a63b20c8f6172bddd">Nickvision::Network::AddressFamily::Unix</a></div><div class="ttdeci">@ Unix</div></div>
</div><!-- fragment --></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.12.0
</small></address>
</div><!-- doc-content -->
</body>
</html>
Loading

0 comments on commit 7f21557

Please sign in to comment.