Skip to content

Commit

Permalink
Merge pull request #18 from libdriver/dev
Browse files Browse the repository at this point in the history 
fix: fix doc errors
  • Loading branch information
@libdriver
libdriver authored Dec 29, 2024
2 parents a467472 + e340666 commit 21a3906
Show file tree
Hide file tree
Showing 37 changed files with 644 additions and 811 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## 2.0.2 (2024-12-01)

## Bug Fixes

- fix doc errors

## 2.0.1 (2024-08-05)

## Bug Fixes
Expand Down
238 changes: 16 additions & 222 deletions doc/html/driver__ds18b20__alarm_8c.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,21 +99,21 @@
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aceca818b591b2a75bf7587264df98e5a"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="driver__ds18b20__alarm_8c.html#aceca818b591b2a75bf7587264df98e5a">ds18b20_alarm_init</a> (void)</td></tr>
<tr class="memdesc:aceca818b591b2a75bf7587264df98e5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">alarm example init <a href="driver__ds18b20__alarm_8c.html#aceca818b591b2a75bf7587264df98e5a">More...</a><br /></td></tr>
<tr class="separator:aceca818b591b2a75bf7587264df98e5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea7386790c80de8807e9f1b7467426f3"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="driver__ds18b20__alarm_8c.html#aea7386790c80de8807e9f1b7467426f3">ds18b20_alarm_set_threshold</a> (uint8_t rom[8], float low, float high)</td></tr>
<tr class="memdesc:aea7386790c80de8807e9f1b7467426f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">alarm example set the threshold <a href="driver__ds18b20__alarm_8c.html#aea7386790c80de8807e9f1b7467426f3">More...</a><br /></td></tr>
<tr class="separator:aea7386790c80de8807e9f1b7467426f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af399ae219cf762344c9bcf9af5177636"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="driver__ds18b20__alarm_8c.html#af399ae219cf762344c9bcf9af5177636">ds18b20_alarm_get_threshold</a> (uint8_t rom[8], float *low, float *high)</td></tr>
<tr class="memdesc:af399ae219cf762344c9bcf9af5177636"><td class="mdescLeft">&#160;</td><td class="mdescRight">alarm example get the threshold <a href="driver__ds18b20__alarm_8c.html#af399ae219cf762344c9bcf9af5177636">More...</a><br /></td></tr>
<tr class="separator:af399ae219cf762344c9bcf9af5177636"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23feb959a6ccf44bfa06138c5ae73319"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="driver__ds18b20__alarm_8c.html#a23feb959a6ccf44bfa06138c5ae73319">ds18b20_alarm_search</a> (uint8_t(*rom)[8], uint8_t *num)</td></tr>
<tr class="memdesc:a23feb959a6ccf44bfa06138c5ae73319"><td class="mdescLeft">&#160;</td><td class="mdescRight">alarm example find <a href="driver__ds18b20__alarm_8c.html#a23feb959a6ccf44bfa06138c5ae73319">More...</a><br /></td></tr>
<tr class="separator:a23feb959a6ccf44bfa06138c5ae73319"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6872277417e0d85467d391c591d182e0"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="driver__ds18b20__alarm_8c.html#a6872277417e0d85467d391c591d182e0">ds18b20_alarm_deinit</a> (void)</td></tr>
<tr class="memdesc:a6872277417e0d85467d391c591d182e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">alarm example deinit <a href="driver__ds18b20__alarm_8c.html#a6872277417e0d85467d391c591d182e0">More...</a><br /></td></tr>
<tr class="separator:a6872277417e0d85467d391c591d182e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaceca818b591b2a75bf7587264df98e5a"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ds18b20__example__driver.html#gaceca818b591b2a75bf7587264df98e5a">ds18b20_alarm_init</a> (void)</td></tr>
<tr class="memdesc:gaceca818b591b2a75bf7587264df98e5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">alarm example init <a href="group__ds18b20__example__driver.html#gaceca818b591b2a75bf7587264df98e5a">More...</a><br /></td></tr>
<tr class="separator:gaceca818b591b2a75bf7587264df98e5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaea7386790c80de8807e9f1b7467426f3"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ds18b20__example__driver.html#gaea7386790c80de8807e9f1b7467426f3">ds18b20_alarm_set_threshold</a> (uint8_t rom[8], float low, float high)</td></tr>
<tr class="memdesc:gaea7386790c80de8807e9f1b7467426f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">alarm example set the threshold <a href="group__ds18b20__example__driver.html#gaea7386790c80de8807e9f1b7467426f3">More...</a><br /></td></tr>
<tr class="separator:gaea7386790c80de8807e9f1b7467426f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf399ae219cf762344c9bcf9af5177636"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ds18b20__example__driver.html#gaf399ae219cf762344c9bcf9af5177636">ds18b20_alarm_get_threshold</a> (uint8_t rom[8], float *low, float *high)</td></tr>
<tr class="memdesc:gaf399ae219cf762344c9bcf9af5177636"><td class="mdescLeft">&#160;</td><td class="mdescRight">alarm example get the threshold <a href="group__ds18b20__example__driver.html#gaf399ae219cf762344c9bcf9af5177636">More...</a><br /></td></tr>
<tr class="separator:gaf399ae219cf762344c9bcf9af5177636"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga23feb959a6ccf44bfa06138c5ae73319"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ds18b20__example__driver.html#ga23feb959a6ccf44bfa06138c5ae73319">ds18b20_alarm_search</a> (uint8_t(*rom)[8], uint8_t *num)</td></tr>
<tr class="memdesc:ga23feb959a6ccf44bfa06138c5ae73319"><td class="mdescLeft">&#160;</td><td class="mdescRight">alarm example find <a href="group__ds18b20__example__driver.html#ga23feb959a6ccf44bfa06138c5ae73319">More...</a><br /></td></tr>
<tr class="separator:ga23feb959a6ccf44bfa06138c5ae73319"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6872277417e0d85467d391c591d182e0"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ds18b20__example__driver.html#ga6872277417e0d85467d391c591d182e0">ds18b20_alarm_deinit</a> (void)</td></tr>
<tr class="memdesc:ga6872277417e0d85467d391c591d182e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">alarm example deinit <a href="group__ds18b20__example__driver.html#ga6872277417e0d85467d391c591d182e0">More...</a><br /></td></tr>
<tr class="separator:ga6872277417e0d85467d391c591d182e0"><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>driver ds18b20 alarm source file </p>
Expand All @@ -136,213 +136,7 @@ <h3>history</h3>
</table>

