Merge pull request #17 from libdriver/dev

fix: fix doc errors

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.0.2 (2024-12-08)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 1.0.1 (2024-08-05)
 
 ## Bug Fixes

doc/html/group__ina219__example__driver.html

@@ -338,8 +338,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaed4ee6c678f7f9a35cc582d
 <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_pin</td><td>is the iic address pin </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">r</td><td>is the reference resistor value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>iic address pin </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">r</td><td>reference resistor value </td></tr>
   </table>
   </dd>
 </dl>
@@ -389,9 +389,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gaa87b67aed8b0171c67ec0db
 <p>basic example read </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*mV</td><td>points to a mV buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*mA</td><td>points to a mA buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*mW</td><td>points to a mW buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*mV</td><td>pointer to a mV buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*mA</td><td>pointer to a mA buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*mW</td><td>pointer to a mW buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -463,8 +463,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga5ceea32b188cca0c2fb5e33
 <p>shot example init </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>is the iic address pin </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">r</td><td>is the reference resistor value </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>iic address pin </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">r</td><td>reference resistor value </td></tr>
   </table>
   </dd>
 </dl>
@@ -514,9 +514,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga3e812a052aa6bc8e73aff5f
 <p>shot example read </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[out]</td><td class="paramname">*mV</td><td>points to a mV buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*mA</td><td>points to a mA buffer </td></tr>
-    <tr><td class="paramdir">[out]</td><td class="paramname">*mW</td><td>points to a mW buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*mV</td><td>pointer to a mV buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*mA</td><td>pointer to a mA buffer </td></tr>
+    <tr><td class="paramdir">[out]</td><td class="paramname">*mW</td><td>pointer to a mW buffer </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__ina219__extern__driver.html

@@ -141,9 +141,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga4c6e99d1313e81c29307e79
 <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 ina219 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">*data</td><td>points to a data buffer </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an ina219 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">*data</td><td>pointer to a data buffer </td></tr>
   </table>
   </dd>
 </dl>
@@ -195,9 +195,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gae0523e2468b0a46a343713d
 <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 ina219 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">data</td><td>is the write data </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to an ina219 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">data</td><td>written data </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__ina219__interface__driver.html

@@ -147,7 +147,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#gad3a806fbff0baa6c10be7da
 <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="#ga633e3559e78e959bf6e9fca
 <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="#ga525b409d9256841bba469d7
 <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>
@@ -342,10 +342,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga26fcca03b2b12f20dd3444e
 <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>

doc/html/group__ina219__link__driver.html

@@ -150,8 +150,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga9922e78b1626ecf7ae53409
 <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 ina219 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 ina219 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="#ga8673e62ce693140e1e1336b
 <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 ina219 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 ina219 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="#ga14c0beaad85c8e67c51bab3
 <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 an ina219 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 an ina219 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="#gab0620e2b8b4ad39924e36ef
 <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 an ina219 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 an ina219 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="#gac594efe5dee88eb96c043f4
 <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 an ina219 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 an ina219 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="#ga67e49c69437c88729b8d72d
 <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 an ina219 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 an ina219 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="#ga48d806c7449c1bc550da89f
 <p>initialize ina219_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 ina219 handle structure </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>is ina219_handle_t </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">HANDLE</td><td>pointer to an ina219 handle structure </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">STRUCTURE</td><td>ina219_handle_t </td></tr>
   </table>
   </dd>
 </dl>

doc/html/group__ina219__test__driver.html

@@ -141,9 +141,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#gadadaf875601015be4418d9a
 <p>read test </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>is the iic device address </td></tr>
-    <tr><td class="paramdir">[in]</td><td class="paramname">r</td><td>is the extern resistance </td></tr>
-    <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">addr_pin</td><td>iic device address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">r</td><td>extern resistance </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">times</td><td>test times </td></tr>
   </table>
   </dd>
 </dl>
@@ -177,7 +177,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga138f2304682f048f17519f4
 <p>register test </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>is the iic device address </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">addr_pin</td><td>iic device address </td></tr>
   </table>
   </dd>
 </dl>

example/driver_ina219_basic.c

