Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Gallardo994 committed Mar 16, 2024
1 parent 15d2ff9 commit 669ebb1
Show file tree
Hide file tree
Showing 96 changed files with 2,379 additions and 598 deletions.
59 changes: 34 additions & 25 deletions docs/html/annotated.html
View file

Large diffs are not rendered by default.

5 changes: 4 additions & 1 deletion docs/html/classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
<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_C">C</a>&#160;|&#160;<a class="qindex" href="#letter_F">F</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_W">W</a></div>
<div class="qindex"><a class="qindex" href="#letter_A">A</a>&#160;|&#160;<a class="qindex" href="#letter_C">C</a>&#160;|&#160;<a class="qindex" href="#letter_F">F</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_W">W</a></div>
<div class="classindex">
<dl class="classindex even">
<dt class="alphachar"><a name="letter_A">A</a></dt>
Expand All @@ -89,6 +89,9 @@
<dt class="alphachar"><a name="letter_S">S</a></dt>
<dd><a class="el" href="structimkcpp_1_1Segment.html">Segment</a> (imkcpp)</dd><dd><a class="el" href="structimkcpp_1_1SegmentData.html">SegmentData</a> (imkcpp)</dd><dd><a class="el" href="structimkcpp_1_1SegmentHeader.html">SegmentHeader</a> (imkcpp)</dd><dd><a class="el" href="structimkcpp_1_1SegmentMetadata.html">SegmentMetadata</a> (imkcpp)</dd><dd><a class="el" href="classimkcpp_1_1SegmentTracker.html">SegmentTracker</a> (imkcpp)</dd><dd><a class="el" href="classimkcpp_1_1Sender.html">Sender</a> (imkcpp)</dd><dd><a class="el" href="classimkcpp_1_1SenderBuffer.html">SenderBuffer</a> (imkcpp)</dd><dd><a class="el" href="classimkcpp_1_1SharedCtx.html">SharedCtx</a> (imkcpp)</dd></dl>
<dl class="classindex odd">
<dt class="alphachar"><a name="letter_T">T</a></dt>
<dd><a class="el" href="structimkcpp_1_1serializer_1_1TraitFixedSize.html">TraitFixedSize</a> (imkcpp::serializer)</dd><dd><a class="el" href="structimkcpp_1_1serializer_1_1TraitFixedSize_3_01u16_01_4.html">TraitFixedSize&lt; u16 &gt;</a> (imkcpp::serializer)</dd><dd><a class="el" href="structimkcpp_1_1serializer_1_1TraitFixedSize_3_01u32_01_4.html">TraitFixedSize&lt; u32 &gt;</a> (imkcpp::serializer)</dd><dd><a class="el" href="structimkcpp_1_1serializer_1_1TraitFixedSize_3_01u8_01_4.html">TraitFixedSize&lt; u8 &gt;</a> (imkcpp::serializer)</dd><dd><a class="el" href="structimkcpp_1_1serializer_1_1TraitSerializable.html">TraitSerializable</a> (imkcpp::serializer)</dd><dd><a class="el" href="structimkcpp_1_1serializer_1_1TraitSerializable_3_01u16_01_4.html">TraitSerializable&lt; u16 &gt;</a> (imkcpp::serializer)</dd><dd><a class="el" href="structimkcpp_1_1serializer_1_1TraitSerializable_3_01u32_01_4.html">TraitSerializable&lt; u32 &gt;</a> (imkcpp::serializer)</dd><dd><a class="el" href="structimkcpp_1_1serializer_1_1TraitSerializable_3_01u8_01_4.html">TraitSerializable&lt; u8 &gt;</a> (imkcpp::serializer)</dd></dl>
<dl class="classindex even">
<dt class="alphachar"><a name="letter_W">W</a></dt>
<dd><a class="el" href="classimkcpp_1_1WindowProber.html">WindowProber</a> (imkcpp)</dd></dl>
</div>
Expand Down
5 changes: 4 additions & 1 deletion docs/html/classimkcpp_1_1Cmd-members.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,13 @@
<p>This is the complete list of members for <a class="el" href="classimkcpp_1_1Cmd.html">imkcpp::Cmd</a>, including all inherited members.</p>
<table class="directory">
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>Cmd</b>(const UT value) noexcept (defined in <a class="el" href="classimkcpp_1_1Cmd.html">imkcpp::Cmd</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Cmd.html">imkcpp::Cmd</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">explicit</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>deserialize</b>(const std::span&lt; const std::byte &gt; buf, size_t &amp;offset) (defined in <a class="el" href="classimkcpp_1_1Cmd.html">imkcpp::Cmd</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Cmd.html">imkcpp::Cmd</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>fixed_size</b>() (defined in <a class="el" href="classimkcpp_1_1Cmd.html">imkcpp::Cmd</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Cmd.html">imkcpp::Cmd</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>get</b>() const noexcept (defined in <a class="el" href="classimkcpp_1_1Cmd.html">imkcpp::Cmd</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Cmd.html">imkcpp::Cmd</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>operator!=</b>(const Cmd &amp;other) const noexcept (defined in <a class="el" href="classimkcpp_1_1Cmd.html">imkcpp::Cmd</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Cmd.html">imkcpp::Cmd</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>operator==</b>(const Cmd &amp;other) const noexcept (defined in <a class="el" href="classimkcpp_1_1Cmd.html">imkcpp::Cmd</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Cmd.html">imkcpp::Cmd</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>UT</b> typedef (defined in <a class="el" href="classimkcpp_1_1Cmd.html">imkcpp::Cmd</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Cmd.html">imkcpp::Cmd</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>serialize</b>(const std::span&lt; std::byte &gt; buf, size_t &amp;offset) const (defined in <a class="el" href="classimkcpp_1_1Cmd.html">imkcpp::Cmd</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Cmd.html">imkcpp::Cmd</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>UT</b> typedef (defined in <a class="el" href="classimkcpp_1_1Cmd.html">imkcpp::Cmd</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Cmd.html">imkcpp::Cmd</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
13 changes: 13 additions & 0 deletions docs/html/classimkcpp_1_1Cmd.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classimkcpp_1_1Cmd-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">imkcpp::Cmd Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
Expand Down Expand Up @@ -96,6 +97,18 @@
<tr class="memitem:ab240695a5101b900349455fcf2b2df14"><td class="memItemLeft" align="right" valign="top"><a id="ab240695a5101b900349455fcf2b2df14"></a>
constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator!=</b> (const <a class="el" href="classimkcpp_1_1Cmd.html">Cmd</a> &amp;other) const noexcept</td></tr>
<tr class="separator:ab240695a5101b900349455fcf2b2df14"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a26e955f029aaa32ddf2144a4c630e6d3"><td class="memItemLeft" align="right" valign="top"><a id="a26e955f029aaa32ddf2144a4c630e6d3"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>serialize</b> (const std::span&lt; std::byte &gt; buf, size_t &amp;offset) const</td></tr>
<tr class="separator:a26e955f029aaa32ddf2144a4c630e6d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acdfc365a6c0c5e795d724e8cfbfabcf2"><td class="memItemLeft" align="right" valign="top"><a id="acdfc365a6c0c5e795d724e8cfbfabcf2"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>deserialize</b> (const std::span&lt; const std::byte &gt; buf, size_t &amp;offset)</td></tr>
<tr class="separator:acdfc365a6c0c5e795d724e8cfbfabcf2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aa03137dfb40d824fc6248f43bf87e32a"><td class="memItemLeft" align="right" valign="top"><a id="aa03137dfb40d824fc6248f43bf87e32a"></a>
constexpr static size_t&#160;</td><td class="memItemRight" valign="bottom"><b>fixed_size</b> ()</td></tr>
<tr class="separator:aa03137dfb40d824fc6248f43bf87e32a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Command ID. Determines the type of the segment and the action to be taken. </p>
Expand Down
5 changes: 4 additions & 1 deletion docs/html/classimkcpp_1_1Conv-members.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,13 @@
<p>This is the complete list of members for <a class="el" href="classimkcpp_1_1Conv.html">imkcpp::Conv</a>, including all inherited members.</p>
<table class="directory">
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>Conv</b>(const UT value) noexcept (defined in <a class="el" href="classimkcpp_1_1Conv.html">imkcpp::Conv</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Conv.html">imkcpp::Conv</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">explicit</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>deserialize</b>(const std::span&lt; const std::byte &gt; buf, size_t &amp;offset) (defined in <a class="el" href="classimkcpp_1_1Conv.html">imkcpp::Conv</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Conv.html">imkcpp::Conv</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>fixed_size</b>() (defined in <a class="el" href="classimkcpp_1_1Conv.html">imkcpp::Conv</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Conv.html">imkcpp::Conv</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>get</b>() const noexcept (defined in <a class="el" href="classimkcpp_1_1Conv.html">imkcpp::Conv</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Conv.html">imkcpp::Conv</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>operator!=</b>(const Conv &amp;other) const noexcept (defined in <a class="el" href="classimkcpp_1_1Conv.html">imkcpp::Conv</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Conv.html">imkcpp::Conv</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>operator==</b>(const Conv &amp;other) const noexcept (defined in <a class="el" href="classimkcpp_1_1Conv.html">imkcpp::Conv</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Conv.html">imkcpp::Conv</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>UT</b> typedef (defined in <a class="el" href="classimkcpp_1_1Conv.html">imkcpp::Conv</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Conv.html">imkcpp::Conv</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>serialize</b>(const std::span&lt; std::byte &gt; buf, size_t &amp;offset) const (defined in <a class="el" href="classimkcpp_1_1Conv.html">imkcpp::Conv</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Conv.html">imkcpp::Conv</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>UT</b> typedef (defined in <a class="el" href="classimkcpp_1_1Conv.html">imkcpp::Conv</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Conv.html">imkcpp::Conv</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
13 changes: 13 additions & 0 deletions docs/html/classimkcpp_1_1Conv.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classimkcpp_1_1Conv-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">imkcpp::Conv Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
Expand Down Expand Up @@ -96,6 +97,18 @@
<tr class="memitem:aea037f211a2cbc91a4bfb1399e107102"><td class="memItemLeft" align="right" valign="top"><a id="aea037f211a2cbc91a4bfb1399e107102"></a>
constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator!=</b> (const <a class="el" href="classimkcpp_1_1Conv.html">Conv</a> &amp;other) const noexcept</td></tr>
<tr class="separator:aea037f211a2cbc91a4bfb1399e107102"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e8f9d5adbbb2ee974e756973cae97cf"><td class="memItemLeft" align="right" valign="top"><a id="a8e8f9d5adbbb2ee974e756973cae97cf"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>serialize</b> (const std::span&lt; std::byte &gt; buf, size_t &amp;offset) const</td></tr>
<tr class="separator:a8e8f9d5adbbb2ee974e756973cae97cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47b531cdce966c4f75735af154e8e9ba"><td class="memItemLeft" align="right" valign="top"><a id="a47b531cdce966c4f75735af154e8e9ba"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>deserialize</b> (const std::span&lt; const std::byte &gt; buf, size_t &amp;offset)</td></tr>
<tr class="separator:a47b531cdce966c4f75735af154e8e9ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ad02fc6f9ac8471831ef098a5219061e4"><td class="memItemLeft" align="right" valign="top"><a id="ad02fc6f9ac8471831ef098a5219061e4"></a>
constexpr static size_t&#160;</td><td class="memItemRight" valign="bottom"><b>fixed_size</b> ()</td></tr>
<tr class="separator:ad02fc6f9ac8471831ef098a5219061e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Conversation ID. Used for splitting channels over the same socket. UT can be changed to u16 or u8 to save space if needed. </p>
Expand Down
5 changes: 4 additions & 1 deletion docs/html/classimkcpp_1_1Fragment-members.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,14 +72,17 @@

<p>This is the complete list of members for <a class="el" href="classimkcpp_1_1Fragment.html">imkcpp::Fragment</a>, including all inherited members.</p>
<table class="directory">
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>deserialize</b>(const std::span&lt; const std::byte &gt; buf, size_t &amp;offset) (defined in <a class="el" href="classimkcpp_1_1Fragment.html">imkcpp::Fragment</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Fragment.html">imkcpp::Fragment</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>fixed_size</b>() (defined in <a class="el" href="classimkcpp_1_1Fragment.html">imkcpp::Fragment</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Fragment.html">imkcpp::Fragment</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">static</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>Fragment</b>(const UT value) noexcept (defined in <a class="el" href="classimkcpp_1_1Fragment.html">imkcpp::Fragment</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Fragment.html">imkcpp::Fragment</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">explicit</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>get</b>() const noexcept (defined in <a class="el" href="classimkcpp_1_1Fragment.html">imkcpp::Fragment</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Fragment.html">imkcpp::Fragment</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>operator!=</b>(const Fragment &amp;other) const noexcept (defined in <a class="el" href="classimkcpp_1_1Fragment.html">imkcpp::Fragment</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Fragment.html">imkcpp::Fragment</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>operator&lt;</b>(const Fragment &amp;other) const noexcept (defined in <a class="el" href="classimkcpp_1_1Fragment.html">imkcpp::Fragment</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Fragment.html">imkcpp::Fragment</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>operator==</b>(const Fragment &amp;other) const noexcept (defined in <a class="el" href="classimkcpp_1_1Fragment.html">imkcpp::Fragment</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Fragment.html">imkcpp::Fragment</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>operator==</b>(const UT &amp;other) const noexcept (defined in <a class="el" href="classimkcpp_1_1Fragment.html">imkcpp::Fragment</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Fragment.html">imkcpp::Fragment</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>operator&gt;</b>(const Fragment &amp;other) const noexcept (defined in <a class="el" href="classimkcpp_1_1Fragment.html">imkcpp::Fragment</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Fragment.html">imkcpp::Fragment</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>UT</b> typedef (defined in <a class="el" href="classimkcpp_1_1Fragment.html">imkcpp::Fragment</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Fragment.html">imkcpp::Fragment</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>serialize</b>(const std::span&lt; std::byte &gt; buf, size_t &amp;offset) const (defined in <a class="el" href="classimkcpp_1_1Fragment.html">imkcpp::Fragment</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Fragment.html">imkcpp::Fragment</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>UT</b> typedef (defined in <a class="el" href="classimkcpp_1_1Fragment.html">imkcpp::Fragment</a>)</td><td class="entry"><a class="el" href="classimkcpp_1_1Fragment.html">imkcpp::Fragment</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
Loading

0 comments on commit 669ebb1

Please sign in to comment.