<p class="definition">Definition in file <a class="el" href="driver__ds18b20__alarm_8c_source.html">driver_ds18b20_alarm.c</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a6872277417e0d85467d391c591d182e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6872277417e0d85467d391c591d182e0">&#9670;&nbsp;</a></span>ds18b20_alarm_deinit()</h2>

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

<p>alarm example deinit </p>
<dl class="section return"><dt>Returns</dt><dd>status code<ul>
<li>0 success</li>
<li>1 deinit failed </li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>none </dd></dl>

<p class="definition">Definition at line <a class="el" href="driver__ds18b20__alarm_8c_source.html#l00210">210</a> of file <a class="el" href="driver__ds18b20__alarm_8c_source.html">driver_ds18b20_alarm.c</a>.</p>

</div>
</div>
<a id="af399ae219cf762344c9bcf9af5177636"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af399ae219cf762344c9bcf9af5177636">&#9670;&nbsp;</a></span>ds18b20_alarm_get_threshold()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t ds18b20_alarm_get_threshold </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>rom</em>[8], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float *&#160;</td>
<td class="paramname"><em>low</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float *&#160;</td>
<td class="paramname"><em>high</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">

<p>alarm example get the threshold </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">*rom</td><td>points to a rom buffer </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">*low</td><td>points to a low threshold </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">*high</td><td>points to a high threshold </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status code<ul>
<li>0 success</li>
<li>1 get threshold failed </li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>none </dd></dl>

<p class="definition">Definition at line <a class="el" href="driver__ds18b20__alarm_8c_source.html#l00144">144</a> of file <a class="el" href="driver__ds18b20__alarm_8c_source.html">driver_ds18b20_alarm.c</a>.</p>

