Merge pull request #24 from libdriver/dev

fix: fix doc errors

Author: libdriver

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.1.5 (2025-03-02)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 2.1.4 (2025-01-15)
 
 ## Bug Fixes

project/raspberrypi4b/interface/inc/iic.h

@@ -55,8 +55,8 @@ extern "C" {
 
 /**
  * @brief      iic bus init
- * @param[in]  *name points to an iic device name buffer
- * @param[out] *fd points to an iic device handle buffer
+ * @param[in]  *name pointer to an iic device name buffer
+ * @param[out] *fd pointer to an iic device handle buffer
  * @return     status code
  *             - 0 success
  *             - 1 init failed
@@ -66,7 +66,7 @@ uint8_t iic_init(char *name, int *fd);
 
 /**
  * @brief     iic bus deinit
- * @param[in] fd is the iic handle
+ * @param[in] fd iic handle
  * @return    status code
  *            - 0 success
  *            - 1 deinit failed
@@ -76,10 +76,10 @@ uint8_t iic_deinit(int fd);
 
 /**
  * @brief      iic bus read command
- * @param[in]  fd is the iic handle
- * @param[in]  addr is the iic device write address
- * @param[out] *buf points to a data buffer
- * @param[in]  len is the length of the data buffer
+ * @param[in]  fd iic handle
+ * @param[in]  addr iic device write 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
@@ -89,11 +89,11 @@ uint8_t iic_read_cmd(int fd, uint8_t addr, uint8_t *buf, uint16_t len);
 
 /**
  * @brief      iic bus read
- * @param[in]  fd is the iic handle
- * @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]  fd iic handle
+ * @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
@@ -103,11 +103,11 @@ uint8_t iic_read(int fd, uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);
 
 /**
  * @brief      iic bus read with 16 bits register address
- * @param[in]  fd is the iic handle
- * @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]  fd iic handle
+ * @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
@@ -117,10 +117,10 @@ uint8_t iic_read_address16(int fd, uint8_t addr, uint16_t reg, uint8_t *buf, uin
 
 /**
  * @brief     iic bus write command
- * @param[in] fd is the iic handle
- * @param[in] addr is the iic device write address
- * @param[in] *buf points to a data buffer
- * @param[in] len is the length of the data buffer
+ * @param[in] fd iic handle
+ * @param[in] addr iic device write 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
@@ -130,11 +130,11 @@ uint8_t iic_write_cmd(int fd, uint8_t addr, uint8_t *buf, uint16_t len);
 
 /**
  * @brief     iic bus write
- * @param[in] fd is the iic handle
- * @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] fd iic handle
+ * @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
@@ -144,11 +144,11 @@ uint8_t iic_write(int fd, uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len)
 
 /**
  * @brief     iic bus write with 16 bits register address
- * @param[in] fd is the iic handle
- * @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] fd iic handle
+ * @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

project/raspberrypi4b/interface/src/iic.c

@@ -42,8 +42,8 @@
 
 /**
  * @brief      iic bus init
- * @param[in]  *name points to an iic device name buffer
- * @param[out] *fd points to an iic device handle buffer
+ * @param[in]  *name pointer to an iic device name buffer
+ * @param[out] *fd pointer to an iic device handle buffer
  * @return     status code
  *             - 0 success
  *             - 1 init failed
@@ -69,7 +69,7 @@ uint8_t iic_init(char *name, int *fd)
 
 /**
  * @brief     iic bus deinit
- * @param[in] fd is the iic handle
+ * @param[in] fd iic handle
  * @return    status code
  *            - 0 success
  *            - 1 deinit failed
@@ -92,10 +92,10 @@ uint8_t iic_deinit(int fd)
 
 /**
  * @brief      iic bus read command
- * @param[in]  fd is the iic handle
- * @param[in]  addr is the iic device write address
- * @param[out] *buf points to a data buffer
- * @param[in]  len is the length of the data buffer
+ * @param[in]  fd iic handle
+ * @param[in]  addr iic device write 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
@@ -133,11 +133,11 @@ uint8_t iic_read_cmd(int fd, uint8_t addr, uint8_t *buf, uint16_t len)
 
 /**
  * @brief      iic bus read
- * @param[in]  fd is the iic handle
- * @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]  fd iic handle
+ * @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
@@ -179,11 +179,11 @@ uint8_t iic_read(int fd, uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len)
 
 /**
  * @brief      iic bus read with 16 bits register address
- * @param[in]  fd is the iic handle
- * @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]  fd iic handle
+ * @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
@@ -228,10 +228,10 @@ uint8_t iic_read_address16(int fd, uint8_t addr, uint16_t reg, uint8_t *buf, uin
 
 /**
  * @brief     iic bus write command
- * @param[in] fd is the iic handle
- * @param[in] addr is the iic device write address
- * @param[in] *buf points to a data buffer
- * @param[in] len is the length of the data buffer
+ * @param[in] fd iic handle
+ * @param[in] addr iic device write 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
@@ -269,11 +269,11 @@ uint8_t iic_write_cmd(int fd, uint8_t addr, uint8_t *buf, uint16_t len)
 
 /**
  * @brief     iic bus write
- * @param[in] fd is the iic handle
- * @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] fd iic handle
+ * @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
@@ -317,11 +317,11 @@ uint8_t iic_write(int fd, uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len)
 
 /**
  * @brief     iic bus write with 16 bits register address
- * @param[in] fd is the iic handle
- * @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] fd iic handle
+ * @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

project/stm32f407/interface/inc/delay.h

@@ -59,14 +59,14 @@ uint8_t delay_init(void);
 
 /**
  * @brief     delay us
- * @param[in] us
+ * @param[in] us time
  * @note      none
  */
 void delay_us(uint32_t us);
 
 /**
  * @brief     delay ms
- * @param[in] ms
+ * @param[in] ms time
  * @note      none
  */
 void delay_ms(uint32_t ms);

project/stm32f407/interface/inc/iic.h

@@ -67,9 +67,9 @@ uint8_t iic_deinit(void);
 
 /**
  * @brief     iic bus write command
- * @param[in] addr is the iic device write 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] *buf pointer to a data buffer
+ * @param[in] len length of the data buffer
  * @return    status code
  *            - 0 success
  *            - 1 write failed
@@ -79,10 +79,10 @@ uint8_t iic_write_cmd(uint8_t addr, uint8_t *buf, uint16_t len);
 
 /**
  * @brief     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
@@ -92,10 +92,10 @@ uint8_t iic_write(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);
 
 /**
  * @brief     iic bus write with 16 bits register address 
- * @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
@@ -105,9 +105,9 @@ uint8_t iic_write_address16(uint8_t addr, uint16_t reg, uint8_t *buf, uint16_t l
 
 /**
  * @brief      iic bus read command
- * @param[in]  addr is the iic device write 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[out] *buf pointer to a data buffer
+ * @param[in]  len length of the data buffer
  * @return     status code
  *             - 0 success
  *             - 1 read failed
@@ -117,10 +117,10 @@ uint8_t iic_read_cmd(uint8_t addr, uint8_t *buf, uint16_t len);
 
 /**
  * @brief      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
@@ -130,10 +130,10 @@ uint8_t iic_read(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);
 
 /**
  * @brief      iic bus read with 16 bits register address 
- * @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