Merge pull request #19 from libdriver/dev

fix: fix doc errors
libdriver · Dec 29, 2024 · 5cc094d · 5cc094d
2 parents 4d4f53d + de3bea3
commit 5cc094d
Show file tree

Hide file tree

Showing 18 changed files with 111 additions and 105 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## 2.0.5 (2024-12-08)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 2.0.4 (2024-09-27)
 
 ## Bug Fixes

diff --git a/doc/html/group__hcsr04__base__driver.html b/doc/html/group__hcsr04__base__driver.html
@@ -233,7 +233,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gab0e495e5244b98a0a926571
 <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 hcsr04 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an hcsr04 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -269,7 +269,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaa550d226b2e1a609844b419
 <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 hcsr04 info structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*info</td><td>pointer to an hcsr04 info structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -303,7 +303,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga21bf55ec8b67ccf2819b491
 <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 hcsr04 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an hcsr04 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -355,9 +355,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga839c62211afbc7134ca9697
 <p>read the distance </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 hcsr04 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*time_us</td><td>points to a us buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*m</td><td>points to a distance buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an hcsr04 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*time_us</td><td>pointer to a us buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*m</td><td>pointer to a distance buffer </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/doc/html/group__hcsr04__example__driver.html b/doc/html/group__hcsr04__example__driver.html
@@ -184,7 +184,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga9604bf2b4125d17bf691434
 <p>basic example read </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*m</td><td>points to a distance buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*m</td><td>pointer to a distance buffer </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/doc/html/group__hcsr04__interface__driver.html b/doc/html/group__hcsr04__interface__driver.html
@@ -159,7 +159,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaaeb38b2900889fe8b56c7a9
 <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>
@@ -188,7 +188,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaa51cf4380c5a24b2121ff1c
 <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>
@@ -217,7 +217,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga6cb24420c4f7a081e62ed7b
 <p>interface delay us </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">us</td><td></td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">us</td><td>time </td></tr>
   </table>
   </dd>
 </dl>
@@ -302,7 +302,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga82bda1c164f0e8e25278340
 <p>interface echo read </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*value</td><td>points to a value buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*value</td><td>pointer to a value buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -336,7 +336,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga4e63965ac047d4d23be21d5
 <p>interface timestamp read </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*t</td><td>points to a time structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*t</td><td>pointer to a time structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -426,7 +426,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gac5065da950f6e50cefa8535
 <p>interface trig 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 written value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>written value </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/doc/html/group__hcsr04__link__driver.html b/doc/html/group__hcsr04__link__driver.html
@@ -162,8 +162,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga14582a24e251aed0c906074
 <p>link debug_print 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 hcsr04 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a debug_print function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an hcsr04 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a debug_print function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -202,8 +202,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga88ace95b39651bd689d4c56
 <p>link delay_ms 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 hcsr04 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a delay_ms function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an hcsr04 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a delay_ms function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -242,8 +242,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaae0d20c5d7c9e49bb10229f
 <p>link delay_us 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 hcsr04 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a delay_us function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an hcsr04 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a delay_us function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -282,8 +282,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaad4bcb4577728627a624cbc
 <p>link echo_deinit 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 hcsr04 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to an echo_deinit function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an hcsr04 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to an echo_deinit function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -322,8 +322,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga943720d9c55a2f6494d3a8c
 <p>link echo_init 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 hcsr04 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to an echo_init function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an hcsr04 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to an echo_init function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -362,8 +362,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gac575dd4e965d9331443f14a
 <p>link echo_read 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 hcsr04 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to an echo_read function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an hcsr04 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to an echo_read function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -402,8 +402,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga700bf1b54d7066a1b9b21ea
 <p>initialize hcsr04_handle_t structure </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 hcsr04 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>is hcsr04_handle_t </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an hcsr04 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>hcsr04_handle_t </td></tr>
   </table>
   </dd>
 </dl>
@@ -442,8 +442,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaca0e83190e7de4edfa2f3f3
 <p>link timestamp_read 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 hcsr04 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a timestamp_read function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an hcsr04 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a timestamp_read function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -482,8 +482,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gad028ce922a50e5ccfeda5c2
 <p>link trig_deinit 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 hcsr04 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a trig_deinit function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an hcsr04 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a trig_deinit function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -522,8 +522,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga192d52401800ede93012e36
 <p>link trig_init 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 hcsr04 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a trig_init function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an hcsr04 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a trig_init function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -562,8 +562,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaeb8cb206fd900a28b8b040f
 <p>link trig_write 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 hcsr04 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a trig_write function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an hcsr04 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a trig_write function address </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/doc/html/group__hcsr04__test__driver.html b/doc/html/group__hcsr04__test__driver.html
