Skip to content

fix: fix doc errors #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
libdriver merged 1 commit into from
Mar 2, 2025
Merged

fix: fix doc errors #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## 2.0.4 (2025-03-02)

## Bug Fixes

- fix doc errors

## 2.0.3 (2025-01-05)

## Bug Fixes
Expand Down
6 changes: 3 additions & 3 deletions project/raspberrypi4b/interface/inc/wire.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
6 changes: 3 additions & 3 deletions project/raspberrypi4b/interface/src/wire.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions project/stm32f407/interface/inc/delay.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
26 changes: 13 additions & 13 deletions project/stm32f407/interface/inc/uart.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
*/
Expand All @@ -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);
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
*/
Expand All @@ -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);
Expand Down
6 changes: 3 additions & 3 deletions project/stm32f407/interface/inc/wire.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions project/stm32f407/interface/src/delay.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down
26 changes: 13 additions & 13 deletions project/stm32f407/interface/src/uart.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
*/
Expand Down Expand Up @@ -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
*/
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
*/
Expand Down Expand Up @@ -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)
Expand All @@ -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)
Expand Down
6 changes: 3 additions & 3 deletions project/stm32f407/interface/src/wire.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions project/stm32f407/usr/inc/shell.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
Loading