diff --git a/CHANGELOG.md b/CHANGELOG.md index 56df34b..6bfa9d7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## 2.0.4 (2025-03-02) + +## Bug Fixes + +- fix doc errors + ## 2.0.3 (2025-01-05) ## Bug Fixes diff --git a/project/raspberrypi4b/interface/inc/wire.h b/project/raspberrypi4b/interface/inc/wire.h index c64d448..a1647c2 100644 --- a/project/raspberrypi4b/interface/inc/wire.h +++ b/project/raspberrypi4b/interface/inc/wire.h @@ -70,7 +70,7 @@ uint8_t wire_deinit(void); /** * @brief wire bus read data - * @param[out] *value points to a data buffer + * @param[out] *value pointer to a data buffer * @return status code * - 0 success * - 1 read failed @@ -80,7 +80,7 @@ uint8_t wire_read(uint8_t *value); /** * @brief wire bus write data - * @param[in] value is the write data + * @param[in] value write data * @return status code * - 0 success * - 1 write failed @@ -107,7 +107,7 @@ uint8_t wire_clock_deinit(void); /** * @brief wire bus write data - * @param[in] value is the write data + * @param[in] value write data * @return status code * - 0 success * - 1 write failed diff --git a/project/raspberrypi4b/interface/src/wire.c b/project/raspberrypi4b/interface/src/wire.c index 36ef83c..f9b18b8 100644 --- a/project/raspberrypi4b/interface/src/wire.c +++ b/project/raspberrypi4b/interface/src/wire.c @@ -108,7 +108,7 @@ uint8_t wire_deinit(void) /** * @brief wire bus read data - * @param[out] *value points to a data buffer + * @param[out] *value pointer to a data buffer * @return status code * - 0 success * - 1 read failed @@ -153,7 +153,7 @@ uint8_t wire_read(uint8_t *value) /** * @brief wire bus write data - * @param[in] value is the write data + * @param[in] value write data * @return status code * - 0 success * - 1 write failed @@ -244,7 +244,7 @@ uint8_t wire_clock_deinit(void) /** * @brief wire bus write data - * @param[in] value is the write data + * @param[in] value write data * @return status code * - 0 success * - 1 write failed diff --git a/project/stm32f407/interface/inc/delay.h b/project/stm32f407/interface/inc/delay.h index df70fea..38aab8c 100644 --- a/project/stm32f407/interface/inc/delay.h +++ b/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); diff --git a/project/stm32f407/interface/inc/uart.h b/project/stm32f407/interface/inc/uart.h index 330979b..193b4aa 100644 --- a/project/stm32f407/interface/inc/uart.h +++ b/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,7 +104,7 @@ 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 */ @@ -112,7 +112,7 @@ 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); diff --git a/project/stm32f407/interface/inc/wire.h b/project/stm32f407/interface/inc/wire.h index 91bbda8..03f4208 100644 --- a/project/stm32f407/interface/inc/wire.h +++ b/project/stm32f407/interface/inc/wire.h @@ -67,7 +67,7 @@ uint8_t wire_deinit(void); /** * @brief wire bus read data - * @param[out] *value points to a read data buffer + * @param[out] *value pointer to a read data buffer * @return status code * - 0 success * @note none @@ -76,7 +76,7 @@ uint8_t wire_read(uint8_t *value); /** * @brief wire bus write data - * @param[in] value is the write data + * @param[in] value write data * @return status code * - 0 success * @note none @@ -101,7 +101,7 @@ uint8_t wire_clock_deinit(void); /** * @brief wire bus write the data - * @param[in] value is the write data + * @param[in] value write data * @return status code * - 0 success * @note none diff --git a/project/stm32f407/interface/src/delay.c b/project/stm32f407/interface/src/delay.c index c729377..8ad9618 100644 --- a/project/stm32f407/interface/src/delay.c +++ b/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) diff --git a/project/stm32f407/interface/src/uart.c b/project/stm32f407/interface/src/uart.c index 44274ca..6b2680f 100644 --- a/project/stm32f407/interface/src/uart.c +++ b/project/stm32f407/interface/src/uart.c @@ -59,7 +59,7 @@ volatile uint8_t g_uart2_tx_done; /**< uart2 tx done flag */ /** * @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 @@ -111,8 +111,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 @@ -151,8 +151,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 */ @@ -196,7 +196,7 @@ 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 */ @@ -226,7 +226,7 @@ uint16_t uart_print(const char *const fmt, ...) /** * @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 @@ -278,8 +278,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 @@ -318,8 +318,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 */ @@ -363,7 +363,7 @@ uint16_t uart2_flush(void) /** * @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) @@ -373,7 +373,7 @@ UART_HandleTypeDef* uart_get_handle(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) diff --git a/project/stm32f407/interface/src/wire.c b/project/stm32f407/interface/src/wire.c index 6690793..7fa7b98 100644 --- a/project/stm32f407/interface/src/wire.c +++ b/project/stm32f407/interface/src/wire.c @@ -103,7 +103,7 @@ uint8_t wire_deinit(void) /** * @brief wire bus read data - * @param[out] *value points to a read data buffer + * @param[out] *value pointer to a read data buffer * @return status code * - 0 success * @note none @@ -121,7 +121,7 @@ uint8_t wire_read(uint8_t *value) /** * @brief wire bus write data - * @param[in] value is the write data + * @param[in] value write data * @return status code * - 0 success * @note none @@ -176,7 +176,7 @@ uint8_t wire_clock_deinit(void) /** * @brief wire bus write the data - * @param[in] value is the write data + * @param[in] value write data * @return status code * - 0 success * @note none diff --git a/project/stm32f407/usr/inc/shell.h b/project/stm32f407/usr/inc/shell.h index 1d3d158..3dfaeee 100644 --- a/project/stm32f407/usr/inc/shell.h +++ b/project/stm32f407/usr/inc/shell.h @@ -89,8 +89,8 @@ uint8_t shell_init(void); /** * @brief shell register function - * @param[in] *name points to a name buffer - * @param[in] *fuc points to a function address + * @param[in] *name pointer to a name buffer + * @param[in] *fuc pointer to a function address * @return status code * - 0 success * - 1 buffer is full @@ -100,8 +100,8 @@ uint8_t shell_register(char *name, uint8_t (*fuc)(uint8_t argc, char **argv)); /** * @brief shell parse command - * @param[in] *buf points to a buffer address - * @param[in] len is the buffer length + * @param[in] *buf pointer to a buffer address + * @param[in] len buffer length * @return status code * - 0 success * - 1 run failed diff --git a/project/stm32f407/usr/src/shell.c b/project/stm32f407/usr/src/shell.c index 1e852c4..d1ae1c7 100644 --- a/project/stm32f407/usr/src/shell.c +++ b/project/stm32f407/usr/src/shell.c @@ -40,12 +40,12 @@ static shell_t gs_shell; /**< shell handle */ /** * @brief shell pretreatment - * @param[in] *buf points to an in data buffer - * @param[in] in_len is the length of in data - * @param[out] *buf_out points to an out data buffer - * @param[out] *out_len points to the length of a out data buffer - * @param[out] **argv points to a argv buffer - * @param[out] *argc points to a argc buffer + * @param[in] *buf pointer to an in data buffer + * @param[in] in_len length of in data + * @param[out] *buf_out pointer to an out data buffer + * @param[out] *out_len pointer to the length of a out data buffer + * @param[out] **argv pointer to a argv buffer + * @param[out] *argc pointer to a argc buffer * @return status code * - 0 success * - 1 pretreatment failed @@ -92,8 +92,8 @@ static uint8_t a_shell_pretreatment(char *buf, uint16_t in_len, char *buf_out, u /** * @brief shell find function - * @param[in] *handle points to a shell structure - * @param[in] *name points to a name buffer + * @param[in] *handle pointer to a shell structure + * @param[in] *name pointer to a name buffer * @return status code * - 0 success * - 1 find failed @@ -116,7 +116,7 @@ static uint8_t a_shell_find(shell_t *handle, char *name) /** * @brief shell run function - * @param[in] *handle points to a shell structure + * @param[in] *handle pointer to a shell structure * @param[in] argc number of param * @param[in] **argv param * @return status code @@ -145,8 +145,8 @@ static uint8_t a_shell_run(shell_t *handle, uint8_t argc, char **argv) /** * @brief shell register function - * @param[in] *name points to a name buffer - * @param[in] *fuc points to a function address + * @param[in] *name pointer to a name buffer + * @param[in] *fuc pointer to a function address * @return status code * - 0 success * - 1 buffer is full @@ -180,16 +180,16 @@ uint8_t shell_init(void) } /** - * @brief shell parse command - * @param[in] *buf points to a buffer address - * @param[in] len is the buffer length - * @return status code - * - 0 success - * - 1 run failed - * - 2 find function failed - * - 3 length is too big - * - 4 pretreat failed - * @note none + * @brief shell parse command + * @param[in] *buf pointer to a buffer address + * @param[in] len buffer length + * @return status code + * - 0 success + * - 1 run failed + * - 2 find function failed + * - 3 length is too big + * - 4 pretreat failed + * @note none */ uint8_t shell_parse(char *buf, uint16_t len) { diff --git a/project/stm32f407/usr/src/stm32f4xx_hal_msp.c b/project/stm32f407/usr/src/stm32f4xx_hal_msp.c index 45c12ad..044342f 100644 --- a/project/stm32f407/usr/src/stm32f4xx_hal_msp.c +++ b/project/stm32f407/usr/src/stm32f4xx_hal_msp.c @@ -61,7 +61,7 @@ void HAL_MspDeInit(void) /** * @brief uart hal init - * @param[in] *huart points to a uart handle + * @param[in] *huart pointer to a uart handle * @note none */ void HAL_UART_MspInit(UART_HandleTypeDef *huart) @@ -118,7 +118,7 @@ void HAL_UART_MspInit(UART_HandleTypeDef *huart) /** * @brief uart hal deinit - * @param[in] *huart points to a uart handle + * @param[in] *huart pointer to a uart handle * @note none */ void HAL_UART_MspDeInit(UART_HandleTypeDef* huart) diff --git a/project/stm32f407/usr/src/stm32f4xx_it.c b/project/stm32f407/usr/src/stm32f4xx_it.c index bcdd00f..29895b2 100644 --- a/project/stm32f407/usr/src/stm32f4xx_it.c +++ b/project/stm32f407/usr/src/stm32f4xx_it.c @@ -166,7 +166,7 @@ void USART2_IRQHandler(void) /** * @brief uart error callback - * @param[in] *huart points to a uart handle + * @param[in] *huart pointer to a uart handle * @note none */ void HAL_UART_ErrorCallback(UART_HandleTypeDef *huart) @@ -176,7 +176,7 @@ void HAL_UART_ErrorCallback(UART_HandleTypeDef *huart) /** * @brief uart rx receive callback - * @param[in] *huart points to a uart handle + * @param[in] *huart pointer to a uart handle * @note none */ void HAL_UART_RxCpltCallback(UART_HandleTypeDef *huart) @@ -195,7 +195,7 @@ void HAL_UART_RxCpltCallback(UART_HandleTypeDef *huart) /** * @brief uart tx finished callback - * @param[in] *huart points to a uart handle + * @param[in] *huart pointer to a uart handle * @note none */ void HAL_UART_TxCpltCallback(UART_HandleTypeDef *huart)