@@ -122,7 +122,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gab9976089b61b8d12f82cb7d
 <p>read test </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">times</td><td>is the read times </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">times</td><td>test times </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/example/driver_hcsr04_basic.c b/example/driver_hcsr04_basic.c
@@ -77,7 +77,7 @@ uint8_t hcsr04_basic_init(void)
 
 /**
  * @brief      basic example read
- * @param[out] *m points to a distance buffer
+ * @param[out] *m pointer to a distance buffer
  * @return     status code
  *             - 0 success
  *             - 1 read failed

diff --git a/example/driver_hcsr04_basic.h b/example/driver_hcsr04_basic.h
@@ -71,7 +71,7 @@ uint8_t hcsr04_basic_deinit(void);
 
 /**
  * @brief      basic example read
- * @param[out] *m points to a distance buffer
+ * @param[out] *m pointer to a distance buffer
  * @return     status code
  *             - 0 success
  *             - 1 read failed

diff --git a/interface/driver_hcsr04_interface.h b/interface/driver_hcsr04_interface.h
@@ -71,7 +71,7 @@ uint8_t hcsr04_interface_trig_deinit(void);
 
 /**
  * @brief     interface trig write
- * @param[in] value is the written value
+ * @param[in] value written value
  * @return    status code
  *            - 0 success
  *            - 1 trig write failed
@@ -99,7 +99,7 @@ uint8_t hcsr04_interface_echo_deinit(void);
 
 /**
  * @brief      interface echo read
- * @param[out] *value points to a value buffer
+ * @param[out] *value pointer to a value buffer
  * @return     status code
  *             - 0 success
  *             - 1 echo read failed
@@ -109,7 +109,7 @@ uint8_t hcsr04_interface_echo_read(uint8_t *value);
 
 /**
  * @brief      interface timestamp read
- * @param[out] *t points to a time structure
+ * @param[out] *t pointer to a time structure
  * @return     status code
  *             - 0 success
  *             - 1 timestamp read failed
@@ -119,21 +119,21 @@ uint8_t hcsr04_interface_timestamp_read(hcsr04_time_t *t);
 
 /**
  * @brief     interface delay us
- * @param[in] us
+ * @param[in] us time
  * @note      none
  */
 void hcsr04_interface_delay_us(uint32_t us);
 
 /**
  * @brief     interface delay ms
- * @param[in] ms
+ * @param[in] ms time
  * @note      none
  */
 void hcsr04_interface_delay_ms(uint32_t ms);
 
 /**
  * @brief     interface print format data
- * @param[in] fmt is the format data
+ * @param[in] fmt format data
  * @note      none
  */
 void hcsr04_interface_debug_print(const char *const fmt, ...);

diff --git a/interface/driver_hcsr04_interface_template.c b/interface/driver_hcsr04_interface_template.c
@@ -63,7 +63,7 @@ uint8_t hcsr04_interface_trig_deinit(void)
 
 /**
  * @brief     interface trig write
- * @param[in] value is the written value
+ * @param[in] value written value
  * @return    status code
  *            - 0 success
  *            - 1 trig write failed
@@ -100,7 +100,7 @@ uint8_t hcsr04_interface_echo_deinit(void)
 
 /**
  * @brief      interface echo read
- * @param[out] *value points to a value buffer
+ * @param[out] *value pointer to a value buffer
  * @return     status code
  *             - 0 success
  *             - 1 echo read failed
@@ -113,7 +113,7 @@ uint8_t hcsr04_interface_echo_read(uint8_t *value)
 
 /**
  * @brief      interface timestamp read
- * @param[out] *t points to a time structure
+ * @param[out] *t pointer to a time structure
  * @return     status code
  *             - 0 success
  *             - 1 timestamp read failed
@@ -126,7 +126,7 @@ uint8_t hcsr04_interface_timestamp_read(hcsr04_time_t *t)
 
 /**
  * @brief     interface delay us
- * @param[in] us
+ * @param[in] us time
  * @note      none
  */
 void hcsr04_interface_delay_us(uint32_t us)
@@ -136,7 +136,7 @@ void hcsr04_interface_delay_us(uint32_t us)
 
 /**
  * @brief     interface delay ms
- * @param[in] ms
+ * @param[in] ms time
  * @note      none
  */
 void hcsr04_interface_delay_ms(uint32_t ms)
@@ -146,7 +146,7 @@ void hcsr04_interface_delay_ms(uint32_t ms)
 
 /**
  * @brief     interface print format data
- * @param[in] fmt is the format data
+ * @param[in] fmt format data
  * @note      none
  */
 void hcsr04_interface_debug_print(const char *const fmt, ...)