diff --git a/CHANGELOG.md b/CHANGELOG.md index 307001a..97fda88 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## 1.0.4 (2024-12-21) + +## Bug Fixes + +- fix doc errors + ## 1.0.3 (2024-10-13) ## Bug Fixes diff --git a/doc/html/group__sfa30__basic__driver.html b/doc/html/group__sfa30__basic__driver.html index 83a473f..7473260 100644 --- a/doc/html/group__sfa30__basic__driver.html +++ b/doc/html/group__sfa30__basic__driver.html @@ -258,7 +258,7 @@

Parameters
- +
[in]*handlepoints to an sfa30 handle structure
[in]*handlepointer to an sfa30 handle structure
@@ -305,8 +305,8 @@

Parameters
- - + +
[in]*handlepoints to an sfa30 handle structure
[out]*infopoints to an info buffer
[in]*handlepointer to an sfa30 handle structure
[out]*infopointer to an info buffer
@@ -352,8 +352,8 @@

Parameters
- - + +
[in]*handlepoints to an sfa30 handle structure
[out]*interfacepoints to a chip interface buffer
[in]*handlepointer to an sfa30 handle structure
[out]*interfacepointer to a chip interface buffer
@@ -387,7 +387,7 @@

Parameters
- +
[out]*infopoints to an sfa30 info structure
[out]*infopointer to an sfa30 info structure
@@ -421,7 +421,7 @@

Parameters
- +
[in]*handlepoints to an sfa30 handle structure
[in]*handlepointer to an sfa30 handle structure
@@ -468,8 +468,8 @@

Parameters
- - + +
[in]*handlepoints to an sfa30 handle structure
[out]*datapoints to an sfa30_data_t structure
[in]*handlepointer to an sfa30 handle structure
[out]*datapointer to an sfa30_data_t structure
@@ -505,7 +505,7 @@

Parameters
- +
[in]*handlepoints to an sfa30 handle structure
[in]*handlepointer to an sfa30 handle structure
@@ -551,8 +551,8 @@

Parameters
- - + +
[in]*handlepoints to an sfa30 handle structure
[in]interfaceis the chip interface
[in]*handlepointer to an sfa30 handle structure
[in]interfacechip interface
@@ -586,7 +586,7 @@

Parameters
- +
[in]*handlepoints to an sfa30 handle structure
[in]*handlepointer to an sfa30 handle structure
@@ -622,7 +622,7 @@

Parameters
- +
[in]*handlepoints to an sfa30 handle structure
[in]*handlepointer to an sfa30 handle structure
diff --git a/doc/html/group__sfa30__example__driver.html b/doc/html/group__sfa30__example__driver.html index deab22e..6b5071e 100644 --- a/doc/html/group__sfa30__example__driver.html +++ b/doc/html/group__sfa30__example__driver.html @@ -162,7 +162,7 @@

Parameters
- +
[out]*infopoints to a info buffer
[out]*infopointer to a info buffer
@@ -196,7 +196,7 @@

Parameters
- +
[in]interfaceis the chip interface
[in]interfacechip interface
@@ -230,7 +230,7 @@

Parameters
- +
[out]*datapoints to a sfa30_data_t structure
[out]*datapointer to a sfa30_data_t structure
diff --git a/doc/html/group__sfa30__extern__driver.html b/doc/html/group__sfa30__extern__driver.html index 9a5de3c..bdcc407 100644 --- a/doc/html/group__sfa30__extern__driver.html +++ b/doc/html/group__sfa30__extern__driver.html @@ -150,10 +150,10 @@

Parameters
- - - - + + + +
[in]*handlepoints to an sfa30 handle structure
[in]regis the iic register address
[out]*bufpoints to a data buffer
[in]lenis the data buffer length
[in]*handlepointer to an sfa30 handle structure
[in]regiic register address
[out]*bufpointer to a data buffer
[in]lendata buffer length
@@ -217,11 +217,11 @@

Parameters
- - - - - + + + + +
[in]*handlepoints to an sfa30 handle structure
[in]*inputpoints to an input buffer
[in]in_lenis the input length
[out]*outputpoints to an output buffer
[in]out_lenis the output length
[in]*handlepointer to an sfa30 handle structure
[in]*inputpointer to an input buffer
[in]in_leninput length
[out]*outputpointer to an output buffer
[in]out_lenoutput length
@@ -277,10 +277,10 @@

Parameters
- - - - + + + +
[in]*handlepoints to an sfa30 handle structure
[in]regis the iic register address
[in]*bufpoints to a data buffer
[in]lenis the data buffer length
[in]*handlepointer to an sfa30 handle structure
[in]regiic register address
[in]*bufpointer to a data buffer
[in]lendata buffer length
diff --git a/doc/html/group__sfa30__interface__driver.html b/doc/html/group__sfa30__interface__driver.html index e35045d..b55a57f 100644 --- a/doc/html/group__sfa30__interface__driver.html +++ b/doc/html/group__sfa30__interface__driver.html @@ -162,7 +162,7 @@

Parameters
- +
[in]fmtis the format data
[in]fmtformat data
@@ -191,7 +191,7 @@

Parameters
- +
[in]ms
[in]mstime
@@ -292,9 +292,9 @@

