Merge pull request #16 from libdriver/dev

fix: fix doc errors

Author: libdriver

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.0.3 (2024-12-16)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 1.0.2 (2024-09-28)
 
 ## Bug Fixes

doc/html/group__mlx90614__advance__driver.html

@@ -230,7 +230,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gace5c4919a7c0dd1b200b86b
 <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 mlx90614 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an mlx90614 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -276,8 +276,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga616e3882fd6eb20e6149678
 <p>get the address </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 mlx90614 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*addr</td><td>point to an iic address buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an mlx90614 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*addr</td><td>pointer to an iic address buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -311,7 +311,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga523d9d677f8e83e6649752f
 <p>get chip 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 mlx90614 info structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*info</td><td>pointer to an mlx90614 info structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -345,7 +345,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga92df0bcb60fde45d9c9bc6f
 <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 mlx90614 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an mlx90614 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -397,9 +397,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gabb7bd4100d5919c6f92cafd
 <p>read the ambient </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 mlx90614 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*raw</td><td>points to a raw data buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*celsius</td><td>points to a celsius data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an mlx90614 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*raw</td><td>pointer to a raw data buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*celsius</td><td>pointer to a celsius data buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -451,9 +451,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga4dfa852dfddcacf00289c8e
 <p>read the object1 </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 mlx90614 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*raw</td><td>points to a raw data buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*celsius</td><td>points to a celsius data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an mlx90614 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*raw</td><td>pointer to a raw data buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*celsius</td><td>pointer to a celsius data buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -506,9 +506,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf37f0f6b980993f5dc1d2c6
 <p>read the object2 </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 mlx90614 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*raw</td><td>points to a raw data buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*celsius</td><td>points to a celsius data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an mlx90614 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*raw</td><td>pointer to a raw data buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*celsius</td><td>pointer to a celsius data buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -561,9 +561,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga41d072dce01de4e2994034b
 <p>read the ir channel 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 an mlx90614 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*channel_1</td><td>points to a channel 1 raw data buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*channel_2</td><td>points to a channel 2 raw data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an mlx90614 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*channel_1</td><td>pointer to a channel 1 raw data buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*channel_2</td><td>pointer to a channel 2 raw data buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -609,8 +609,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gab60b78a1d3c8efe38156b57
 <p>set the address </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 mlx90614 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>is the iic address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an mlx90614 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>iic address </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__mlx90614__basic__driver.html

@@ -160,8 +160,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga44a9b3fbf67e3509fba8076
 <p>read the address </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 mlx90614 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*addr</td><td>points to an iic address buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an mlx90614 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*addr</td><td>pointer to an iic address buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -207,8 +207,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gab33d2c5bdcacdc81b4f453f
 <p>write the address </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 mlx90614 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>is the iic address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an mlx90614 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>iic address </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__mlx90614__driver.html

@@ -428,7 +428,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga8d7a3fffd5a39bfc6236216
 <p>advance example get id </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*id</td><td>points to a id buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*id</td><td>pointer to a id buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -500,8 +500,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga82e8c0ccec3a0d30d8ce46f
 <p>advance example read </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*ambient</td><td>points to a ambient buffer </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*object</td><td>points to a object buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*ambient</td><td>pointer to a ambient buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*object</td><td>pointer to a object buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -601,8 +601,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga8f3fd68621019904732f605
 <p>basic example read </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*ambient</td><td>points to a ambient buffer </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*object</td><td>points to a object buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*ambient</td><td>pointer to a ambient buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*object</td><td>pointer to a object buffer </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__mlx90614__example__driver.html

@@ -141,9 +141,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga4f59923ea8b739761308529
 <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 an mlx90614 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">*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 mlx90614 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">*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="#ga83f88ab286336af0de5505f
 <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 an mlx90614 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">data</td><td>is the write data </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an mlx90614 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">data</td><td>written data </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__mlx90614__extern__driver.html

@@ -153,7 +153,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gae131079bb0527366d0c6fa9
 <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>
@@ -182,7 +182,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga63792ad5bfa17f8c75d6717
 <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>
@@ -289,10 +289,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#gadf9d35a55bfa4ac8782e468
 <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>
@@ -348,10 +348,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga0de85f1b76b0641e601a5b7
 <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>
@@ -385,7 +385,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gacec1e1f7236d20c7cb64eec
 <p>interface scl write </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>is the input value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>input value </td></tr>
   </table>
   </dd>
 </dl>
@@ -419,7 +419,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga84b8e1826902be3f5cf9636
 <p>interface sda write </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>is the input value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>input value </td></tr>
   </table>
   </dd>
 </dl>