</div>
</div>
<a id="aceca818b591b2a75bf7587264df98e5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aceca818b591b2a75bf7587264df98e5a">&#9670;&nbsp;</a></span>ds18b20_alarm_init()</h2>

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

<p>alarm example init </p>
<dl class="section return"><dt>Returns</dt><dd>status code<ul>
<li>0 success</li>
<li>1 init failed </li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>none </dd></dl>

<p class="definition">Definition at line <a class="el" href="driver__ds18b20__alarm_8c_source.html#l00049">49</a> of file <a class="el" href="driver__ds18b20__alarm_8c_source.html">driver_ds18b20_alarm.c</a>.</p>

</div>
</div>
<a id="a23feb959a6ccf44bfa06138c5ae73319"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23feb959a6ccf44bfa06138c5ae73319">&#9670;&nbsp;</a></span>ds18b20_alarm_search()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t ds18b20_alarm_search </td>
<td>(</td>
<td class="paramtype">uint8_t(*)&#160;</td>
<td class="paramname"><em>rom</em>[8], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>num</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">

<p>alarm example find </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">*rom</td><td>points to a rom buffer </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">*num</td><td>points to a number buffer </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status code<ul>
<li>0 success</li>
<li>1 search failed </li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>none </dd></dl>

<p class="definition">Definition at line <a class="el" href="driver__ds18b20__alarm_8c_source.html#l00190">190</a> of file <a class="el" href="driver__ds18b20__alarm_8c_source.html">driver_ds18b20_alarm.c</a>.</p>

</div>
</div>
<a id="aea7386790c80de8807e9f1b7467426f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea7386790c80de8807e9f1b7467426f3">&#9670;&nbsp;</a></span>ds18b20_alarm_set_threshold()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t ds18b20_alarm_set_threshold </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>rom</em>[8], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>low</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>high</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">

<p>alarm example set the threshold </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">*rom</td><td>points to a rom buffer </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">low</td><td>is the low threshold </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">high</td><td>is the high threshold </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status code<ul>
<li>0 success</li>
<li>1 set threshold failed </li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>none </dd></dl>

<p class="definition">Definition at line <a class="el" href="driver__ds18b20__alarm_8c_source.html#l00097">97</a> of file <a class="el" href="driver__ds18b20__alarm_8c_source.html">driver_ds18b20_alarm.c</a>.</p>

</div>
</div>
</div><!-- contents -->
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
Expand Down
10 changes: 5 additions & 5 deletions doc/html/driver__ds18b20__alarm_8c.js
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
var driver__ds18b20__alarm_8c =
[
[ "ds18b20_alarm_deinit", "driver__ds18b20__alarm_8c.html#a6872277417e0d85467d391c591d182e0", null ],
[ "ds18b20_alarm_get_threshold", "driver__ds18b20__alarm_8c.html#af399ae219cf762344c9bcf9af5177636", null ],
[ "ds18b20_alarm_init", "driver__ds18b20__alarm_8c.html#aceca818b591b2a75bf7587264df98e5a", null ],
[ "ds18b20_alarm_search", "driver__ds18b20__alarm_8c.html#a23feb959a6ccf44bfa06138c5ae73319", null ],
[ "ds18b20_alarm_set_threshold", "driver__ds18b20__alarm_8c.html#aea7386790c80de8807e9f1b7467426f3", null ]
[ "ds18b20_alarm_deinit", "group__ds18b20__example__driver.html#ga6872277417e0d85467d391c591d182e0", null ],
[ "ds18b20_alarm_get_threshold", "group__ds18b20__example__driver.html#gaf399ae219cf762344c9bcf9af5177636", null ],
[ "ds18b20_alarm_init", "group__ds18b20__example__driver.html#gaceca818b591b2a75bf7587264df98e5a", null ],
[ "ds18b20_alarm_search", "group__ds18b20__example__driver.html#ga23feb959a6ccf44bfa06138c5ae73319", null ],
[ "ds18b20_alarm_set_threshold", "group__ds18b20__example__driver.html#gaea7386790c80de8807e9f1b7467426f3", null ]
];
Loading

0 comments on commit 21a3906

Please sign in to comment.