Merge pull request #9 from libdriver/dev

fix: fix doc errors
libdriver · Jan 4, 2025 · 709c0f1 · 709c0f1
2 parents 1c90830 + 4829710
commit 709c0f1
Show file tree

Hide file tree

Showing 22 changed files with 452 additions and 455 deletions.
diff --git a/CHANGELOG.md b/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

diff --git a/doc/html/group__tea5767__base__driver.html b/doc/html/group__tea5767__base__driver.html
diff --git a/doc/html/group__tea5767__example__driver.html b/doc/html/group__tea5767__example__driver.html
@@ -518,7 +518,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga004180277c08715215433c3
 <p>basic example get frequency </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*mhz</td><td>points to a frequency buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*mhz</td><td>pointer to a frequency buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -638,7 +638,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaa34897a0f5fd564e7244c77
 <p>basic example set frequency </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">mhz</td><td>is the set frequency </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">mhz</td><td>set frequency </td></tr>
   </table>
   </dd>
 </dl>
@@ -672,7 +672,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gad385511bb3f252df571761d
 <p>basic example enable or disable mute </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>is a bool value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">enable</td><td>bool value </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/doc/html/group__tea5767__extern__driver.html b/doc/html/group__tea5767__extern__driver.html
@@ -141,9 +141,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gad6417a9f0a113689dccea92
 <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 a tea5767 handle structure </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 </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a tea5767 handle structure </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>
@@ -195,9 +195,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga1e17d232df000e90232218f
 <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 tea5767 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 buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a tea5767 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 buffer length </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/doc/html/group__tea5767__interface__driver.html b/doc/html/group__tea5767__interface__driver.html
@@ -147,7 +147,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga356bc845594de92839622a3
 <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>
@@ -176,7 +176,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gada57151d96c43fee4f8c2f5
 <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>
@@ -277,9 +277,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga9489395bf5afdf0d06904cc
 <p>interface iic bus read command </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>is the iic device write 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">addr</td><td>iic device write 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>
@@ -329,9 +329,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gab838dd4bcc739186bed222e
 <p>interface iic bus write command </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>is the iic device write 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">addr</td><td>iic device write 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__tea5767__link__driver.html b/doc/html/group__tea5767__link__driver.html
@@ -150,8 +150,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga195474337893e8f1de5946f
 <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 tea5767 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 tea5767 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>
@@ -190,8 +190,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga6540baaa299e1f764ac2c99
 <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 tea5767 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 tea5767 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>
@@ -230,8 +230,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga17593a0f795203ed7eaaf06
 <p>link iic_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 tea5767 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to an iic_deinit function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to a tea5767 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to an iic_deinit function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -270,8 +270,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaad34cd5920d962e3ec1da5e
 <p>link iic_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 tea5767 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to an iic_init function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to a tea5767 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to an iic_init function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -310,8 +310,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaae46b6523307f85f31179bf
 <p>link iic_read_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 tea5767 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to an iic_read_cmd function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to a tea5767 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to an iic_read_cmd function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -350,8 +350,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga29a7ab3981591d2c34ba74d
 <p>link iic_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 tea5767 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to an iic_write_cmd function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to a tea5767 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to an iic_write_cmd function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -390,8 +390,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gac356be88f3f1c886575a5dd
 <p>initialize tea5767_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 tea5767 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>is tea5767_handle_t </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to a tea5767 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>tea5767_handle_t </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/doc/html/group__tea5767__test__driver.html b/doc/html/group__tea5767__test__driver.html
@@ -125,7 +125,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gad5b4becb7b9ddb7a928bdad
 <p>radio test </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">clk</td><td>is the chip crystal frequency </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">clk</td><td>chip crystal frequency </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/example/driver_tea5767_basic.c b/example/driver_tea5767_basic.c
@@ -491,7 +491,7 @@ uint8_t tea5767_basic_search_down(void)
 
 /**
  * @brief     basic example set frequency
- * @param[in] mhz is the set frequency
+ * @param[in] mhz set frequency
  * @return    status code
  *            - 0 success
  *            - 1 set frequency failed
@@ -528,7 +528,7 @@ uint8_t tea5767_basic_set_frequency(float mhz)
 
 /**
  * @brief      basic example get frequency
- * @param[out] *mhz points to a frequency buffer
+ * @param[out] *mhz pointer to a frequency buffer
  * @return     status code
  *             - 0 success
  *             - 1 get frequency failed
@@ -565,7 +565,7 @@ uint8_t tea5767_basic_get_frequency(float *mhz)
 
 /**
  * @brief     basic example enable or disable mute
- * @param[in] enable is a bool value
+ * @param[in] enable bool value
  * @return    status code
  *            - 0 success
  *            - 1 set mute failed

diff --git a/example/driver_tea5767_basic.h b/example/driver_tea5767_basic.h
@@ -112,7 +112,7 @@ uint8_t tea5767_basic_search_down(void);
 
 /**
  * @brief     basic example set frequency
- * @param[in] mhz is the set frequency
+ * @param[in] mhz set frequency
  * @return    status code
  *            - 0 success
  *            - 1 set frequency failed
@@ -122,7 +122,7 @@ uint8_t tea5767_basic_set_frequency(float mhz);
 
 /**
  * @brief      basic example get frequency
- * @param[out] *mhz points to a frequency buffer
+ * @param[out] *mhz pointer to a frequency buffer
  * @return     status code
  *             - 0 success
  *             - 1 get frequency failed
@@ -132,7 +132,7 @@ uint8_t tea5767_basic_get_frequency(float *mhz);
 
 /**
  * @brief     basic example enable or disable mute
- * @param[in] enable is a bool value
+ * @param[in] enable bool value
  * @return    status code
  *            - 0 success
  *            - 1 set mute failed

diff --git a/interface/driver_tea5767_interface.h b/interface/driver_tea5767_interface.h
@@ -70,9 +70,9 @@ uint8_t tea5767_interface_iic_deinit(void);
 
 /**
  * @brief     interface iic bus write command
- * @param[in] addr is the iic device write address
- * @param[in] *buf points to a data buffer
- * @param[in] len is the length of data buffer
+ * @param[in] addr iic device write address
+ * @param[in] *buf pointer to a data buffer
+ * @param[in] len length of data buffer
  * @return    status code
  *            - 0 success
  *            - 1 write failed
@@ -82,9 +82,9 @@ uint8_t tea5767_interface_iic_write_cmd(uint8_t addr, uint8_t *buf, uint16_t len
 
 /**
  * @brief      interface iic bus read command
- * @param[in]  addr is the iic device write address
- * @param[out] *buf points to a data buffer
- * @param[in]  len is the length of data buffer
+ * @param[in]  addr iic device write address
+ * @param[out] *buf pointer to a data buffer
+ * @param[in]  len length of data buffer
  * @return     status code
  *             - 0 success
  *             - 1 read failed
@@ -94,14 +94,14 @@ uint8_t tea5767_interface_iic_read_cmd(uint8_t addr, uint8_t *buf, uint16_t len)
 
 /**
  * @brief     interface delay ms
- * @param[in] ms
+ * @param[in] ms time
  * @note      none
  */
 void tea5767_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 tea5767_interface_debug_print(const char *const fmt, ...);

