Merge pull request #9 from libdriver/dev

fix: fix doc errors
libdriver · Dec 29, 2024 · 1fe6a0f · 1fe6a0f
2 parents 649e5a6 + eb4c1e1
commit 1fe6a0f
Show file tree

Hide file tree

Showing 23 changed files with 355 additions and 349 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## 1.0.3 (2024-12-01)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 1.0.2 (2024-08-05)
 
 ## Bug Fixes

diff --git a/doc/html/group__bmp280__base__driver.html b/doc/html/group__bmp280__base__driver.html
diff --git a/doc/html/group__bmp280__example__driver.html b/doc/html/group__bmp280__example__driver.html
@@ -376,8 +376,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gabae18b68a65c7c03546f31d
 <p>basic example init </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>is the set interface </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>is the chip address pin </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>chip interface </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>chip address pin </td></tr>
   </table>
   </dd>
 </dl>
@@ -421,8 +421,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga8e98f5a1669944a5fe9a224
 <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>
@@ -494,8 +494,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf21f36f8384ccffab1cf6a6
 <p>shot example init </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>is the set interface </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>is the chip address pin </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>chip interface </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>chip address pin </td></tr>
   </table>
   </dd>
 </dl>
@@ -539,8 +539,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaec99c32abbb4d024bc09a31
 <p>shot 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__bmp280__extern__driver.html b/doc/html/group__bmp280__extern__driver.html
@@ -141,9 +141,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaea664a73b23f8b9905c0abc
 <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 bmp280 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 bmp280 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="#ga36bb389280c3d514f58a177
 <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 bmp280 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 bmp280 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__bmp280__interface__driver.html b/doc/html/group__bmp280__interface__driver.html
@@ -159,7 +159,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaa52121dc463140311b6388b
 <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="#ga92e63bfad37f98468a9a76a
 <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>
@@ -295,10 +295,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga84f4b158699467900501307
 <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 the iic device write address </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">*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>
@@ -354,10 +354,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga789f2e299281c558712443a
 <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 the iic device write address </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">*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>
@@ -463,9 +463,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga510d39266bf6afa2582dfb0
 <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>
@@ -515,9 +515,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga88000c6e5f7433439fce4e3
 <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__bmp280__link__driver.html b/doc/html/group__bmp280__link__driver.html
@@ -162,8 +162,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gab8de73a19d4e90c26d002b2
 <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 bmp280 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 bmp280 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="#ga67d2fab07fc01589bd73e3d
 <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 bmp280 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 bmp280 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="#gaef462eb94493ae852c86390
 <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 bmp280 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 bmp280 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>
@@ -282,8 +282,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga86712186f1d99940149c826
 <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 bmp280 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 bmp280 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>
@@ -322,8 +322,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaaa23a46dcc5ebbd64d96beb
 <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 bmp280 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 bmp280 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>
@@ -362,8 +362,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gac26275291827ba9d49e5c6a
 <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 bmp280 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 bmp280 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>
@@ -402,8 +402,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaed533d8d078eef83a688016
 <p>initialize bmp280_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 bmp280 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>is bmp280_handle_t </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to a bmp280 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>bmp280_handle_t </td></tr>
   </table>
   </dd>
 </dl>
@@ -442,8 +442,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga82a6dd42c47c5136ac94e3c
 <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 a bmp280 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 a bmp280 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="#ga333d6c6ca8007df34f89b35
 <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 a bmp280 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 a bmp280 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="#ga4250a0dba415de5741e96ad
 <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 a bmp280 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 a bmp280 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="#gafcf8712f31c83cbb174013b
 <p>link spi_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 bmp280 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>points to a spi_write function address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to a bmp280 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">FUC</td><td>pointer to a spi_write function address </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/doc/html/group__bmp280__test__driver.html b/doc/html/group__bmp280__test__driver.html
@@ -141,9 +141,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga13ab24aaf4fb6aae5d31ecb
 <p>read test </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>is the set interface </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>is the chip address pin </td></tr>
-    <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">interface</td><td>chip interface </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>chip address pin </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">times</td><td>test times </td></tr>
   </table>
   </dd>
 </dl>
@@ -187,8 +187,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaf6ea2d30225dace3c930afc
 <p>register test </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>is the set interface </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>is the chip address pin </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>chip interface </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>chip address pin </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/example/driver_bmp280_basic.c b/example/driver_bmp280_basic.c
@@ -40,8 +40,8 @@ static bmp280_handle_t gs_handle;        /**< bmp280 handle */
 
 /**
  * @brief     basic example init
- * @param[in] interface is the set interface
- * @param[in] addr_pin is the chip address pin
+ * @param[in] interface chip interface
+ * @param[in] addr_pin chip address pin
  * @return    status code
  *            - 0 success
  *            - 1 init failed
@@ -156,8 +156,8 @@ uint8_t bmp280_basic_init(bmp280_interface_t interface, bmp280_address_t addr_pi
 
 /**
  * @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