Merge pull request #7 from libdriver/dev

fix: fix doc errors

Author: libdriver

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.0.4 (2025-03-02)
+
+## Bug Fixes
+
+- fix doc errors
+
 ## 1.0.3 (2025-01-05)
 
 ## Bug Fixes

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 10ms
- * @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
@@ -143,10 +143,10 @@ uint8_t iic_read_with_wait(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

project/stm32f407/interface/inc/uart.h

@@ -57,7 +57,7 @@ extern "C"{
 
 /**
  * @brief     uart init with 8 data bits, 1 stop bit and no parity
- * @param[in] baud is the baud rate
+ * @param[in] baud baud rate
  * @return    status code
  *            - 0 success
  *            - 1 init failed
@@ -76,8 +76,8 @@ uint8_t uart_deinit(void);
 
 /**
  * @brief     uart write data
- * @param[in] *buf points to a data buffer
- * @param[in] len is the data length
+ * @param[in] *buf pointer to a data buffer
+ * @param[in] len data length
  * @return    status code
  *            - 0 success
  *            - 1 write failed
@@ -87,8 +87,8 @@ uint8_t uart_write(uint8_t *buf, uint16_t len);
 
 /**
  * @brief      uart read data
- * @param[out] *buf points to a data buffer
- * @param[in]  len is the data length
+ * @param[out] *buf pointer to a data buffer
+ * @param[in]  len data length
  * @return     length of the read data
  * @note       this function will clear all received buffer even read length is less than received length
  */
@@ -104,15 +104,15 @@ uint16_t uart_flush(void);
 
 /**
  * @brief     uart print format data
- * @param[in] fmt is the format data
+ * @param[in] fmt format data
  * @return    length of the sent data
  * @note      none
  */
 uint16_t uart_print(const char *const fmt, ...);
 
 /**
  * @brief  uart get the handle
- * @return points to a uart handle
+ * @return pointer to a uart handle
  * @note   none
  */
 UART_HandleTypeDef* uart_get_handle(void);
@@ -131,7 +131,7 @@ void uart_irq_handler(void);
 
 /**
  * @brief     uart2 init with 8 data bits, 1 stop bit and no parity
- * @param[in] baud is the baud rate
+ * @param[in] baud baud rate
  * @return    status code
  *            - 0 success
  *            - 1 init failed
@@ -150,8 +150,8 @@ uint8_t uart2_deinit(void);
 
 /**
  * @brief     uart2 write data
- * @param[in] *buf points to a data buffer
- * @param[in] len is the data length
+ * @param[in] *buf pointer to a data buffer
+ * @param[in] len data length
  * @return    status code
  *            - 0 success
  *            - 1 write failed
@@ -161,8 +161,8 @@ uint8_t uart2_write(uint8_t *buf, uint16_t len);
 
 /**
  * @brief      uart2 read data
- * @param[out] *buf points to a data buffer
- * @param[in]  len is the data length
+ * @param[out] *buf pointer to a data buffer
+ * @param[in]  len data length
  * @return     length of the read data
  * @note       this function will clear all received buffer even read length is less than received length
  */
@@ -178,7 +178,7 @@ uint16_t uart2_flush(void);
 
 /**
  * @brief  uart2 get the handle
- * @return points to a uart handle
+ * @return pointer to a uart handle
  * @note   none
  */
 UART_HandleTypeDef* uart2_get_handle(void);

project/stm32f407/interface/src/delay.c

@@ -57,7 +57,7 @@ uint8_t delay_init(void)
 
 /**
  * @brief     delay us
- * @param[in] us
+ * @param[in] us time
  * @note      none
  */
 void delay_us(uint32_t us)
@@ -99,7 +99,7 @@ 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/src/iic.c

@@ -194,7 +194,7 @@ static void a_iic_nack(void)
 
 /**
  * @brief     iic send one byte
- * @param[in] txd is the sent byte
+ * @param[in] txd sent byte
  * @note      none
  */
 static void a_iic_send_byte(uint8_t txd)
@@ -217,7 +217,7 @@ static void a_iic_send_byte(uint8_t txd)
 
 /**
  * @brief     iic read one byte
- * @param[in] ack is the sent ack
+ * @param[in] ack sent ack
  * @return    read byte
  * @note      none
  */
@@ -253,9 +253,9 @@ static uint8_t a_iic_read_byte(uint8_t ack)
 
 /**
  * @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
@@ -298,10 +298,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
@@ -353,10 +353,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
@@ -417,9 +417,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
@@ -465,10 +465,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
@@ -535,10 +535,10 @@ uint8_t iic_read(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len)
 
 /**
  * @brief      iic bus read with 10ms
- * @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
@@ -608,10 +608,10 @@ uint8_t iic_read_with_wait(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