Merge pull request #38 from libdriver/dev

fix: fix doc errors

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.0.2 (2024-11-29)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 2.0.1 (2024-08-05)
 
 ## Bug Fixes

doc/html/driver__ads1115__register__test_8c_source.html

@@ -860,8 +860,8 @@
 <div class="line"><a name="l00815"></a><span class="lineno">  815</span>&#160;    </div>
 <div class="line"><a name="l00816"></a><span class="lineno">  816</span>&#160;    <span class="comment">/* ads1115_set_compare_threshold/ads1115_get_compare_threshold test */</span></div>
 <div class="line"><a name="l00817"></a><span class="lineno">  817</span>&#160;    <a class="code" href="group__ads1115__interface__driver.html#ga7a540a82ef71d79205a93d367091cff8">ads1115_interface_debug_print</a>(<span class="stringliteral">&quot;ads1115: ads1115_set_compare_threshold/ads1115_get_compare_threshold test.\n&quot;</span>);</div>
-<div class="line"><a name="l00818"></a><span class="lineno">  818</span>&#160;    high_threshold_before = rand()%8196;</div>
-<div class="line"><a name="l00819"></a><span class="lineno">  819</span>&#160;    low_threshold_before = -rand()%8196;</div>
+<div class="line"><a name="l00818"></a><span class="lineno">  818</span>&#160;    high_threshold_before = rand() % 8196;</div>
+<div class="line"><a name="l00819"></a><span class="lineno">  819</span>&#160;    low_threshold_before = -rand() % 8196;</div>
 <div class="line"><a name="l00820"></a><span class="lineno">  820</span>&#160;    res = <a class="code" href="group__ads1115__interrupt__driver.html#ga4c22e17d86270d8e550d9132e304d2d6">ads1115_set_compare_threshold</a>(&amp;gs_handle, high_threshold_before, low_threshold_before);</div>
 <div class="line"><a name="l00821"></a><span class="lineno">  821</span>&#160;    <span class="keywordflow">if</span> (res != 0)</div>
 <div class="line"><a name="l00822"></a><span class="lineno">  822</span>&#160;    {</div>
@@ -937,7 +937,7 @@
 <div class="line"><a name="l00892"></a><span class="lineno">  892</span>&#160;        </div>
 <div class="line"><a name="l00893"></a><span class="lineno">  893</span>&#160;        <span class="keywordflow">return</span> 1;</div>
 <div class="line"><a name="l00894"></a><span class="lineno">  894</span>&#160;    }</div>
-<div class="line"><a name="l00895"></a><span class="lineno">  895</span>&#160;    f_reg = -(rand()%6144)/1000.0f;</div>
+<div class="line"><a name="l00895"></a><span class="lineno">  895</span>&#160;    f_reg = -(rand() % 6144) / 1000.0f;</div>
 <div class="line"><a name="l00896"></a><span class="lineno">  896</span>&#160;    <a class="code" href="group__ads1115__interface__driver.html#ga7a540a82ef71d79205a93d367091cff8">ads1115_interface_debug_print</a>(<span class="stringliteral">&quot;ads1115: convert to register %0.2fV.\n&quot;</span>, f_reg);</div>
 <div class="line"><a name="l00897"></a><span class="lineno">  897</span>&#160;    res = <a class="code" href="group__ads1115__interrupt__driver.html#ga4c0ac892b7b5b7260482ddda16f53813">ads1115_convert_to_register</a>(&amp;gs_handle, f_reg, (int16_t *)&amp;reg);</div>
 <div class="line"><a name="l00898"></a><span class="lineno">  898</span>&#160;    <span class="keywordflow">if</span> (res != 0)</div>
@@ -958,7 +958,7 @@
 <div class="line"><a name="l00913"></a><span class="lineno">  913</span>&#160;        </div>
 <div class="line"><a name="l00914"></a><span class="lineno">  914</span>&#160;        <span class="keywordflow">return</span> 1;</div>
 <div class="line"><a name="l00915"></a><span class="lineno">  915</span>&#160;    }</div>
-<div class="line"><a name="l00916"></a><span class="lineno">  916</span>&#160;    f_reg = (rand()%4096)/1000.0f;</div>
+<div class="line"><a name="l00916"></a><span class="lineno">  916</span>&#160;    f_reg = (rand() % 4096) / 1000.0f;</div>
 <div class="line"><a name="l00917"></a><span class="lineno">  917</span>&#160;    <a class="code" href="group__ads1115__interface__driver.html#ga7a540a82ef71d79205a93d367091cff8">ads1115_interface_debug_print</a>(<span class="stringliteral">&quot;ads1115: convert to register %0.2fV.\n&quot;</span>, f_reg);</div>
 <div class="line"><a name="l00918"></a><span class="lineno">  918</span>&#160;    res = <a class="code" href="group__ads1115__interrupt__driver.html#ga4c0ac892b7b5b7260482ddda16f53813">ads1115_convert_to_register</a>(&amp;gs_handle, f_reg, (int16_t *)&amp;reg);</div>
 <div class="line"><a name="l00919"></a><span class="lineno">  919</span>&#160;    <span class="keywordflow">if</span> (res != 0)</div>
