Merge pull request #4 from libdriver/dev

fix: fix doc errors
libdriver · Dec 29, 2024 · 097f094 · 097f094
2 parents 2a63d03 + ed07eea
commit 097f094
Show file tree

Hide file tree

Showing 18 changed files with 676 additions and 670 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## 1.0.2 (2024-12-10)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 1.0.1 (2024-08-05)
 
 ## Bug Fixes

diff --git a/doc/html/group__lan8720__advance__driver.html b/doc/html/group__lan8720__advance__driver.html
diff --git a/doc/html/group__lan8720__base__driver.html b/doc/html/group__lan8720__base__driver.html
diff --git a/doc/html/group__lan8720__example__driver.html b/doc/html/group__lan8720__example__driver.html
@@ -177,7 +177,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga1dfac0c8b2b0f67dce0165d
 <p>basic example auto negotiation </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*speed</td><td>points to a speed indication buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*speed</td><td>pointer to a speed indication buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -241,7 +241,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga70f8bf9cab56b5ae5f5ece4
 <p>basic example init </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 device address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>device address </td></tr>
   </table>
   </dd>
 </dl>
@@ -275,7 +275,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga42fc50a762a76cf1886109c
 <p>basic example get link status </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*status</td><td>points to a status buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*status</td><td>pointer to a status buffer </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/doc/html/group__lan8720__extend__driver.html b/doc/html/group__lan8720__extend__driver.html
@@ -141,9 +141,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga49bfe95072f2832f3b58244
 <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 lan8720 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">*value</td><td>points to a read data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an lan8720 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">*value</td><td>pointer to a read data buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -196,9 +196,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga2b650f870029a07dbde7b13
 <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 lan8720 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">value</td><td>is the data written to the register </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an lan8720 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">value</td><td>written value </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/doc/html/group__lan8720__interface__driver.html b/doc/html/group__lan8720__interface__driver.html
@@ -156,7 +156,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga1ee5b959ef53c1889554551
 <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>
@@ -185,7 +185,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga957fd18955787b963cf84b1
 <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>
@@ -270,7 +270,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga1a6eea24de9c5d54c14f990
 <p>interface reset gpio write </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>is the set level </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>set level </td></tr>
   </table>
   </dd>
 </dl>
@@ -376,9 +376,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga72c7fa662903565279c6567
 <p>interface smi bus read </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 device address </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">*data</td><td>points to a data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>device address </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">*data</td><td>pointer to a data buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -428,9 +428,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gad4519b8361be297387537c6
 <p>interface smi bus write </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 device address </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">data</td><td>is the set data </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>device address </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">data</td><td>set data </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/doc/html/group__lan8720__link__driver.html b/doc/html/group__lan8720__link__driver.html
@@ -159,8 +159,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gae4b3d6550f71ca75bdc9f51
 <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 lan8720 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 lan8720 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>
@@ -199,8 +199,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gad66ce6a21f58ff3375f948c
 <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 lan8720 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 lan8720 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>
@@ -239,8 +239,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga4f02803833e0d0c557dba64
 <p>initialize lan8720_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 lan8720 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>is lan8720_handle_t </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an lan8720 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>lan8720_handle_t </td></tr>
   </table>
   </dd>
 </dl>
@@ -279,8 +279,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gab534d9915094a1052b0a43a
 <p>link reset_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 lan8720 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a reset_gpio_deinit function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an lan8720 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a reset_gpio_deinit function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -319,8 +319,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga79fc491665b99ee114b0c22
 <p>link reset_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 lan8720 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a reset_gpio_init function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an lan8720 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a reset_gpio_init function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -359,8 +359,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga51c85c8dafb24cf73de59cd
 <p>link reset_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 lan8720 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a reset_gpio_write function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an lan8720 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a reset_gpio_write function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -399,8 +399,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf5f6c5847631a7c8380dca9
 <p>link smi_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 lan8720 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to an smi_deinit function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an lan8720 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to an smi_deinit function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -439,8 +439,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga6f297f8bc6c9358188fcaf8
 <p>link smi_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 lan8720 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to an smi_init function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an lan8720 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to an smi_init function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -479,8 +479,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga8040875e631bb158964f6cc
 <p>link smi_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 lan8720 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to an smi_read function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an lan8720 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to an smi_read function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -519,8 +519,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gae7f5959241e0166d5282588
 <p>link smi_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 lan8720 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to an smi_write function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an lan8720 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to an smi_write function address </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/doc/html/group__lan8720__test__driver.html b/doc/html/group__lan8720__test__driver.html
@@ -122,7 +122,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaa728c66805d854648ce9c8a
 <p>register test </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 device address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr</td><td>device address </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/example/driver_lan8720_basic.c b/example/driver_lan8720_basic.c
