Merge pull request #13 from libdriver/dev

fix: fix doc errors

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.0.6 (2024-12-12)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 1.0.5 (2024-11-18)
 
 ## Bug Fixes

doc/html/group__llcc68__example__driver.html

@@ -638,7 +638,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga20120052b0b33bf46e46296
 <p>lora example check packet error </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*enable</td><td>points to a bool value buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*enable</td><td>pointer to a bool value buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -649,7 +649,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga20120052b0b33bf46e46296
 </dd></dl>
 <dl class="section note"><dt>Note</dt><dd>none </dd></dl>
 
-<p class="definition">Definition at line <a class="el" href="driver__llcc68__lora_8c_source.html#l00624">624</a> of file <a class="el" href="driver__llcc68__lora_8c_source.html">driver_llcc68_lora.c</a>.</p>
+<p class="definition">Definition at line <a class="el" href="driver__llcc68__lora_8c_source.html#l00625">625</a> of file <a class="el" href="driver__llcc68__lora_8c_source.html">driver_llcc68_lora.c</a>.</p>
 
 </div>
 </div>
@@ -710,8 +710,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaefbd0fd44cb730769e9dd0d
 <p>lora example get the status </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*rssi</td><td>points to a rssi buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*snr</td><td>points to a snr buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*rssi</td><td>pointer to a rssi buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*snr</td><td>pointer to a snr buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -722,7 +722,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaefbd0fd44cb730769e9dd0d
 </dd></dl>
 <dl class="section note"><dt>Note</dt><dd>none </dd></dl>
 
-<p class="definition">Definition at line <a class="el" href="driver__llcc68__lora_8c_source.html#l00599">599</a> of file <a class="el" href="driver__llcc68__lora_8c_source.html">driver_llcc68_lora.c</a>.</p>
+<p class="definition">Definition at line <a class="el" href="driver__llcc68__lora_8c_source.html#l00600">600</a> of file <a class="el" href="driver__llcc68__lora_8c_source.html">driver_llcc68_lora.c</a>.</p>
 
 </div>
 </div>
@@ -745,7 +745,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gab73c4918560f2c8a62a3ce2
 <p>lora example init </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*callback</td><td>points to a callback address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*callback</td><td>pointer to a callback address </td></tr>
   </table>
   </dd>
 </dl>
@@ -807,7 +807,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga3d109b746bfe2f95048609e
 <p>lora example run the cad </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*enable</td><td>points to a enable buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*enable</td><td>pointer to a enable buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -818,7 +818,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga3d109b746bfe2f95048609e
 </dd></dl>
 <dl class="section note"><dt>Note</dt><dd>none </dd></dl>
 
-<p class="definition">Definition at line <a class="el" href="driver__llcc68__lora_8c_source.html#l00571">571</a> of file <a class="el" href="driver__llcc68__lora_8c_source.html">driver_llcc68_lora.c</a>.</p>
+<p class="definition">Definition at line <a class="el" href="driver__llcc68__lora_8c_source.html#l00572">572</a> of file <a class="el" href="driver__llcc68__lora_8c_source.html">driver_llcc68_lora.c</a>.</p>
 
 </div>
 </div>
@@ -851,8 +851,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga5d873c5c399413df78e9117
 <p>lora example send lora data </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*buf</td><td>points to a data buffer </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>is the data length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*buf</td><td>pointer to a data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>data length </td></tr>
   </table>
   </dd>
 </dl>
@@ -863,7 +863,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga5d873c5c399413df78e9117
 </dd></dl>
 <dl class="section note"><dt>Note</dt><dd>none </dd></dl>
 
-<p class="definition">Definition at line <a class="el" href="driver__llcc68__lora_8c_source.html#l00549">549</a> of file <a class="el" href="driver__llcc68__lora_8c_source.html">driver_llcc68_lora.c</a>.</p>
+<p class="definition">Definition at line <a class="el" href="driver__llcc68__lora_8c_source.html#l00550">550</a> of file <a class="el" href="driver__llcc68__lora_8c_source.html">driver_llcc68_lora.c</a>.</p>
 
 </div>
 </div>
