Merge pull request #24 from libdriver/dev

fix: fix doc errors

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.0.2 (2024-12-01)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 2.0.1 (2024-08-05)
 
 ## Bug Fixes

doc/html/group__dht11__base__driver.html

@@ -190,7 +190,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gac1f2cdf4a0ee1a07bd931f8
 <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 dht11 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a dht11 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -226,7 +226,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga613fe8d9e5e47c0da3824c7
 <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 dht11 info structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*info</td><td>pointer to a dht11 info structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -260,7 +260,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaba23e7aa523fc9ba8459efc
 <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 dht11 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a dht11 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -313,9 +313,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gabe7da0c6a3197e905fef02c
 <p>read the humidity data </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 dht11 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*raw</td><td>points to a raw humidity buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*s</td><td>points to a converted humidity buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a dht11 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*raw</td><td>pointer to a raw humidity buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*s</td><td>pointer to a converted humidity buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -367,9 +367,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gae4f4f59a5709425d295b470
 <p>read the temperature data </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 dht11 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*raw</td><td>points to a raw temperature buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*s</td><td>points to a converted temperature buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a dht11 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*raw</td><td>pointer to a raw temperature buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*s</td><td>pointer to a converted temperature buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -433,11 +433,11 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga11de188827337b3c3782b44
 <p>read the temperature and humidity data </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 dht11 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*temperature_raw</td><td>points to a raw temperature buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*temperature_s</td><td>points to a converted temperature buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*humidity_raw</td><td>points to a raw humidity buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*humidity_s</td><td>points to a converted humidity buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a dht11 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*temperature_raw</td><td>pointer to a raw temperature buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*temperature_s</td><td>pointer to a converted temperature buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*humidity_raw</td><td>pointer to a raw humidity buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*humidity_s</td><td>pointer to a converted humidity buffer </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__dht11__example__driver.html

@@ -194,8 +194,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaaaeeeecb5891c352c751424
 <p>basic example read </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*temperature</td><td>points to a converted temperature buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*humidity</td><td>points to a converted humidity buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*temperature</td><td>pointer to a converted temperature buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*humidity</td><td>pointer to a converted humidity buffer </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__dht11__interface__driver.html

@@ -156,7 +156,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gac818cc70f2a4e72ac2358ed
 <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>
@@ -213,7 +213,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaeb26aa4617659b1c9802c00
 <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>
@@ -242,7 +242,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga7f24439de47eaef6b6abee9
 <p>interface delay us </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">us</td><td></td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">us</td><td>time </td></tr>
   </table>
   </dd>
 </dl>
@@ -345,7 +345,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga43a2f561a09951c81538899
 <p>interface bus read </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*value</td><td>points to a value buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*value</td><td>pointer to a value buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -379,7 +379,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga7cb221d264dc07fd3440139
 <p>interface bus write </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>is the written value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>written value </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__dht11__link__driver.html

@@ -159,8 +159,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga4b6f006099880b35dd4e3b6
 <p>link bus_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 dht11 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a bus_deinit function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to a dht11 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a bus_deinit function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -199,8 +199,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaaa498e65035815db017e992
 <p>link bus_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 dht11 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a bus_init function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to a dht11 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a bus_init function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -239,8 +239,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gae4dee9f1e15d3b9703e4a14
 <p>link bus_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 a dht11 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a bus_read function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to a dht11 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a bus_read function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -279,8 +279,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga3648d4f7820d3464d50bf42
 <p>link bus_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 a dht11 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a bus_write function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to a dht11 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a bus_write function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -319,8 +319,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gadc781f1488eb5737572ad8c
 <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 dht11 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 dht11 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>
@@ -359,8 +359,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gadc6a117f79e19b33a5e475c
 <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 dht11 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 dht11 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>
@@ -399,8 +399,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaea465f1a82c5a951d0bb369
 <p>link delay_us 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 dht11 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a delay_us function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to a dht11 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a delay_us function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -439,8 +439,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga850df311fd8f97e37338212
 <p>link disable_irq 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 dht11 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a disable_irq function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to a dht11 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a disable_irq function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -479,8 +479,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga38867397a82575abe19b0f2
 <p>link enable_irq 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 dht11 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to an enable_irq function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to a dht11 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to an enable_irq function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -519,8 +519,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga3ec86992f8bbf3626114766
 <p>initialize dht11_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 dht11 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>is dht11_handle_t </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to a dht11 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>dht11_handle_t </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__dht11__test__driver.html

