Merge pull request #17 from libdriver/dev

fix: fix doc errors

Author: libdriver

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.0.3 (2025-01-02)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 1.0.2 (2024-10-01)
 
 ## Bug Fixes

doc/html/group__st7920__basic__driver.html

@@ -396,7 +396,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga9ac309fec505b57e6360f4c
 <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 st7920 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an st7920 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -432,7 +432,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga23c2f154b72222a831fb736
 <p>clear the 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 an st7920 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an st7920 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -468,7 +468,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga08e5f76110949ea561d7674
 <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 st7920 info structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*info</td><td>pointer to an st7920 info structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -502,7 +502,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga895c5b868cc81b2c08a3457
 <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 st7920 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an st7920 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -538,7 +538,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga4bda5e15c153e996214b63b
 <p>return the home </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 st7920 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an st7920 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -585,8 +585,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga08c1300c82d7b47910b8045
 <p>set the cgram 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 st7920 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>is the cgram address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an st7920 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>cgram address </td></tr>
   </table>
   </dd>
 </dl>
@@ -634,8 +634,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaa04e8a6bae4104ed921ea53
 <p>set the ddram 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 st7920 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>is the ddram address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an st7920 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>ddram address </td></tr>
   </table>
   </dd>
 </dl>
@@ -695,10 +695,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#gad5f70a6103e067a0f43a62e
 <p>set the display control </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 st7920 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">display_on</td><td>is a bool value </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">cursor_on</td><td>is a bool value </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">character_blink_on</td><td>is a bool value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an st7920 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">display_on</td><td>bool value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">cursor_on</td><td>bool value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">character_blink_on</td><td>bool value </td></tr>
   </table>
   </dd>
 </dl>
@@ -745,8 +745,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf1749037efe404e2234ec26
 <p>set the display shift 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 st7920 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>is the display shift mode </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an st7920 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>display shift mode </td></tr>
   </table>
   </dd>
 </dl>
@@ -799,9 +799,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga2598f9fc0f532b1be81fa72
 <p>set the entry 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 st7920 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">shift</td><td>is the display shift </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>is the address counter mode </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an st7920 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">shift</td><td>display shift </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>address counter mode </td></tr>
   </table>
   </dd>
 </dl>
@@ -854,9 +854,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga0fc13c1c98b78f4f3a4a02f
 <p>set the function </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 st7920 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">bus_bit</td><td>is the bus bit </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>is the command mode </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an st7920 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">bus_bit</td><td>bus bit </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>command mode </td></tr>
   </table>
   </dd>
 </dl>
@@ -908,9 +908,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga138e7d658b6b612b5c71e51
 <p>write the ram </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 st7920 handle structure </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 an st7920 handle structure </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>
@@ -969,10 +969,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#gadd144654f50c3bd75952d22
 <p>show a string </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 st7920 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>is the coordinate x </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>is the coordinate y </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*str</td><td>points to a write string address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an st7920 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>coordinate x </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>coordinate y </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*str</td><td>pointer to a write string address </td></tr>
   </table>
   </dd>
 </dl>