@@ -919,7 +919,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gafe0cd4f1d689a68681ab2be
 </dd></dl>
 <dl class="section note"><dt>Note</dt><dd>none </dd></dl>
 
-<p class="definition">Definition at line <a class="el" href="driver__llcc68__lora_8c_source.html#l00521">521</a> of file <a class="el" href="driver__llcc68__lora_8c_source.html">driver_llcc68_lora.c</a>.</p>
+<p class="definition">Definition at line <a class="el" href="driver__llcc68__lora_8c_source.html#l00522">522</a> of file <a class="el" href="driver__llcc68__lora_8c_source.html">driver_llcc68_lora.c</a>.</p>
 
 </div>
 </div>
@@ -940,14 +940,20 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga3638e443351f0ee93685482
 </div><div class="memdoc">
 
 <p>lora example enter to the shot receive mode </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramdir">[in]</td><td class="paramname">us</td><td>time in us </td></tr>
+  </table>
+  </dd>
+</dl>
 <dl class="section return"><dt>Returns</dt><dd>status code<ul>
 <li>0 success</li>
 <li>1 enter 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__llcc68__lora_8c_source.html#l00461">461</a> of file <a class="el" href="driver__llcc68__lora_8c_source.html">driver_llcc68_lora.c</a>.</p>
+<p class="definition">Definition at line <a class="el" href="driver__llcc68__lora_8c_source.html#l00462">462</a> of file <a class="el" href="driver__llcc68__lora_8c_source.html">driver_llcc68_lora.c</a>.</p>
 
 </div>
 </div>

doc/html/group__llcc68__extern__driver.html

@@ -150,11 +150,11 @@ <h2 class="memtitle"><span class="permalink"><a href="#gad8d4b66dbe7f0b7939fe806
 <p>write and read register </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>points to an llcc68 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*in_buf</td><td>points to an input buffer </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">in_len</td><td>is the input length </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*out_buf</td><td>points to an output buffer </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">out_len</td><td>is the output length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an llcc68 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*in_buf</td><td>pointer to an input buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">in_len</td><td>input length </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*out_buf</td><td>pointer to an output buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">out_len</td><td>output length </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__llcc68__interface__driver.html

@@ -211,7 +211,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga29d1f24134f0224f1dd4125
 <p>interface busy gpio read </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*value</td><td>points to a value buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*value</td><td>pointer to a value buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -255,7 +255,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gac2fce1fe77dbf76dace4c91
 <p>interface print format data </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">fmt</td><td>is the format data </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">fmt</td><td>format data </td></tr>
   </table>
   </dd>
 </dl>
@@ -284,7 +284,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gac629a17da5f2e066e60b3ef
 <p>interface delay ms </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">ms</td><td></td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">ms</td><td>time </td></tr>
   </table>
   </dd>
 </dl>
@@ -329,9 +329,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaa18d360d59376da33060a17
 <p>interface receive callback </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>is the receive callback type </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*buf</td><td>points to a buffer address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>is the buffer length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>receive callback type </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*buf</td><td>pointer to a buffer address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>buffer length </td></tr>
   </table>
   </dd>
 </dl>
@@ -416,7 +416,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf306a5d478b9cb0cc4f855b
 <p>interface reset gpio write </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>is the written data </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>written data </td></tr>
   </table>
   </dd>
 </dl>
@@ -528,10 +528,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga6249185ed7b26c1d00555f6
 <p>interface spi bus write read </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*in_buf</td><td>points to a input buffer </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">in_len</td><td>is the input length </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*out_buf</td><td>points to a output buffer </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">out_len</td><td>is the output length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*in_buf</td><td>pointer to a input buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">in_len</td><td>input length </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*out_buf</td><td>pointer to a output buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">out_len</td><td>output length </td></tr>
   </table>
   </dd>
 </dl>