fix: fix doc bugs

libdriver · Dec 29, 2024 · 0e18ece · 0e18ece
1 parent a03fe45
commit 0e18ece
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## 2.0.4 (2024-12-28)
+
+## Bug Fixes
+
+- fix doc bugs
+
 ## 2.0.3 (2024-12-15)
 
 ## Bug Fixes

diff --git a/doc/html/group__max30205__base__driver.html b/doc/html/group__max30205__base__driver.html
@@ -551,7 +551,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga37bd9f1b89d1d9dfd016e5a
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a max30205 handle structure </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">bus_timeout</td><td>pointer to an iic bus timeout buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*bus_timeout</td><td>pointer to an iic bus timeout buffer </td></tr>
   </table>
   </dd>
 </dl>

diff --git a/src/driver_max30205.c b/src/driver_max30205.c
@@ -491,7 +491,7 @@ uint8_t max30205_set_bus_timeout(max30205_handle_t *handle, max30205_bus_timeout
 /**
  * @brief      get the iic bus timeout
  * @param[in]  *handle pointer to a max30205 handle structure
- * @param[out] bus_timeout pointer to an iic bus timeout buffer
+ * @param[out] *bus_timeout pointer to an iic bus timeout buffer
  * @return     status code
  *             - 0 success
  *             - 2 handle is NULL

diff --git a/src/driver_max30205.h b/src/driver_max30205.h
@@ -419,7 +419,7 @@ uint8_t max30205_set_bus_timeout(max30205_handle_t *handle, max30205_bus_timeout
 /**
  * @brief      get the iic bus timeout
  * @param[in]  *handle pointer to a max30205 handle structure
- * @param[out] bus_timeout pointer to an iic bus timeout buffer
+ * @param[out] *bus_timeout pointer to an iic bus timeout buffer
  * @return     status code
  *             - 0 success
  *             - 2 handle is NULL