@@ -40,8 +40,8 @@ static ina219_handle_t gs_handle;        /**< ina219 handle */
 
 /**
  * @brief     basic example init
- * @param[in] addr_pin is the iic address pin
- * @param[in] r is the reference resistor value
+ * @param[in] addr_pin iic address pin
+ * @param[in] r reference resistor value
  * @return    status code
  *            - 0 success
  *            - 1 init failed
@@ -163,9 +163,9 @@ uint8_t ina219_basic_init(ina219_address_t addr_pin, double r)
 
 /**
  * @brief      basic example read
- * @param[out] *mV points to a mV buffer
- * @param[out] *mA points to a mA buffer
- * @param[out] *mW points to a mW buffer
+ * @param[out] *mV pointer to a mV buffer
+ * @param[out] *mA pointer to a mA buffer
+ * @param[out] *mW pointer to a mW buffer
  * @return     status code
  *             - 0 success
  *             - 1 read failed

example/driver_ina219_basic.h

@@ -60,8 +60,8 @@ extern "C"{
 
 /**
  * @brief     basic example init
- * @param[in] addr_pin is the iic address pin
- * @param[in] r is the reference resistor value
+ * @param[in] addr_pin iic address pin
+ * @param[in] r reference resistor value
  * @return    status code
  *            - 0 success
  *            - 1 init failed
@@ -80,9 +80,9 @@ uint8_t ina219_basic_deinit(void);
 
 /**
  * @brief      basic example read
- * @param[out] *mV points to a mV buffer
- * @param[out] *mA points to a mA buffer
- * @param[out] *mW points to a mW buffer
+ * @param[out] *mV pointer to a mV buffer
+ * @param[out] *mA pointer to a mA buffer
+ * @param[out] *mW pointer to a mW buffer
  * @return     status code
  *             - 0 success
  *             - 1 read failed

example/driver_ina219_shot.c

@@ -40,8 +40,8 @@ static ina219_handle_t gs_handle;        /**< ina219 handle */
 
 /**
  * @brief     shot example init
- * @param[in] addr_pin is the iic address pin
- * @param[in] r is the reference resistor value
+ * @param[in] addr_pin iic address pin
+ * @param[in] r reference resistor value
  * @return    status code
  *            - 0 success
  *            - 1 init failed
@@ -153,9 +153,9 @@ uint8_t ina219_shot_init(ina219_address_t addr_pin, double r)
 
 /**
  * @brief      shot example read
- * @param[out] *mV points to a mV buffer
- * @param[out] *mA points to a mA buffer
- * @param[out] *mW points to a mW buffer
+ * @param[out] *mV pointer to a mV buffer
+ * @param[out] *mA pointer to a mA buffer
+ * @param[out] *mW pointer to a mW buffer
  * @return     status code
  *             - 0 success
  *             - 1 read failed

example/driver_ina219_shot.h

@@ -58,8 +58,8 @@ extern "C"{
 
 /**
  * @brief     shot example init
- * @param[in] addr_pin is the iic address pin
- * @param[in] r is the reference resistor value
+ * @param[in] addr_pin iic address pin
+ * @param[in] r reference resistor value
  * @return    status code
  *            - 0 success
  *            - 1 init failed
@@ -78,9 +78,9 @@ uint8_t ina219_shot_deinit(void);
 
 /**
  * @brief      shot example read
- * @param[out] *mV points to a mV buffer
- * @param[out] *mA points to a mA buffer
- * @param[out] *mW points to a mW buffer
+ * @param[out] *mV pointer to a mV buffer
+ * @param[out] *mA pointer to a mA buffer
+ * @param[out] *mW pointer to a mW buffer
  * @return     status code
  *             - 0 success
  *             - 1 read failed

interface/driver_ina219_interface.h

@@ -70,10 +70,10 @@ uint8_t ina219_interface_iic_deinit(void);
 
 /**
  * @brief      interface iic bus read
- * @param[in]  addr is the iic device write address
- * @param[in]  reg is the 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
@@ -83,10 +83,10 @@ uint8_t ina219_interface_iic_read(uint8_t addr, uint8_t reg, uint8_t *buf, uint1
 
 /**
  * @brief     interface iic bus write
- * @param[in] addr is the iic device write address
- * @param[in] reg is the 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
@@ -96,14 +96,14 @@ uint8_t ina219_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 ina219_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 ina219_interface_debug_print(const char *const fmt, ...);