fix: fix doc errors

Author: libdriver

CHANGELOG.md

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

doc/html/group__ws2812b__base__driver.html

@@ -220,7 +220,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga6fa1311ef2353ea55c58aa3
 <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 ws2812b handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ws2812b handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -256,7 +256,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga2d68712e7e7d1b8f8329217
 <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 ws2812b info structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*info</td><td>pointer to a ws2812b info structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -290,7 +290,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gae6fbb749585737a343245f9
 <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 ws2812b handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ws2812b handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -342,9 +342,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf9000e2cf8036d77c73d913
 <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 ws2812b handle structure </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 data length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ws2812b handle structure </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>data length </td></tr>
   </table>
   </dd>
 </dl>
@@ -408,11 +408,11 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga60effc5b5f3a3326ffaa3a8
 <p>write reset and color frame </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 ws2812b handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*rgb</td><td>points to a rgb color buffer </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>is the rgb length </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*temp</td><td>points to a temp buffer </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">temp_len</td><td>is the temp buffer length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ws2812b handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*rgb</td><td>pointer to a rgb color buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>rgb length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*temp</td><td>pointer to a temp buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">temp_len</td><td>temp buffer length </td></tr>
   </table>
   </dd>
 </dl>
@@ -479,11 +479,11 @@ <h2 class="memtitle"><span class="permalink"><a href="#gac6fd3f9b02dff6d25690de9
 <p>write the color frame </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 ws2812b handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*rgb</td><td>points to a rgb color buffer </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>is the rgb length </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*temp</td><td>points to a temp buffer </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">temp_len</td><td>is the temp buffer length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ws2812b handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*rgb</td><td>pointer to a rgb color buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>rgb length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*temp</td><td>pointer to a temp buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">temp_len</td><td>temp buffer length </td></tr>
   </table>
   </dd>
 </dl>
@@ -544,10 +544,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga9143c3d9bf67e15e3124f06
 <p>write the reset frame </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 ws2812b handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>is the rgb length </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*temp</td><td>points to a temp buffer </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">temp_len</td><td>is the temp buffer length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ws2812b handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>rgb length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*temp</td><td>pointer to a temp buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">temp_len</td><td>temp buffer length </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__ws2812b__example__driver.html

@@ -206,10 +206,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga0290134d7f85efe7a3c3018
 <p>basic example write </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*rgb</td><td>points to a rgb color buffer </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>is the rgb length </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*temp</td><td>points to a temp buffer </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">temp_len</td><td>is the temp buffer length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*rgb</td><td>pointer to a rgb color buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>rgb length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*temp</td><td>pointer to a temp buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">temp_len</td><td>temp buffer length </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__ws2812b__interface__driver.html

@@ -144,7 +144,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga06272a71df762b39a7a5577
 <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>
@@ -173,7 +173,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gafbc8bb115b98f6821e9abce
 <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>
@@ -268,8 +268,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga4a5339883cb90bc06763b2c
 <p>interface spi bus write command </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <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">*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>

doc/html/group__ws2812b__link__driver.html

@@ -147,8 +147,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga2fa848fe3582a8d5aa7008e
 <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 a ws2812b 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 a ws2812b 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>
@@ -187,8 +187,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gad96acb900fe5494fca54f6e
 <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 a ws2812b 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 a ws2812b 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>
@@ -227,8 +227,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga4ed311131502d4a9f112056
 <p>initialize ws2812b_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 a ws2812b handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>is ws2812b_handle_t </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to a ws2812b handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>ws2812b_handle_t </td></tr>
   </table>
   </dd>
 </dl>
@@ -267,8 +267,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga2e74fcd73d577d01706521a
 <p>link spi_10mhz_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 a ws2812b handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a spi_10mhz_init function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to a ws2812b handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a spi_10mhz_init function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -307,8 +307,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gac7f6e4e290d0cd4390acf26
 <p>link spi_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 a ws2812b handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a spi_deinit function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to a ws2812b handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a spi_deinit function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -347,8 +347,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga5690d20be0f3ccf553c9348
 <p>link spi_write_cmd 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 a ws2812b handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a spi_write_cmd function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to a ws2812b handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a spi_write_cmd function address </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__ws2812b__test__driver.html

@@ -132,8 +132,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga9a0887c35117ee6647fc0c9
 <p>write test </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">cnt</td><td>is the number of the ws2812b led </td></tr>
-    <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">cnt</td><td>number of the ws2812b led </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">times</td><td>test times </td></tr>
   </table>
   </dd>
 </dl>

example/driver_ws2812b_basic.c

@@ -71,10 +71,10 @@ uint8_t ws2812b_basic_init(void)
 
 /**
  * @brief     basic example write 
- * @param[in] *rgb points to a rgb color buffer
- * @param[in] len is the rgb length
- * @param[in] *temp points to a temp buffer
- * @param[in] temp_len is the temp buffer length
+ * @param[in] *rgb pointer to a rgb color buffer
+ * @param[in] len rgb length
+ * @param[in] *temp pointer to a temp buffer
+ * @param[in] temp_len temp buffer length
  * @return    status code
  *            - 0 success
  *            - 1 write failed

example/driver_ws2812b_basic.h

@@ -70,10 +70,10 @@ uint8_t ws2812b_basic_deinit(void);
 
 /**
  * @brief     basic example write 
- * @param[in] *rgb points to a rgb color buffer
- * @param[in] len is the rgb length
- * @param[in] *temp points to a temp buffer
- * @param[in] temp_len is the temp buffer length
+ * @param[in] *rgb pointer to a rgb color buffer
+ * @param[in] len rgb length
+ * @param[in] *temp pointer to a temp buffer
+ * @param[in] temp_len temp buffer length
  * @return    status code
  *            - 0 success
  *            - 1 write failed

interface/driver_ws2812b_interface.h

@@ -70,8 +70,8 @@ uint8_t ws2812b_interface_spi_deinit(void);
 
 /**
  * @brief     interface spi bus write command
- * @param[in] *buf points to a data buffer
- * @param[in] len is the length of data buffer
+ * @param[in] *buf pointer to a data buffer
+ * @param[in] len length of data buffer
  * @return    status code
  *            - 0 success
  *            - 1 write failed
@@ -81,14 +81,14 @@ uint8_t ws2812b_interface_spi_write_cmd(uint8_t *buf, uint16_t len);
 
 /**
  * @brief     interface delay ms
- * @param[in] ms
+ * @param[in] ms time
  * @note      none
  */
 void ws2812b_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 ws2812b_interface_debug_print(const char *const fmt, ...);

interface/driver_ws2812b_interface_template.c

@@ -62,8 +62,8 @@ uint8_t ws2812b_interface_spi_deinit(void)
 
 /**
  * @brief     interface spi bus write command
- * @param[in] *buf points to a data buffer
- * @param[in] len is the length of data buffer
+ * @param[in] *buf pointer to a data buffer
+ * @param[in] len length of data buffer
  * @return    status code
  *            - 0 success
  *            - 1 write failed
@@ -76,7 +76,7 @@ uint8_t ws2812b_interface_spi_write_cmd(uint8_t *buf, uint16_t len)
 
 /**
  * @brief     interface delay ms
- * @param[in] ms
+ * @param[in] ms time
  * @note      none
  */
 void ws2812b_interface_delay_ms(uint32_t ms)
@@ -86,7 +86,7 @@ void ws2812b_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 ws2812b_interface_debug_print(const char *const fmt, ...)