Skip to content

Commit

Permalink
Update doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
Rubberazer committed Nov 17, 2023
1 parent 6c7de78 commit 5a5a047
Show file tree
Hide file tree
Showing 18 changed files with 78 additions and 122 deletions.
1 change: 0 additions & 1 deletion docs/html/globals.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,6 @@

<div class="contents">
<div class="textblock">Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation:</div><ul>
<li>chip_get_id()&#160;:&#160;<a class="el" href="jetgpio_8h.html#abc4a0f7f1eb1b595b6c129c036731334">jetgpio.h</a></li>
<li>gpioInitialise()&#160;:&#160;<a class="el" href="jetgpio_8h.html#a80d84e5dd32fd8ec04cb0370eab0a5b0">jetgpio.h</a></li>
<li>gpioPWM()&#160;:&#160;<a class="el" href="jetgpio_8h.html#a81675c68b04f3c19be1f743eae7f2136">jetgpio.h</a></li>
<li>gpioRead()&#160;:&#160;<a class="el" href="jetgpio_8h.html#a754d22c52d797f32f02c86863496b0ec">jetgpio.h</a></li>
Expand Down
1 change: 0 additions & 1 deletion docs/html/globals_func.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,6 @@

<div class="contents">
<div class="textblock">Here is a list of all documented functions with links to the documentation:</div><ul>
<li>chip_get_id()&#160;:&#160;<a class="el" href="jetgpio_8h.html#abc4a0f7f1eb1b595b6c129c036731334">jetgpio.h</a></li>
<li>gpioInitialise()&#160;:&#160;<a class="el" href="jetgpio_8h.html#a80d84e5dd32fd8ec04cb0370eab0a5b0">jetgpio.h</a></li>
<li>gpioPWM()&#160;:&#160;<a class="el" href="jetgpio_8h.html#a81675c68b04f3c19be1f743eae7f2136">jetgpio.h</a></li>
<li>gpioRead()&#160;:&#160;<a class="el" href="jetgpio_8h.html#a754d22c52d797f32f02c86863496b0ec">jetgpio.h</a></li>
Expand Down
24 changes: 0 additions & 24 deletions docs/html/jetgpio_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -115,9 +115,6 @@
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:abc4a0f7f1eb1b595b6c129c036731334" id="r_abc4a0f7f1eb1b595b6c129c036731334"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abc4a0f7f1eb1b595b6c129c036731334">chip_get_id</a> (void)</td></tr>
<tr class="memdesc:abc4a0f7f1eb1b595b6c129c036731334"><td class="mdescLeft">&#160;</td><td class="mdescRight">Auxiliary function used by <a class="el" href="#a80d84e5dd32fd8ec04cb0370eab0a5b0" title="Initialises the library. gpioInitialise must be called before using the other library functions,...">gpioInitialise()</a> to find out whether the hardware is supported by the library. <br /></td></tr>
<tr class="separator:abc4a0f7f1eb1b595b6c129c036731334"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80d84e5dd32fd8ec04cb0370eab0a5b0" id="r_a80d84e5dd32fd8ec04cb0370eab0a5b0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a80d84e5dd32fd8ec04cb0370eab0a5b0">gpioInitialise</a> (void)</td></tr>
<tr class="memdesc:a80d84e5dd32fd8ec04cb0370eab0a5b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialises the library. gpioInitialise must be called before using the other library functions, it stores the status of all the relevant registers before using/modifying them. <br /></td></tr>
<tr class="separator:a80d84e5dd32fd8ec04cb0370eab0a5b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand Down Expand Up @@ -171,27 +168,6 @@
<tr class="separator:a96e92eb729c89f2a9a893adf83251dc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="abc4a0f7f1eb1b595b6c129c036731334" name="abc4a0f7f1eb1b595b6c129c036731334"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc4a0f7f1eb1b595b6c129c036731334">&#9670;&#160;</a></span>chip_get_id()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int chip_get_id </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">

<p>Auxiliary function used by <a class="el" href="#a80d84e5dd32fd8ec04cb0370eab0a5b0" title="Initialises the library. gpioInitialise must be called before using the other library functions,...">gpioInitialise()</a> to find out whether the hardware is supported by the library. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns the Jetson model if supported, otherwise will exit with an error message. </dd></dl>

</div>
</div>
<a id="a80d84e5dd32fd8ec04cb0370eab0a5b0" name="a80d84e5dd32fd8ec04cb0370eab0a5b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80d84e5dd32fd8ec04cb0370eab0a5b0">&#9670;&#160;</a></span>gpioInitialise()</h2>

Expand Down
1 change: 0 additions & 1 deletion docs/html/jetgpio_8h.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
var jetgpio_8h =
[
[ "chip_get_id", "jetgpio_8h.html#abc4a0f7f1eb1b595b6c129c036731334", null ],
[ "gpioInitialise", "jetgpio_8h.html#a80d84e5dd32fd8ec04cb0370eab0a5b0", null ],
[ "gpioPWM", "jetgpio_8h.html#a81675c68b04f3c19be1f743eae7f2136", null ],
[ "gpioRead", "jetgpio_8h.html#a754d22c52d797f32f02c86863496b0ec", null ],
Expand Down
Loading

0 comments on commit 5a5a047

Please sign in to comment.