fix: fix doc errors

libdriver · Jan 4, 2025 · 191346a · 191346a
1 parent fe239c9
commit 191346a
Show file tree

Hide file tree

Showing 28 changed files with 300 additions and 308 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## 2.0.3 (2025-01-01)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 2.0.2 (2024-08-10)
 
 ## Bug Fixes

diff --git a/doc/html/group__tsl2561__base__driver.html b/doc/html/group__tsl2561__base__driver.html
@@ -335,7 +335,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga28d9692abebc8d1c7c70ef8
 <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 tsl2561 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a tsl2561 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -381,8 +381,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga9a4fcf1b56dfc1e732e48b2
 <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 a tsl2561 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 a tsl2561 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>
@@ -427,8 +427,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gace1a8ffe903b67568b962bf
 <p>get the adc gain </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 tsl2561 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*gain</td><td>points to an adc gain buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a tsl2561 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*gain</td><td>pointer to an adc gain buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -473,8 +473,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga2d2fbb6ecd0b1b8da9d867d
 <p>get the integration time </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 tsl2561 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*t</td><td>points to an integration time buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a tsl2561 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*t</td><td>pointer to an integration time buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -509,7 +509,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaaa69c8839ab2afc4220189f
 <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 tsl2561 info structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*info</td><td>pointer to a tsl2561 info structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -543,7 +543,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga84a50a0c1118ead7fadb6f7
 <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 tsl2561 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a tsl2561 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -579,7 +579,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga2c5931d6badc7ccd1a9f2f1
 <p>power down 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 tsl2561 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a tsl2561 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -637,10 +637,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga173d906891364d617b0f80c
 <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 tsl2561 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*channel_0_raw</td><td>points to a channel 0 raw data </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*channel_1_raw</td><td>points to a channel 1 raw data </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*lux</td><td>points to a converted lux </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a tsl2561 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*channel_0_raw</td><td>pointer to a channel 0 raw data </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*channel_1_raw</td><td>pointer to a channel 1 raw data </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*lux</td><td>pointer to a converted lux </td></tr>
   </table>
   </dd>
 </dl>
@@ -686,8 +686,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga6f162e88076d195caa4b2f0
 <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 a tsl2561 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 a tsl2561 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>chip iic address pin </td></tr>
   </table>
   </dd>
 </dl>
@@ -732,8 +732,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gac665a54c9db148693b8cb7e
 <p>set the adc gain </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 tsl2561 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">gain</td><td>is the adc gain </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a tsl2561 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">gain</td><td>adc gain </td></tr>
   </table>
   </dd>
 </dl>
@@ -778,8 +778,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gad331206ce72a18afca3ccd6
 <p>set the integration time </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 tsl2561 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">t</td><td>is the integration time </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a tsl2561 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">t</td><td>integration time </td></tr>
   </table>
   </dd>
 </dl>
@@ -814,7 +814,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gae080c29275c44f5496977b8
 <p>wake up 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 tsl2561 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a tsl2561 handle structure </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/doc/html/group__tsl2561__example__driver.html b/doc/html/group__tsl2561__example__driver.html
@@ -328,7 +328,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gae3e1c7277b58321d93a1073
 <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_pin</td><td>is the iic device address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>iic device address </td></tr>
   </table>
   </dd>
 </dl>
@@ -362,7 +362,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga92de97b1b97b02bd9cd1e16
 <p>basic example read </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*lux</td><td>points to a lux buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*lux</td><td>pointer to a lux buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -446,10 +446,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaa9fe220ea5fb16f51cec321
 <p>interrupt example init </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>is the iic device address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>is the interrupt mode </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">ch0_low_threshold</td><td>is the channel 0 interrupt low threshold </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">ch0_high_threshold</td><td>is the channel 0 interrupt high threshold </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>iic device address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>interrupt mode </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">ch0_low_threshold</td><td>channel 0 interrupt low threshold </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">ch0_high_threshold</td><td>channel 0 interrupt high threshold </td></tr>
   </table>
   </dd>
 </dl>
@@ -483,7 +483,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaff0ec6d1994bc68d636c68a
 <p>interrupt example read </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*lux</td><td>points to a lux buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*lux</td><td>pointer to a lux buffer </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/doc/html/group__tsl2561__extend__driver.html b/doc/html/group__tsl2561__extend__driver.html
@@ -147,10 +147,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga3464ecf34e3464bac75214f
 <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 tsl2561 handle structure </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 data buffer length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a tsl2561 handle structure </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>data buffer length </td></tr>
   </table>
   </dd>
 </dl>
@@ -208,10 +208,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga9f0ca91fd815cab6067acfd
 <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 tsl2561 handle structure </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 data buffer length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a tsl2561 handle structure </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>data buffer length </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/doc/html/group__tsl2561__interface__driver.html b/doc/html/group__tsl2561__interface__driver.html
@@ -147,7 +147,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga3477a0a39215d6b4fd6ef14
 <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>
@@ -176,7 +176,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf1d2377fef3145b6c570f03
 <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>
@@ -283,10 +283,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga573ea1b7ae198af677bc3b2
 <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>
@@ -342,10 +342,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga98a581f813a5c86a5ab3478
 <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>