Skip to content

Commit

Permalink
wip docs and definitions renaming
Browse files Browse the repository at this point in the history
  • Loading branch information
@0xfrej
0xfrej committed Jan 3, 2025
1 parent 4a2417a commit 655e564
Show file tree
Hide file tree
Showing 580 changed files with 18,197 additions and 12,634 deletions.
7 changes: 3 additions & 4 deletions docs/html/adapter_8c.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,11 +105,10 @@
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="adapter_8h_source.html">vlcb/net/adapter.h</a>&quot;</code><br />
<code>#include &lt;assert.h&gt;</code><br />
<code>#include &quot;<a class="el" href="common_2inc_2vlcb_2common_2can_8h_source.html">vlcb/common/can.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for adapter.c:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="adapter_8c__incl.svg" width="868" height="418"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<div class="center"><iframe scrolling="no" frameborder="0" src="adapter_8c__incl.svg" width="826" height="418"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
<p><a href="adapter_8c_source.html">Go to the source code of this file.</a></p>
Expand All @@ -135,7 +134,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a74b46c574ae26bb9f527b6b1
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="adapter_8c_source.html#l00007">7</a> of file <a class="el" href="adapter_8c_source.html">adapter.c</a>.</p>
<p class="definition">Definition at line <a class="el" href="adapter_8c_source.html#l00005">5</a> of file <a class="el" href="adapter_8c_source.html">adapter.c</a>.</p>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
Expand All @@ -150,7 +149,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a74b46c574ae26bb9f527b6b1
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_427baa8a9a5be237f298d4545d0d1ce2.html">net</a></li><li class="navelem"><a class="el" href="dir_1125596c65a252cc7ae564f4b9ccb92e.html">src</a></li><li class="navelem"><a class="el" href="dir_93d0ef10fa3e9bdf980553bc2c395df8.html">adapter</a></li><li class="navelem"><a class="el" href="adapter_8c.html">adapter.c</a></li>
<li class="footer">Generated on Mon Nov 4 2024 09:13:33 for VLCB SDK by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
<li class="footer">Generated on Fri Nov 8 2024 16:10:13 for VLCB SDK by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/adapter_8c__incl.md5
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0e33382dd01e49d2825d5fd4ab3201fd
705cd7e70543e15585ffbd4b8ec77f6d
145 changes: 68 additions & 77 deletions docs/html/adapter_8c__incl.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 17 additions & 20 deletions docs/html/adapter_8c_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,25 +105,23 @@
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &lt;assert.h&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &quot;<a class="code" href="common_2inc_2vlcb_2common_2can_8h.html">vlcb/common/can.h</a>&quot;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="foldopen" id="foldopen00007" data-start="{" data-end="}">
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"><a class="line" href="adapter_8h.html#a01fcc81840085a0c1381613c768bb85b"> 7</a></span><a class="code hl_typedef" href="error_8h.html#ab95cb734291e5e025c1ba1e3ddc4e921">vlcb_error</a> <a class="code hl_function" href="adapter_8c.html#a74b46c574ae26bb9f527b6b157cb644e">vlcb_net_adpt_ErrToStr</a>(<span class="keyword">const</span> <a class="code hl_enumeration" href="adapter_8h.html#a07c07a6882fd3bdce27b16e759d145ff">VlcbNetAdptErr</a> err) {</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> assert(err &gt; <a class="code hl_enumvalue" href="adapter_8h.html#a07c07a6882fd3bdce27b16e759d145ffa12fd66b0858ae7bf461a3fd0f648a330">VLCB_NET_ADPT_ERR_OK</a> &amp;&amp; err &lt; <a class="code hl_enumvalue" href="adapter_8h.html#a07c07a6882fd3bdce27b16e759d145ffad9199a11eff26aee83346dd68623707f">VLCB_NET_ADPT_ERR_COUNT</a>);</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> <span class="keywordflow">switch</span> (err) {</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="adapter_8h.html#a07c07a6882fd3bdce27b16e759d145ffa72387472d4535c1e8d92828d41d63429">VLCB_NET_ADPT_ERR_WOULD_BLOCK</a>:</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> <span class="keywordflow">return</span> <span class="stringliteral">&quot;call would block&quot;</span>;</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="adapter_8h.html#a07c07a6882fd3bdce27b16e759d145ffa14b0beb2ca64689b4ee2175b92803f80">VLCB_NET_ADPT_ERR_UNSUPPORTED_MEDIUM</a>:</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <span class="keywordflow">return</span> <span class="stringliteral">&quot;unsupported medium&quot;</span>;</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="adapter_8h.html#a07c07a6882fd3bdce27b16e759d145ffaa8421fdcb17abe4d5f742b9103f2f9db">VLCB_NET_ADPT_ERR_PAYLOAD_TOO_LARGE</a>:</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <span class="keywordflow">return</span> <span class="stringliteral">&quot;payload is too large&quot;</span>;</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="adapter_8h.html#a07c07a6882fd3bdce27b16e759d145ffa080d70dfbbebf1c2a64d4a1d158c03d6">VLCB_NET_ADPT_ERR_INVALID_CANID</a>:</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <span class="keywordflow">return</span> <span class="stringliteral">&quot;invalid CAN id&quot;</span>;</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> }</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> assert(<span class="keyword">false</span> <span class="comment">/* unimplemented case guard */</span>);</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span>}</div>
<div class="foldopen" id="foldopen00005" data-start="{" data-end="}">
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"><a class="line" href="adapter_8h.html#a01fcc81840085a0c1381613c768bb85b"> 5</a></span><a class="code hl_typedef" href="error_8h.html#ab95cb734291e5e025c1ba1e3ddc4e921">vlcb_error</a> <a class="code hl_function" href="adapter_8c.html#a74b46c574ae26bb9f527b6b157cb644e">vlcb_net_adpt_ErrToStr</a>(<span class="keyword">const</span> <a class="code hl_enumeration" href="adapter_8h.html#a07c07a6882fd3bdce27b16e759d145ff">VlcbNetAdptErr</a> err) {</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> assert(err &gt; <a class="code hl_enumvalue" href="adapter_8h.html#a07c07a6882fd3bdce27b16e759d145ffa12fd66b0858ae7bf461a3fd0f648a330">VLCB_NET_ADPT_ERR_OK</a> &amp;&amp; err &lt; <a class="code hl_enumvalue" href="adapter_8h.html#a07c07a6882fd3bdce27b16e759d145ffad9199a11eff26aee83346dd68623707f">VLCB_NET_ADPT_ERR_COUNT</a>);</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> <span class="keywordflow">switch</span> (err) {</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="adapter_8h.html#a07c07a6882fd3bdce27b16e759d145ffa72387472d4535c1e8d92828d41d63429">VLCB_NET_ADPT_ERR_WOULD_BLOCK</a>:</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> <span class="keywordflow">return</span> <span class="stringliteral">&quot;call would block&quot;</span>;</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="adapter_8h.html#a07c07a6882fd3bdce27b16e759d145ffa14b0beb2ca64689b4ee2175b92803f80">VLCB_NET_ADPT_ERR_UNSUPPORTED_MEDIUM</a>:</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> <span class="keywordflow">return</span> <span class="stringliteral">&quot;unsupported medium&quot;</span>;</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="adapter_8h.html#a07c07a6882fd3bdce27b16e759d145ffaa8421fdcb17abe4d5f742b9103f2f9db">VLCB_NET_ADPT_ERR_PAYLOAD_TOO_LARGE</a>:</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <span class="keywordflow">return</span> <span class="stringliteral">&quot;payload is too large&quot;</span>;</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="adapter_8h.html#a07c07a6882fd3bdce27b16e759d145ffa080d70dfbbebf1c2a64d4a1d158c03d6">VLCB_NET_ADPT_ERR_INVALID_CANID</a>:</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <span class="keywordflow">return</span> <span class="stringliteral">&quot;invalid CAN id&quot;</span>;</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> assert(<span class="keyword">false</span> <span class="comment">/* unimplemented case guard */</span>);</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span>}</div>
</div>
<div class="ttc" id="aadapter_8c_html_a74b46c574ae26bb9f527b6b157cb644e"><div class="ttname"><a href="adapter_8c.html#a74b46c574ae26bb9f527b6b157cb644e">vlcb_net_adpt_ErrToStr</a></div><div class="ttdeci">vlcb_error vlcb_net_adpt_ErrToStr(const VlcbNetAdptErr err)</div><div class="ttdef"><b>Definition</b> <a href="#l00007">adapter.c:7</a></div></div>
<div class="ttc" id="aadapter_8c_html_a74b46c574ae26bb9f527b6b157cb644e"><div class="ttname"><a href="adapter_8c.html#a74b46c574ae26bb9f527b6b157cb644e">vlcb_net_adpt_ErrToStr</a></div><div class="ttdeci">vlcb_error vlcb_net_adpt_ErrToStr(const VlcbNetAdptErr err)</div><div class="ttdef"><b>Definition</b> <a href="#l00005">adapter.c:5</a></div></div>
<div class="ttc" id="aadapter_8h_html"><div class="ttname"><a href="adapter_8h.html">adapter.h</a></div></div>
<div class="ttc" id="aadapter_8h_html_a07c07a6882fd3bdce27b16e759d145ff"><div class="ttname"><a href="adapter_8h.html#a07c07a6882fd3bdce27b16e759d145ff">VlcbNetAdptErr</a></div><div class="ttdeci">VlcbNetAdptErr</div><div class="ttdef"><b>Definition</b> <a href="adapter_8h_source.html#l00039">adapter.h:39</a></div></div>
<div class="ttc" id="aadapter_8h_html_a07c07a6882fd3bdce27b16e759d145ffa080d70dfbbebf1c2a64d4a1d158c03d6"><div class="ttname"><a href="adapter_8h.html#a07c07a6882fd3bdce27b16e759d145ffa080d70dfbbebf1c2a64d4a1d158c03d6">VLCB_NET_ADPT_ERR_INVALID_CANID</a></div><div class="ttdeci">@ VLCB_NET_ADPT_ERR_INVALID_CANID</div><div class="ttdef"><b>Definition</b> <a href="adapter_8h_source.html#l00066">adapter.h:66</a></div></div>
Expand All @@ -132,15 +130,14 @@
<div class="ttc" id="aadapter_8h_html_a07c07a6882fd3bdce27b16e759d145ffa72387472d4535c1e8d92828d41d63429"><div class="ttname"><a href="adapter_8h.html#a07c07a6882fd3bdce27b16e759d145ffa72387472d4535c1e8d92828d41d63429">VLCB_NET_ADPT_ERR_WOULD_BLOCK</a></div><div class="ttdeci">@ VLCB_NET_ADPT_ERR_WOULD_BLOCK</div><div class="ttdef"><b>Definition</b> <a href="adapter_8h_source.html#l00052">adapter.h:52</a></div></div>
<div class="ttc" id="aadapter_8h_html_a07c07a6882fd3bdce27b16e759d145ffaa8421fdcb17abe4d5f742b9103f2f9db"><div class="ttname"><a href="adapter_8h.html#a07c07a6882fd3bdce27b16e759d145ffaa8421fdcb17abe4d5f742b9103f2f9db">VLCB_NET_ADPT_ERR_PAYLOAD_TOO_LARGE</a></div><div class="ttdeci">@ VLCB_NET_ADPT_ERR_PAYLOAD_TOO_LARGE</div><div class="ttdef"><b>Definition</b> <a href="adapter_8h_source.html#l00064">adapter.h:64</a></div></div>
<div class="ttc" id="aadapter_8h_html_a07c07a6882fd3bdce27b16e759d145ffad9199a11eff26aee83346dd68623707f"><div class="ttname"><a href="adapter_8h.html#a07c07a6882fd3bdce27b16e759d145ffad9199a11eff26aee83346dd68623707f">VLCB_NET_ADPT_ERR_COUNT</a></div><div class="ttdeci">@ VLCB_NET_ADPT_ERR_COUNT</div><div class="ttdef"><b>Definition</b> <a href="adapter_8h_source.html#l00072">adapter.h:72</a></div></div>
<div class="ttc" id="acommon_2inc_2vlcb_2common_2can_8h_html"><div class="ttname"><a href="common_2inc_2vlcb_2common_2can_8h.html">can.h</a></div></div>
<div class="ttc" id="aerror_8h_html_ab95cb734291e5e025c1ba1e3ddc4e921"><div class="ttname"><a href="error_8h.html#ab95cb734291e5e025c1ba1e3ddc4e921">vlcb_error</a></div><div class="ttdeci">const char *const vlcb_error</div><div class="ttdef"><b>Definition</b> <a href="error_8h_source.html#l00003">error.h:3</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_427baa8a9a5be237f298d4545d0d1ce2.html">net</a></li><li class="navelem"><a class="el" href="dir_1125596c65a252cc7ae564f4b9ccb92e.html">src</a></li><li class="navelem"><a class="el" href="dir_93d0ef10fa3e9bdf980553bc2c395df8.html">adapter</a></li><li class="navelem"><a class="el" href="adapter_8c.html">adapter.c</a></li>
<li class="footer">Generated on Mon Nov 4 2024 09:13:33 for VLCB SDK by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
<li class="footer">Generated on Fri Nov 8 2024 16:10:13 for VLCB SDK by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
Expand Down
4 changes: 2 additions & 2 deletions docs/html/adapter_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a01fcc81840085a0c1381613c
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="adapter_8c_source.html#l00007">7</a> of file <a class="el" href="adapter_8c_source.html">adapter.c</a>.</p>
<p class="definition">Definition at line <a class="el" href="adapter_8c_source.html#l00005">5</a> of file <a class="el" href="adapter_8c_source.html">adapter.c</a>.</p>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
Expand All @@ -283,7 +283,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a01fcc81840085a0c1381613c
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_427baa8a9a5be237f298d4545d0d1ce2.html">net</a></li><li class="navelem"><a class="el" href="dir_c0575b5e81918ff6cd7d86b5adbed5d0.html">inc</a></li><li class="navelem"><a class="el" href="dir_5314d62625720a050713b0cba532fdc8.html">vlcb</a></li><li class="navelem"><a class="el" href="dir_ca0879ab5012c7f5f5b50184c926c0b0.html">net</a></li><li class="navelem"><a class="el" href="adapter_8h.html">adapter.h</a></li>
<li class="footer">Generated on Mon Nov 4 2024 09:13:33 for VLCB SDK by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
<li class="footer">Generated on Fri Nov 8 2024 16:10:13 for VLCB SDK by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/adapter_8h__incl.md5
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
ecd83025f816fe78ead5a7e3dcac6456
bcc8c31d70c5acf2ebb7e7257b95ee0d
Loading

0 comments on commit 655e564

Please sign in to comment.