Merge pull request #3 from libdriver/dev

fix: fix doc errors
libdriver · Jan 4, 2025 · 6a42504 · 6a42504
2 parents 4fc293b + 3425f06
commit 6a42504
Show file tree

Hide file tree

Showing 22 changed files with 239 additions and 243 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## 1.0.3 (2025-01-01)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 1.0.2 (2024-08-10)
 
 ## Bug Fixes

diff --git a/doc/html/group__tm1638__basic__driver.html b/doc/html/group__tm1638__basic__driver.html
@@ -384,7 +384,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga98eead5c2e411574bf5054c
 <p>clear segment </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 tm1638 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a tm1638 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -420,7 +420,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga65da3a37b0a2a704139c8d1
 <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 tm1638 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a tm1638 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -467,8 +467,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaca85a7c86c31e5f4b9b9abb
 <p>get address 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 tm1638 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*mode</td><td>points to an address mode buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a tm1638 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*mode</td><td>pointer to an address mode buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -513,8 +513,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gac663addfd5ebce0208642dd
 <p>get display 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 a tm1638 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 tm1638 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>
@@ -559,8 +559,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf6dcfda885cf6585fbba66d
 <p>get pulse width </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 tm1638 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*width</td><td>points to a pulse width buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a tm1638 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*width</td><td>pointer to a pulse width buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -605,8 +605,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga01e21bf52f61058aaed9684
 <p>get test mode 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 a tm1638 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 tm1638 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>
@@ -641,7 +641,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf39fa1422eee0dd85a43749
 <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 tm1638 info structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*info</td><td>pointer to a tm1638 info structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -675,7 +675,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga9dd1709bef41169f5f9bd7e
 <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 tm1638 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a tm1638 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -721,8 +721,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaa1bc395dd66e1911d43f75c
 <p>read segment </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 tm1638 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*segk</td><td>points to a segk buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a tm1638 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*segk</td><td>pointer to a segk buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -768,8 +768,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga17185f55a4dae954cf21165
 <p>set address 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 tm1638 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>is the address mode </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a tm1638 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>address mode </td></tr>
   </table>
   </dd>
 </dl>
@@ -815,8 +815,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaa644b06d55b0727ae663dcb
 <p>enable or disable display </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 tm1638 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 tm1638 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>bool value </td></tr>
   </table>
   </dd>
 </dl>
@@ -862,8 +862,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga368a8f2def6e613bbe831e6
 <p>set pulse width </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 tm1638 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>is the pulse width </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a tm1638 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>pulse width </td></tr>
   </table>
   </dd>
 </dl>
@@ -909,8 +909,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gacc461a194eb86b8835c47a2
 <p>enable or disable test 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 tm1638 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 tm1638 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>bool value </td></tr>
   </table>
   </dd>
 </dl>
@@ -968,10 +968,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga03f3b5ab8b266a032dc2e91
 <p>write segment </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 tm1638 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>is the start address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*data</td><td>points to a data buffer </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>is the data length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a tm1638 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>start address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*data</td><td>pointer to a data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>data length </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/doc/html/group__tm1638__example__driver.html b/doc/html/group__tm1638__example__driver.html
@@ -326,7 +326,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga4b763013f09245f85223cb6
 <p>basic example read </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*segk</td><td>points to a segk buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*segk</td><td>pointer to a segk buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -376,9 +376,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga2a7ba8a0bb753f211547035
 <p>basic example 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 start address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*data</td><td>points to a data buffer </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>is the data length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>start address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*data</td><td>pointer to a data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>data length </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/doc/html/group__tm1638__extern__driver.html b/doc/html/group__tm1638__extern__driver.html
@@ -147,10 +147,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf016bb8f4fca3864f5740a6
 <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 tm1638 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">cmd</td><td>is the send command </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">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 tm1638 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">cmd</td><td>sent command </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*data</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="#gae538218cb3a0a3e91360f21
 <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 tm1638 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">cmd</td><td>is the send command </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*data</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 tm1638 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">cmd</td><td>sent command </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*data</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__tm1638__interface__driver.html b/doc/html/group__tm1638__interface__driver.html
@@ -147,7 +147,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gac92863ecda283067012911e
 <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="#ga46427cbb3c2ba68527832c7
 <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>
@@ -277,9 +277,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga3f68000908af1409a2622d9
 <p>interface spi 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 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 data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>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 data buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -329,9 +329,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gabf3b67426cf2d6a7a91af99
 <p>interface spi 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 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 data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>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 data buffer </td></tr>
   </table>
   </dd>
 </dl>