diff --git a/CHANGELOG.md b/CHANGELOG.md index 5170656..7e13541 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## 2.0.3 (2025-01-01) + +## Bug Fixes + +- fix doc errors + ## 2.0.2 (2024-08-10) ## Bug Fixes diff --git a/doc/html/group__tsl2561__base__driver.html b/doc/html/group__tsl2561__base__driver.html index 51c9f51..8146528 100644 --- a/doc/html/group__tsl2561__base__driver.html +++ b/doc/html/group__tsl2561__base__driver.html @@ -335,7 +335,7 @@

Parameters
- +
[in]*handlepoints to a tsl2561 handle structure
[in]*handlepointer to a tsl2561 handle structure
@@ -381,8 +381,8 @@

Parameters
- - + +
[in]*handlepoints to a tsl2561 handle structure
[out]*addr_pinpoints to a chip iic address pin buffer
[in]*handlepointer to a tsl2561 handle structure
[out]*addr_pinpointer to a chip iic address pin buffer
@@ -427,8 +427,8 @@

Parameters
- - + +
[in]*handlepoints to a tsl2561 handle structure
[out]*gainpoints to an adc gain buffer
[in]*handlepointer to a tsl2561 handle structure
[out]*gainpointer to an adc gain buffer
@@ -473,8 +473,8 @@

Parameters
- - + +
[in]*handlepoints to a tsl2561 handle structure
[out]*tpoints to an integration time buffer
[in]*handlepointer to a tsl2561 handle structure
[out]*tpointer to an integration time buffer
@@ -509,7 +509,7 @@

Parameters
- +
[out]*infopoints to a tsl2561 info structure
[out]*infopointer to a tsl2561 info structure
@@ -543,7 +543,7 @@

Parameters
- +
[in]*handlepoints to a tsl2561 handle structure
[in]*handlepointer to a tsl2561 handle structure
@@ -579,7 +579,7 @@

Parameters
- +
[in]*handlepoints to a tsl2561 handle structure
[in]*handlepointer to a tsl2561 handle structure
@@ -637,10 +637,10 @@

Parameters
- - - - + + + +
[in]*handlepoints to a tsl2561 handle structure
[out]*channel_0_rawpoints to a channel 0 raw data
[out]*channel_1_rawpoints to a channel 1 raw data
[out]*luxpoints to a converted lux
[in]*handlepointer to a tsl2561 handle structure
[out]*channel_0_rawpointer to a channel 0 raw data
[out]*channel_1_rawpointer to a channel 1 raw data
[out]*luxpointer to a converted lux
@@ -686,8 +686,8 @@

Parameters
- - + +
[in]*handlepoints to a tsl2561 handle structure
[in]addr_pinis the chip iic address pin
[in]*handlepointer to a tsl2561 handle structure
[in]addr_pinchip iic address pin
@@ -732,8 +732,8 @@

Parameters
- - + +
[in]*handlepoints to a tsl2561 handle structure
[in]gainis the adc gain
[in]*handlepointer to a tsl2561 handle structure
[in]gainadc gain
@@ -778,8 +778,8 @@

Parameters
- - + +
[in]*handlepoints to a tsl2561 handle structure
[in]tis the integration time
[in]*handlepointer to a tsl2561 handle structure
[in]tintegration time
@@ -814,7 +814,7 @@

Parameters
- +
[in]*handlepoints to a tsl2561 handle structure
[in]*handlepointer to a tsl2561 handle structure
diff --git a/doc/html/group__tsl2561__example__driver.html b/doc/html/group__tsl2561__example__driver.html index 94bab96..416f2df 100644 --- a/doc/html/group__tsl2561__example__driver.html +++ b/doc/html/group__tsl2561__example__driver.html @@ -328,7 +328,7 @@

Parameters
- +
[in]addr_pinis the iic device address
[in]addr_piniic device address
@@ -362,7 +362,7 @@

Parameters
- +
[out]*luxpoints to a lux buffer
[out]*luxpointer to a lux buffer
@@ -446,10 +446,10 @@

Parameters
- - - - + + + +
[in]addr_pinis the iic device address
[in]modeis the interrupt mode
[in]ch0_low_thresholdis the channel 0 interrupt low threshold
[in]ch0_high_thresholdis the channel 0 interrupt high threshold
[in]addr_piniic device address
[in]modeinterrupt mode
[in]ch0_low_thresholdchannel 0 interrupt low threshold
[in]ch0_high_thresholdchannel 0 interrupt high threshold
@@ -483,7 +483,7 @@

Parameters
- +
[out]*luxpoints to a lux buffer
[out]*luxpointer to a lux buffer
diff --git a/doc/html/group__tsl2561__extend__driver.html b/doc/html/group__tsl2561__extend__driver.html index 24adbee..44d19b5 100644 --- a/doc/html/group__tsl2561__extend__driver.html +++ b/doc/html/group__tsl2561__extend__driver.html @@ -147,10 +147,10 @@

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

Parameters
- - - - + + + +
[in]*handlepoints to a tsl2561 handle structure
[in]regis the iic register address
[in]*bufpoints to a data buffer
[in]lenis the data buffer length
[in]*handlepointer to a tsl2561 handle structure
[in]regiic register address
[in]*bufpointer to a data buffer
[in]lendata buffer length
diff --git a/doc/html/group__tsl2561__interface__driver.html b/doc/html/group__tsl2561__interface__driver.html index 0826f27..2747fe5 100644 --- a/doc/html/group__tsl2561__interface__driver.html +++ b/doc/html/group__tsl2561__interface__driver.html @@ -147,7 +147,7 @@

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

Parameters
- +
[in]ms
[in]mstime
@@ -283,10 +283,10 @@

Parameters
- - - - + + + +
[in]addris the iic device write address
[in]regis the iic register address
[out]*bufpoints to a data buffer
[in]lenis the length of the data buffer
[in]addriic device write address
[in]regiic register address
[out]*bufpointer to a data buffer
[in]lenlength of the data buffer
@@ -342,10 +342,10 @@

