Merge pull request #7 from libdriver/dev

fix: fix doc errors

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.0.3 (2024-12-08)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 1.0.2 (2024-08-05)
 
 ## Bug Fixes

doc/html/group__ir__remote__basic__driver.html

@@ -323,7 +323,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gac73c3d8cf1954ebec79b91e
 <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 ir_remote handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an ir_remote handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -358,7 +358,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga728c98fab458eba541363b6
 <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 ir_remote info structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*info</td><td>pointer to an ir_remote info structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -392,7 +392,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga4583935a7b5c1ade655879e
 <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 ir_remote handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an ir_remote handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -428,7 +428,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga2f59cccbc0c12cfff85c3fb
 <p>irq handler </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 ir_remote handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an ir_remote handle structure </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__ir__remote__example__driver.html

@@ -156,7 +156,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga1f59c165541a83bdddd1568
 <p>basic example init </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*callback</td><td>points to an irq callback address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*callback</td><td>pointer to an irq callback address </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__ir__remote__interface__driver.html

@@ -141,7 +141,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gae2bcde076de4f7f0b36209a
 <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>
@@ -170,7 +170,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gacba90ca146a52e315444de8
 <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>
@@ -199,7 +199,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga89a53a6287ecb139bc66805
 <p>interface receive callback </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*data</td><td>points to an ir_remote_t structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*data</td><td>pointer to an ir_remote_t structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -228,7 +228,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga72205bcc2a8ac5755c85287
 <p>interface timestamp read </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*t</td><td>points to an ir_remote_time structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*t</td><td>pointer to an ir_remote_time structure </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__ir__remote__link__driver.html

@@ -144,8 +144,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga39c60e474c05b301e3a2bb6
 <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 ir_remote 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 ir_remote 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>
@@ -184,8 +184,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaa22ed9181db1db48cb617b9
 <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 ir_remote 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 ir_remote 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>
@@ -224,8 +224,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaab40b50bc0fc6c55874c50b
 <p>initialize ir_remote_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 ir_remote handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>is ir_remote_handle_t </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an ir_remote handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>ir_remote_handle_t </td></tr>
   </table>
   </dd>
 </dl>
@@ -264,8 +264,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga74e0a8aca4aae8a05943b9d
 <p>link receive_callback 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 ir_remote handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a receive_callback function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an ir_remote handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a receive_callback function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -304,8 +304,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga273a3390b072abd50217a12
 <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 ir_remote 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 ir_remote 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>

doc/html/group__ir__remote__test__driver.html

@@ -125,7 +125,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf54fd33dd8c12502104d1a4
 <p>receive 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 test times </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">times</td><td>test times </td></tr>
   </table>
   </dd>
 </dl>

example/driver_ir_remote_basic.c

@@ -59,7 +59,7 @@ uint8_t ir_remote_basic_irq_handler(void)
 
 /**
  * @brief     basic example init
- * @param[in] *callback points to an irq callback address
+ * @param[in] *callback pointer to an irq callback address
  * @return    status code
  *            - 0 success
  *            - 1 init failed

example/driver_ir_remote_basic.h

@@ -61,7 +61,7 @@ uint8_t ir_remote_basic_irq_handler(void);
 
 /**
  * @brief     basic example init
- * @param[in] *callback points to an irq callback address
+ * @param[in] *callback pointer to an irq callback address
  * @return    status code
  *            - 0 success
  *            - 1 init failed

interface/driver_ir_remote_interface.h

@@ -52,7 +52,7 @@ extern "C"{
 
 /**
  * @brief     interface timestamp read
- * @param[in] *t points to an ir_remote_time structure
+ * @param[in] *t pointer to an ir_remote_time structure
  * @return    status code
  *            - 0 success
  *            - 1 read failed
@@ -62,21 +62,21 @@ uint8_t ir_remote_interface_timestamp_read(ir_remote_time_t *t);
 
 /**
  * @brief     interface delay ms
- * @param[in] ms
+ * @param[in] ms time
  * @note      none
  */
 void ir_remote_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 ir_remote_interface_debug_print(const char *const fmt, ...);
 
 /**
  * @brief     interface receive callback
- * @param[in] *data points to an ir_remote_t structure
+ * @param[in] *data pointer to an ir_remote_t structure
  * @note      none
  */
 void ir_remote_interface_receive_callback(ir_remote_t *data);

interface/driver_ir_remote_interface_template.c

@@ -38,7 +38,7 @@
 
 /**
  * @brief     interface timestamp read
- * @param[in] *t points to an ir_remote_time structure
+ * @param[in] *t pointer to an ir_remote_time structure
  * @return    status code
  *            - 0 success
  *            - 1 read failed
@@ -51,7 +51,7 @@ uint8_t ir_remote_interface_timestamp_read(ir_remote_time_t *t)
 
 /**
  * @brief     interface delay ms
- * @param[in] ms
+ * @param[in] ms time
  * @note      none
  */
 void ir_remote_interface_delay_ms(uint32_t ms)
