Merge pull request #15 from libdriver/dev

fix: fix doc errors
libdriver · Dec 29, 2024 · 3ba5c5e · 3ba5c5e
2 parents 768bb69 + 4319321
commit 3ba5c5e
Show file tree

Hide file tree

Showing 19 changed files with 179 additions and 173 deletions.
diff --git a/CHANGELOG.md b/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

diff --git a/doc/html/group__bmp180__base__driver.html b/doc/html/group__bmp180__base__driver.html
@@ -236,7 +236,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga0deef18df82d84377438784
 <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 bmp180 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a bmp180 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -282,8 +282,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf3c662188f12c8064ae9942
 <p>get the measurement mode </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 bmp180 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*mode</td><td>points to a measurement mode buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a bmp180 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*mode</td><td>pointer to a measurement mode buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -318,7 +318,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga65168f688eb5ff35498b534
 <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 bmp180 info structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*info</td><td>pointer to a bmp180 info structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -352,7 +352,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga5aa54db20f8f98b1181bbd9
 <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 bmp180 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a bmp180 handle structure </td></tr>
   </table>
   </dd>
 </dl>
@@ -406,9 +406,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga880d3a313cb6718b9f0b166
 <p>read the pressure 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 bmp180 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*raw</td><td>points to a raw pressure buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*pa</td><td>points to a converted pressure buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a bmp180 handle structure </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*raw</td><td>pointer to a raw pressure buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*pa</td><td>pointer to a converted pressure buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -460,9 +460,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga67c7bf7d60c05ed72440745
 <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 bmp180 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">*c</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 bmp180 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">*c</td><td>pointer to a converted temperature buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -526,11 +526,11 @@ <h2 class="memtitle"><span class="permalink"><a href="#gacd04f1f25891ffbbbde3c4f
 <p>read the temperature and pressure 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 bmp180 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_c</td><td>points to a converted temperature buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*pressure_raw</td><td>points to a raw pressure buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*pressure_pa</td><td>points to a converted pressure buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a bmp180 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_c</td><td>pointer to a converted temperature buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*pressure_raw</td><td>pointer to a raw pressure buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*pressure_pa</td><td>pointer to a converted pressure buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -576,8 +576,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gafb64e489e0c46b2393db47a
 <p>set the measurement mode </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 bmp180 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>is the measurement mode </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a bmp180 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>measurement mode </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/doc/html/group__bmp180__example__driver.html b/doc/html/group__bmp180__example__driver.html
@@ -221,8 +221,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga0056b1734cc5512b8a9c2f2
 <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">*pressure</td><td>points to a converted pressure 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">*pressure</td><td>pointer to a converted pressure buffer </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/doc/html/group__bmp180__extend__driver.html b/doc/html/group__bmp180__extend__driver.html
@@ -141,9 +141,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga4f0ff7d30288034448463a1
 <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 bmp180 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>is the iic 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 a bmp180 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>iic 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>
@@ -195,9 +195,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga39a583af33b1e8043cf9873
 <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 bmp180 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>is the iic register address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>is the data write to the register </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a bmp180 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>iic register address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>data written to the register </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/doc/html/group__bmp180__interface__driver.html b/doc/html/group__bmp180__interface__driver.html
@@ -147,7 +147,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga97c773d57db23eb62db5c13
 <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="#ga584e79ff6e58d8cc51777fc
 <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>
@@ -283,10 +283,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#gab8771f53ae6beee58556124
 <p>interface iic 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 iic device write address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>is iic 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 the 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">reg</td><td>iic 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 the data buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -342,10 +342,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga7a2af030498cbf09d25a229
 <p>interface iic 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 iic device write address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">reg</td><td>is iic 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 the 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">reg</td><td>iic 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 the data buffer </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/doc/html/group__bmp180__link__driver.html b/doc/html/group__bmp180__link__driver.html
