diff --git a/CHANGELOG.md b/CHANGELOG.md index 536fad7..0d28d53 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## 1.0.3 (2024-12-01) + +## Bug Fixes + +- fix doc errors + ## 1.0.2 (2024-08-05) ## Bug Fixes diff --git a/doc/html/group__bmp280__base__driver.html b/doc/html/group__bmp280__base__driver.html index e88a9b1..9b9f661 100644 --- a/doc/html/group__bmp280__base__driver.html +++ b/doc/html/group__bmp280__base__driver.html @@ -532,7 +532,7 @@

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

Parameters
- - + +
[in]*handlepoints to a bmp280 handle structure
[out]*addr_pinpoints to an iic address pin buffer
[in]*handlepointer to a bmp280 handle structure
[out]*addr_pinpointer to an iic address pin buffer
@@ -624,8 +624,8 @@

Parameters
- - + +
[in]*handlepoints to a bmp280 handle structure
[out]*filterpoints to a filter buffer
[in]*handlepointer to a bmp280 handle structure
[out]*filterpointer to a filter buffer
@@ -671,8 +671,8 @@

Parameters
- - + +
[in]*handlepoints to a bmp280 handle structure
[out]*interfacepoints to a chip interface buffer
[in]*handlepointer to a bmp280 handle structure
[out]*interfacepointer to a chip interface buffer
@@ -716,8 +716,8 @@

Parameters
- - + +
[in]*handlepoints to a bmp280 handle structure
[out]*modepoints to a mode buffer
[in]*handlepointer to a bmp280 handle structure
[out]*modepointer to a mode buffer
@@ -763,8 +763,8 @@

Parameters
- - + +
[in]*handlepoints to a bmp280 handle structure
[out]*oversamplingpoints to a oversampling buffer
[in]*handlepointer to a bmp280 handle structure
[out]*oversamplingpointer to a oversampling buffer
@@ -810,8 +810,8 @@

Parameters
- - + +
[in]*handlepoints to a bmp280 handle structure
[out]*spipoints to a spi wire buffer
[in]*handlepointer to a bmp280 handle structure
[out]*spipointer to a spi wire buffer
@@ -857,8 +857,8 @@

Parameters
- - + +
[in]*handlepoints to a bmp280 handle structure
[out]*standby_timepoints to a standby time buffer
[in]*handlepointer to a bmp280 handle structure
[out]*standby_timepointer to a standby time buffer
@@ -904,8 +904,8 @@

Parameters
- - + +
[in]*handlepoints to a bmp280 handle structure
[out]*statuspoints to a status buffer
[in]*handlepointer to a bmp280 handle structure
[out]*statuspointer to a status buffer
@@ -951,8 +951,8 @@

Parameters
- - + +
[in]*handlepoints to a bmp280 handle structure
[out]*oversamplingpoints to a oversampling buffer
[in]*handlepointer to a bmp280 handle structure
[out]*oversamplingpointer to a oversampling buffer
@@ -988,7 +988,7 @@

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

Parameters
- +
[in]*handlepoints to a bmp280 handle structure
[in]*handlepointer to a bmp280 handle structure
@@ -1077,9 +1077,9 @@

Parameters
- - - + + +
[in]*handlepoints to a bmp280 handle structure
[out]*pressure_rawpoints to a raw pressure buffer
[out]*pressure_papoints to a converted pressure buffer
[in]*handlepointer to a bmp280 handle structure
[out]*pressure_rawpointer to a raw pressure buffer
[out]*pressure_papointer to a converted pressure buffer
@@ -1133,9 +1133,9 @@

Parameters
- - - + + +
[in]*handlepoints to a bmp280 handle structure
[out]*temperature_rawpoints to a raw temperature buffer
[out]*temperature_cpoints to a converted temperature buffer
[in]*handlepointer to a bmp280 handle structure
[out]*temperature_rawpointer to a raw temperature buffer
[out]*temperature_cpointer to a converted temperature buffer
@@ -1201,11 +1201,11 @@

Parameters
- - - - - + + + + +
[in]*handlepoints to a bmp280 handle structure
[out]*temperature_rawpoints to a raw temperature buffer
[out]*temperature_cpoints to a converted temperature buffer
[out]*pressure_rawpoints to a raw pressure buffer
[out]*pressure_papoints to a converted pressure buffer
[in]*handlepointer to a bmp280 handle structure
[out]*temperature_rawpointer to a raw temperature buffer
[out]*temperature_cpointer to a converted temperature buffer
[out]*pressure_rawpointer to a raw pressure buffer
[out]*pressure_papointer to a converted pressure buffer
@@ -1253,8 +1253,8 @@

Parameters
- - + +
[in]*handlepoints to a bmp280 handle structure
[in]addr_pinis the iic address pin
[in]*handlepointer to a bmp280 handle structure
[in]addr_piniic address pin
@@ -1298,8 +1298,8 @@

Parameters
- - + +
[in]*handlepoints to a bmp280 handle structure
[in]filteris the set filter
[in]*handlepointer to a bmp280 handle structure
[in]filterinput filter
@@ -1345,8 +1345,8 @@

Parameters
- - + +
[in]*handlepoints to a bmp280 handle structure
[in]interfaceis the chip interface
[in]*handlepointer to a bmp280 handle structure
[in]interfacechip interface
@@ -1390,8 +1390,8 @@

Parameters
- - + +
[in]*handlepoints to a bmp280 handle structure
[in]modeis the set mode
[in]*handlepointer to a bmp280 handle structure
[in]modechip mode
@@ -1437,8 +1437,8 @@

Parameters
- - + +
[in]*handlepoints to a bmp280 handle structure
[in]oversamplingis the pressure oversampling
[in]*handlepointer to a bmp280 handle structure
[in]oversamplingpressure oversampling
@@ -1484,8 +1484,8 @@

Parameters
- - + +
[in]*handlepoints to a bmp280 handle structure
[in]spiis the spi wire
[in]*handlepointer to a bmp280 handle structure
[in]spispi wire
@@ -1531,8 +1531,8 @@

Parameters
- - + +
[in]*handlepoints to a bmp280 handle structure
[in]standby_timeis the set standby time
[in]*handlepointer to a bmp280 handle structure
[in]standby_timestandby time
@@ -1578,8 +1578,8 @@

Parameters
- - + +
[in]*handlepoints to a bmp280 handle structure
[in]oversamplingis the temperatue oversampling
[in]*handlepointer to a bmp280 handle structure
[in]oversamplingtemperatue oversampling
@@ -1615,7 +1615,7 @@

Parameters
- +
[in]*handlepoints to a bmp280 handle structure
[in]*handlepointer to a bmp280 handle structure
diff --git a/doc/html/group__bmp280__example__driver.html b/doc/html/group__bmp280__example__driver.html index a7deaf0..eeb2a0a 100644 --- a/doc/html/group__bmp280__example__driver.html +++ b/doc/html/group__bmp280__example__driver.html @@ -376,8 +376,8 @@