@@ -40,7 +40,7 @@ static lan8720_handle_t gs_handle;        /**< lan8720 handle */
 
 /**
  * @brief     basic example init
- * @param[in] addr is the device address
+ * @param[in] addr device address
  * @return    status code
  *            - 0 success
  *            - 1 init failed
@@ -185,7 +185,7 @@ uint8_t lan8720_basic_deinit(void)
 
 /**
  * @brief      basic example get link status
- * @param[out] *status points to a status buffer
+ * @param[out] *status pointer to a status buffer
  * @return     status code
  *             - 0 success
  *             - 1 link status failed
@@ -209,7 +209,7 @@ uint8_t lan8720_basic_link_status(lan8720_link_t *status)
 
 /**
  * @brief      basic example auto negotiation
- * @param[out] *speed points to a speed indication buffer
+ * @param[out] *speed pointer to a speed indication buffer
  * @return     status code
  *             - 0 success
  *             - 1 auto negotiation failed

diff --git a/example/driver_lan8720_basic.h b/example/driver_lan8720_basic.h
@@ -58,7 +58,7 @@ extern "C"{
 
 /**
  * @brief     basic example init
- * @param[in] addr is the device address
+ * @param[in] addr device address
  * @return    status code
  *            - 0 success
  *            - 1 init failed
@@ -77,7 +77,7 @@ uint8_t lan8720_basic_deinit(void);
 
 /**
  * @brief      basic example get link status
- * @param[out] *status points to a status buffer
+ * @param[out] *status pointer to a status buffer
  * @return     status code
  *             - 0 success
  *             - 1 link status failed
@@ -89,7 +89,7 @@ uint8_t lan8720_basic_link_status(lan8720_link_t *status);
 
 /**
  * @brief      basic example auto negotiation
- * @param[out] *speed points to a speed indication buffer
+ * @param[out] *speed pointer to a speed indication buffer
  * @return     status code
  *             - 0 success
  *             - 1 auto negotiation failed

diff --git a/interface/driver_lan8720_interface.h b/interface/driver_lan8720_interface.h
@@ -70,9 +70,9 @@ uint8_t lan8720_interface_smi_deinit(void);
 
 /**
  * @brief      interface smi bus read
- * @param[in]  addr is the device address
- * @param[in]  reg is the register address
- * @param[out] *data points to a data buffer
+ * @param[in]  addr device address
+ * @param[in]  reg register address
+ * @param[out] *data pointer to a data buffer
  * @return     status code
  *             - 0 success
  *             - 1 read failed
@@ -82,9 +82,9 @@ uint8_t lan8720_interface_smi_read(uint8_t addr, uint8_t reg, uint16_t *data);
 
 /**
  * @brief     interface smi bus write
- * @param[in] addr is the device address
- * @param[in] reg is the register address
- * @param[in] data is the set data
+ * @param[in] addr device address
+ * @param[in] reg register address
+ * @param[in] data set data
  * @return    status code
  *            - 0 success
  *            - 1 write failed
@@ -112,7 +112,7 @@ uint8_t lan8720_interface_reset_gpio_deinit(void);
 
 /**
  * @brief     interface reset gpio write
- * @param[in] level is the set level
+ * @param[in] level set level
  * @return    status code
  *            - 0 success
  *            - 1 reset gpio write failed
@@ -122,14 +122,14 @@ uint8_t lan8720_interface_reset_gpio_write(uint8_t level);
 
 /**
  * @brief     interface delay ms
- * @param[in] ms
+ * @param[in] ms time
  * @note      none
  */
 void lan8720_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 lan8720_interface_debug_print(const char *const fmt, ...);

diff --git a/interface/driver_lan8720_interface_template.c b/interface/driver_lan8720_interface_template.c
@@ -62,9 +62,9 @@ uint8_t lan8720_interface_smi_deinit(void)
 
 /**
  * @brief      interface smi bus read
- * @param[in]  addr is the device address
- * @param[in]  reg is the register address
- * @param[out] *data points to a data buffer
+ * @param[in]  addr device address
+ * @param[in]  reg register address
+ * @param[out] *data pointer to a data buffer
  * @return     status code
  *             - 0 success
  *             - 1 read failed
@@ -77,9 +77,9 @@ uint8_t lan8720_interface_smi_read(uint8_t addr, uint8_t reg, uint16_t *data)
 
 /**
  * @brief     interface smi bus write
- * @param[in] addr is the device address
- * @param[in] reg is the register address
- * @param[in] data is the set data
+ * @param[in] addr device address
+ * @param[in] reg register address
+ * @param[in] data set data
  * @return    status code
  *            - 0 success
  *            - 1 write failed
@@ -116,7 +116,7 @@ uint8_t lan8720_interface_reset_gpio_deinit(void)
 
 /**
  * @brief     interface reset gpio write
- * @param[in] level is the set level
+ * @param[in] level set level
  * @return    status code
  *            - 0 success
  *            - 1 reset gpio write failed
@@ -129,7 +129,7 @@ uint8_t lan8720_interface_reset_gpio_write(uint8_t level)
 
 /**
  * @brief     interface delay ms
- * @param[in] ms
+ * @param[in] ms time
  * @note      none
  */
 void lan8720_interface_delay_ms(uint32_t ms)
@@ -139,7 +139,7 @@ void lan8720_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 lan8720_interface_debug_print(const char *const fmt, ...)