diff --git a/interface/driver_tea5767_interface_template.c b/interface/driver_tea5767_interface_template.c
@@ -62,9 +62,9 @@ uint8_t tea5767_interface_iic_deinit(void)
 
 /**
  * @brief     interface iic bus write command
- * @param[in] addr is the iic device write address
- * @param[in] *buf points to a data buffer
- * @param[in] len is the length of data buffer
+ * @param[in] addr iic device write address
+ * @param[in] *buf pointer to a data buffer
+ * @param[in] len length of data buffer
  * @return    status code
  *            - 0 success
  *            - 1 write failed
@@ -77,9 +77,9 @@ uint8_t tea5767_interface_iic_write_cmd(uint8_t addr, uint8_t *buf, uint16_t len
 
 /**
  * @brief      interface iic bus read command
- * @param[in]  addr is the iic device write address
- * @param[out] *buf points to a data buffer
- * @param[in]  len is the length of data buffer
+ * @param[in]  addr iic device write address
+ * @param[out] *buf pointer to a data buffer
+ * @param[in]  len length of data buffer
  * @return     status code
  *             - 0 success
  *             - 1 read failed
@@ -92,7 +92,7 @@ uint8_t tea5767_interface_iic_read_cmd(uint8_t addr, uint8_t *buf, uint16_t len)
 
 /**
  * @brief     interface delay ms
- * @param[in] ms
+ * @param[in] ms time
  * @note      none
  */
 void tea5767_interface_delay_ms(uint32_t ms)
@@ -102,7 +102,7 @@ void tea5767_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 tea5767_interface_debug_print(const char *const fmt, ...)

diff --git a/project/raspberrypi4b/driver/src/raspberrypi4b_driver_tea5767_interface.c b/project/raspberrypi4b/driver/src/raspberrypi4b_driver_tea5767_interface.c
@@ -74,9 +74,9 @@ uint8_t tea5767_interface_iic_deinit(void)
 
 /**
  * @brief     interface iic bus write command
- * @param[in] addr is the iic device write address
- * @param[in] *buf points to a data buffer
- * @param[in] len is the length of data buffer
+ * @param[in] addr iic device write address
+ * @param[in] *buf pointer to a data buffer
+ * @param[in] len length of data buffer
  * @return    status code
  *            - 0 success
  *            - 1 write failed
@@ -89,9 +89,9 @@ uint8_t tea5767_interface_iic_write_cmd(uint8_t addr, uint8_t *buf, uint16_t len
 
 /**
  * @brief      interface iic bus read command
- * @param[in]  addr is the iic device write address
- * @param[out] *buf points to a data buffer
- * @param[in]  len is the length of data buffer
+ * @param[in]  addr iic device write address
+ * @param[out] *buf pointer to a data buffer
+ * @param[in]  len length of data buffer
  * @return     status code
  *             - 0 success
  *             - 1 read failed
@@ -104,7 +104,7 @@ uint8_t tea5767_interface_iic_read_cmd(uint8_t addr, uint8_t *buf, uint16_t len)
 
 /**
  * @brief     interface delay ms
- * @param[in] ms
+ * @param[in] ms time
  * @note      none
  */
 void tea5767_interface_delay_ms(uint32_t ms)
@@ -114,7 +114,7 @@ void tea5767_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 tea5767_interface_debug_print(const char *const fmt, ...)

diff --git a/project/raspberrypi4b/src/client.c b/project/raspberrypi4b/src/client.c
@@ -53,8 +53,13 @@ static int gs_conn_fd;                           /**< network handle */
 static struct sockaddr_in gs_server_addr;        /**< server address */
 
 /**
- * @brief main function
- * @note  none
+ * @brief     main function
+ * @param[in] argc arg numbers
+ * @param[in] **argv arg address
+ * @return    status code
+ *            - 0 success
+ *            - 1 run failed
+ * @note      none
  */
 int main(uint8_t argc, char **argv)
 {