Parameters
- - - - + + + +
[in]addris the iic device write address
[in]regis the iic register address
[in]*bufpoints to a data buffer
[in]lenis the length of the data buffer
[in]addriic device write address
[in]regiic register address
[in]*bufpointer to a data buffer
[in]lenlength of the data buffer
diff --git a/doc/html/group__tsl2561__interrupt__driver.html b/doc/html/group__tsl2561__interrupt__driver.html index f7b1390..f3d6198 100644 --- a/doc/html/group__tsl2561__interrupt__driver.html +++ b/doc/html/group__tsl2561__interrupt__driver.html @@ -234,8 +234,8 @@

Parameters
- - + +
[in]*handlepoints to a tsl2561 handle structure
[out]*enablepoints to a bool buffer
[in]*handlepointer to a tsl2561 handle structure
[out]*enablepointer to a bool buffer
@@ -280,8 +280,8 @@

Parameters
- - + +
[in]*handlepoints to a tsl2561 handle structure
[out]*ch0_rawpoints to a channel 0 raw data buffer
[in]*handlepointer to a tsl2561 handle structure
[out]*ch0_rawpointer to a channel 0 raw data buffer
@@ -326,8 +326,8 @@

Parameters
- - + +
[in]*handlepoints to a tsl2561 handle structure
[out]*ch0_rawpoints to a channel 0 raw data buffer
[in]*handlepointer to a tsl2561 handle structure
[out]*ch0_rawpointer to a channel 0 raw data buffer
@@ -372,8 +372,8 @@

Parameters
- - + +
[in]*handlepoints to a tsl2561 handle structure
[out]*modepoints to an interrupt mode buffer
[in]*handlepointer to a tsl2561 handle structure
[out]*modepointer to an interrupt mode buffer
@@ -418,8 +418,8 @@

Parameters
- - + +
[in]*handlepoints to a tsl2561 handle structure
[in]enableis a bool value
[in]*handlepointer to a tsl2561 handle structure
[in]enablebool value
@@ -464,8 +464,8 @@

Parameters
- - + +
[in]*handlepoints to a tsl2561 handle structure
[in]ch0_rawis the channel 0 raw data
[in]*handlepointer to a tsl2561 handle structure
[in]ch0_rawchannel 0 raw data
@@ -510,8 +510,8 @@

Parameters
- - + +
[in]*handlepoints to a tsl2561 handle structure
[in]ch0_rawis the channel 0 raw data
[in]*handlepointer to a tsl2561 handle structure
[in]ch0_rawchannel 0 raw data
@@ -556,8 +556,8 @@

Parameters
- - + +
[in]*handlepoints to a tsl2561 handle structure
[in]modeis the interrupt mode
[in]*handlepointer to a tsl2561 handle structure
[in]modeinterrupt mode
diff --git a/doc/html/group__tsl2561__link__driver.html b/doc/html/group__tsl2561__link__driver.html index eb2da99..35c363a 100644 --- a/doc/html/group__tsl2561__link__driver.html +++ b/doc/html/group__tsl2561__link__driver.html @@ -150,8 +150,8 @@

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

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

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

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

Parameters
- - + +
[in]HANDLEpoints to a tsl2561 handle structure
[in]FUCpoints to an iic_read function address
[in]HANDLEpointer to a tsl2561 handle structure
[in]FUCpointer to an iic_read function address
@@ -350,8 +350,8 @@

Parameters
- - + +
[in]HANDLEpoints to a tsl2561 handle structure
[in]FUCpoints to an iic_write function address
[in]HANDLEpointer to a tsl2561 handle structure
[in]FUCpointer to an iic_write function address
@@ -390,8 +390,8 @@

Parameters
- - + +
[in]HANDLEpoints to a tsl2561 handle structure
[in]STRUCTUREis tsl2561_handle_t
[in]HANDLEpointer to a tsl2561 handle structure
[in]STRUCTUREtsl2561_handle_t
diff --git a/doc/html/group__tsl2561__test__driver.html b/doc/html/group__tsl2561__test__driver.html index ba0c646..c3c5724 100644 --- a/doc/html/group__tsl2561__test__driver.html +++ b/doc/html/group__tsl2561__test__driver.html @@ -156,11 +156,11 @@

Parameters
- - - - - + + + + +
[in]addr_pinis the iic device address
[in]modeis the interrupt mode
[in]ch0_low_thresholdis the channel 0 interrupt low threshold
[in]ch0_high_thresholdis the channel 0 interrupt high threshold
[in]timesis the test times
[in]addr_piniic device address
[in]modeinterrupt mode
[in]ch0_low_thresholdchannel 0 interrupt low threshold
[in]ch0_high_thresholdchannel 0 interrupt high threshold
[in]timestest times
@@ -204,8 +204,8 @@

Parameters
- - + +
[in]addr_pinis the iic device address
[in]timesis the test times
[in]addr_piniic device address
[in]timestest times
@@ -239,7 +239,7 @@