@@ -979,7 +979,7 @@
 <div class="line"><a name="l00934"></a><span class="lineno">  934</span>&#160;        </div>
 <div class="line"><a name="l00935"></a><span class="lineno">  935</span>&#160;        <span class="keywordflow">return</span> 1;</div>
 <div class="line"><a name="l00936"></a><span class="lineno">  936</span>&#160;    }</div>
-<div class="line"><a name="l00937"></a><span class="lineno">  937</span>&#160;    f_reg = -(rand()%2048)/1000.0f;</div>
+<div class="line"><a name="l00937"></a><span class="lineno">  937</span>&#160;    f_reg = -(rand() % 2048) / 1000.0f;</div>
 <div class="line"><a name="l00938"></a><span class="lineno">  938</span>&#160;    <a class="code" href="group__ads1115__interface__driver.html#ga7a540a82ef71d79205a93d367091cff8">ads1115_interface_debug_print</a>(<span class="stringliteral">&quot;ads1115: convert to register %0.2fV.\n&quot;</span>, f_reg);</div>
 <div class="line"><a name="l00939"></a><span class="lineno">  939</span>&#160;    res = <a class="code" href="group__ads1115__interrupt__driver.html#ga4c0ac892b7b5b7260482ddda16f53813">ads1115_convert_to_register</a>(&amp;gs_handle, f_reg, (int16_t *)&amp;reg);</div>
 <div class="line"><a name="l00940"></a><span class="lineno">  940</span>&#160;    <span class="keywordflow">if</span> (res != 0)</div>
@@ -1000,7 +1000,7 @@
 <div class="line"><a name="l00955"></a><span class="lineno">  955</span>&#160;        </div>
 <div class="line"><a name="l00956"></a><span class="lineno">  956</span>&#160;        <span class="keywordflow">return</span> 1;</div>
 <div class="line"><a name="l00957"></a><span class="lineno">  957</span>&#160;    }</div>
-<div class="line"><a name="l00958"></a><span class="lineno">  958</span>&#160;    f_reg = (rand()%1024)/1000.0f;</div>
+<div class="line"><a name="l00958"></a><span class="lineno">  958</span>&#160;    f_reg = (rand() % 1024) / 1000.0f;</div>
 <div class="line"><a name="l00959"></a><span class="lineno">  959</span>&#160;    <a class="code" href="group__ads1115__interface__driver.html#ga7a540a82ef71d79205a93d367091cff8">ads1115_interface_debug_print</a>(<span class="stringliteral">&quot;ads1115: convert to register %0.2fV.\n&quot;</span>, f_reg);</div>
 <div class="line"><a name="l00960"></a><span class="lineno">  960</span>&#160;    res = <a class="code" href="group__ads1115__interrupt__driver.html#ga4c0ac892b7b5b7260482ddda16f53813">ads1115_convert_to_register</a>(&amp;gs_handle, f_reg, (int16_t *)&amp;reg);</div>
 <div class="line"><a name="l00961"></a><span class="lineno">  961</span>&#160;    <span class="keywordflow">if</span> (res != 0)</div>
@@ -1021,7 +1021,7 @@
 <div class="line"><a name="l00976"></a><span class="lineno">  976</span>&#160;        </div>
 <div class="line"><a name="l00977"></a><span class="lineno">  977</span>&#160;        <span class="keywordflow">return</span> 1;</div>
 <div class="line"><a name="l00978"></a><span class="lineno">  978</span>&#160;    }</div>
-<div class="line"><a name="l00979"></a><span class="lineno">  979</span>&#160;    f_reg = -(rand()%512)/1000.0f;</div>
+<div class="line"><a name="l00979"></a><span class="lineno">  979</span>&#160;    f_reg = -(rand() % 512) / 1000.0f;</div>
 <div class="line"><a name="l00980"></a><span class="lineno">  980</span>&#160;    <a class="code" href="group__ads1115__interface__driver.html#ga7a540a82ef71d79205a93d367091cff8">ads1115_interface_debug_print</a>(<span class="stringliteral">&quot;ads1115: convert to register %0.2fV.\n&quot;</span>, f_reg);</div>
 <div class="line"><a name="l00981"></a><span class="lineno">  981</span>&#160;    res = <a class="code" href="group__ads1115__interrupt__driver.html#ga4c0ac892b7b5b7260482ddda16f53813">ads1115_convert_to_register</a>(&amp;gs_handle, f_reg, (int16_t *)&amp;reg);</div>
 <div class="line"><a name="l00982"></a><span class="lineno">  982</span>&#160;    <span class="keywordflow">if</span> (res != 0)</div>