Parameters
- - - + + +
[in]addris the iic device write address
[out]*bufpoints to a data buffer
[in]lenis the length of the data buffer
[in]addriic device write address
[out]*bufpointer to a data buffer
[in]lenlength of the data buffer
@@ -344,9 +344,9 @@

Parameters
- - - + + +
[in]addris the iic device write address
[in]*bufpoints to a data buffer
[in]lenis the length of the data buffer
[in]addriic device write address
[in]*bufpointer to a data buffer
[in]lenlength of the data buffer
@@ -474,8 +474,8 @@

Parameters
- - + +
[out]*bufpoints to a data buffer
[in]lenis the length of the data buffer
[out]*bufpointer to a data buffer
[in]lenlength of the data buffer
@@ -519,8 +519,8 @@

Parameters
- - + +
[in]*bufpoints to a data buffer
[in]lenis the length of the data buffer
[in]*bufpointer to a data buffer
[in]lenlength of the data buffer
diff --git a/doc/html/group__sfa30__link__driver.html b/doc/html/group__sfa30__link__driver.html index 6a2abcc..7534faf 100644 --- a/doc/html/group__sfa30__link__driver.html +++ b/doc/html/group__sfa30__link__driver.html @@ -165,8 +165,8 @@

Parameters
- - + +
[in]HANDLEpoints to an sfa30 handle structure
[in]FUCpoints to a debug_print function address
[in]HANDLEpointer to an sfa30 handle structure
[in]FUCpointer to a debug_print function address
@@ -205,8 +205,8 @@

Parameters
- - + +
[in]HANDLEpoints to an sfa30 handle structure
[in]FUCpoints to a delay_ms function address
[in]HANDLEpointer to an sfa30 handle structure
[in]FUCpointer to a delay_ms function address
@@ -245,8 +245,8 @@

Parameters
- - + +
[in]HANDLEpoints to an sfa30 handle structure
[in]FUCpoints to an iic_deinit function address
[in]HANDLEpointer to an sfa30 handle structure
[in]FUCpointer to an iic_deinit function address
@@ -285,8 +285,8 @@

Parameters
- - + +
[in]HANDLEpoints to an sfa30 handle structure
[in]FUCpoints to an iic_init function address
[in]HANDLEpointer to an sfa30 handle structure
[in]FUCpointer to an iic_init function address
@@ -325,8 +325,8 @@

Parameters
- - + +
[in]HANDLEpoints to an sfa30 handle structure
[in]FUCpoints to an iic_read_cmd function address
[in]HANDLEpointer to an sfa30 handle structure
[in]FUCpointer to an iic_read_cmd function address
@@ -365,8 +365,8 @@

Parameters
- - + +
[in]HANDLEpoints to an sfa30 handle structure
[in]FUCpoints to an iic_write_cmd function address
[in]HANDLEpointer to an sfa30 handle structure
[in]FUCpointer to an iic_write_cmd function address
@@ -405,8 +405,8 @@

Parameters
- - + +
[in]HANDLEpoints to an sfa30 handle structure
[in]STRUCTUREis sfa30_handle_t
[in]HANDLEpointer to an sfa30 handle structure
[in]STRUCTUREsfa30_handle_t
@@ -445,8 +445,8 @@

Parameters
- - + +
[in]HANDLEpoints to an sfa30 handle structure
[in]FUCpoints to a uart_deinit function address
[in]HANDLEpointer to an sfa30 handle structure
[in]FUCpointer to a uart_deinit function address
@@ -485,8 +485,8 @@

Parameters
- - + +
[in]HANDLEpoints to an sfa30 handle structure
[in]FUCpoints to a uart_flush function address
[in]HANDLEpointer to an sfa30 handle structure
[in]FUCpointer to a uart_flush function address
@@ -525,8 +525,8 @@

Parameters
- - + +
[in]HANDLEpoints to an sfa30 handle structure
[in]FUCpoints to a uart_init function address
[in]HANDLEpointer to an sfa30 handle structure
[in]FUCpointer to a uart_init function address
@@ -565,8 +565,8 @@

Parameters
- - + +
[in]HANDLEpoints to an sfa30 handle structure
[in]FUCpoints to a uart_read function address
[in]HANDLEpointer to an sfa30 handle structure
[in]FUCpointer to a uart_read function address
@@ -605,8 +605,8 @@

Parameters
- - + +
[in]HANDLEpoints to an sfa30 handle structure
[in]FUCpoints to a uart_write function address
[in]HANDLEpointer to an sfa30 handle structure
[in]FUCpointer to a uart_write function address
diff --git a/doc/html/group__sfa30__test__driver.html b/doc/html/group__sfa30__test__driver.html index 88d5baf..135ca6f 100644 --- a/doc/html/group__sfa30__test__driver.html +++ b/doc/html/group__sfa30__test__driver.html @@ -132,8 +132,8 @@