Parameters
- +
[in]addris the iic device address
[in]addriic device address
diff --git a/example/driver_tsl2561_basic.c b/example/driver_tsl2561_basic.c index 0101a11..12bec83 100644 --- a/example/driver_tsl2561_basic.c +++ b/example/driver_tsl2561_basic.c @@ -41,7 +41,7 @@ static tsl2561_handle_t gs_handle; /**< tsl2561 handle */ /** * @brief basic example init - * @param[in] addr_pin is the iic device address + * @param[in] addr_pin iic device address * @return status code * - 0 success * - 1 init failed @@ -153,7 +153,7 @@ uint8_t tsl2561_basic_init(tsl2561_address_t addr_pin) /** * @brief basic example read - * @param[out] *lux points to a lux buffer + * @param[out] *lux pointer to a lux buffer * @return status code * - 0 success * - 1 read failed diff --git a/example/driver_tsl2561_basic.h b/example/driver_tsl2561_basic.h index d850ad1..510664e 100644 --- a/example/driver_tsl2561_basic.h +++ b/example/driver_tsl2561_basic.h @@ -63,7 +63,7 @@ extern "C"{ /** * @brief basic example init - * @param[in] addr_pin is the iic device address + * @param[in] addr_pin iic device address * @return status code * - 0 success * - 1 init failed @@ -82,7 +82,7 @@ uint8_t tsl2561_basic_deinit(void); /** * @brief basic example read - * @param[out] *lux points to a lux buffer + * @param[out] *lux pointer to a lux buffer * @return status code * - 0 success * - 1 read failed diff --git a/example/driver_tsl2561_interrupt.c b/example/driver_tsl2561_interrupt.c index f5a1b50..122cb01 100644 --- a/example/driver_tsl2561_interrupt.c +++ b/example/driver_tsl2561_interrupt.c @@ -41,10 +41,10 @@ static tsl2561_handle_t gs_handle; /**< tsl2561 handle */ /** * @brief interrupt example init - * @param[in] addr_pin is the iic device address - * @param[in] mode is the interrupt mode - * @param[in] ch0_low_threshold is the channel 0 interrupt low threshold - * @param[in] ch0_high_threshold is the channel 0 interrupt high threshold + * @param[in] addr_pin iic device address + * @param[in] mode interrupt mode + * @param[in] ch0_low_threshold channel 0 interrupt low threshold + * @param[in] ch0_high_threshold channel 0 interrupt high threshold * @return status code * - 0 success * - 1 init failed @@ -157,7 +157,7 @@ uint8_t tsl2561_interrupt_init(tsl2561_address_t addr_pin, tsl2561_interrupt_mod /** * @brief interrupt example read - * @param[out] *lux points to a lux buffer + * @param[out] *lux pointer to a lux buffer * @return status code * - 0 success * - 1 read failed diff --git a/example/driver_tsl2561_interrupt.h b/example/driver_tsl2561_interrupt.h index 5262385..0955aeb 100644 --- a/example/driver_tsl2561_interrupt.h +++ b/example/driver_tsl2561_interrupt.h @@ -57,10 +57,10 @@ extern "C"{ /** * @brief interrupt example init - * @param[in] addr_pin is the iic device address - * @param[in] mode is the interrupt mode - * @param[in] ch0_low_threshold is the channel 0 interrupt low threshold - * @param[in] ch0_high_threshold is the channel 0 interrupt high threshold + * @param[in] addr_pin iic device address + * @param[in] mode interrupt mode + * @param[in] ch0_low_threshold channel 0 interrupt low threshold + * @param[in] ch0_high_threshold channel 0 interrupt high threshold * @return status code * - 0 success * - 1 init failed @@ -80,7 +80,7 @@ uint8_t tsl2561_interrupt_deinit(void); /** * @brief interrupt example read - * @param[out] *lux points to a lux buffer + * @param[out] *lux pointer to a lux buffer * @return status code * - 0 success * - 1 read failed diff --git a/interface/driver_tsl2561_interface.h b/interface/driver_tsl2561_interface.h index 3bf8815..5f0d125 100644 --- a/interface/driver_tsl2561_interface.h +++ b/interface/driver_tsl2561_interface.h @@ -71,10 +71,10 @@ uint8_t tsl2561_interface_iic_deinit(void); /** * @brief interface 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 @@ -84,10 +84,10 @@ uint8_t tsl2561_interface_iic_read(uint8_t addr, uint8_t reg, uint8_t *buf, uint /** * @brief interface 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 @@ -97,14 +97,14 @@ uint8_t tsl2561_interface_iic_write(uint8_t addr, uint8_t reg, uint8_t *buf, uin /** * @brief interface delay ms - * @param[in] ms + * @param[in] ms time * @note none */ void tsl2561_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 tsl2561_interface_debug_print(const char *const fmt, ...); diff --git a/interface/driver_tsl2561_interface_template.c b/interface/driver_tsl2561_interface_template.c index ae3a51d..1f0a279 100644 --- a/interface/driver_tsl2561_interface_template.c +++ b/interface/driver_tsl2561_interface_template.c @@ -63,10 +63,10 @@ uint8_t tsl2561_interface_iic_deinit(void) /** * @brief interface 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 @@ -79,10 +79,10 @@ uint8_t tsl2561_interface_iic_read(uint8_t addr, uint8_t reg, uint8_t *buf, uint /** * @brief interface 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 @@ -95,7 +95,7 @@ uint8_t tsl2561_interface_iic_write(uint8_t addr, uint8_t reg, uint8_t *buf, uin /** * @brief interface delay ms - * @param[in] ms + * @param[in] ms time * @note none */ void tsl2561_interface_delay_ms(uint32_t ms) @@ -105,7 +105,7 @@ void tsl2561_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 tsl2561_interface_debug_print(const char *const fmt, ...) diff --git a/project/raspberrypi4b/driver/src/raspberrypi4b_driver_tsl2561_interface.c b/project/raspberrypi4b/driver/src/raspberrypi4b_driver_tsl2561_interface.c index da00ac3..28ac8e2 100644 --- a/project/raspberrypi4b/driver/src/raspberrypi4b_driver_tsl2561_interface.c +++ b/project/raspberrypi4b/driver/src/raspberrypi4b_driver_tsl2561_interface.c @@ -75,10 +75,10 @@ uint8_t tsl2561_interface_iic_deinit(void) /** * @brief interface 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 @@ -91,10 +91,10 @@ uint8_t tsl2561_interface_iic_read(uint8_t addr, uint8_t reg, uint8_t *buf, uint /** * @brief interface 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 @@ -107,7 +107,7 @@ uint8_t tsl2561_interface_iic_write(uint8_t addr, uint8_t reg, uint8_t *buf, uin /** * @brief interface delay ms - * @param[in] ms + * @param[in] ms time * @note none */ void tsl2561_interface_delay_ms(uint32_t ms) @@ -117,7 +117,7 @@ void tsl2561_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 tsl2561_interface_debug_print(const char *const fmt, ...) diff --git a/project/raspberrypi4b/src/main.c b/project/raspberrypi4b/src/main.c index e364fef..aae9d5b 100644 --- a/project/raspberrypi4b/src/main.c +++ b/project/raspberrypi4b/src/main.c @@ -50,8 +50,8 @@ volatile uint8_t g_flag; /**< interrupt flag */ /** * @brief tsl2561 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 @@ -521,8 +521,8 @@ uint8_t tsl2561(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/MDK/stm32f407.uvprojx b/project/stm32f407/MDK/stm32f407.uvprojx index 8191468..c6d4be1 100644 --- a/project/stm32f407/MDK/stm32f407.uvprojx +++ b/project/stm32f407/MDK/stm32f407.uvprojx @@ -10,14 +10,14 @@ stm32f407 0x4 ARM-ADS - 6140000::V6.14::ARMCLANG + 6220000::V6.22::ARMCLANG 1 STM32F407ZGTx STMicroelectronics - Keil.STM32F4xx_DFP.2.14.0 - http://www.keil.com/pack/ + Keil.STM32F4xx_DFP.3.0.0 + https://www.keil.com/pack/ IRAM(0x20000000,0x00020000) IRAM2(0x10000000,0x00010000) IROM(0x08000000,0x00100000) CPUTYPE("Cortex-M4") FPU2 CLOCK(12000000) ELITTLE @@ -186,6 +186,7 @@ 2 0 0 + 0 1 0 8 @@ -974,11 +975,6 @@ <Project Info> - - - - - 0 1 diff --git a/project/stm32f407/driver/src/stm32f407_driver_tsl2561_interface.c b/project/stm32f407/driver/src/stm32f407_driver_tsl2561_interface.c index cb7335a..149ba56 100644 --- a/project/stm32f407/driver/src/stm32f407_driver_tsl2561_interface.c +++ b/project/stm32f407/driver/src/stm32f407_driver_tsl2561_interface.c @@ -67,10 +67,10 @@ uint8_t tsl2561_interface_iic_deinit(void) /** * @brief interface 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 @@ -83,10 +83,10 @@ uint8_t tsl2561_interface_iic_read(uint8_t addr, uint8_t reg, uint8_t *buf, uint /** * @brief interface 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 @@ -99,7 +99,7 @@ uint8_t tsl2561_interface_iic_write(uint8_t addr, uint8_t reg, uint8_t *buf, uin /** * @brief interface delay ms - * @param[in] ms + * @param[in] ms time * @note none */ void tsl2561_interface_delay_ms(uint32_t ms) @@ -109,7 +109,7 @@ void tsl2561_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 tsl2561_interface_debug_print(const char *const fmt, ...) diff --git a/project/stm32f407/usr/src/getopt.c b/project/stm32f407/usr/src/getopt.c index b9499bc..bf4a0d1 100644 --- a/project/stm32f407/usr/src/getopt.c +++ b/project/stm32f407/usr/src/getopt.c @@ -180,9 +180,7 @@ static char *my_index (const char *str, int chr); extern char *getenv (); #endif -static int -my_strlen (str) - const char *str; +static int my_strlen(const char *str) { int n = 0; while (*str++) @@ -190,10 +188,7 @@ my_strlen (str) return n; } -static char * -my_index (str, chr) - const char *str; - int chr; +static char *my_index(const char *str, int chr) { while (*str) { @@ -234,12 +229,10 @@ static int last_nonopt; */ #if __STDC__ || defined(PROTO) -static void exchange (char **argv); +static void exchange(char **argv); #endif -static void -exchange (argv) - char **argv; +static void exchange(char **argv) { char *temp, **first, **last; @@ -322,14 +315,13 @@ exchange (argv) If LONG_ONLY is nonzero, '-' as well as '--' can introduce long-named options. */ -int -_getopt_internal (argc, argv, optstring, longopts, longind, long_only) - int argc; - char *const *argv; - const char *optstring; - const struct option *longopts; - int *longind; - int long_only; +int _getopt_internal(int argc, + char *const *argv, + const char *optstring, + const struct option *longopts, + int *longind, + int long_only + ) { int option_index; @@ -656,11 +648,10 @@ _getopt_internal (argc, argv, optstring, longopts, longind, long_only) } } -int -getopt (argc, argv, optstring) - int argc; - char *const *argv; - const char *optstring; +int getopt(int argc, + char *const *argv, + const char *optstring + ) { return _getopt_internal (argc, argv, optstring, (const struct option *) 0, @@ -668,13 +659,12 @@ getopt (argc, argv, optstring) 0); } -int -getopt_long (argc, argv, options, long_options, opt_index) - int argc; - char *const *argv; - const char *options; - const struct option *long_options; - int *opt_index; +int getopt_long(int argc, + char *const *argv, + const char *options, + const struct option *long_options, + int *opt_index + ) { return _getopt_internal (argc, argv, options, long_options, opt_index, 0); } diff --git a/project/stm32f407/usr/src/main.c b/project/stm32f407/usr/src/main.c index 1b53e5e..6afcfad 100644 --- a/project/stm32f407/usr/src/main.c +++ b/project/stm32f407/usr/src/main.c @@ -65,7 +65,7 @@ void EXTI0_IRQHandler(void) /** * @brief gpio exti callback - * @param[in] pin is the gpio pin + * @param[in] pin gpio pin * @note none */ void HAL_GPIO_EXTI_Callback(uint16_t pin) @@ -78,8 +78,8 @@ void HAL_GPIO_EXTI_Callback(uint16_t pin) /** * @brief tsl2561 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_tsl2561.c b/src/driver_tsl2561.c index cc2d009..4387909 100644 --- a/src/driver_tsl2561.c +++ b/src/driver_tsl2561.c @@ -104,10 +104,10 @@ /** * @brief calculate the lux - * @param[in] gain is the adc gain - * @param[in] t is the integration time - * @param[in] ch0 is the channel 0 raw data - * @param[in] ch1 is the channel 1 raw data + * @param[in] gain adc gain + * @param[in] t integration time + * @param[in] ch0 channel 0 raw data + * @param[in] ch1 channel 1 raw data * @return calculated lux * @note none */ @@ -203,7 +203,7 @@ static uint32_t a_tsl2561_calculate_lux(uint16_t gain, uint16_t t, uint16_t ch0, /** * @brief initialize the chip - * @param[in] *handle points to a tsl2561 handle structure + * @param[in] *handle pointer to a tsl2561 handle structure * @return status code * - 0 success * - 1 iic initialization failed @@ -283,7 +283,7 @@ uint8_t tsl2561_init(tsl2561_handle_t *handle) /** * @brief close the chip - * @param[in] *handle points to a tsl2561 handle structure + * @param[in] *handle pointer to a tsl2561 handle structure * @return status code * - 0 success * - 1 iic deinit failed @@ -324,8 +324,8 @@ uint8_t tsl2561_deinit(tsl2561_handle_t *handle) /** * @brief set the iic address pin - * @param[in] *handle points to a tsl2561 handle structure - * @param[in] addr_pin is the chip iic address pin + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[in] addr_pin chip iic address pin * @return status code * - 0 success * - 1 set addr pin failed @@ -346,8 +346,8 @@ uint8_t tsl2561_set_addr_pin(tsl2561_handle_t *handle, tsl2561_address_t addr_pi /** * @brief get the iic address pin - * @param[in] *handle points to a tsl2561 handle structure - * @param[out] *addr_pin points to a chip iic address pin buffer + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[out] *addr_pin pointer to a chip iic address pin buffer * @return status code * - 0 success * - 1 get addr pin failed @@ -368,10 +368,10 @@ uint8_t tsl2561_get_addr_pin(tsl2561_handle_t *handle, tsl2561_address_t *addr_p /** * @brief read data from the chip - * @param[in] *handle points to a tsl2561 handle structure - * @param[out] *channel_0_raw points to a channel 0 raw data - * @param[out] *channel_1_raw points to a channel 1 raw data - * @param[out] *lux points to a converted lux + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[out] *channel_0_raw pointer to a channel 0 raw data + * @param[out] *channel_1_raw pointer to a channel 1 raw data + * @param[out] *lux pointer to a converted lux * @return status code * - 0 success * - 1 read failed @@ -422,8 +422,8 @@ uint8_t tsl2561_read(tsl2561_handle_t *handle, uint16_t *channel_0_raw, uint16_t /** * @brief set the adc gain - * @param[in] *handle points to a tsl2561 handle structure - * @param[in] gain is the adc gain + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[in] gain adc gain * @return status code * - 0 success * - 1 set gain failed @@ -466,8 +466,8 @@ uint8_t tsl2561_set_gain(tsl2561_handle_t *handle, tsl2561_gain_t gain) /** * @brief get the adc gain - * @param[in] *handle points to a tsl2561 handle structure - * @param[out] *gain points to an adc gain buffer + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[out] *gain pointer to an adc gain buffer * @return status code * - 0 success * - 1 get gain failed @@ -502,8 +502,8 @@ uint8_t tsl2561_get_gain(tsl2561_handle_t *handle, tsl2561_gain_t *gain) /** * @brief set the integration time - * @param[in] *handle points to a tsl2561 handle structure - * @param[in] t is the integration time + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[in] t integration time * @return status code * - 0 success * - 1 set integration time failed @@ -546,8 +546,8 @@ uint8_t tsl2561_set_integration_time(tsl2561_handle_t *handle, tsl2561_integrati /** * @brief get the integration time - * @param[in] *handle points to a tsl2561 handle structure - * @param[out] *t points to an integration time buffer + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[out] *t pointer to an integration time buffer * @return status code * - 0 success * - 1 get integration time failed @@ -582,8 +582,8 @@ uint8_t tsl2561_get_integration_time(tsl2561_handle_t *handle, tsl2561_integrati /** * @brief set the interrupt mode - * @param[in] *handle points to a tsl2561 handle structure - * @param[in] mode is the interrupt mode + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[in] mode interrupt mode * @return status code * - 0 success * - 1 set interrupt mode failed @@ -626,8 +626,8 @@ uint8_t tsl2561_set_interrupt_mode(tsl2561_handle_t *handle, tsl2561_interrupt_m /** * @brief get the interrupt mode - * @param[in] *handle points to a tsl2561 handle structure - * @param[out] *mode points to an interrupt mode buffer + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[out] *mode pointer to an interrupt mode buffer * @return status code * - 0 success * - 1 get interrupt mode failed @@ -662,8 +662,8 @@ uint8_t tsl2561_get_interrupt_mode(tsl2561_handle_t *handle, tsl2561_interrupt_m /** * @brief enable or disable the chip interrupt - * @param[in] *handle points to a tsl2561 handle structure - * @param[in] enable is a bool value + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[in] enable bool value * @return status code * - 0 success * - 1 set interrupt failed @@ -706,8 +706,8 @@ uint8_t tsl2561_set_interrupt(tsl2561_handle_t *handle, tsl2561_bool_t enable) /** * @brief get the chip interrupt - * @param[in] *handle points to a tsl2561 handle structure - * @param[out] *enable points to a bool buffer + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[out] *enable pointer to a bool buffer * @return status code * - 0 success * - 1 get interrupt failed @@ -742,8 +742,8 @@ uint8_t tsl2561_get_interrupt(tsl2561_handle_t *handle, tsl2561_bool_t *enable) /** * @brief set the interrupt high threshold - * @param[in] *handle points to a tsl2561 handle structure - * @param[in] ch0_raw is the channel 0 raw data + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[in] ch0_raw channel 0 raw data * @return status code * - 0 success * - 1 set interrupt high threshold failed @@ -779,8 +779,8 @@ uint8_t tsl2561_set_interrupt_high_threshold(tsl2561_handle_t *handle, uint16_t /** * @brief get the interrupt high threshold - * @param[in] *handle points to a tsl2561 handle structure - * @param[out] *ch0_raw points to a channel 0 raw data buffer + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[out] *ch0_raw pointer to a channel 0 raw data buffer * @return status code * - 0 success * - 1 get interrupt high threshold failed @@ -816,8 +816,8 @@ uint8_t tsl2561_get_interrupt_high_threshold(tsl2561_handle_t *handle, uint16_t /** * @brief set the interrupt low threshold - * @param[in] *handle points to a tsl2561 handle structure - * @param[in] ch0_raw is the channel 0 raw data + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[in] ch0_raw channel 0 raw data * @return status code * - 0 success * - 1 set interrupt low threshold failed @@ -853,8 +853,8 @@ uint8_t tsl2561_set_interrupt_low_threshold(tsl2561_handle_t *handle, uint16_t c /** * @brief get the interrupt low threshold - * @param[in] *handle points to a tsl2561 handle structure - * @param[out] *ch0_raw points to a channel 0 raw data buffer + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[out] *ch0_raw pointer to a channel 0 raw data buffer * @return status code * - 0 success * - 1 get interrupt low threshold failed @@ -890,7 +890,7 @@ uint8_t tsl2561_get_interrupt_low_threshold(tsl2561_handle_t *handle, uint16_t * /** * @brief power down the chip - * @param[in] *handle points to a tsl2561 handle structure + * @param[in] *handle pointer to a tsl2561 handle structure * @return status code * - 0 success * - 1 power down failed @@ -926,7 +926,7 @@ uint8_t tsl2561_power_down(tsl2561_handle_t *handle) /** * @brief wake up the chip - * @param[in] *handle points to a tsl2561 handle structure + * @param[in] *handle pointer to a tsl2561 handle structure * @return status code * - 0 success * - 1 wake up failed @@ -962,10 +962,10 @@ uint8_t tsl2561_wake_up(tsl2561_handle_t *handle) /** * @brief set the chip register - * @param[in] *handle points to a tsl2561 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 a tsl2561 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 @@ -998,10 +998,10 @@ uint8_t tsl2561_set_reg(tsl2561_handle_t *handle, uint8_t reg, uint8_t *buf, uin /** * @brief get the chip register - * @param[in] *handle points to a tsl2561 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 a tsl2561 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 @@ -1034,7 +1034,7 @@ uint8_t tsl2561_get_reg(tsl2561_handle_t *handle, uint8_t reg, uint8_t *buf, uin /** * @brief get chip's information - * @param[out] *info points to a tsl2561 info structure + * @param[out] *info pointer to a tsl2561 info structure * @return status code * - 0 success * - 2 handle is NULL diff --git a/src/driver_tsl2561.h b/src/driver_tsl2561.h index eb1dad4..c2a29d1 100644 --- a/src/driver_tsl2561.h +++ b/src/driver_tsl2561.h @@ -180,56 +180,56 @@ typedef struct tsl2561_info_s /** * @brief initialize tsl2561_handle_t structure - * @param[in] HANDLE points to a tsl2561 handle structure - * @param[in] STRUCTURE is tsl2561_handle_t + * @param[in] HANDLE pointer to a tsl2561 handle structure + * @param[in] STRUCTURE tsl2561_handle_t * @note none */ #define DRIVER_TSL2561_LINK_INIT(HANDLE, STRUCTURE) memset(HANDLE, 0, sizeof(STRUCTURE)) /** * @brief link iic_init function - * @param[in] HANDLE points to a tsl2561 handle structure - * @param[in] FUC points to an iic_init function address + * @param[in] HANDLE pointer to a tsl2561 handle structure + * @param[in] FUC pointer to an iic_init function address * @note none */ #define DRIVER_TSL2561_LINK_IIC_INIT(HANDLE, FUC) (HANDLE)->iic_init = FUC /** * @brief link iic_deinit function - * @param[in] HANDLE points to a tsl2561 handle structure - * @param[in] FUC points to an iic_deinit function address + * @param[in] HANDLE pointer to a tsl2561 handle structure + * @param[in] FUC pointer to an iic_deinit function address * @note none */ #define DRIVER_TSL2561_LINK_IIC_DEINIT(HANDLE, FUC) (HANDLE)->iic_deinit = FUC /** * @brief link iic_read function - * @param[in] HANDLE points to a tsl2561 handle structure - * @param[in] FUC points to an iic_read function address + * @param[in] HANDLE pointer to a tsl2561 handle structure + * @param[in] FUC pointer to an iic_read function address * @note none */ #define DRIVER_TSL2561_LINK_IIC_READ(HANDLE, FUC) (HANDLE)->iic_read = FUC /** * @brief link iic_write function - * @param[in] HANDLE points to a tsl2561 handle structure - * @param[in] FUC points to an iic_write function address + * @param[in] HANDLE pointer to a tsl2561 handle structure + * @param[in] FUC pointer to an iic_write function address * @note none */ #define DRIVER_TSL2561_LINK_IIC_WRITE(HANDLE, FUC) (HANDLE)->iic_write = FUC /** * @brief link delay_ms function - * @param[in] HANDLE points to a tsl2561 handle structure - * @param[in] FUC points to a delay_ms function address + * @param[in] HANDLE pointer to a tsl2561 handle structure + * @param[in] FUC pointer to a delay_ms function address * @note none */ #define DRIVER_TSL2561_LINK_DELAY_MS(HANDLE, FUC) (HANDLE)->delay_ms = FUC /** * @brief link debug_print function - * @param[in] HANDLE points to a tsl2561 handle structure - * @param[in] FUC points to a debug_print function address + * @param[in] HANDLE pointer to a tsl2561 handle structure + * @param[in] FUC pointer to a debug_print function address * @note none */ #define DRIVER_TSL2561_LINK_DEBUG_PRINT(HANDLE, FUC) (HANDLE)->debug_print = FUC @@ -247,7 +247,7 @@ typedef struct tsl2561_info_s /** * @brief get chip's information - * @param[out] *info points to a tsl2561 info structure + * @param[out] *info pointer to a tsl2561 info structure * @return status code * - 0 success * - 2 handle is NULL @@ -257,8 +257,8 @@ uint8_t tsl2561_info(tsl2561_info_t *info); /** * @brief set the iic address pin - * @param[in] *handle points to a tsl2561 handle structure - * @param[in] addr_pin is the chip iic address pin + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[in] addr_pin chip iic address pin * @return status code * - 0 success * - 1 set addr pin failed @@ -269,8 +269,8 @@ uint8_t tsl2561_set_addr_pin(tsl2561_handle_t *handle, tsl2561_address_t addr_pi /** * @brief get the iic address pin - * @param[in] *handle points to a tsl2561 handle structure - * @param[out] *addr_pin points to a chip iic address pin buffer + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[out] *addr_pin pointer to a chip iic address pin buffer * @return status code * - 0 success * - 1 get addr pin failed @@ -281,7 +281,7 @@ uint8_t tsl2561_get_addr_pin(tsl2561_handle_t *handle, tsl2561_address_t *addr_p /** * @brief initialize the chip - * @param[in] *handle points to a tsl2561 handle structure + * @param[in] *handle pointer to a tsl2561 handle structure * @return status code * - 0 success * - 1 iic initialization failed @@ -293,7 +293,7 @@ uint8_t tsl2561_init(tsl2561_handle_t *handle); /** * @brief close the chip - * @param[in] *handle points to a tsl2561 handle structure + * @param[in] *handle pointer to a tsl2561 handle structure * @return status code * - 0 success * - 1 iic deinit failed @@ -305,10 +305,10 @@ uint8_t tsl2561_deinit(tsl2561_handle_t *handle); /** * @brief read data from the chip - * @param[in] *handle points to a tsl2561 handle structure - * @param[out] *channel_0_raw points to a channel 0 raw data - * @param[out] *channel_1_raw points to a channel 1 raw data - * @param[out] *lux points to a converted lux + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[out] *channel_0_raw pointer to a channel 0 raw data + * @param[out] *channel_1_raw pointer to a channel 1 raw data + * @param[out] *lux pointer to a converted lux * @return status code * - 0 success * - 1 read failed @@ -320,7 +320,7 @@ uint8_t tsl2561_read(tsl2561_handle_t *handle, uint16_t *channel_0_raw, uint16_t /** * @brief power down the chip - * @param[in] *handle points to a tsl2561 handle structure + * @param[in] *handle pointer to a tsl2561 handle structure * @return status code * - 0 success * - 1 power down failed @@ -332,7 +332,7 @@ uint8_t tsl2561_power_down(tsl2561_handle_t *handle); /** * @brief wake up the chip - * @param[in] *handle points to a tsl2561 handle structure + * @param[in] *handle pointer to a tsl2561 handle structure * @return status code * - 0 success * - 1 wake up failed @@ -344,8 +344,8 @@ uint8_t tsl2561_wake_up(tsl2561_handle_t *handle); /** * @brief set the adc gain - * @param[in] *handle points to a tsl2561 handle structure - * @param[in] gain is the adc gain + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[in] gain adc gain * @return status code * - 0 success * - 1 set gain failed @@ -356,8 +356,8 @@ uint8_t tsl2561_set_gain(tsl2561_handle_t *handle, tsl2561_gain_t gain); /** * @brief get the adc gain - * @param[in] *handle points to a tsl2561 handle structure - * @param[out] *gain points to an adc gain buffer + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[out] *gain pointer to an adc gain buffer * @return status code * - 0 success * - 1 get gain failed @@ -368,8 +368,8 @@ uint8_t tsl2561_get_gain(tsl2561_handle_t *handle, tsl2561_gain_t *gain); /** * @brief set the integration time - * @param[in] *handle points to a tsl2561 handle structure - * @param[in] t is the integration time + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[in] t integration time * @return status code * - 0 success * - 1 set integration time failed @@ -380,8 +380,8 @@ uint8_t tsl2561_set_integration_time(tsl2561_handle_t *handle, tsl2561_integrati /** * @brief get the integration time - * @param[in] *handle points to a tsl2561 handle structure - * @param[out] *t points to an integration time buffer + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[out] *t pointer to an integration time buffer * @return status code * - 0 success * - 1 get integration time failed @@ -403,8 +403,8 @@ uint8_t tsl2561_get_integration_time(tsl2561_handle_t *handle, tsl2561_integrati /** * @brief set the interrupt mode - * @param[in] *handle points to a tsl2561 handle structure - * @param[in] mode is the interrupt mode + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[in] mode interrupt mode * @return status code * - 0 success * - 1 set interrupt mode failed @@ -415,8 +415,8 @@ uint8_t tsl2561_set_interrupt_mode(tsl2561_handle_t *handle, tsl2561_interrupt_m /** * @brief get the interrupt mode - * @param[in] *handle points to a tsl2561 handle structure - * @param[out] *mode points to an interrupt mode buffer + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[out] *mode pointer to an interrupt mode buffer * @return status code * - 0 success * - 1 get interrupt mode failed @@ -427,8 +427,8 @@ uint8_t tsl2561_get_interrupt_mode(tsl2561_handle_t *handle, tsl2561_interrupt_m /** * @brief enable or disable the chip interrupt - * @param[in] *handle points to a tsl2561 handle structure - * @param[in] enable is a bool value + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[in] enable bool value * @return status code * - 0 success * - 1 set interrupt failed @@ -439,8 +439,8 @@ uint8_t tsl2561_set_interrupt(tsl2561_handle_t *handle, tsl2561_bool_t enable); /** * @brief get the chip interrupt - * @param[in] *handle points to a tsl2561 handle structure - * @param[out] *enable points to a bool buffer + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[out] *enable pointer to a bool buffer * @return status code * - 0 success * - 1 get interrupt failed @@ -451,8 +451,8 @@ uint8_t tsl2561_get_interrupt(tsl2561_handle_t *handle, tsl2561_bool_t *enable); /** * @brief set the interrupt high threshold - * @param[in] *handle points to a tsl2561 handle structure - * @param[in] ch0_raw is the channel 0 raw data + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[in] ch0_raw channel 0 raw data * @return status code * - 0 success * - 1 set interrupt high threshold failed @@ -463,8 +463,8 @@ uint8_t tsl2561_set_interrupt_high_threshold(tsl2561_handle_t *handle, uint16_t /** * @brief get the interrupt high threshold - * @param[in] *handle points to a tsl2561 handle structure - * @param[out] *ch0_raw points to a channel 0 raw data buffer + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[out] *ch0_raw pointer to a channel 0 raw data buffer * @return status code * - 0 success * - 1 get interrupt high threshold failed @@ -475,8 +475,8 @@ uint8_t tsl2561_get_interrupt_high_threshold(tsl2561_handle_t *handle, uint16_t /** * @brief set the interrupt low threshold - * @param[in] *handle points to a tsl2561 handle structure - * @param[in] ch0_raw is the channel 0 raw data + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[in] ch0_raw channel 0 raw data * @return status code * - 0 success * - 1 set interrupt low threshold failed @@ -487,8 +487,8 @@ uint8_t tsl2561_set_interrupt_low_threshold(tsl2561_handle_t *handle, uint16_t c /** * @brief get the interrupt low threshold - * @param[in] *handle points to a tsl2561 handle structure - * @param[out] *ch0_raw points to a channel 0 raw data buffer + * @param[in] *handle pointer to a tsl2561 handle structure + * @param[out] *ch0_raw pointer to a channel 0 raw data buffer * @return status code * - 0 success * - 1 get interrupt low threshold failed @@ -510,10 +510,10 @@ uint8_t tsl2561_get_interrupt_low_threshold(tsl2561_handle_t *handle, uint16_t * /** * @brief set the chip register - * @param[in] *handle points to a tsl2561 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 a tsl2561 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 @@ -525,10 +525,10 @@ uint8_t tsl2561_set_reg(tsl2561_handle_t *handle, uint8_t reg, uint8_t *buf, uin /** * @brief get the chip register - * @param[in] *handle points to a tsl2561 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 a tsl2561 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_tsl2561_interrupt_test.c b/test/driver_tsl2561_interrupt_test.c index 1e282a0..ad7950c 100644 --- a/test/driver_tsl2561_interrupt_test.c +++ b/test/driver_tsl2561_interrupt_test.c @@ -41,11 +41,11 @@ static tsl2561_handle_t gs_handle; /**< tsl2561 handle */ /** * @brief interrupt test - * @param[in] addr_pin is the iic device address - * @param[in] mode is the interrupt mode - * @param[in] ch0_low_threshold is the channel 0 interrupt low threshold - * @param[in] ch0_high_threshold is the channel 0 interrupt high threshold - * @param[in] times is the test times + * @param[in] addr_pin iic device address + * @param[in] mode interrupt mode + * @param[in] ch0_low_threshold channel 0 interrupt low threshold + * @param[in] ch0_high_threshold channel 0 interrupt high threshold + * @param[in] times test times * @return status code * - 0 success * - 1 test failed diff --git a/test/driver_tsl2561_interrupt_test.h b/test/driver_tsl2561_interrupt_test.h index 60368c9..c4d0b26 100644 --- a/test/driver_tsl2561_interrupt_test.h +++ b/test/driver_tsl2561_interrupt_test.h @@ -51,11 +51,11 @@ extern "C"{ /** * @brief interrupt test - * @param[in] addr_pin is the iic device address - * @param[in] mode is the interrupt mode - * @param[in] ch0_low_threshold is the channel 0 interrupt low threshold - * @param[in] ch0_high_threshold is the channel 0 interrupt high threshold - * @param[in] times is the test times + * @param[in] addr_pin iic device address + * @param[in] mode interrupt mode + * @param[in] ch0_low_threshold channel 0 interrupt low threshold + * @param[in] ch0_high_threshold channel 0 interrupt high threshold + * @param[in] times test times * @return status code * - 0 success * - 1 test failed diff --git a/test/driver_tsl2561_read_test.c b/test/driver_tsl2561_read_test.c index 42eef8c..13b27ee 100644 --- a/test/driver_tsl2561_read_test.c +++ b/test/driver_tsl2561_read_test.c @@ -41,8 +41,8 @@ static tsl2561_handle_t gs_handle; /**< tsl2561 handle */ /** * @brief read test - * @param[in] addr_pin is the iic device address - * @param[in] times is the test times + * @param[in] addr_pin iic device address + * @param[in] times test times * @return status code * - 0 success * - 1 test failed diff --git a/test/driver_tsl2561_read_test.h b/test/driver_tsl2561_read_test.h index e5c5c80..06ff258 100644 --- a/test/driver_tsl2561_read_test.h +++ b/test/driver_tsl2561_read_test.h @@ -51,8 +51,8 @@ extern "C"{ /** * @brief read test - * @param[in] addr_pin is the iic device address - * @param[in] times is the test times + * @param[in] addr_pin iic device address + * @param[in] times test times * @return status code * - 0 success * - 1 test failed diff --git a/test/driver_tsl2561_register_test.c b/test/driver_tsl2561_register_test.c index 5791e12..2cb1ace 100644 --- a/test/driver_tsl2561_register_test.c +++ b/test/driver_tsl2561_register_test.c @@ -42,7 +42,7 @@ static tsl2561_handle_t gs_handle; /**< tsl2561 handle */ /** * @brief register test - * @param[in] addr is the iic device address + * @param[in] addr iic device address * @return status code * - 0 success * - 1 test failed diff --git a/test/driver_tsl2561_register_test.h b/test/driver_tsl2561_register_test.h index c819a95..537d478 100644 --- a/test/driver_tsl2561_register_test.h +++ b/test/driver_tsl2561_register_test.h @@ -53,7 +53,7 @@ extern "C"{ /** * @brief register test - * @param[in] addr is the iic device address + * @param[in] addr iic device address * @return status code * - 0 success * - 1 test failed