@@ -1042,7 +1042,7 @@
 <div class="line"><a name="l00997"></a><span class="lineno">  997</span>&#160;        </div>
 <div class="line"><a name="l00998"></a><span class="lineno">  998</span>&#160;        <span class="keywordflow">return</span> 1;</div>
 <div class="line"><a name="l00999"></a><span class="lineno">  999</span>&#160;    }</div>
-<div class="line"><a name="l01000"></a><span class="lineno"> 1000</span>&#160;    f_reg = (rand()%256)/1000.0f;</div>
+<div class="line"><a name="l01000"></a><span class="lineno"> 1000</span>&#160;    f_reg = (rand() % 256) / 1000.0f;</div>
 <div class="line"><a name="l01001"></a><span class="lineno"> 1001</span>&#160;    <a class="code" href="group__ads1115__interface__driver.html#ga7a540a82ef71d79205a93d367091cff8">ads1115_interface_debug_print</a>(<span class="stringliteral">&quot;ads1115: convert to register %0.2fV.\n&quot;</span>, f_reg);</div>
 <div class="line"><a name="l01002"></a><span class="lineno"> 1002</span>&#160;    res = <a class="code" href="group__ads1115__interrupt__driver.html#ga4c0ac892b7b5b7260482ddda16f53813">ads1115_convert_to_register</a>(&amp;gs_handle, f_reg, (int16_t *)&amp;reg);</div>
 <div class="line"><a name="l01003"></a><span class="lineno"> 1003</span>&#160;    <span class="keywordflow">if</span> (res != 0)</div>

doc/html/group__ads1115__base__driver.html

@@ -446,9 +446,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf7a5d73594916329726d06e
 <p>read data from the chip continuously </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 ads1115 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*raw</td><td>points to a raw adc buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*v</td><td>points to a converted adc buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an ads1115 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*raw</td><td>pointer to a raw adc buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*v</td><td>pointer to a converted adc buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -484,7 +484,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga53af60470c9978fcb06cb75
 <p>close the chip </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 ads1115 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an ads1115 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -531,8 +531,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga1273652a419ebe96d01236d
 <p>get the iic address pin </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 ads1115 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*addr_pin</td><td>points to a chip iic address pin buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an ads1115 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*addr_pin</td><td>pointer to a chip iic address pin buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -577,8 +577,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga00a22fd9bf891fe65e467bf
 <p>get the adc channel </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 ads1115 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*channel</td><td>points to a channel buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an ads1115 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*channel</td><td>pointer to a channel buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -624,8 +624,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga99caba4678c8e1b4242ec6f
 <p>get the adc range </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 ads1115 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*range</td><td>points to a voltage range buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an ads1115 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*range</td><td>pointer to a voltage range buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -671,8 +671,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga4c1e3a417ecbd1b3b332d22
 <p>get the sample rate </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 ads1115 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*rate</td><td>points to an adc sample rate buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an ads1115 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*rate</td><td>pointer to an adc sample rate buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -708,7 +708,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gab5d10f22011ff65a0ae93bc
 <p>get chip's information </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*info</td><td>points to an ads1115 info structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*info</td><td>pointer to an ads1115 info structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -742,7 +742,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga2a3811d8c153b4cf4c4aa9e
 <p>initialize the chip </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 ads1115 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an ads1115 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -788,8 +788,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga0a8c51a182966607715ef1c
 <p>set the iic address pin </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 ads1115 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>is the chip iic address pin </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an ads1115 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>iic address pin </td></tr>
   </table>
   </dd>
 </dl>
@@ -834,8 +834,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gada00fca9688f42d26abed5c
 <p>set the adc channel </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 ads1115 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">channel</td><td>is the adc channel </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an ads1115 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">channel</td><td>adc channel </td></tr>
   </table>
   </dd>
 </dl>
@@ -881,8 +881,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga714417d725f2af515d530ba
 <p>set the adc range </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 ads1115 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">range</td><td>is the adc max voltage range </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an ads1115 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">range</td><td>adc max voltage range </td></tr>
   </table>
   </dd>
 </dl>
@@ -928,8 +928,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga3361fff2058d0f1a2e9559a
 <p>set the sample rate </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 ads1115 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">rate</td><td>is the adc sample rate </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an ads1115 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">rate</td><td>adc sample rate </td></tr>
   </table>
   </dd>
 </dl>
@@ -981,9 +981,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaa1c65ce42e3da95391dec29
 <p>read data from the chip once </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 ads1115 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*raw</td><td>points to a raw adc buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*v</td><td>points to a converted adc buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an ads1115 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*raw</td><td>pointer to a raw adc buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*v</td><td>pointer to a converted adc buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -1019,7 +1019,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga182b523f8e70e7c114c9e0d
 <p>start the chip reading </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 ads1115 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an ads1115 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -1055,7 +1055,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gacc928e999b87a77dcb45865
 <p>stop the chip reading </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 ads1115 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an ads1115 handle structure </td></tr>
   </table>
   </dd>
 </dl>