fix: fix doc errors

Author: libdriver

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.0.2 (2024-12-08)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 1.0.1 (2024-08-05)
 
 ## Bug Fixes

doc/html/group__hdc1080__base__driver.html

@@ -376,7 +376,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga882e726d24d6231e8eeb4b3
 <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 hdc1080 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an hdc1080 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -422,8 +422,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga351e7def5115c8b872a8c7c
 <p>get battery status </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 hdc1080 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*status</td><td>points to a battery status buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an hdc1080 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*status</td><td>pointer to a battery status buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -469,8 +469,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gae58f8451e96e8684e929f77
 <p>get the heater status </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 hdc1080 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 an hdc1080 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>
@@ -516,8 +516,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaac56cf04fb81e6804b51723
 <p>get humidity resolution </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 hdc1080 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*resolution</td><td>points to a humidity resolution buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an hdc1080 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*resolution</td><td>pointer to a humidity resolution buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -563,8 +563,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf859e8ef5aafb6f21b1d8fe
 <p>get the chip 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 an hdc1080 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*mode</td><td>points to a mode buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an hdc1080 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*mode</td><td>pointer to a mode buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -610,8 +610,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga14506096112b737c8a7b6a9
 <p>get serial id </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 hdc1080 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*id</td><td>points to an id buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an hdc1080 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*id</td><td>pointer to an id buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -657,8 +657,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga2539ab78b7812d823fc2f73
 <p>get temperature resolution </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 hdc1080 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*resolution</td><td>points to a temperature resolution buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an hdc1080 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*resolution</td><td>pointer to a temperature resolution buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -694,7 +694,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga242aea46d72a3c67e9b2d09
 <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 hdc1080 info structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*info</td><td>pointer to an hdc1080 info structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -728,7 +728,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gac20dc3eba62b08c6de3321e
 <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 hdc1080 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an hdc1080 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -783,9 +783,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga30f519eeb9eef3bc858ead8
 <p>read the humidity 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 an hdc1080 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*humidity_raw</td><td>points to a raw humidity buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*humidity_s</td><td>points to a converted humidity buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an hdc1080 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*humidity_raw</td><td>pointer to a raw humidity buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*humidity_s</td><td>pointer to a converted humidity buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -837,9 +837,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf42a953488ee2927f7d3b14
 <p>read the temperature </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 hdc1080 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*temperature_raw</td><td>points to a raw temperature buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*temperature_s</td><td>points to a converted temperature buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an hdc1080 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*temperature_raw</td><td>pointer to a raw temperature buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*temperature_s</td><td>pointer to a converted temperature buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -903,11 +903,11 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga81362bb9f229a50a758136f
 <p>read the temperature and humidity 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 an hdc1080 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*temperature_raw</td><td>points to a raw temperature buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*temperature_s</td><td>points to a converted temperature buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*humidity_raw</td><td>points to a raw humidity buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*humidity_s</td><td>points to a converted humidity buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an hdc1080 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*temperature_raw</td><td>pointer to a raw temperature buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*temperature_s</td><td>pointer to a converted temperature buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*humidity_raw</td><td>pointer to a raw humidity buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*humidity_s</td><td>pointer to a converted humidity buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -953,8 +953,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga8bea4f4651cb3cced0b4d42
 <p>enable or disable heater </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 hdc1080 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 an hdc1080 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>bool value </td></tr>
   </table>
   </dd>
 </dl>
@@ -1000,8 +1000,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaaf1e18b35c06510e3ef4aa9
 <p>set humidity resolution </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 hdc1080 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">resolution</td><td>is the humidity resolution </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an hdc1080 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">resolution</td><td>humidity resolution </td></tr>
   </table>
   </dd>
 </dl>
@@ -1047,8 +1047,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaaa3d658cf4807a8331e1d7b
 <p>set the chip 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 an hdc1080 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>is the set mode </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an hdc1080 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>chip mode </td></tr>
   </table>
   </dd>
 </dl>
@@ -1094,8 +1094,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gafccb126e6a9c022d6bfc0eb
 <p>set temperature resolution </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 hdc1080 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">resolution</td><td>is the temperature resolution </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an hdc1080 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">resolution</td><td>temperature resolution </td></tr>
   </table>
   </dd>
 </dl>
@@ -1131,7 +1131,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gae975756a22e4edbb352b37d
 <p>software reset </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 hdc1080 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an hdc1080 handle structure </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__hdc1080__example__driver.html

@@ -278,8 +278,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga2b302a2a2111f206543bff3
 <p>basic example read </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*temperature</td><td>points to a converted temperature buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*humidity</td><td>points to a converted humidity buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*temperature</td><td>pointer to a converted temperature buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*humidity</td><td>pointer to a converted humidity buffer </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__hdc1080__extend__driver.html

@@ -141,9 +141,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga2ef81a8c2ae19eab938988d
 <p>get 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 an hdc1080 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>is the read register address </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*data</td><td>points to a data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an hdc1080 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>register address </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*data</td><td>pointer to a data buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -195,9 +195,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gafb064181e8d51396204e6f9
 <p>set 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 an hdc1080 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>is the write register address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>is the write data </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an hdc1080 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>register address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>written data </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__hdc1080__interface__driver.html

@@ -150,7 +150,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga55399a3475d6ac34da2096f
 <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>
@@ -179,7 +179,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaa1097e5d053af09713eb4cf
 <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>
@@ -286,10 +286,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaab641944451fe7154ca25f6
 <p>interface iic bus read </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 write address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>is the iic register address </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 length of the data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>iic device write address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>iic register address </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>length of the data buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -345,10 +345,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga50157e2898bafcee5dd6e31
 <p>interface iic bus read with wait </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 write address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>is the iic register address </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 length of the data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>iic device write address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>iic register address </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>length of the data buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -404,10 +404,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf9eef84d96d71ac59966050
 <p>interface iic bus write </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 write address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>is the iic register address </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 length of the data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>iic device write address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>iic register address </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>length of the data buffer </td></tr>
   </table>
   </dd>
 </dl>