Merge pull request #22 from libdriver/dev

fix: fix doc errors

Author: libdriver

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.0.2 (2024-12-21)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 2.0.1 (2024-08-10)
 
 ## Bug Fixes

doc/html/group__pcf8591__base__driver.html

@@ -393,9 +393,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga020ba9f4bcaf91a966fa795
 <p>convert a dac value to a register raw data </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 a pcf8591 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">dac</td><td>is a converted dac value </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*reg</td><td>points to a register raw buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a pcf8591 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">dac</td><td>converted dac value </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*reg</td><td>pointer to a register raw buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -430,7 +430,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gac8910d5e29cfdaf4aba0f9f
 <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 a pcf8591 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a pcf8591 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -476,8 +476,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga6b7b4a26473158a84565a31
 <p>get the 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 a pcf8591 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*addr_pin</td><td>points to a chip address pins buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a pcf8591 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*addr_pin</td><td>pointer to a chip address pins buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -521,8 +521,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga3bf3fefc3ff64a69db20f81
 <p>get the adc auto increment read mode </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 a pcf8591 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*enable</td><td>points to a bool value buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a pcf8591 handle structure </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>
@@ -567,8 +567,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga1b89f2a27fbf992a7ea6291
 <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 a pcf8591 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*channel</td><td>points to an adc channel buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a pcf8591 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*channel</td><td>pointer to an adc channel buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -613,8 +613,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga7636444b3f59c57d92ebdf8
 <p>get the adc mode </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 a pcf8591 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*mode</td><td>points to an adc mode buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a pcf8591 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*mode</td><td>pointer to an adc mode buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -659,8 +659,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga9b94fdde9cd15430b01efe7
 <p>get the adc reference voltage </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 a pcf8591 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*ref_voltage</td><td>points to an adc reference voltage buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a pcf8591 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*ref_voltage</td><td>pointer to an adc reference voltage buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -695,7 +695,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga0c522639b1a95beb4edb8db
 <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 a pcf8591 info structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*info</td><td>pointer to a pcf8591 info structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -729,7 +729,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga2ca386791960303ac6c0309
 <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 a pcf8591 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a pcf8591 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -787,10 +787,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga4b82a0a9a1f4ebc8bf6bf9e
 <p>read the multiple channel data from 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 a pcf8591 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">*adc</td><td>points to a converted adc buffer </td></tr>
-    <tr><td class="paramdir">[in,out]</td><td class="paramname">*len</td><td>points to an adc length buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a pcf8591 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">*adc</td><td>pointer to a converted adc buffer </td></tr>
+    <tr><td class="paramdir">[in,out]</td><td class="paramname">*len</td><td>pointer to an adc length buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -842,9 +842,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga0b39dca43839c19d3ec6e0b
 <p>read data from 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 a pcf8591 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">*adc</td><td>points to a converted adc buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a pcf8591 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">*adc</td><td>pointer to a converted adc buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -890,8 +890,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga1b674f6f1a1fc601617b690
 <p>set the 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 a pcf8591 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>is the chip address pins </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a pcf8591 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>chip address pins </td></tr>
   </table>
   </dd>
 </dl>
@@ -935,8 +935,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf6ae6ea059b986cd3074649
 <p>set the adc auto increment read mode </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 a pcf8591 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>is a bool value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a pcf8591 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>bool value </td></tr>
   </table>
   </dd>
 </dl>
@@ -982,8 +982,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga6abca278ca1c99c4a5e1a0d
 <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 a pcf8591 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 a pcf8591 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">channel</td><td>adc channel </td></tr>
   </table>
   </dd>
 </dl>
@@ -1029,8 +1029,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga58e39aaf064b360541c8a2f
 <p>set the adc mode </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 a pcf8591 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>is the adc mode </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a pcf8591 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>adc mode </td></tr>
   </table>
   </dd>
 </dl>
@@ -1076,8 +1076,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga66e04d5b655adbdbb4ae475
 <p>set the adc reference voltage </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 a pcf8591 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">ref_voltage</td><td>is the adc reference voltage </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a pcf8591 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">ref_voltage</td><td>adc reference voltage </td></tr>
   </table>
   </dd>
 </dl>
@@ -1122,8 +1122,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga1d6327acfcb231d13be8295
 <p>write to the dac </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 a pcf8591 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>is the dac value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a pcf8591 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>dac value </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__pcf8591__example__driver.html

@@ -233,8 +233,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga71e7a511f7541292975a421
 <p>basic example init </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>is the iic device address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>is the adc mode </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>iic device address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>adc mode </td></tr>
   </table>
   </dd>
 </dl>
@@ -278,8 +278,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga479a5a31c9d239209625030
 <p>basic example read the adc </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <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">*adc</td><td>points to a converted adc buffer </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">*adc</td><td>pointer to a converted adc buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -313,7 +313,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga613fbe7c6ff5ed9a4a8b9f6
 <p>basic example set the channel </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <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">channel</td><td>adc channel </td></tr>
   </table>
   </dd>
 </dl>
@@ -347,7 +347,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaa77694966f650bcd5140ed2
 <p>basic example write the dac </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">dac</td><td>is a converted dac value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">dac</td><td>converted dac value </td></tr>
   </table>
   </dd>
 </dl>
@@ -419,8 +419,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga104ac87d4afd92b148bf0a4
 <p>increment example init </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>is the iic device address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>is the adc mode </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>iic device address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>adc mode </td></tr>
   </table>
   </dd>
 </dl>
@@ -470,9 +470,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga256ce26b3f9203c33c0b0ce
 <p>increment example read the adc </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <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">*adc</td><td>points to a converted adc buffer </td></tr>
-    <tr><td class="paramdir">[in,out]</td><td class="paramname">*len</td><td>points to a input buffer length address </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">*adc</td><td>pointer to a converted adc buffer </td></tr>
+    <tr><td class="paramdir">[in,out]</td><td class="paramname">*len</td><td>pointer to a input buffer length address </td></tr>
   </table>
   </dd>
 </dl>
@@ -506,7 +506,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga44fed10e2dd370f7b315aa8
 <p>increment example write the dac </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">dac</td><td>is a converted dac value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">dac</td><td>converted dac value </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__pcf8591__extern__driver.html

@@ -141,9 +141,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gac14d76f8f19207991bc4295
 <p>get the chip 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 a pcf8591 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</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 buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a pcf8591 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</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 buffer length </td></tr>
   </table>
   </dd>
 </dl>
@@ -195,9 +195,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gafe8bc995155299255e0b299
 <p>set the chip 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 a pcf8591 handle structure </td></tr>
-    <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 buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a pcf8591 handle structure </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 buffer length </td></tr>
   </table>
   </dd>
 </dl>