@@ -150,8 +150,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gad1d34fcd1ec17bf447e8207
 <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 bmp180 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 bmp180 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="#gaa5ee9999121e7b993785f2c
 <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 bmp180 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 bmp180 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="#gaeab8796404ae45bc28767d1
 <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 bmp180 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 bmp180 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="#ga4f3b638ae89217d795ffd05
 <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 bmp180 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 bmp180 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="#ga0ee137a4f53d6c29729bb24
 <p>link iic_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 bmp180 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to an iic_read function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to a bmp180 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to an iic_read function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -350,8 +350,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga806196708fe194565074a63
 <p>link iic_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 bmp180 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to an iic_write function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to a bmp180 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to an iic_write function address </td></tr>
   </table>
   </dd>
 </dl>
@@ -390,8 +390,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gad39ab646ca66d5fb2db4e9a
 <p>initialize bmp180_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 bmp180 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>is bmp180_handle_t </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to a bmp180 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>bmp180_handle_t </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/doc/html/group__bmp180__test__driver.html b/doc/html/group__bmp180__test__driver.html
@@ -125,7 +125,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga91d9e19614777a29a5dbace
 <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 read times </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">times</td><td>test times </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/example/driver_bmp180_basic.c b/example/driver_bmp180_basic.c
@@ -83,8 +83,8 @@ uint8_t bmp180_basic_init(void)
 
 /**
  * @brief      basic example read
- * @param[out] *temperature points to a converted temperature buffer
- * @param[out] *pressure points to a converted pressure buffer
+ * @param[out] *temperature pointer to a converted temperature buffer
+ * @param[out] *pressure pointer to a converted pressure buffer
  * @return     status code
  *             - 0 success
  *             - 1 read failed

diff --git a/example/driver_bmp180_basic.h b/example/driver_bmp180_basic.h
@@ -76,8 +76,8 @@ uint8_t bmp180_basic_deinit(void);
 
 /**
  * @brief      basic example read
- * @param[out] *temperature points to a converted temperature buffer
- * @param[out] *pressure points to a converted pressure buffer
+ * @param[out] *temperature pointer to a converted temperature buffer
+ * @param[out] *pressure pointer to a converted pressure buffer
  * @return     status code
  *             - 0 success
  *             - 1 read failed

diff --git a/interface/driver_bmp180_interface.h b/interface/driver_bmp180_interface.h
@@ -71,10 +71,10 @@ uint8_t bmp180_interface_iic_deinit(void);
 
 /**
  * @brief      interface iic bus read
- * @param[in]  addr is iic device write address
- * @param[in]  reg is iic register address
- * @param[out] *buf points to a data buffer
- * @param[in]  len is the length of the data buffer
+ * @param[in]  addr iic device write address
+ * @param[in]  reg iic register address
+ * @param[out] *buf pointer to a data buffer
+ * @param[in]  len length of the data buffer
  * @return     status code
  *             - 0 success
  *             - 1 read failed
@@ -84,10 +84,10 @@ uint8_t bmp180_interface_iic_read(uint8_t addr, uint8_t reg, uint8_t *buf, uint1
 
 /**
  * @brief     interface iic bus write
- * @param[in] addr is iic device write address
- * @param[in] reg is iic register address
- * @param[in] *buf points to a data buffer
- * @param[in] len is the length of the data buffer
+ * @param[in] addr iic device write address
+ * @param[in] reg iic register address
+ * @param[in] *buf pointer to a data buffer
+ * @param[in] len length of the data buffer
  * @return    status code
  *            - 0 success
  *            - 1 write failed
@@ -97,14 +97,14 @@ uint8_t bmp180_interface_iic_write(uint8_t addr, uint8_t reg, uint8_t *buf, uint
 
 /**
  * @brief     interface delay ms
- * @param[in] ms
+ * @param[in] ms time
  * @note      none
  */
 void bmp180_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 bmp180_interface_debug_print(const char *const fmt, ...);