@@ -61,7 +61,7 @@ void ir_remote_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 ir_remote_interface_debug_print(const char *const fmt, ...)
@@ -71,7 +71,7 @@ void ir_remote_interface_debug_print(const char *const fmt, ...)
 
 /**
  * @brief     interface receive callback
- * @param[in] *data points to an ir_remote_t structure
+ * @param[in] *data pointer to an ir_remote_t structure
  * @note      none
  */
 void ir_remote_interface_receive_callback(ir_remote_t *data)

project/raspberrypi4b/driver/src/raspberrypi4b_driver_ir_remote_interface.c

@@ -41,7 +41,7 @@
 
 /**
  * @brief     interface timestamp read
- * @param[in] *t points to an ir_remote_time structure
+ * @param[in] *t pointer to an ir_remote_time structure
  * @return    status code
  *            - 0 success
  *            - 1 read failed
@@ -64,7 +64,7 @@ uint8_t ir_remote_interface_timestamp_read(ir_remote_time_t *t)
 
 /**
  * @brief     interface delay ms
- * @param[in] ms
+ * @param[in] ms time
  * @note      none
  */
 void ir_remote_interface_delay_ms(uint32_t ms)
@@ -74,7 +74,7 @@ void ir_remote_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 ir_remote_interface_debug_print(const char *const fmt, ...)
@@ -94,7 +94,7 @@ void ir_remote_interface_debug_print(const char *const fmt, ...)
 
 /**
  * @brief     interface receive callback
- * @param[in] *data points to an ir_remote_t structure
+ * @param[in] *data pointer to an ir_remote_t structure
  * @note      none
  */
 void ir_remote_interface_receive_callback(ir_remote_t *data)

project/raspberrypi4b/src/main.c

@@ -48,7 +48,7 @@ volatile uint8_t g_flag;                   /**< interrupt flag */
 
 /**
  * @brief     interface receive callback
- * @param[in] *data points to an ir_remote_t structure
+ * @param[in] *data pointer to an ir_remote_t structure
  * @note      none
  */
 static void a_receive_callback(ir_remote_t *data)
@@ -96,8 +96,8 @@ static void a_receive_callback(ir_remote_t *data)
 
 /**
  * @brief     ir_remote full function
- * @param[in] argc is arg numbers
- * @param[in] **argv is the arg address
+ * @param[in] argc arg numbers
+ * @param[in] **argv arg address
  * @return    status code
  *            - 0 success
  *            - 1 run failed
@@ -370,8 +370,8 @@ uint8_t ir_remote(uint8_t argc, char **argv)
 
 /**
  * @brief     main function
- * @param[in] argc is arg numbers
- * @param[in] **argv is the arg address
+ * @param[in] argc arg numbers
+ * @param[in] **argv arg address
  * @return    status code
  *             - 0 success
  * @note      none

project/stm32f407/driver/src/stm32f407_driver_ir_remote_interface.c

@@ -47,7 +47,7 @@ static uint64_t gs_second = 0;        /**< second */
 
 /**
  * @brief     timer callback
- * @param[in] us is the timer cnt
+ * @param[in] us timer cnt
  * @note      none
  */
 static void gs_tim_irq(uint32_t us)
@@ -81,7 +81,7 @@ uint8_t ir_remote_interface_timer_init(void)
 
 /**
  * @brief     interface timestamp read
- * @param[in] *t points to an ir_remote_time structure
+ * @param[in] *t pointer to an ir_remote_time structure
  * @return    status code
  *            - 0 success
  *            - 1 read failed
@@ -97,7 +97,7 @@ uint8_t ir_remote_interface_timestamp_read(ir_remote_time_t *t)
 
 /**
  * @brief     interface delay ms
- * @param[in] ms
+ * @param[in] ms time
  * @note      none
  */
 void ir_remote_interface_delay_ms(uint32_t ms)
@@ -107,7 +107,7 @@ void ir_remote_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 ir_remote_interface_debug_print(const char *const fmt, ...)
@@ -127,7 +127,7 @@ void ir_remote_interface_debug_print(const char *const fmt, ...)
 
 /**
  * @brief     interface receive callback
- * @param[in] *data points to an ir_remote_t structure
+ * @param[in] *data pointer to an ir_remote_t structure
  * @note      none
  */
 void ir_remote_interface_receive_callback(ir_remote_t *data)

project/stm32f407/usr/src/main.c

@@ -64,7 +64,7 @@ void EXTI0_IRQHandler(void)
 
 /**
  * @brief     gpio exti callback
- * @param[in] pin is the gpio pin
+ * @param[in] pin gpio pin
  * @note      none
  */
 void HAL_GPIO_EXTI_Callback(uint16_t pin)
@@ -81,7 +81,7 @@ void HAL_GPIO_EXTI_Callback(uint16_t pin)
 
 /**
  * @brief     interface receive callback
- * @param[in] *data points to an ir_remote_t structure
+ * @param[in] *data pointer to an ir_remote_t structure
  * @note      none
  */
 static void a_receive_callback(ir_remote_t *data)
@@ -129,8 +129,8 @@ static void a_receive_callback(ir_remote_t *data)
 
 /**
  * @brief     ir_remote full function
- * @param[in] argc is arg numbers
- * @param[in] **argv is the arg address
+ * @param[in] argc arg numbers
+ * @param[in] **argv arg address
  * @return    status code
  *            - 0 success
  *            - 1 run failed