Parameters
- - + +
[in]interfaceis the chip interface
[in]timesis the test times
[in]interfacechip interface
[in]timestest times
diff --git a/example/driver_sfa30_basic.c b/example/driver_sfa30_basic.c index dae5b32..1e933ee 100644 --- a/example/driver_sfa30_basic.c +++ b/example/driver_sfa30_basic.c @@ -40,7 +40,7 @@ static sfa30_handle_t gs_handle; /**< sfa30 handle */ /** * @brief basic example init - * @param[in] interface is the chip interface + * @param[in] interface chip interface * @return status code * - 0 success * - 1 init failed @@ -125,7 +125,7 @@ uint8_t sfa30_basic_deinit(void) /** * @brief basic example read - * @param[out] *data points to a sfa30_data_t structure + * @param[out] *data pointer to a sfa30_data_t structure * @return status code * - 0 success * - 1 read failed @@ -164,7 +164,7 @@ uint8_t sfa30_basic_reset(void) /** * @brief basic example get device information - * @param[out] *info points to a info buffer + * @param[out] *info pointer to a info buffer * @return status code * - 0 success * - 1 get device information failed diff --git a/example/driver_sfa30_basic.h b/example/driver_sfa30_basic.h index d176045..239a5a7 100644 --- a/example/driver_sfa30_basic.h +++ b/example/driver_sfa30_basic.h @@ -52,7 +52,7 @@ extern "C"{ /** * @brief basic example init - * @param[in] interface is the chip interface + * @param[in] interface chip interface * @return status code * - 0 success * - 1 init failed @@ -71,7 +71,7 @@ uint8_t sfa30_basic_deinit(void); /** * @brief basic example read - * @param[out] *data points to a sfa30_data_t structure + * @param[out] *data pointer to a sfa30_data_t structure * @return status code * - 0 success * - 1 read failed @@ -90,7 +90,7 @@ uint8_t sfa30_basic_reset(void); /** * @brief basic example get device information - * @param[out] *info points to a info buffer + * @param[out] *info pointer to a info buffer * @return status code * - 0 success * - 1 get device information failed diff --git a/interface/driver_sfa30_interface.h b/interface/driver_sfa30_interface.h index 7a9dbbe..c7e2c1b 100644 --- a/interface/driver_sfa30_interface.h +++ b/interface/driver_sfa30_interface.h @@ -70,9 +70,9 @@ uint8_t sfa30_interface_iic_deinit(void); /** * @brief interface iic bus read - * @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 @@ -82,9 +82,9 @@ uint8_t sfa30_interface_iic_read_cmd(uint8_t addr, uint8_t *buf, uint16_t len); /** * @brief interface iic bus write - * @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 @@ -112,8 +112,8 @@ uint8_t sfa30_interface_uart_deinit(void); /** * @brief interface uart read - * @param[out] *buf points to a data buffer - * @param[in] len is the length of the data buffer + * @param[out] *buf pointer to a data buffer + * @param[in] len length of the data buffer * @return status code * - 0 success * - 1 read failed @@ -123,8 +123,8 @@ uint16_t sfa30_interface_uart_read(uint8_t *buf, uint16_t len); /** * @brief interface uart write - * @param[in] *buf points to a data buffer - * @param[in] len is the length of the data buffer + * @param[in] *buf pointer to a data buffer + * @param[in] len length of the data buffer * @return status code * - 0 success * - 1 write failed @@ -143,14 +143,14 @@ uint8_t sfa30_interface_uart_flush(void); /** * @brief interface delay ms - * @param[in] ms + * @param[in] ms time * @note none */ void sfa30_interface_delay_ms(uint32_t ms); /** * @brief interface print format data - * @param[in] fmt is the format data + * @param[in] fmt format data * @note none */ void sfa30_interface_debug_print(const char *const fmt, ...); diff --git a/interface/driver_sfa30_interface_template.c b/interface/driver_sfa30_interface_template.c index 8fff7bd..cdcf7a8 100644 --- a/interface/driver_sfa30_interface_template.c +++ b/interface/driver_sfa30_interface_template.c @@ -62,9 +62,9 @@ uint8_t sfa30_interface_iic_deinit(void) /** * @brief interface iic bus read - * @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 @@ -77,9 +77,9 @@ uint8_t sfa30_interface_iic_read_cmd(uint8_t addr, uint8_t *buf, uint16_t len) /** * @brief interface iic bus write - * @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 @@ -116,8 +116,8 @@ uint8_t sfa30_interface_uart_deinit(void) /** * @brief interface uart read - * @param[out] *buf points to a data buffer - * @param[in] len is the length of the data buffer + * @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,8 +130,8 @@ uint16_t sfa30_interface_uart_read(uint8_t *buf, uint16_t len) /** * @brief interface uart write - * @param[in] *buf points to a data buffer - * @param[in] len is the length of the data buffer + * @param[in] *buf pointer to a data buffer + * @param[in] len length of the data buffer * @return status code * - 0 success * - 1 write failed @@ -156,7 +156,7 @@ uint8_t sfa30_interface_uart_flush(void) /** * @brief interface delay ms - * @param[in] ms + * @param[in] ms time * @note none */ void sfa30_interface_delay_ms(uint32_t ms) @@ -166,7 +166,7 @@ void sfa30_interface_delay_ms(uint32_t ms) /** * @brief interface print format data - * @param[in] fmt is the format data + * @param[in] fmt format data * @note none */ void sfa30_interface_debug_print(const char *const fmt, ...) diff --git a/project/raspberrypi4b/driver/src/raspberrypi4b_driver_sfa30_interface.c b/project/raspberrypi4b/driver/src/raspberrypi4b_driver_sfa30_interface.c index f383f23..986ac8a 100644 --- a/project/raspberrypi4b/driver/src/raspberrypi4b_driver_sfa30_interface.c +++ b/project/raspberrypi4b/driver/src/raspberrypi4b_driver_sfa30_interface.c @@ -85,9 +85,9 @@ uint8_t sfa30_interface_iic_deinit(void) /** * @brief interface iic bus read - * @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 @@ -100,9 +100,9 @@ uint8_t sfa30_interface_iic_read_cmd(uint8_t addr, uint8_t *buf, uint16_t len) /** * @brief interface iic bus write - * @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 @@ -139,8 +139,8 @@ uint8_t sfa30_interface_uart_deinit(void) /** * @brief interface uart read - * @param[out] *buf points to a data buffer - * @param[in] len is the length of the data buffer + * @param[out] *buf pointer to a data buffer + * @param[in] len length of the data buffer * @return status code * - 0 success * - 1 read failed @@ -162,8 +162,8 @@ uint16_t sfa30_interface_uart_read(uint8_t *buf, uint16_t len) /** * @brief interface uart write - * @param[in] *buf points to a data buffer - * @param[in] len is the length of the data buffer + * @param[in] *buf pointer to a data buffer + * @param[in] len length of the data buffer * @return status code * - 0 success * - 1 write failed @@ -197,7 +197,7 @@ uint8_t sfa30_interface_uart_flush(void) /** * @brief interface delay ms - * @param[in] ms + * @param[in] ms time * @note none */ void sfa30_interface_delay_ms(uint32_t ms) @@ -207,7 +207,7 @@ void sfa30_interface_delay_ms(uint32_t ms) /** * @brief interface print format data - * @param[in] fmt is the format data + * @param[in] fmt format data * @note none */ void sfa30_interface_debug_print(const char *const fmt, ...) diff --git a/project/raspberrypi4b/src/main.c b/project/raspberrypi4b/src/main.c index 2350fc9..e53fa00 100644 --- a/project/raspberrypi4b/src/main.c +++ b/project/raspberrypi4b/src/main.c @@ -41,8 +41,8 @@ /** * @brief sfa30 full function - * @param[in] argc is arg numbers - * @param[in] **argv is the arg address + * @param[in] argc arg numbers + * @param[in] **argv arg address * @return status code * - 0 success * - 1 run failed @@ -323,8 +323,8 @@ uint8_t sfa30(uint8_t argc, char **argv) /** * @brief main function - * @param[in] argc is arg numbers - * @param[in] **argv is the arg address + * @param[in] argc arg numbers + * @param[in] **argv arg address * @return status code * - 0 success * @note none diff --git a/project/stm32f407/driver/src/stm32f407_driver_sfa30_interface.c b/project/stm32f407/driver/src/stm32f407_driver_sfa30_interface.c index 7774368..2f8b452 100644 --- a/project/stm32f407/driver/src/stm32f407_driver_sfa30_interface.c +++ b/project/stm32f407/driver/src/stm32f407_driver_sfa30_interface.c @@ -66,9 +66,9 @@ uint8_t sfa30_interface_iic_deinit(void) /** * @brief interface iic bus read - * @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 @@ -81,9 +81,9 @@ uint8_t sfa30_interface_iic_read_cmd(uint8_t addr, uint8_t *buf, uint16_t len) /** * @brief interface iic bus write - * @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 @@ -120,8 +120,8 @@ uint8_t sfa30_interface_uart_deinit(void) /** * @brief interface uart read - * @param[out] *buf points to a data buffer - * @param[in] len is the length of the data buffer + * @param[out] *buf pointer to a data buffer + * @param[in] len length of the data buffer * @return status code * - 0 success * - 1 read failed @@ -134,8 +134,8 @@ uint16_t sfa30_interface_uart_read(uint8_t *buf, uint16_t len) /** * @brief interface uart write - * @param[in] *buf points to a data buffer - * @param[in] len is the length of the data buffer + * @param[in] *buf pointer to a data buffer + * @param[in] len length of the data buffer * @return status code * - 0 success * - 1 write failed @@ -160,7 +160,7 @@ uint8_t sfa30_interface_uart_flush(void) /** * @brief interface delay ms - * @param[in] ms + * @param[in] ms time * @note none */ void sfa30_interface_delay_ms(uint32_t ms) @@ -170,7 +170,7 @@ void sfa30_interface_delay_ms(uint32_t ms) /** * @brief interface print format data - * @param[in] fmt is the format data + * @param[in] fmt format data * @note none */ void sfa30_interface_debug_print(const char *const fmt, ...) diff --git a/project/stm32f407/usr/src/main.c b/project/stm32f407/usr/src/main.c index c41bb6d..92ac137 100644 --- a/project/stm32f407/usr/src/main.c +++ b/project/stm32f407/usr/src/main.c @@ -51,8 +51,8 @@ volatile uint16_t g_len; /**< uart buffer length */ /** * @brief sfa30 full function - * @param[in] argc is arg numbers - * @param[in] **argv is the arg address + * @param[in] argc arg numbers + * @param[in] **argv arg address * @return status code * - 0 success * - 1 run failed diff --git a/src/driver_sfa30.c b/src/driver_sfa30.c index a50461d..42153e2 100644 --- a/src/driver_sfa30.c +++ b/src/driver_sfa30.c @@ -69,9 +69,9 @@ /** * @brief generate the crc - * @param[in] *handle points to an sfa30 handle structure - * @param[in] *data points to a data buffer - * @param[in] count is the data length + * @param[in] *handle pointer to an sfa30 handle structure + * @param[in] *data pointer to a data buffer + * @param[in] count data length * @return crc * @note none */ @@ -117,12 +117,12 @@ static uint8_t a_sfa30_generate_crc(sfa30_handle_t *handle, uint8_t* data, uint8 /** * @brief read bytes - * @param[in] *handle points to an sfa30 handle structure - * @param[in] addr is the iic device address - * @param[in] reg is the iic register address - * @param[out] *data points to a data buffer - * @param[in] len is the data length - * @param[in] delay_ms is the delay time in ms + * @param[in] *handle pointer to an sfa30 handle structure + * @param[in] addr iic device address + * @param[in] reg iic register address + * @param[out] *data pointer to a data buffer + * @param[in] len data length + * @param[in] delay_ms delay time in ms * @return status code * - 0 success * - 1 read failed @@ -149,12 +149,12 @@ static uint8_t a_sfa30_iic_read(sfa30_handle_t *handle, uint8_t addr, uint16_t r /** * @brief write bytes - * @param[in] *handle points to an sfa30 handle structure - * @param[in] addr is the iic device address - * @param[in] reg is the iic register address - * @param[in] *data points to a data buffer - * @param[in] len is the data length - * @param[in] delay_ms is the delay time in ms + * @param[in] *handle pointer to an sfa30 handle structure + * @param[in] addr iic device address + * @param[in] reg iic register address + * @param[in] *data pointer to a data buffer + * @param[in] len data length + * @param[in] delay_ms delay time in ms * @return status code * - 0 success * - 1 write failed @@ -182,10 +182,10 @@ static uint8_t a_sfa30_iic_write(sfa30_handle_t *handle, uint8_t addr, uint16_t /** * @brief uart get the rx frame - * @param[in] *handle points to an sfa30 handle structure - * @param[in] len is the buffer length - * @param[out] *output points to an output buffer - * @param[in] out_len is the output length + * @param[in] *handle pointer to an sfa30 handle structure + * @param[in] len buffer length + * @param[out] *output pointer to an output buffer + * @param[in] out_len output length * @return status code * - 0 success * - 1 uart get rx frame failed @@ -267,10 +267,10 @@ static uint8_t a_sfa30_uart_get_rx_frame(sfa30_handle_t *handle, uint16_t len, u /** * @brief uart set the tx frame - * @param[in] *handle points to an sfa30 handle structure - * @param[in] *input points to an input buffer - * @param[in] in_len is the input length - * @param[out] *out_len points to an output length buffer + * @param[in] *handle pointer to an sfa30 handle structure + * @param[in] *input pointer to an input buffer + * @param[in] in_len input length + * @param[out] *out_len pointer to an output length buffer * @return status code * - 0 success * - 1 uart set tx frame failed @@ -351,12 +351,12 @@ static uint8_t a_sfa30_uart_set_tx_frame(sfa30_handle_t *handle, uint8_t *input, /** * @brief write read bytes - * @param[in] *handle points to an sfa30 handle structure - * @param[in] *input points to an input buffer - * @param[in] in_len is the input length - * @param[in] delay_ms is the delay time in ms - * @param[out] *output points to an output buffer - * @param[in] out_len is the output length + * @param[in] *handle pointer to an sfa30 handle structure + * @param[in] *input pointer to an input buffer + * @param[in] in_len input length + * @param[in] delay_ms delay time in ms + * @param[out] *output pointer to an output buffer + * @param[in] out_len output length * @return status code * - 0 success * - 1 write read failed @@ -391,8 +391,8 @@ static uint8_t a_sfa30_uart_write_read(sfa30_handle_t *handle, uint8_t *input, u /** * @brief print error - * @param[in] *handle points to an sfa30 handle structure - * @param[in] e is the error code + * @param[in] *handle pointer to an sfa30 handle structure + * @param[in] e error code * @return error code * @note none */ @@ -466,8 +466,8 @@ static uint8_t a_sfa30_uart_error(sfa30_handle_t *handle, uint8_t e) /** * @brief set the chip interface - * @param[in] *handle points to an sfa30 handle structure - * @param[in] interface is the chip interface + * @param[in] *handle pointer to an sfa30 handle structure + * @param[in] interface chip interface * @return status code * - 0 success * - 2 handle is NULL @@ -487,8 +487,8 @@ uint8_t sfa30_set_interface(sfa30_handle_t *handle, sfa30_interface_t interface) /** * @brief get the chip interface - * @param[in] *handle points to an sfa30 handle structure - * @param[out] *interface points to a chip interface buffer + * @param[in] *handle pointer to an sfa30 handle structure + * @param[out] *interface pointer to a chip interface buffer * @return status code * - 0 success * - 2 handle is NULL @@ -508,7 +508,7 @@ uint8_t sfa30_get_interface(sfa30_handle_t *handle, sfa30_interface_t *interface /** * @brief start the measurement - * @param[in] *handle points to an sfa30 handle structure + * @param[in] *handle pointer to an sfa30 handle structure * @return status code * - 0 success * - 1 start measurement failed @@ -576,7 +576,7 @@ uint8_t sfa30_start_measurement(sfa30_handle_t *handle) /** * @brief stop the measurement - * @param[in] *handle points to an sfa30 handle structure + * @param[in] *handle pointer to an sfa30 handle structure * @return status code * - 0 success * - 1 stop measurement failed @@ -643,8 +643,8 @@ uint8_t sfa30_stop_measurement(sfa30_handle_t *handle) /** * @brief get device information - * @param[in] *handle points to an sfa30 handle structure - * @param[out] *info points to an info buffer + * @param[in] *handle pointer to an sfa30 handle structure + * @param[out] *info pointer to an info buffer * @return status code * - 0 success * - 1 get device information failed @@ -735,7 +735,7 @@ uint8_t sfa30_get_device_information(sfa30_handle_t *handle, char info[32]) /** * @brief reset the chip - * @param[in] *handle points to an sfa30 handle structure + * @param[in] *handle pointer to an sfa30 handle structure * @return status code * - 0 success * - 1 reset failed @@ -802,8 +802,8 @@ uint8_t sfa30_reset(sfa30_handle_t *handle) /** * @brief read the result - * @param[in] *handle points to an sfa30 handle structure - * @param[out] *data points to an sfa30_data_t structure + * @param[in] *handle pointer to an sfa30 handle structure + * @param[out] *data pointer to an sfa30_data_t structure * @return status code * - 0 success * - 1 read failed @@ -896,7 +896,7 @@ uint8_t sfa30_read(sfa30_handle_t *handle, sfa30_data_t *data) /** * @brief initialize the chip - * @param[in] *handle points to an sfa30 handle structure + * @param[in] *handle pointer to an sfa30 handle structure * @return status code * - 0 success * - 1 iic or uart initialization failed @@ -1042,7 +1042,7 @@ uint8_t sfa30_init(sfa30_handle_t *handle) /** * @brief close the chip - * @param[in] *handle points to an sfa30 handle structure + * @param[in] *handle pointer to an sfa30 handle structure * @return status code * - 0 success * - 1 iic or uart deinit failed @@ -1125,11 +1125,11 @@ uint8_t sfa30_deinit(sfa30_handle_t *handle) /** * @brief set and get the chip register with uart interface - * @param[in] *handle points to an sfa30 handle structure - * @param[in] *input points to an input buffer - * @param[in] in_len is the input length - * @param[out] *output points to an output buffer - * @param[in] out_len is the output length + * @param[in] *handle pointer to an sfa30 handle structure + * @param[in] *input pointer to an input buffer + * @param[in] in_len input length + * @param[out] *output pointer to an output buffer + * @param[in] out_len output length * @return status code * - 0 success * - 1 write read failed @@ -1160,10 +1160,10 @@ uint8_t sfa30_set_get_reg_uart(sfa30_handle_t *handle, uint8_t *input, uint16_t /** * @brief set the chip register with iic interface - * @param[in] *handle points to an sfa30 handle structure - * @param[in] reg is the iic register address - * @param[in] *buf points to a data buffer - * @param[in] len is the data buffer length + * @param[in] *handle pointer to an sfa30 handle structure + * @param[in] reg iic register address + * @param[in] *buf pointer to a data buffer + * @param[in] len data buffer length * @return status code * - 0 success * - 1 write failed @@ -1196,10 +1196,10 @@ uint8_t sfa30_set_reg_iic(sfa30_handle_t *handle, uint16_t reg, uint8_t *buf, ui /** * @brief get the chip register with iic interface - * @param[in] *handle points to an sfa30 handle structure - * @param[in] reg is the iic register address - * @param[out] *buf points to a data buffer - * @param[in] len is the data buffer length + * @param[in] *handle pointer to an sfa30 handle structure + * @param[in] reg iic register address + * @param[out] *buf pointer to a data buffer + * @param[in] len data buffer length * @return status code * - 0 success * - 1 read failed @@ -1232,7 +1232,7 @@ uint8_t sfa30_get_reg_iic(sfa30_handle_t *handle, uint16_t reg, uint8_t *buf, ui /** * @brief get chip information - * @param[out] *info points to an sfa30 info structure + * @param[out] *info pointer to an sfa30 info structure * @return status code * - 0 success * - 2 handle is NULL diff --git a/src/driver_sfa30.h b/src/driver_sfa30.h index e89067a..ed5790f 100644 --- a/src/driver_sfa30.h +++ b/src/driver_sfa30.h @@ -128,96 +128,96 @@ typedef struct sfa30_info_s /** * @brief initialize sfa30_handle_t structure - * @param[in] HANDLE points to an sfa30 handle structure - * @param[in] STRUCTURE is sfa30_handle_t + * @param[in] HANDLE pointer to an sfa30 handle structure + * @param[in] STRUCTURE sfa30_handle_t * @note none */ #define DRIVER_SFA30_LINK_INIT(HANDLE, STRUCTURE) memset(HANDLE, 0, sizeof(STRUCTURE)) /** * @brief link uart_init function - * @param[in] HANDLE points to an sfa30 handle structure - * @param[in] FUC points to a uart_init function address + * @param[in] HANDLE pointer to an sfa30 handle structure + * @param[in] FUC pointer to a uart_init function address * @note none */ #define DRIVER_SFA30_LINK_UART_INIT(HANDLE, FUC) (HANDLE)->uart_init = FUC /** * @brief link uart_deinit function - * @param[in] HANDLE points to an sfa30 handle structure - * @param[in] FUC points to a uart_deinit function address + * @param[in] HANDLE pointer to an sfa30 handle structure + * @param[in] FUC pointer to a uart_deinit function address * @note none */ #define DRIVER_SFA30_LINK_UART_DEINIT(HANDLE, FUC) (HANDLE)->uart_deinit = FUC /** * @brief link uart_read function - * @param[in] HANDLE points to an sfa30 handle structure - * @param[in] FUC points to a uart_read function address + * @param[in] HANDLE pointer to an sfa30 handle structure + * @param[in] FUC pointer to a uart_read function address * @note none */ #define DRIVER_SFA30_LINK_UART_READ(HANDLE, FUC) (HANDLE)->uart_read = FUC /** * @brief link uart_write function - * @param[in] HANDLE points to an sfa30 handle structure - * @param[in] FUC points to a uart_write function address + * @param[in] HANDLE pointer to an sfa30 handle structure + * @param[in] FUC pointer to a uart_write function address * @note none */ #define DRIVER_SFA30_LINK_UART_WRITE(HANDLE, FUC) (HANDLE)->uart_write = FUC /** * @brief link uart_flush function - * @param[in] HANDLE points to an sfa30 handle structure - * @param[in] FUC points to a uart_flush function address + * @param[in] HANDLE pointer to an sfa30 handle structure + * @param[in] FUC pointer to a uart_flush function address * @note none */ #define DRIVER_SFA30_LINK_UART_FLUSH(HANDLE, FUC) (HANDLE)->uart_flush = FUC /** * @brief link iic_init function - * @param[in] HANDLE points to an sfa30 handle structure - * @param[in] FUC points to an iic_init function address + * @param[in] HANDLE pointer to an sfa30 handle structure + * @param[in] FUC pointer to an iic_init function address * @note none */ #define DRIVER_SFA30_LINK_IIC_INIT(HANDLE, FUC) (HANDLE)->iic_init = FUC /** * @brief link iic_deinit function - * @param[in] HANDLE points to an sfa30 handle structure - * @param[in] FUC points to an iic_deinit function address + * @param[in] HANDLE pointer to an sfa30 handle structure + * @param[in] FUC pointer to an iic_deinit function address * @note none */ #define DRIVER_SFA30_LINK_IIC_DEINIT(HANDLE, FUC) (HANDLE)->iic_deinit = FUC /** * @brief link iic_write_cmd function - * @param[in] HANDLE points to an sfa30 handle structure - * @param[in] FUC points to an iic_write_cmd function address + * @param[in] HANDLE pointer to an sfa30 handle structure + * @param[in] FUC pointer to an iic_write_cmd function address * @note none */ #define DRIVER_SFA30_LINK_IIC_WRITE_COMMAND(HANDLE, FUC) (HANDLE)->iic_write_cmd = FUC /** * @brief link iic_read_cmd function - * @param[in] HANDLE points to an sfa30 handle structure - * @param[in] FUC points to an iic_read_cmd function address + * @param[in] HANDLE pointer to an sfa30 handle structure + * @param[in] FUC pointer to an iic_read_cmd function address * @note none */ #define DRIVER_SFA30_LINK_IIC_READ_COMMAND(HANDLE, FUC) (HANDLE)->iic_read_cmd = FUC /** * @brief link delay_ms function - * @param[in] HANDLE points to an sfa30 handle structure - * @param[in] FUC points to a delay_ms function address + * @param[in] HANDLE pointer to an sfa30 handle structure + * @param[in] FUC pointer to a delay_ms function address * @note none */ #define DRIVER_SFA30_LINK_DELAY_MS(HANDLE, FUC) (HANDLE)->delay_ms = FUC /** * @brief link debug_print function - * @param[in] HANDLE points to an sfa30 handle structure - * @param[in] FUC points to a debug_print function address + * @param[in] HANDLE pointer to an sfa30 handle structure + * @param[in] FUC pointer to a debug_print function address * @note none */ #define DRIVER_SFA30_LINK_DEBUG_PRINT(HANDLE, FUC) (HANDLE)->debug_print = FUC @@ -235,7 +235,7 @@ typedef struct sfa30_info_s /** * @brief get chip information - * @param[out] *info points to an sfa30 info structure + * @param[out] *info pointer to an sfa30 info structure * @return status code * - 0 success * - 2 handle is NULL @@ -245,8 +245,8 @@ uint8_t sfa30_info(sfa30_info_t *info); /** * @brief set the chip interface - * @param[in] *handle points to an sfa30 handle structure - * @param[in] interface is the chip interface + * @param[in] *handle pointer to an sfa30 handle structure + * @param[in] interface chip interface * @return status code * - 0 success * - 2 handle is NULL @@ -256,8 +256,8 @@ uint8_t sfa30_set_interface(sfa30_handle_t *handle, sfa30_interface_t interface) /** * @brief get the chip interface - * @param[in] *handle points to an sfa30 handle structure - * @param[out] *interface points to a chip interface buffer + * @param[in] *handle pointer to an sfa30 handle structure + * @param[out] *interface pointer to a chip interface buffer * @return status code * - 0 success * - 2 handle is NULL @@ -267,7 +267,7 @@ uint8_t sfa30_get_interface(sfa30_handle_t *handle, sfa30_interface_t *interface /** * @brief initialize the chip - * @param[in] *handle points to an sfa30 handle structure + * @param[in] *handle pointer to an sfa30 handle structure * @return status code * - 0 success * - 1 iic or uart initialization failed @@ -280,7 +280,7 @@ uint8_t sfa30_init(sfa30_handle_t *handle); /** * @brief close the chip - * @param[in] *handle points to an sfa30 handle structure + * @param[in] *handle pointer to an sfa30 handle structure * @return status code * - 0 success * - 1 iic or uart deinit failed @@ -293,8 +293,8 @@ uint8_t sfa30_deinit(sfa30_handle_t *handle); /** * @brief read the result - * @param[in] *handle points to an sfa30 handle structure - * @param[out] *data points to an sfa30_data_t structure + * @param[in] *handle pointer to an sfa30 handle structure + * @param[out] *data pointer to an sfa30_data_t structure * @return status code * - 0 success * - 1 read failed @@ -306,7 +306,7 @@ uint8_t sfa30_read(sfa30_handle_t *handle, sfa30_data_t *data); /** * @brief start the measurement - * @param[in] *handle points to an sfa30 handle structure + * @param[in] *handle pointer to an sfa30 handle structure * @return status code * - 0 success * - 1 start measurement failed @@ -318,7 +318,7 @@ uint8_t sfa30_start_measurement(sfa30_handle_t *handle); /** * @brief stop the measurement - * @param[in] *handle points to an sfa30 handle structure + * @param[in] *handle pointer to an sfa30 handle structure * @return status code * - 0 success * - 1 stop measurement failed @@ -330,7 +330,7 @@ uint8_t sfa30_stop_measurement(sfa30_handle_t *handle); /** * @brief reset the chip - * @param[in] *handle points to an sfa30 handle structure + * @param[in] *handle pointer to an sfa30 handle structure * @return status code * - 0 success * - 1 reset failed @@ -342,8 +342,8 @@ uint8_t sfa30_reset(sfa30_handle_t *handle); /** * @brief get device information - * @param[in] *handle points to an sfa30 handle structure - * @param[out] *info points to an info buffer + * @param[in] *handle pointer to an sfa30 handle structure + * @param[out] *info pointer to an info buffer * @return status code * - 0 success * - 1 get device information failed @@ -366,11 +366,11 @@ uint8_t sfa30_get_device_information(sfa30_handle_t *handle, char info[32]); /** * @brief set and get the chip register with uart interface - * @param[in] *handle points to an sfa30 handle structure - * @param[in] *input points to an input buffer - * @param[in] in_len is the input length - * @param[out] *output points to an output buffer - * @param[in] out_len is the output length + * @param[in] *handle pointer to an sfa30 handle structure + * @param[in] *input pointer to an input buffer + * @param[in] in_len input length + * @param[out] *output pointer to an output buffer + * @param[in] out_len output length * @return status code * - 0 success * - 1 write read failed @@ -380,10 +380,10 @@ uint8_t sfa30_set_get_reg_uart(sfa30_handle_t *handle, uint8_t *input, uint16_t /** * @brief set the chip register with iic interface - * @param[in] *handle points to an sfa30 handle structure - * @param[in] reg is the iic register address - * @param[in] *buf points to a data buffer - * @param[in] len is the data buffer length + * @param[in] *handle pointer to an sfa30 handle structure + * @param[in] reg iic register address + * @param[in] *buf pointer to a data buffer + * @param[in] len data buffer length * @return status code * - 0 success * - 1 write failed @@ -395,10 +395,10 @@ uint8_t sfa30_set_reg_iic(sfa30_handle_t *handle, uint16_t reg, uint8_t *buf, ui /** * @brief get the chip register with iic interface - * @param[in] *handle points to an sfa30 handle structure - * @param[in] reg is the iic register address - * @param[out] *buf points to a data buffer - * @param[in] len is the data buffer length + * @param[in] *handle pointer to an sfa30 handle structure + * @param[in] reg iic register address + * @param[out] *buf pointer to a data buffer + * @param[in] len data buffer length * @return status code * - 0 success * - 1 read failed diff --git a/test/driver_sfa30_read_test.c b/test/driver_sfa30_read_test.c index c96b2b0..c31835d 100644 --- a/test/driver_sfa30_read_test.c +++ b/test/driver_sfa30_read_test.c @@ -40,8 +40,8 @@ static sfa30_handle_t gs_handle; /**< sfa30 handle */ /** * @brief read test - * @param[in] interface is the chip interface - * @param[in] times is the test times + * @param[in] interface chip interface + * @param[in] times test times * @return status code * - 0 success * - 1 test failed diff --git a/test/driver_sfa30_read_test.h b/test/driver_sfa30_read_test.h index 416b14d..c4fcc98 100644 --- a/test/driver_sfa30_read_test.h +++ b/test/driver_sfa30_read_test.h @@ -52,8 +52,8 @@ extern "C"{ /** * @brief read test - * @param[in] interface is the chip interface - * @param[in] times is the test times + * @param[in] interface chip interface + * @param[in] times test times * @return status code * - 0 success * - 1 test failed