@@ -122,7 +122,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gac1ee5cd76e7a33101c36708
 <p>read 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_dht11_basic.c

@@ -76,8 +76,8 @@ uint8_t dht11_basic_init(void)
 
 /**
  * @brief      basic example read
- * @param[out] *temperature points to a converted temperature buffer
- * @param[out] *humidity points to a converted humidity buffer
+ * @param[out] *temperature pointer to a converted temperature buffer
+ * @param[out] *humidity pointer to a converted humidity buffer
  * @return     status code
  *             - 0 success
  *             - 1 read failed

example/driver_dht11_basic.h

@@ -71,8 +71,8 @@ uint8_t dht11_basic_deinit(void);
 
 /**
  * @brief      basic example read
- * @param[out] *temperature points to a converted temperature buffer
- * @param[out] *humidity points to a converted humidity buffer
+ * @param[out] *temperature pointer to a converted temperature buffer
+ * @param[out] *humidity pointer to a converted humidity buffer
  * @return     status code
  *             - 0 success
  *             - 1 read failed

interface/driver_dht11_interface.h

@@ -71,7 +71,7 @@ uint8_t dht11_interface_deinit(void);
 
 /**
  * @brief      interface bus read
- * @param[out] *value points to a value buffer
+ * @param[out] *value pointer to a value buffer
  * @return     status code
  *             - 0 success
  *             - 1 read failed
@@ -81,7 +81,7 @@ uint8_t dht11_interface_read(uint8_t *value);
 
 /**
  * @brief     interface bus write
- * @param[in] value is the written value
+ * @param[in] value written value
  * @return    status code
  *            - 0 success
  *            - 1 write failed
@@ -91,14 +91,14 @@ uint8_t dht11_interface_write(uint8_t value);
 
 /**
  * @brief     interface delay ms
- * @param[in] ms
+ * @param[in] ms time
  * @note      none
  */
 void dht11_interface_delay_ms(uint32_t ms);
 
 /**
  * @brief     interface delay us
- * @param[in] us
+ * @param[in] us time
  * @note      none
  */
 void dht11_interface_delay_us(uint32_t us);
@@ -117,7 +117,7 @@ void dht11_interface_disable_irq(void);
 
 /**
  * @brief     interface print format data
- * @param[in] fmt is the format data
+ * @param[in] fmt format data
  * @note      none
  */
 void dht11_interface_debug_print(const char *const fmt, ...);

interface/driver_dht11_interface_template.c

@@ -63,7 +63,7 @@ uint8_t dht11_interface_deinit(void)
 
 /**
  * @brief      interface bus read
- * @param[out] *value points to a value buffer
+ * @param[out] *value pointer to a value buffer
  * @return     status code
  *             - 0 success
  *             - 1 read failed
@@ -76,7 +76,7 @@ uint8_t dht11_interface_read(uint8_t *value)
 
 /**
  * @brief     interface bus write
- * @param[in] value is the written value
+ * @param[in] value written value
  * @return    status code
  *            - 0 success
  *            - 1 write failed
@@ -89,7 +89,7 @@ uint8_t dht11_interface_write(uint8_t value)
 
 /**
  * @brief     interface delay ms
- * @param[in] ms
+ * @param[in] ms time
  * @note      none
  */
 void dht11_interface_delay_ms(uint32_t ms)
@@ -99,7 +99,7 @@ void dht11_interface_delay_ms(uint32_t ms)
 
 /**
  * @brief     interface delay us
- * @param[in] us
+ * @param[in] us time
  * @note      none
  */
 void dht11_interface_delay_us(uint32_t us)
@@ -127,7 +127,7 @@ void dht11_interface_disable_irq(void)
 
 /**
  * @brief     interface print format data
- * @param[in] fmt is the format data
+ * @param[in] fmt format data
  * @note      none
  */
 void dht11_interface_debug_print(const char *const fmt, ...)