Parameters
- - + +
[in]interfaceis the set interface
[in]addr_pinis the chip address pin
[in]interfacechip interface
[in]addr_pinchip address pin
@@ -421,8 +421,8 @@

Parameters
- - + +
[out]*temperaturepoints to a converted temperature buffer
[out]*pressurepoints to a converted pressure buffer
[out]*temperaturepointer to a converted temperature buffer
[out]*pressurepointer to a converted pressure buffer
@@ -494,8 +494,8 @@

Parameters
- - + +
[in]interfaceis the set interface
[in]addr_pinis the chip address pin
[in]interfacechip interface
[in]addr_pinchip address pin
@@ -539,8 +539,8 @@

Parameters
- - + +
[out]*temperaturepoints to a converted temperature buffer
[out]*pressurepoints to a converted pressure buffer
[out]*temperaturepointer to a converted temperature buffer
[out]*pressurepointer to a converted pressure buffer
diff --git a/doc/html/group__bmp280__extern__driver.html b/doc/html/group__bmp280__extern__driver.html index 547f4bd..223db74 100644 --- a/doc/html/group__bmp280__extern__driver.html +++ b/doc/html/group__bmp280__extern__driver.html @@ -141,9 +141,9 @@

Parameters
- - - + + +
[in]*handlepoints to a bmp280 handle structure
[in]regis the iic register address
[out]*valuepoints to a read data buffer
[in]*handlepointer to a bmp280 handle structure
[in]regiic register address
[out]*valuepointer to a read data buffer
@@ -195,9 +195,9 @@

Parameters
- - - + + +
[in]*handlepoints to a bmp280 handle structure
[in]regis the iic register address
[in]valueis the data write to the register
[in]*handlepointer to a bmp280 handle structure
[in]regiic register address
[in]valuedata written to the register
diff --git a/doc/html/group__bmp280__interface__driver.html b/doc/html/group__bmp280__interface__driver.html index d2e5c68..b4be11a 100644 --- a/doc/html/group__bmp280__interface__driver.html +++ b/doc/html/group__bmp280__interface__driver.html @@ -159,7 +159,7 @@

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

Parameters
- +
[in]ms
[in]mstime
@@ -295,10 +295,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
@@ -354,10 +354,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
@@ -463,9 +463,9 @@

Parameters
- - - + + +
[in]regis the register address
[out]*bufpoints to a data buffer
[in]lenis the length of data buffer
[in]regregister address
[out]*bufpointer to a data buffer
[in]lenlength of data buffer
@@ -515,9 +515,9 @@

Parameters
- - - + + +
[in]regis the register address
[in]*bufpoints to a data buffer
[in]lenis the length of data buffer
[in]regregister address
[in]*bufpointer to a data buffer
[in]lenlength of data buffer
diff --git a/doc/html/group__bmp280__link__driver.html b/doc/html/group__bmp280__link__driver.html index 05d8af9..20ede8b 100644 --- a/doc/html/group__bmp280__link__driver.html +++ b/doc/html/group__bmp280__link__driver.html @@ -162,8 +162,8 @@

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

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

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

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

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

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

Parameters
- - + +
[in]HANDLEpoints to a bmp280 handle structure
[in]STRUCTUREis bmp280_handle_t
[in]HANDLEpointer to a bmp280 handle structure
[in]STRUCTUREbmp280_handle_t
@@ -442,8 +442,8 @@

Parameters
- - + +
[in]HANDLEpoints to a bmp280 handle structure
[in]FUCpoints to a spi_deinit function address
[in]HANDLEpointer to a bmp280 handle structure
[in]FUCpointer to a spi_deinit function address
@@ -482,8 +482,8 @@

Parameters
- - + +
[in]HANDLEpoints to a bmp280 handle structure
[in]FUCpoints to a spi_init function address
[in]HANDLEpointer to a bmp280 handle structure
[in]FUCpointer to a spi_init function address
@@ -522,8 +522,8 @@

Parameters
- - + +
[in]HANDLEpoints to a bmp280 handle structure
[in]FUCpoints to a spi_read function address
[in]HANDLEpointer to a bmp280 handle structure
[in]FUCpointer to a spi_read function address
@@ -562,8 +562,8 @@

Parameters
- - + +
[in]HANDLEpoints to a bmp280 handle structure
[in]FUCpoints to a spi_write function address
[in]HANDLEpointer to a bmp280 handle structure
[in]FUCpointer to a spi_write function address
diff --git a/doc/html/group__bmp280__test__driver.html b/doc/html/group__bmp280__test__driver.html index 2cf9330..67b78a6 100644 --- a/doc/html/group__bmp280__test__driver.html +++ b/doc/html/group__bmp280__test__driver.html @@ -141,9 +141,9 @@

Parameters
- - - + + +
[in]interfaceis the set interface
[in]addr_pinis the chip address pin
[in]timesis the read times
[in]interfacechip interface
[in]addr_pinchip address pin
[in]timestest times
@@ -187,8 +187,8 @@

