Skip to content

fix: fix doc errors #16

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 #16

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.6 (2025-03-02)

## Bug Fixes

- fix doc bugs

## 2.0.5 (2025-01-05)

## Bug Fixes
Expand Down
62 changes: 31 additions & 31 deletions project/raspberrypi4b/interface/inc/iic.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion project/raspberrypi4b/interface/src/gpio.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ extern volatile uint8_t g_flag; /**< interrupt flag */

/**
* @brief gpio interrupt pthread
* @param *p ponts to an args buffer
* @param *p pointer to an args buffer
* @return NULL
* @note none
*/
Expand Down
62 changes: 31 additions & 31 deletions project/raspberrypi4b/interface/src/iic.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
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
44 changes: 22 additions & 22 deletions project/stm32f407/interface/inc/iic.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
Loading