Merge pull request #16 from libdriver/dev

fix: fix doc errors
libdriver · Dec 29, 2024 · b3b479a · b3b479a
2 parents b977c30 + 866db5a
commit b3b479a
Show file tree

Hide file tree

Showing 16 changed files with 714 additions and 708 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## 1.0.3 (2024-12-21)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 1.0.2 (2024-11-17)
 
 ## Bug Fixes

diff --git a/doc/html/group__nrf24l01__basic__driver.html b/doc/html/group__nrf24l01__basic__driver.html
diff --git a/doc/html/group__nrf24l01__example__driver.html b/doc/html/group__nrf24l01__example__driver.html
@@ -990,8 +990,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf485754d5ef709a329d926e
 <p>basic example init </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>is the chip working mode </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">*callback</td><td>points to a callback function </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>chip working mode </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*callback</td><td>pointer to a callback function </td></tr>
   </table>
   </dd>
 </dl>
@@ -1041,9 +1041,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga2a9bb68b655b06cf4e2dbea
 <p>basic example send </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">*addr</td><td>points to a address buffer </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 buffer length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*addr</td><td>pointer to a address 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>buffer length </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/doc/html/group__nrf24l01__extern__driver.html b/doc/html/group__nrf24l01__extern__driver.html
@@ -147,10 +147,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga5a746c3e5128e55d680c9e5
 <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 an nrf24l01 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">reg</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 data buffer length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an nrf24l01 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">reg</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>data buffer length </td></tr>
   </table>
   </dd>
 </dl>
@@ -208,10 +208,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga8aac9a03e76d8253d991a32
 <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 an nrf24l01 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">reg</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 data buffer length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an nrf24l01 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">reg</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>data buffer length </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/doc/html/group__nrf24l01__interface__driver.html b/doc/html/group__nrf24l01__interface__driver.html
@@ -159,7 +159,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga91998e27bfdcebdf63792bf
 <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="#ga5d9c2e24aac8b63edcba5de
 <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>
@@ -273,7 +273,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaee1991f1755c5750ce57ad0
 <p>interface gpio write </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>is the written data </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>written data </td></tr>
   </table>
   </dd>
 </dl>
@@ -329,10 +329,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga83f4c56919a403df2dd133f
 <p>interface receive callback </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>is the receive callback type </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>is the pipe number </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 buffer length </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>receive callback type </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">num</td><td>pipe number </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>buffer length </td></tr>
   </table>
   </dd>
 </dl>
@@ -433,9 +433,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga09dc443ef8214d5471dafe7
 <p>interface spi bus read </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">reg</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">reg</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>
@@ -485,9 +485,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gad9ceabea87109c6ba86f677
 <p>interface spi bus write </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">reg</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">reg</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>

diff --git a/doc/html/group__nrf24l01__link__driver.html b/doc/html/group__nrf24l01__link__driver.html
@@ -162,8 +162,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga6fa3ea544daa2b5962e072e
 <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 nrf24l01 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 nrf24l01 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="#ga220b90369752e972bcf5b94
 <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 nrf24l01 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 nrf24l01 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="#ga9af9b9d9c48cfdc8dc4a9f5
 <p>link gpio_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 nrf24l01 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a gpio_deinit function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an nrf24l01 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a gpio_deinit function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -282,8 +282,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga762c8709b78bb52adb59bd7
 <p>link gpio_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 nrf24l01 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a gpio_init function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an nrf24l01 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a gpio_init function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -322,8 +322,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga600ca6e4e8d2b950847111c
 <p>link gpio_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 nrf24l01 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a gpio_write function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an nrf24l01 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a gpio_write function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -362,8 +362,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga9e3785f2dbe42883794181a
 <p>initialize nrf24l01_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 nrf24l01 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>is nrf24l01_handle_t </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an nrf24l01 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>nrf24l01_handle_t </td></tr>
   </table>
   </dd>
 </dl>
@@ -402,8 +402,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaad7a983c8704f8e57a350fa
 <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 nrf24l01 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 nrf24l01 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>
@@ -442,8 +442,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaa772344fc5621cc944dcc86
 <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 an nrf24l01 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 an nrf24l01 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>