Parameters
- - + +
[in]interfaceis the set interface
[in]addr_pinis the chip address pin
[in]interfacechip interface
[in]addr_pinchip address pin
diff --git a/example/driver_bmp280_basic.c b/example/driver_bmp280_basic.c index 4c8a1af..7831525 100644 --- a/example/driver_bmp280_basic.c +++ b/example/driver_bmp280_basic.c @@ -40,8 +40,8 @@ static bmp280_handle_t gs_handle; /**< bmp280 handle */ /** * @brief basic example init - * @param[in] interface is the set interface - * @param[in] addr_pin is the chip address pin + * @param[in] interface chip interface + * @param[in] addr_pin chip address pin * @return status code * - 0 success * - 1 init failed @@ -156,8 +156,8 @@ uint8_t bmp280_basic_init(bmp280_interface_t interface, bmp280_address_t addr_pi /** * @brief basic example read - * @param[out] *temperature points to a converted temperature buffer - * @param[out] *pressure points to a converted pressure buffer + * @param[out] *temperature pointer to a converted temperature buffer + * @param[out] *pressure pointer to a converted pressure buffer * @return status code * - 0 success * - 1 read failed diff --git a/example/driver_bmp280_basic.h b/example/driver_bmp280_basic.h index af0473b..2635fa4 100644 --- a/example/driver_bmp280_basic.h +++ b/example/driver_bmp280_basic.h @@ -61,8 +61,8 @@ extern "C"{ /** * @brief basic example init - * @param[in] interface is the set interface - * @param[in] addr_pin is the chip address pin + * @param[in] interface chip interface + * @param[in] addr_pin chip address pin * @return status code * - 0 success * - 1 init failed @@ -81,8 +81,8 @@ uint8_t bmp280_basic_deinit(void); /** * @brief basic example read - * @param[out] *temperature points to a converted temperature buffer - * @param[out] *pressure points to a converted pressure buffer + * @param[out] *temperature pointer to a converted temperature buffer + * @param[out] *pressure pointer to a converted pressure buffer * @return status code * - 0 success * - 1 read failed diff --git a/example/driver_bmp280_shot.c b/example/driver_bmp280_shot.c index 9585c07..040fc45 100644 --- a/example/driver_bmp280_shot.c +++ b/example/driver_bmp280_shot.c @@ -40,8 +40,8 @@ static bmp280_handle_t gs_handle; /**< bmp280 handle */ /** * @brief shot example init - * @param[in] interface is the set interface - * @param[in] addr_pin is the chip address pin + * @param[in] interface chip interface + * @param[in] addr_pin chip address pin * @return status code * - 0 success * - 1 init failed @@ -156,8 +156,8 @@ uint8_t bmp280_shot_init(bmp280_interface_t interface, bmp280_address_t addr_pin /** * @brief shot example read - * @param[out] *temperature points to a converted temperature buffer - * @param[out] *pressure points to a converted pressure buffer + * @param[out] *temperature pointer to a converted temperature buffer + * @param[out] *pressure pointer to a converted pressure buffer * @return status code * - 0 success * - 1 read failed diff --git a/example/driver_bmp280_shot.h b/example/driver_bmp280_shot.h index aa0efe7..6c79e18 100644 --- a/example/driver_bmp280_shot.h +++ b/example/driver_bmp280_shot.h @@ -59,8 +59,8 @@ extern "C"{ /** * @brief shot example init - * @param[in] interface is the set interface - * @param[in] addr_pin is the chip address pin + * @param[in] interface chip interface + * @param[in] addr_pin chip address pin * @return status code * - 0 success * - 1 init failed @@ -79,8 +79,8 @@ uint8_t bmp280_shot_deinit(void); /** * @brief shot example read - * @param[out] *temperature points to a converted temperature buffer - * @param[out] *pressure points to a converted pressure buffer + * @param[out] *temperature pointer to a converted temperature buffer + * @param[out] *pressure pointer to a converted pressure buffer * @return status code * - 0 success * - 1 read failed diff --git a/interface/driver_bmp280_interface.h b/interface/driver_bmp280_interface.h index 087dfcc..e7134c3 100644 --- a/interface/driver_bmp280_interface.h +++ b/interface/driver_bmp280_interface.h @@ -70,10 +70,10 @@ uint8_t bmp280_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 bmp280_interface_iic_read(uint8_t addr, uint8_t reg, uint8_t *buf, uint1 /** * @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 @@ -114,9 +114,9 @@ uint8_t bmp280_interface_spi_deinit(void); /** * @brief interface spi bus read - * @param[in] reg is the register address - * @param[out] *buf points to a data buffer - * @param[in] len is the length of data buffer + * @param[in] reg register address + * @param[out] *buf pointer to a data buffer + * @param[in] len length of data buffer * @return status code * - 0 success * - 1 read failed @@ -126,9 +126,9 @@ uint8_t bmp280_interface_spi_read(uint8_t reg, uint8_t *buf, uint16_t len); /** * @brief interface spi bus write - * @param[in] reg is the register address - * @param[in] *buf points to a data buffer - * @param[in] len is the length of data buffer + * @param[in] reg register address + * @param[in] *buf pointer to a data buffer + * @param[in] len length of data buffer * @return status code * - 0 success * - 1 write failed @@ -138,14 +138,14 @@ uint8_t bmp280_interface_spi_write(uint8_t reg, uint8_t *buf, uint16_t len); /** * @brief interface delay ms - * @param[in] ms + * @param[in] ms time * @note none */ void bmp280_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 bmp280_interface_debug_print(const char *const fmt, ...); diff --git a/interface/driver_bmp280_interface_template.c b/interface/driver_bmp280_interface_template.c index 13d0e0c..9bf7862 100644 --- a/interface/driver_bmp280_interface_template.c +++ b/interface/driver_bmp280_interface_template.c @@ -62,10 +62,10 @@ uint8_t bmp280_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 @@ -78,10 +78,10 @@ uint8_t bmp280_interface_iic_read(uint8_t addr, uint8_t reg, uint8_t *buf, uint1 /** * @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 @@ -118,9 +118,9 @@ uint8_t bmp280_interface_spi_deinit(void) /** * @brief interface spi bus read - * @param[in] reg is the register address - * @param[out] *buf points to a data buffer - * @param[in] len is the length of data buffer + * @param[in] reg register address + * @param[out] *buf pointer to a data buffer + * @param[in] len length of data buffer * @return status code * - 0 success * - 1 read failed @@ -133,9 +133,9 @@ uint8_t bmp280_interface_spi_read(uint8_t reg, uint8_t *buf, uint16_t len) /** * @brief interface spi bus write - * @param[in] reg is the register address - * @param[in] *buf points to a data buffer - * @param[in] len is the length of data buffer + * @param[in] reg register address + * @param[in] *buf pointer to a data buffer + * @param[in] len length of data buffer * @return status code * - 0 success * - 1 write failed @@ -148,7 +148,7 @@ uint8_t bmp280_interface_spi_write(uint8_t reg, uint8_t *buf, uint16_t len) /** * @brief interface delay ms - * @param[in] ms + * @param[in] ms time * @note none */ void bmp280_interface_delay_ms(uint32_t ms) @@ -158,7 +158,7 @@ void bmp280_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 bmp280_interface_debug_print(const char *const fmt, ...) diff --git a/project/raspberrypi4b/driver/src/raspberrypi4b_driver_bmp280_interface.c b/project/raspberrypi4b/driver/src/raspberrypi4b_driver_bmp280_interface.c index 9e7177a..87b53f8 100644 --- a/project/raspberrypi4b/driver/src/raspberrypi4b_driver_bmp280_interface.c +++ b/project/raspberrypi4b/driver/src/raspberrypi4b_driver_bmp280_interface.c @@ -85,10 +85,10 @@ uint8_t bmp280_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 @@ -101,10 +101,10 @@ uint8_t bmp280_interface_iic_read(uint8_t addr, uint8_t reg, uint8_t *buf, uint1 /** * @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 @@ -141,9 +141,9 @@ uint8_t bmp280_interface_spi_deinit(void) /** * @brief interface spi bus read - * @param[in] reg is the register address - * @param[out] *buf points to a data buffer - * @param[in] len is the length of data buffer + * @param[in] reg register address + * @param[out] *buf pointer to a data buffer + * @param[in] len length of data buffer * @return status code * - 0 success * - 1 read failed @@ -156,9 +156,9 @@ uint8_t bmp280_interface_spi_read(uint8_t reg, uint8_t *buf, uint16_t len) /** * @brief interface spi bus write - * @param[in] reg is the register address - * @param[in] *buf points to a data buffer - * @param[in] len is the length of data buffer + * @param[in] reg register address + * @param[in] *buf pointer to a data buffer + * @param[in] len length of data buffer * @return status code * - 0 success * - 1 write failed @@ -171,7 +171,7 @@ uint8_t bmp280_interface_spi_write(uint8_t reg, uint8_t *buf, uint16_t len) /** * @brief interface delay ms - * @param[in] ms + * @param[in] ms time * @note none */ void bmp280_interface_delay_ms(uint32_t ms) @@ -181,7 +181,7 @@ void bmp280_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 bmp280_interface_debug_print(const char *const fmt, ...) diff --git a/project/raspberrypi4b/src/main.c b/project/raspberrypi4b/src/main.c index 747fe41..3874efe 100644 --- a/project/raspberrypi4b/src/main.c +++ b/project/raspberrypi4b/src/main.c @@ -43,8 +43,8 @@ /** * @brief bmp280 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 @@ -374,8 +374,8 @@ uint8_t bmp280(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_bmp280_interface.c b/project/stm32f407/driver/src/stm32f407_driver_bmp280_interface.c index fb5cc2d..d7417b6 100644 --- a/project/stm32f407/driver/src/stm32f407_driver_bmp280_interface.c +++ b/project/stm32f407/driver/src/stm32f407_driver_bmp280_interface.c @@ -67,10 +67,10 @@ uint8_t bmp280_interface_iic_deinit(void) /** * @brief interface iic bus read - * @param[in] addr is iic device write address - * @param[in] reg is 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 bmp280_interface_iic_read(uint8_t addr, uint8_t reg, uint8_t *buf, uint1 /** * @brief interface iic bus write - * @param[in] addr is iic device write address - * @param[in] reg is 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 @@ -123,9 +123,9 @@ uint8_t bmp280_interface_spi_deinit(void) /** * @brief interface spi bus read - * @param[in] reg is the register address - * @param[out] *buf points to a data buffer - * @param[in] len is the length of data buffer + * @param[in] reg register address + * @param[out] *buf pointer to a data buffer + * @param[in] len length of data buffer * @return status code * - 0 success * - 1 read failed @@ -138,9 +138,9 @@ uint8_t bmp280_interface_spi_read(uint8_t reg, uint8_t *buf, uint16_t len) /** * @brief interface spi bus write - * @param[in] reg is the register address - * @param[in] *buf points to a data buffer - * @param[in] len is the length of data buffer + * @param[in] reg register address + * @param[in] *buf pointer to a data buffer + * @param[in] len length of data buffer * @return status code * - 0 success * - 1 write failed @@ -153,7 +153,7 @@ uint8_t bmp280_interface_spi_write(uint8_t reg, uint8_t *buf, uint16_t len) /** * @brief interface delay ms - * @param[in] ms + * @param[in] ms time * @note none */ void bmp280_interface_delay_ms(uint32_t ms) @@ -163,7 +163,7 @@ void bmp280_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 bmp280_interface_debug_print(const char *const fmt, ...) diff --git a/project/stm32f407/usr/src/main.c b/project/stm32f407/usr/src/main.c index 7580554..9a50865 100644 --- a/project/stm32f407/usr/src/main.c +++ b/project/stm32f407/usr/src/main.c @@ -53,8 +53,8 @@ volatile uint16_t g_len; /**< uart buffer length */ /** * @brief bmp280 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_bmp280.c b/src/driver_bmp280.c index ee237be..1b92ad1 100644 --- a/src/driver_bmp280.c +++ b/src/driver_bmp280.c @@ -89,10 +89,10 @@ /** * @brief read multiple bytes - * @param[in] *handle points to a bmp280 handle structure - * @param[in] reg is the register address - * @param[out] *buf points to a data buffer - * @param[in] len is the data length + * @param[in] *handle pointer to a bmp280 handle structure + * @param[in] reg register address + * @param[out] *buf pointer to a data buffer + * @param[in] len data length * @return status code * - 0 success * - 1 iic spi read failed @@ -123,10 +123,10 @@ static uint8_t a_bmp280_iic_spi_read(bmp280_handle_t *handle, uint8_t reg, uint8 /** * @brief write multiple bytes - * @param[in] *handle points to a bmp280 handle structure - * @param[in] reg is the register address - * @param[in] *buf points to a data buffer - * @param[in] len is the data length + * @param[in] *handle pointer to a bmp280 handle structure + * @param[in] reg register address + * @param[in] *buf pointer to a data buffer + * @param[in] len data length * @return status code * - 0 success * - 1 iic spi write failed @@ -157,7 +157,7 @@ static uint8_t a_bmp280_iic_spi_write(bmp280_handle_t *handle, uint8_t reg, uint /** * @brief get nvm calibration - * @param[in] *handle points to a bmp280 handle structure + * @param[in] *handle pointer to a bmp280 handle structure * @return status code * - 0 success * - 1 get calibration data failed @@ -258,9 +258,9 @@ static uint8_t a_bmp280_get_nvm_calibration(bmp280_handle_t *handle) /** * @brief compensate temperature - * @param[in] *handle points to a bmp280 handle structure - * @param[in] raw is the set raw - * @param[out] *output points to an output buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[in] raw raw data + * @param[out] *output pointer to an output buffer * @return status code * - 0 success * - 1 compensate temperature failed @@ -297,9 +297,9 @@ static uint8_t a_bmp280_compensate_temperature(bmp280_handle_t *handle, uint32_t /** * @brief compensate pressure - * @param[in] *handle points to a bmp280 handle structure - * @param[in] raw is the set raw - * @param[out] *output points to an output buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[in] raw raw data + * @param[out] *output pointer to an output buffer * @return status code * - 0 success * - 1 compensate pressure failed @@ -354,8 +354,8 @@ static uint8_t a_bmp280_compensate_pressure(bmp280_handle_t *handle, uint32_t ra /** * @brief set the iic address pin - * @param[in] *handle points to a bmp280 handle structure - * @param[in] addr_pin is the iic address pin + * @param[in] *handle pointer to a bmp280 handle structure + * @param[in] addr_pin iic address pin * @return status code * - 0 success * - 2 handle is NULL @@ -375,8 +375,8 @@ uint8_t bmp280_set_addr_pin(bmp280_handle_t *handle, bmp280_address_t addr_pin) /** * @brief get the iic address pin - * @param[in] *handle points to a bmp280 handle structure - * @param[out] *addr_pin points to an iic address pin buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[out] *addr_pin pointer to an iic address pin buffer * @return status code * - 0 success * - 2 handle is NULL @@ -396,8 +396,8 @@ uint8_t bmp280_get_addr_pin(bmp280_handle_t *handle, bmp280_address_t *addr_pin) /** * @brief set the interface - * @param[in] *handle points to a bmp280 handle structure - * @param[in] interface is the chip interface + * @param[in] *handle pointer to a bmp280 handle structure + * @param[in] interface chip interface * @return status code * - 0 success * - 2 handle is NULL @@ -417,8 +417,8 @@ uint8_t bmp280_set_interface(bmp280_handle_t *handle, bmp280_interface_t interfa /** * @brief get the interface - * @param[in] *handle points to a bmp280 handle structure - * @param[out] *interface points to a chip interface buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[out] *interface pointer to a chip interface buffer * @return status code * - 0 success * - 2 handle is NULL @@ -438,7 +438,7 @@ uint8_t bmp280_get_interface(bmp280_handle_t *handle, bmp280_interface_t *interf /** * @brief initialize the chip - * @param[in] *handle points to a bmp280 handle structure + * @param[in] *handle pointer to a bmp280 handle structure * @return status code * - 0 success * - 1 iic or spi initialization failed @@ -572,7 +572,7 @@ uint8_t bmp280_init(bmp280_handle_t *handle) /** * @brief close the chip - * @param[in] *handle points to a bmp280 handle structure + * @param[in] *handle pointer to a bmp280 handle structure * @return status code * - 0 success * - 1 iic deinit failed @@ -633,7 +633,7 @@ uint8_t bmp280_deinit(bmp280_handle_t *handle) /** * @brief soft reset - * @param[in] *handle points to a bmp280 handle structure + * @param[in] *handle pointer to a bmp280 handle structure * @return status code * - 0 success * - 1 soft reset failed @@ -668,8 +668,8 @@ uint8_t bmp280_soft_reset(bmp280_handle_t *handle) /** * @brief get status - * @param[in] *handle points to a bmp280 handle structure - * @param[out] *status points to a status buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[out] *status pointer to a status buffer * @return status code * - 0 success * - 1 get status failed @@ -700,8 +700,8 @@ uint8_t bmp280_get_status(bmp280_handle_t *handle, uint8_t *status) /** * @brief set temperatue oversampling - * @param[in] *handle points to a bmp280 handle structure - * @param[in] oversampling is the temperatue oversampling + * @param[in] *handle pointer to a bmp280 handle structure + * @param[in] oversampling temperatue oversampling * @return status code * - 0 success * - 1 set temperatue oversampling failed @@ -742,8 +742,8 @@ uint8_t bmp280_set_temperatue_oversampling(bmp280_handle_t *handle, bmp280_overs /** * @brief get temperatue oversampling - * @param[in] *handle points to a bmp280 handle structure - * @param[out] *oversampling points to a oversampling buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[out] *oversampling pointer to a oversampling buffer * @return status code * - 0 success * - 1 get temperatue oversampling failed @@ -777,8 +777,8 @@ uint8_t bmp280_get_temperatue_oversampling(bmp280_handle_t *handle, bmp280_overs /** * @brief set pressure oversampling - * @param[in] *handle points to a bmp280 handle structure - * @param[in] oversampling is the pressure oversampling + * @param[in] *handle pointer to a bmp280 handle structure + * @param[in] oversampling pressure oversampling * @return status code * - 0 success * - 1 set pressure oversampling failed @@ -819,8 +819,8 @@ uint8_t bmp280_set_pressure_oversampling(bmp280_handle_t *handle, bmp280_oversam /** * @brief get pressure oversampling - * @param[in] *handle points to a bmp280 handle structure - * @param[out] *oversampling points to a oversampling buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[out] *oversampling pointer to a oversampling buffer * @return status code * - 0 success * - 1 get pressure oversampling failed @@ -854,8 +854,8 @@ uint8_t bmp280_get_pressure_oversampling(bmp280_handle_t *handle, bmp280_oversam /** * @brief set mode - * @param[in] *handle points to a bmp280 handle structure - * @param[in] mode is the set mode + * @param[in] *handle pointer to a bmp280 handle structure + * @param[in] mode chip mode * @return status code * - 0 success * - 1 set mode failed @@ -896,8 +896,8 @@ uint8_t bmp280_set_mode(bmp280_handle_t *handle, bmp280_mode_t mode) /** * @brief get mode - * @param[in] *handle points to a bmp280 handle structure - * @param[out] *mode points to a mode buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[out] *mode pointer to a mode buffer * @return status code * - 0 success * - 1 get mode failed @@ -931,8 +931,8 @@ uint8_t bmp280_get_mode(bmp280_handle_t *handle, bmp280_mode_t *mode) /** * @brief set standby time - * @param[in] *handle points to a bmp280 handle structure - * @param[in] standby_time is the set standby time + * @param[in] *handle pointer to a bmp280 handle structure + * @param[in] standby_time standby time * @return status code * - 0 success * - 1 set standby time failed @@ -973,8 +973,8 @@ uint8_t bmp280_set_standby_time(bmp280_handle_t *handle, bmp280_standby_time_t s /** * @brief get standby time - * @param[in] *handle points to a bmp280 handle structure - * @param[out] *standby_time points to a standby time buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[out] *standby_time pointer to a standby time buffer * @return status code * - 0 success * - 1 get standby time failed @@ -1008,8 +1008,8 @@ uint8_t bmp280_get_standby_time(bmp280_handle_t *handle, bmp280_standby_time_t * /** * @brief set filter - * @param[in] *handle points to a bmp280 handle structure - * @param[in] filter is the set filter + * @param[in] *handle pointer to a bmp280 handle structure + * @param[in] filter input filter * @return status code * - 0 success * - 1 set filter failed @@ -1050,8 +1050,8 @@ uint8_t bmp280_set_filter(bmp280_handle_t *handle, bmp280_filter_t filter) /** * @brief get filter - * @param[in] *handle points to a bmp280 handle structure - * @param[out] *filter points to a filter buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[out] *filter pointer to a filter buffer * @return status code * - 0 success * - 1 get filter failed @@ -1085,8 +1085,8 @@ uint8_t bmp280_get_filter(bmp280_handle_t *handle, bmp280_filter_t *filter) /** * @brief set spi wire - * @param[in] *handle points to a bmp280 handle structure - * @param[in] spi is the spi wire + * @param[in] *handle pointer to a bmp280 handle structure + * @param[in] spi spi wire * @return status code * - 0 success * - 1 set spi wire failed @@ -1127,8 +1127,8 @@ uint8_t bmp280_set_spi_wire(bmp280_handle_t *handle, bmp280_spi_wire_t spi) /** * @brief get spi wire - * @param[in] *handle points to a bmp280 handle structure - * @param[out] *spi points to a spi wire buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[out] *spi pointer to a spi wire buffer * @return status code * - 0 success * - 1 get spi wire failed @@ -1162,9 +1162,9 @@ uint8_t bmp280_get_spi_wire(bmp280_handle_t *handle, bmp280_spi_wire_t *spi) /** * @brief read the pressure data - * @param[in] *handle points to a bmp280 handle structure - * @param[out] *pressure_raw points to a raw pressure buffer - * @param[out] *pressure_pa points to a converted pressure buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[out] *pressure_raw pointer to a raw pressure buffer + * @param[out] *pressure_pa pointer to a converted pressure buffer * @return status code * - 0 success * - 1 pressure read failed @@ -1300,9 +1300,9 @@ uint8_t bmp280_read_pressure(bmp280_handle_t *handle, uint32_t *pressure_raw, fl /** * @brief read the temperature data - * @param[in] *handle points to a bmp280 handle structure - * @param[out] *temperature_raw points to a raw temperature buffer - * @param[out] *temperature_c points to a converted temperature buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[out] *temperature_raw pointer to a raw temperature buffer + * @param[out] *temperature_c pointer to a converted temperature buffer * @return status code * - 0 success * - 1 temperature read failed @@ -1416,11 +1416,11 @@ uint8_t bmp280_read_temperature(bmp280_handle_t *handle, uint32_t *temperature_r /** * @brief read the temperature and pressure data - * @param[in] *handle points to a bmp280 handle structure - * @param[out] *temperature_raw points to a raw temperature buffer - * @param[out] *temperature_c points to a converted temperature buffer - * @param[out] *pressure_raw points to a raw pressure buffer - * @param[out] *pressure_pa points to a converted pressure buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[out] *temperature_raw pointer to a raw temperature buffer + * @param[out] *temperature_c pointer to a converted temperature buffer + * @param[out] *pressure_raw pointer to a raw pressure buffer + * @param[out] *pressure_pa pointer to a converted pressure buffer * @return status code * - 0 success * - 1 read failed @@ -1555,9 +1555,9 @@ uint8_t bmp280_read_temperature_pressure(bmp280_handle_t *handle, uint32_t *temp /** * @brief set the chip register - * @param[in] *handle points to a bmp280 handle structure - * @param[in] reg is the iic register address - * @param[in] value is the data write to the register + * @param[in] *handle pointer to a bmp280 handle structure + * @param[in] reg iic register address + * @param[in] value data written to the register * @return status code * - 0 success * - 1 write failed @@ -1581,9 +1581,9 @@ uint8_t bmp280_set_reg(bmp280_handle_t *handle, uint8_t reg, uint8_t value) /** * @brief get the chip register - * @param[in] *handle points to a bmp280 handle structure - * @param[in] reg is the iic register address - * @param[out] *value points to a read data buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[in] reg iic register address + * @param[out] *value pointer to a read data buffer * @return status code * - 0 success * - 1 read failed @@ -1607,7 +1607,7 @@ uint8_t bmp280_get_reg(bmp280_handle_t *handle, uint8_t reg, uint8_t *value) /** * @brief get chip's information - * @param[out] *info points to a bmp280 info structure + * @param[out] *info pointer to a bmp280 info structure * @return status code * - 0 success * - 2 handle is NULL diff --git a/src/driver_bmp280.h b/src/driver_bmp280.h index 3c0d6a4..f7d2709 100644 --- a/src/driver_bmp280.h +++ b/src/driver_bmp280.h @@ -204,88 +204,88 @@ typedef struct bmp280_info_s /** * @brief initialize bmp280_handle_t structure - * @param[in] HANDLE points to a bmp280 handle structure - * @param[in] STRUCTURE is bmp280_handle_t + * @param[in] HANDLE pointer to a bmp280 handle structure + * @param[in] STRUCTURE bmp280_handle_t * @note none */ #define DRIVER_BMP280_LINK_INIT(HANDLE, STRUCTURE) memset(HANDLE, 0, sizeof(STRUCTURE)) /** * @brief link iic_init function - * @param[in] HANDLE points to a bmp280 handle structure - * @param[in] FUC points to an iic_init function address + * @param[in] HANDLE pointer to a bmp280 handle structure + * @param[in] FUC pointer to an iic_init function address * @note none */ #define DRIVER_BMP280_LINK_IIC_INIT(HANDLE, FUC) (HANDLE)->iic_init = FUC /** * @brief link iic_deinit function - * @param[in] HANDLE points to a bmp280 handle structure - * @param[in] FUC points to an iic_deinit function address + * @param[in] HANDLE pointer to a bmp280 handle structure + * @param[in] FUC pointer to an iic_deinit function address * @note none */ #define DRIVER_BMP280_LINK_IIC_DEINIT(HANDLE, FUC) (HANDLE)->iic_deinit = FUC /** * @brief link iic_read function - * @param[in] HANDLE points to a bmp280 handle structure - * @param[in] FUC points to an iic_read function address + * @param[in] HANDLE pointer to a bmp280 handle structure + * @param[in] FUC pointer to an iic_read function address * @note none */ #define DRIVER_BMP280_LINK_IIC_READ(HANDLE, FUC) (HANDLE)->iic_read = FUC /** * @brief link iic_write function - * @param[in] HANDLE points to a bmp280 handle structure - * @param[in] FUC points to an iic_write function address + * @param[in] HANDLE pointer to a bmp280 handle structure + * @param[in] FUC pointer to an iic_write function address * @note none */ #define DRIVER_BMP280_LINK_IIC_WRITE(HANDLE, FUC) (HANDLE)->iic_write = FUC /** * @brief link spi_init function - * @param[in] HANDLE points to a bmp280 handle structure - * @param[in] FUC points to a spi_init function address + * @param[in] HANDLE pointer to a bmp280 handle structure + * @param[in] FUC pointer to a spi_init function address * @note none */ #define DRIVER_BMP280_LINK_SPI_INIT(HANDLE, FUC) (HANDLE)->spi_init = FUC /** * @brief link spi_deinit function - * @param[in] HANDLE points to a bmp280 handle structure - * @param[in] FUC points to a spi_deinit function address + * @param[in] HANDLE pointer to a bmp280 handle structure + * @param[in] FUC pointer to a spi_deinit function address * @note none */ #define DRIVER_BMP280_LINK_SPI_DEINIT(HANDLE, FUC) (HANDLE)->spi_deinit = FUC /** * @brief link spi_read function - * @param[in] HANDLE points to a bmp280 handle structure - * @param[in] FUC points to a spi_read function address + * @param[in] HANDLE pointer to a bmp280 handle structure + * @param[in] FUC pointer to a spi_read function address * @note none */ #define DRIVER_BMP280_LINK_SPI_READ(HANDLE, FUC) (HANDLE)->spi_read = FUC /** * @brief link spi_write function - * @param[in] HANDLE points to a bmp280 handle structure - * @param[in] FUC points to a spi_write function address + * @param[in] HANDLE pointer to a bmp280 handle structure + * @param[in] FUC pointer to a spi_write function address * @note none */ #define DRIVER_BMP280_LINK_SPI_WRITE(HANDLE, FUC) (HANDLE)->spi_write = FUC /** * @brief link delay_ms function - * @param[in] HANDLE points to a bmp280 handle structure - * @param[in] FUC points to a delay_ms function address + * @param[in] HANDLE pointer to a bmp280 handle structure + * @param[in] FUC pointer to a delay_ms function address * @note none */ #define DRIVER_BMP280_LINK_DELAY_MS(HANDLE, FUC) (HANDLE)->delay_ms = FUC /** * @brief link debug_print function - * @param[in] HANDLE points to a bmp280 handle structure - * @param[in] FUC points to a debug_print function address + * @param[in] HANDLE pointer to a bmp280 handle structure + * @param[in] FUC pointer to a debug_print function address * @note none */ #define DRIVER_BMP280_LINK_DEBUG_PRINT(HANDLE, FUC) (HANDLE)->debug_print = FUC @@ -303,7 +303,7 @@ typedef struct bmp280_info_s /** * @brief get chip's information - * @param[out] *info points to a bmp280 info structure + * @param[out] *info pointer to a bmp280 info structure * @return status code * - 0 success * - 2 handle is NULL @@ -313,8 +313,8 @@ uint8_t bmp280_info(bmp280_info_t *info); /** * @brief set the interface - * @param[in] *handle points to a bmp280 handle structure - * @param[in] interface is the chip interface + * @param[in] *handle pointer to a bmp280 handle structure + * @param[in] interface chip interface * @return status code * - 0 success * - 2 handle is NULL @@ -324,8 +324,8 @@ uint8_t bmp280_set_interface(bmp280_handle_t *handle, bmp280_interface_t interfa /** * @brief get the interface - * @param[in] *handle points to a bmp280 handle structure - * @param[out] *interface points to a chip interface buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[out] *interface pointer to a chip interface buffer * @return status code * - 0 success * - 2 handle is NULL @@ -335,8 +335,8 @@ uint8_t bmp280_get_interface(bmp280_handle_t *handle, bmp280_interface_t *interf /** * @brief set the iic address pin - * @param[in] *handle points to a bmp280 handle structure - * @param[in] addr_pin is the iic address pin + * @param[in] *handle pointer to a bmp280 handle structure + * @param[in] addr_pin iic address pin * @return status code * - 0 success * - 2 handle is NULL @@ -346,8 +346,8 @@ uint8_t bmp280_set_addr_pin(bmp280_handle_t *handle, bmp280_address_t addr_pin); /** * @brief get the iic address pin - * @param[in] *handle points to a bmp280 handle structure - * @param[out] *addr_pin points to an iic address pin buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[out] *addr_pin pointer to an iic address pin buffer * @return status code * - 0 success * - 2 handle is NULL @@ -357,7 +357,7 @@ uint8_t bmp280_get_addr_pin(bmp280_handle_t *handle, bmp280_address_t *addr_pin) /** * @brief initialize the chip - * @param[in] *handle points to a bmp280 handle structure + * @param[in] *handle pointer to a bmp280 handle structure * @return status code * - 0 success * - 1 iic or spi initialization failed @@ -372,7 +372,7 @@ uint8_t bmp280_init(bmp280_handle_t *handle); /** * @brief close the chip - * @param[in] *handle points to a bmp280 handle structure + * @param[in] *handle pointer to a bmp280 handle structure * @return status code * - 0 success * - 1 iic deinit failed @@ -385,11 +385,11 @@ uint8_t bmp280_deinit(bmp280_handle_t *handle); /** * @brief read the temperature and pressure data - * @param[in] *handle points to a bmp280 handle structure - * @param[out] *temperature_raw points to a raw temperature buffer - * @param[out] *temperature_c points to a converted temperature buffer - * @param[out] *pressure_raw points to a raw pressure buffer - * @param[out] *pressure_pa points to a converted pressure buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[out] *temperature_raw pointer to a raw temperature buffer + * @param[out] *temperature_c pointer to a converted temperature buffer + * @param[out] *pressure_raw pointer to a raw pressure buffer + * @param[out] *pressure_pa pointer to a converted pressure buffer * @return status code * - 0 success * - 1 read failed @@ -404,9 +404,9 @@ uint8_t bmp280_read_temperature_pressure(bmp280_handle_t *handle, uint32_t *temp /** * @brief read the pressure data - * @param[in] *handle points to a bmp280 handle structure - * @param[out] *pressure_raw points to a raw pressure buffer - * @param[out] *pressure_pa points to a converted pressure buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[out] *pressure_raw pointer to a raw pressure buffer + * @param[out] *pressure_pa pointer to a converted pressure buffer * @return status code * - 0 success * - 1 pressure read failed @@ -420,9 +420,9 @@ uint8_t bmp280_read_pressure(bmp280_handle_t *handle, uint32_t *pressure_raw, fl /** * @brief read the temperature data - * @param[in] *handle points to a bmp280 handle structure - * @param[out] *temperature_raw points to a raw temperature buffer - * @param[out] *temperature_c points to a converted temperature buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[out] *temperature_raw pointer to a raw temperature buffer + * @param[out] *temperature_c pointer to a converted temperature buffer * @return status code * - 0 success * - 1 temperature read failed @@ -436,7 +436,7 @@ uint8_t bmp280_read_temperature(bmp280_handle_t *handle, uint32_t *temperature_r /** * @brief soft reset - * @param[in] *handle points to a bmp280 handle structure + * @param[in] *handle pointer to a bmp280 handle structure * @return status code * - 0 success * - 1 soft reset failed @@ -448,8 +448,8 @@ uint8_t bmp280_soft_reset(bmp280_handle_t *handle); /** * @brief get status - * @param[in] *handle points to a bmp280 handle structure - * @param[out] *status points to a status buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[out] *status pointer to a status buffer * @return status code * - 0 success * - 1 get status failed @@ -461,8 +461,8 @@ uint8_t bmp280_get_status(bmp280_handle_t *handle, uint8_t *status); /** * @brief set temperatue oversampling - * @param[in] *handle points to a bmp280 handle structure - * @param[in] oversampling is the temperatue oversampling + * @param[in] *handle pointer to a bmp280 handle structure + * @param[in] oversampling temperatue oversampling * @return status code * - 0 success * - 1 set temperatue oversampling failed @@ -474,8 +474,8 @@ uint8_t bmp280_set_temperatue_oversampling(bmp280_handle_t *handle, bmp280_overs /** * @brief get temperatue oversampling - * @param[in] *handle points to a bmp280 handle structure - * @param[out] *oversampling points to a oversampling buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[out] *oversampling pointer to a oversampling buffer * @return status code * - 0 success * - 1 get temperatue oversampling failed @@ -487,8 +487,8 @@ uint8_t bmp280_get_temperatue_oversampling(bmp280_handle_t *handle, bmp280_overs /** * @brief set pressure oversampling - * @param[in] *handle points to a bmp280 handle structure - * @param[in] oversampling is the pressure oversampling + * @param[in] *handle pointer to a bmp280 handle structure + * @param[in] oversampling pressure oversampling * @return status code * - 0 success * - 1 set pressure oversampling failed @@ -500,8 +500,8 @@ uint8_t bmp280_set_pressure_oversampling(bmp280_handle_t *handle, bmp280_oversam /** * @brief get pressure oversampling - * @param[in] *handle points to a bmp280 handle structure - * @param[out] *oversampling points to a oversampling buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[out] *oversampling pointer to a oversampling buffer * @return status code * - 0 success * - 1 get pressure oversampling failed @@ -513,8 +513,8 @@ uint8_t bmp280_get_pressure_oversampling(bmp280_handle_t *handle, bmp280_oversam /** * @brief set mode - * @param[in] *handle points to a bmp280 handle structure - * @param[in] mode is the set mode + * @param[in] *handle pointer to a bmp280 handle structure + * @param[in] mode chip mode * @return status code * - 0 success * - 1 set mode failed @@ -526,8 +526,8 @@ uint8_t bmp280_set_mode(bmp280_handle_t *handle, bmp280_mode_t mode); /** * @brief get mode - * @param[in] *handle points to a bmp280 handle structure - * @param[out] *mode points to a mode buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[out] *mode pointer to a mode buffer * @return status code * - 0 success * - 1 get mode failed @@ -539,8 +539,8 @@ uint8_t bmp280_get_mode(bmp280_handle_t *handle, bmp280_mode_t *mode); /** * @brief set standby time - * @param[in] *handle points to a bmp280 handle structure - * @param[in] standby_time is the set standby time + * @param[in] *handle pointer to a bmp280 handle structure + * @param[in] standby_time standby time * @return status code * - 0 success * - 1 set standby time failed @@ -552,8 +552,8 @@ uint8_t bmp280_set_standby_time(bmp280_handle_t *handle, bmp280_standby_time_t s /** * @brief get standby time - * @param[in] *handle points to a bmp280 handle structure - * @param[out] *standby_time points to a standby time buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[out] *standby_time pointer to a standby time buffer * @return status code * - 0 success * - 1 get standby time failed @@ -565,8 +565,8 @@ uint8_t bmp280_get_standby_time(bmp280_handle_t *handle, bmp280_standby_time_t * /** * @brief set filter - * @param[in] *handle points to a bmp280 handle structure - * @param[in] filter is the set filter + * @param[in] *handle pointer to a bmp280 handle structure + * @param[in] filter input filter * @return status code * - 0 success * - 1 set filter failed @@ -578,8 +578,8 @@ uint8_t bmp280_set_filter(bmp280_handle_t *handle, bmp280_filter_t filter); /** * @brief get filter - * @param[in] *handle points to a bmp280 handle structure - * @param[out] *filter points to a filter buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[out] *filter pointer to a filter buffer * @return status code * - 0 success * - 1 get filter failed @@ -591,8 +591,8 @@ uint8_t bmp280_get_filter(bmp280_handle_t *handle, bmp280_filter_t *filter); /** * @brief set spi wire - * @param[in] *handle points to a bmp280 handle structure - * @param[in] spi is the spi wire + * @param[in] *handle pointer to a bmp280 handle structure + * @param[in] spi spi wire * @return status code * - 0 success * - 1 set spi wire failed @@ -604,8 +604,8 @@ uint8_t bmp280_set_spi_wire(bmp280_handle_t *handle, bmp280_spi_wire_t spi); /** * @brief get spi wire - * @param[in] *handle points to a bmp280 handle structure - * @param[out] *spi points to a spi wire buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[out] *spi pointer to a spi wire buffer * @return status code * - 0 success * - 1 get spi wire failed @@ -628,9 +628,9 @@ uint8_t bmp280_get_spi_wire(bmp280_handle_t *handle, bmp280_spi_wire_t *spi); /** * @brief set the chip register - * @param[in] *handle points to a bmp280 handle structure - * @param[in] reg is the iic register address - * @param[in] value is the data write to the register + * @param[in] *handle pointer to a bmp280 handle structure + * @param[in] reg iic register address + * @param[in] value data written to the register * @return status code * - 0 success * - 1 write failed @@ -642,9 +642,9 @@ uint8_t bmp280_set_reg(bmp280_handle_t *handle, uint8_t reg, uint8_t value); /** * @brief get the chip register - * @param[in] *handle points to a bmp280 handle structure - * @param[in] reg is the iic register address - * @param[out] *value points to a read data buffer + * @param[in] *handle pointer to a bmp280 handle structure + * @param[in] reg iic register address + * @param[out] *value pointer to a read data buffer * @return status code * - 0 success * - 1 read failed diff --git a/test/driver_bmp280_read_test.c b/test/driver_bmp280_read_test.c index 608cb26..f9222d1 100644 --- a/test/driver_bmp280_read_test.c +++ b/test/driver_bmp280_read_test.c @@ -40,9 +40,9 @@ static bmp280_handle_t gs_handle; /**< bmp280 handle */ /** * @brief read test - * @param[in] interface is the set interface - * @param[in] addr_pin is the chip address pin - * @param[in] times is the read times + * @param[in] interface chip interface + * @param[in] addr_pin chip address pin + * @param[in] times test times * @return status code * - 0 success * - 1 test failed diff --git a/test/driver_bmp280_read_test.h b/test/driver_bmp280_read_test.h index 57bdb9d..d764e41 100644 --- a/test/driver_bmp280_read_test.h +++ b/test/driver_bmp280_read_test.h @@ -50,9 +50,9 @@ extern "C"{ /** * @brief read test - * @param[in] interface is the set interface - * @param[in] addr_pin is the chip address pin - * @param[in] times is the read times + * @param[in] interface chip interface + * @param[in] addr_pin chip address pin + * @param[in] times test times * @return status code * - 0 success * - 1 test failed diff --git a/test/driver_bmp280_register_test.c b/test/driver_bmp280_register_test.c index 05300f9..75c9956 100644 --- a/test/driver_bmp280_register_test.c +++ b/test/driver_bmp280_register_test.c @@ -40,8 +40,8 @@ static bmp280_handle_t gs_handle; /**< bmp280 handle */ /** * @brief register test - * @param[in] interface is the set interface - * @param[in] addr_pin is the chip address pin + * @param[in] interface chip interface + * @param[in] addr_pin chip address pin * @return status code * - 0 success * - 1 test failed diff --git a/test/driver_bmp280_register_test.h b/test/driver_bmp280_register_test.h index 14aae78..f52a598 100644 --- a/test/driver_bmp280_register_test.h +++ b/test/driver_bmp280_register_test.h @@ -52,8 +52,8 @@ extern "C"{ /** * @brief register test - * @param[in] interface is the set interface - * @param[in] addr_pin is the chip address pin + * @param[in] interface chip interface + * @param[in] addr_pin chip address pin * @return status code * - 0 success * - 1 test failed