@@ -482,8 +482,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga3ba65e04e24e7913f27a43c
 <p>link spi_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 nrf24l01 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a spi_init function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an nrf24l01 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a spi_init function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -522,8 +522,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga783349cce6d43f938980fda
 <p>link spi_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 nrf24l01 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a spi_read function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an nrf24l01 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a spi_read function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -562,8 +562,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga91ddfcdb8250e4208d5d095
 <p>link gpio_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 nrf24l01 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a gpio_write function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an nrf24l01 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a gpio_write function address </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/example/driver_nrf24l01_basic.c b/example/driver_nrf24l01_basic.c
@@ -59,8 +59,8 @@ uint8_t nrf24l01_interrupt_irq_handler(void)
 
 /**
  * @brief     basic example init
- * @param[in] type is the chip working mode
- * @param[in] *callback points to a callback function
+ * @param[in] type chip working mode
+ * @param[in] *callback pointer to a callback function
  * @return    status code
  *            - 0 success
  *            - 1 init failed
@@ -708,9 +708,9 @@ uint8_t nrf24l01_basic_deinit(void)
 
 /**
  * @brief     basic example send
- * @param[in] *addr points to a address buffer
- * @param[in] *buf points to a data buffer
- * @param[in] len is the buffer length
+ * @param[in] *addr pointer to a address buffer
+ * @param[in] *buf pointer to a data buffer
+ * @param[in] len buffer length
  * @return    status code
  *            - 0 success
  *            - 1 send failed

diff --git a/example/driver_nrf24l01_basic.h b/example/driver_nrf24l01_basic.h
@@ -115,8 +115,8 @@ uint8_t nrf24l01_interrupt_irq_handler(void);
 
 /**
  * @brief     basic example init
- * @param[in] type is the chip working mode
- * @param[in] *callback points to a callback function
+ * @param[in] type chip working mode
+ * @param[in] *callback pointer to a callback function
  * @return    status code
  *            - 0 success
  *            - 1 init failed
@@ -135,9 +135,9 @@ uint8_t nrf24l01_basic_deinit(void);
 
 /**
  * @brief     basic example send
- * @param[in] *addr points to a address buffer
- * @param[in] *buf points to a data buffer
- * @param[in] len is the buffer length
+ * @param[in] *addr pointer to a address buffer
+ * @param[in] *buf pointer to a data buffer
+ * @param[in] len buffer length
  * @return    status code
  *            - 0 success
  *            - 1 send failed

diff --git a/interface/driver_nrf24l01_interface.h b/interface/driver_nrf24l01_interface.h
@@ -70,9 +70,9 @@ uint8_t nrf24l01_interface_spi_deinit(void);
 
 /**
  * @brief      interface spi bus read
- * @param[in]  reg is the register address
- * @param[out] *buf points to a data buffer
- * @param[in]  len is the length of data buffer
+ * @param[in]  reg register address
+ * @param[out] *buf pointer to a data buffer
+ * @param[in]  len length of data buffer
  * @return     status code
  *             - 0 success
  *             - 1 read failed
@@ -82,9 +82,9 @@ uint8_t nrf24l01_interface_spi_read(uint8_t reg, uint8_t *buf, uint16_t len);
 
 /**
  * @brief     interface spi bus write
- * @param[in] reg is the register address
- * @param[in] *buf points to a data buffer
- * @param[in] len is the length of data buffer
+ * @param[in] reg register address
+ * @param[in] *buf pointer to a data buffer
+ * @param[in] len length of data buffer
  * @return    status code
  *            - 0 success
  *            - 1 write failed
@@ -112,7 +112,7 @@ uint8_t nrf24l01_interface_gpio_deinit(void);
 
 /**
  * @brief     interface gpio write
- * @param[in] data is the written data
+ * @param[in] data written data
  * @return    status code
  *            - 0 success
  *            - 1 write failed
@@ -122,24 +122,24 @@ uint8_t nrf24l01_interface_gpio_write(uint8_t data);
 
 /**
  * @brief     interface delay ms
- * @param[in] ms
+ * @param[in] ms time
  * @note      none
  */
 void nrf24l01_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 nrf24l01_interface_debug_print(const char *const fmt, ...);
 
 /**
  * @brief     interface receive callback
- * @param[in] type is the receive callback type
- * @param[in] num is the pipe number
- * @param[in] *buf points to a data buffer
- * @param[in] len is the buffer length
+ * @param[in] type receive callback type
+ * @param[in] num pipe number
+ * @param[in] *buf pointer to a data buffer
+ * @param[in] len buffer length
  * @note      none
  */
 void nrf24l01_interface_receive_callback(uint8_t type, uint8_t num, uint8_t *buf, uint8_t len);