diff --git a/CHANGELOG.md b/CHANGELOG.md index b7c2e57..8eee5d1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## 2.0.2 (2024-12-01) + +## Bug Fixes + +- fix doc errors + ## 2.0.1 (2024-08-05) ## Bug Fixes diff --git a/doc/html/group__bmp180__base__driver.html b/doc/html/group__bmp180__base__driver.html index 208649c..acf4db3 100644 --- a/doc/html/group__bmp180__base__driver.html +++ b/doc/html/group__bmp180__base__driver.html @@ -236,7 +236,7 @@

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

Parameters
- - + +
[in]*handlepoints to a bmp180 handle structure
[out]*modepoints to a measurement mode buffer
[in]*handlepointer to a bmp180 handle structure
[out]*modepointer to a measurement mode buffer
@@ -318,7 +318,7 @@

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

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

Parameters
- - - + + +
[in]*handlepoints to a bmp180 handle structure
[out]*rawpoints to a raw pressure buffer
[out]*papoints to a converted pressure buffer
[in]*handlepointer to a bmp180 handle structure
[out]*rawpointer to a raw pressure buffer
[out]*papointer to a converted pressure buffer
@@ -460,9 +460,9 @@

Parameters
- - - + + +
[in]*handlepoints to a bmp180 handle structure
[out]*rawpoints to a raw temperature buffer
[out]*cpoints to a converted temperature buffer
[in]*handlepointer to a bmp180 handle structure
[out]*rawpointer to a raw temperature buffer
[out]*cpointer to a converted temperature buffer
@@ -526,11 +526,11 @@

Parameters
- - - - - + + + + +
[in]*handlepoints to a bmp180 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 bmp180 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
@@ -576,8 +576,8 @@

Parameters
- - + +
[in]*handlepoints to a bmp180 handle structure
[in]modeis the measurement mode
[in]*handlepointer to a bmp180 handle structure
[in]modemeasurement mode
diff --git a/doc/html/group__bmp180__example__driver.html b/doc/html/group__bmp180__example__driver.html index 5da5afa..dc9ff12 100644 --- a/doc/html/group__bmp180__example__driver.html +++ b/doc/html/group__bmp180__example__driver.html @@ -221,8 +221,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__bmp180__extend__driver.html b/doc/html/group__bmp180__extend__driver.html index cf781fb..fa9d28d 100644 --- a/doc/html/group__bmp180__extend__driver.html +++ b/doc/html/group__bmp180__extend__driver.html @@ -141,9 +141,9 @@

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

Parameters
- - - + + +
[in]*handlepoints to a bmp180 handle structure
[in]regis the iic register address
[in]valueis the data write to the register
[in]*handlepointer to a bmp180 handle structure
[in]regiic register address
[in]valuedata written to the register
diff --git a/doc/html/group__bmp180__interface__driver.html b/doc/html/group__bmp180__interface__driver.html index e720e59..64f44f9 100644 --- a/doc/html/group__bmp180__interface__driver.html +++ b/doc/html/group__bmp180__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 iic device write address
[in]regis 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 iic device write address
[in]regis 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__bmp180__link__driver.html b/doc/html/group__bmp180__link__driver.html index 4f50940..03aeddd 100644 --- a/doc/html/group__bmp180__link__driver.html +++ b/doc/html/group__bmp180__link__driver.html @@ -150,8 +150,8 @@

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

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

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

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

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

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

Parameters
- - + +
[in]HANDLEpoints to a bmp180 handle structure
[in]STRUCTUREis bmp180_handle_t
[in]HANDLEpointer to a bmp180 handle structure
[in]STRUCTUREbmp180_handle_t
diff --git a/doc/html/group__bmp180__test__driver.html b/doc/html/group__bmp180__test__driver.html index 5446fb6..e984e13 100644 --- a/doc/html/group__bmp180__test__driver.html +++ b/doc/html/group__bmp180__test__driver.html @@ -125,7 +125,7 @@

Parameters
- +
[in]timesis the read times
[in]timestest times
diff --git a/example/driver_bmp180_basic.c b/example/driver_bmp180_basic.c index bfc9a5a..f6f4a70 100644 --- a/example/driver_bmp180_basic.c +++ b/example/driver_bmp180_basic.c @@ -83,8 +83,8 @@ uint8_t bmp180_basic_init(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_bmp180_basic.h b/example/driver_bmp180_basic.h index bee3245..4fd809f 100644 --- a/example/driver_bmp180_basic.h +++ b/example/driver_bmp180_basic.h @@ -76,8 +76,8 @@ uint8_t bmp180_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/interface/driver_bmp180_interface.h b/interface/driver_bmp180_interface.h index fbec0bd..f7472e9 100644 --- a/interface/driver_bmp180_interface.h +++ b/interface/driver_bmp180_interface.h @@ -71,10 +71,10 @@ uint8_t bmp180_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 @@ -84,10 +84,10 @@ uint8_t bmp180_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 @@ -97,14 +97,14 @@ uint8_t bmp180_interface_iic_write(uint8_t addr, uint8_t reg, uint8_t *buf, uint /** * @brief interface delay ms - * @param[in] ms + * @param[in] ms time * @note none */ void bmp180_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 bmp180_interface_debug_print(const char *const fmt, ...); diff --git a/interface/driver_bmp180_interface_template.c b/interface/driver_bmp180_interface_template.c index 2ccfb71..8943b87 100644 --- a/interface/driver_bmp180_interface_template.c +++ b/interface/driver_bmp180_interface_template.c @@ -63,10 +63,10 @@ uint8_t bmp180_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 @@ -79,10 +79,10 @@ uint8_t bmp180_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 @@ -95,7 +95,7 @@ uint8_t bmp180_interface_iic_write(uint8_t addr, uint8_t reg, uint8_t *buf, uint /** * @brief interface delay ms - * @param[in] ms + * @param[in] ms time * @note none */ void bmp180_interface_delay_ms(uint32_t ms) @@ -105,7 +105,7 @@ void bmp180_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 bmp180_interface_debug_print(const char *const fmt, ...) diff --git a/project/raspberrypi4b/driver/src/raspberrypi4b_driver_bmp180_interface.c b/project/raspberrypi4b/driver/src/raspberrypi4b_driver_bmp180_interface.c index b947c8f..2e866f0 100644 --- a/project/raspberrypi4b/driver/src/raspberrypi4b_driver_bmp180_interface.c +++ b/project/raspberrypi4b/driver/src/raspberrypi4b_driver_bmp180_interface.c @@ -75,10 +75,10 @@ uint8_t bmp180_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 bmp180_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 @@ -107,7 +107,7 @@ uint8_t bmp180_interface_iic_write(uint8_t addr, uint8_t reg, uint8_t *buf, uint /** * @brief interface delay ms - * @param[in] ms + * @param[in] ms time * @note none */ void bmp180_interface_delay_ms(uint32_t ms) @@ -117,7 +117,7 @@ void bmp180_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 bmp180_interface_debug_print(const char *const fmt, ...) diff --git a/project/raspberrypi4b/src/main.c b/project/raspberrypi4b/src/main.c index 19f505a..21fc1e4 100644 --- a/project/raspberrypi4b/src/main.c +++ b/project/raspberrypi4b/src/main.c @@ -42,8 +42,8 @@ /** * @brief bmp180 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 @@ -281,8 +281,8 @@ uint8_t bmp180(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_bmp180_interface.c b/project/stm32f407/driver/src/stm32f407_driver_bmp180_interface.c index 8ba7a94..efaf8e1 100644 --- a/project/stm32f407/driver/src/stm32f407_driver_bmp180_interface.c +++ b/project/stm32f407/driver/src/stm32f407_driver_bmp180_interface.c @@ -67,10 +67,10 @@ uint8_t bmp180_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 bmp180_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 @@ -99,7 +99,7 @@ uint8_t bmp180_interface_iic_write(uint8_t addr, uint8_t reg, uint8_t *buf, uint /** * @brief interface delay ms - * @param[in] ms + * @param[in] ms time * @note none */ void bmp180_interface_delay_ms(uint32_t ms) @@ -109,7 +109,7 @@ void bmp180_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 bmp180_interface_debug_print(const char *const fmt, ...) diff --git a/project/stm32f407/usr/src/main.c b/project/stm32f407/usr/src/main.c index 8f8ff78..c3b5e51 100644 --- a/project/stm32f407/usr/src/main.c +++ b/project/stm32f407/usr/src/main.c @@ -52,8 +52,8 @@ volatile uint16_t g_len; /**< uart buffer length */ /** * @brief bmp180 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_bmp180.c b/src/driver_bmp180.c index 5546a9e..e3c37d9 100644 --- a/src/driver_bmp180.c +++ b/src/driver_bmp180.c @@ -88,10 +88,10 @@ /** * @brief read bytes - * @param[in] *handle points to a bmp180 handle structure - * @param[in] addr is the iic device address - * @param[in] reg is the iic register address - * @param[out] *data points to a data buffer + * @param[in] *handle pointer to a bmp180 handle structure + * @param[in] addr iic device address + * @param[in] reg iic register address + * @param[out] *data pointer to a data buffer * @return status code * - 0 success * - 1 read failed @@ -111,10 +111,10 @@ static uint8_t a_bmp180_iic_read(bmp180_handle_t *handle, uint8_t addr, uint8_t /** * @brief write bytes - * @param[in] *handle points to a bmp180 handle structure - * @param[in] addr is the iic device address - * @param[in] reg is the iic register address - * @param[in] data is the write data + * @param[in] *handle pointer to a bmp180 handle structure + * @param[in] addr iic device address + * @param[in] reg iic register address + * @param[in] data written data * @return status code * - 0 success * - 1 write failed @@ -134,7 +134,7 @@ static uint8_t a_bmp180_iic_write(bmp180_handle_t *handle, uint8_t addr, uint8_t /** * @brief initialize the chip - * @param[in] *handle points to a bmp180 handle structure + * @param[in] *handle pointer to a bmp180 handle structure * @return status code * - 0 success * - 1 iic initialization failed @@ -266,7 +266,7 @@ uint8_t bmp180_init(bmp180_handle_t *handle) /** * @brief close the chip - * @param[in] *handle points to a bmp180 handle structure + * @param[in] *handle pointer to a bmp180 handle structure * @return status code * - 0 success * - 1 iic deinit failed @@ -298,8 +298,8 @@ uint8_t bmp180_deinit(bmp180_handle_t *handle) /** * @brief set the measurement mode - * @param[in] *handle points to a bmp180 handle structure - * @param[in] mode is the measurement mode + * @param[in] *handle pointer to a bmp180 handle structure + * @param[in] mode measurement mode * @return status code * - 0 success * - 2 handle is NULL @@ -324,8 +324,8 @@ uint8_t bmp180_set_mode(bmp180_handle_t *handle, bmp180_mode_t mode) /** * @brief get the measurement mode - * @param[in] *handle points to a bmp180 handle structure - * @param[out] *mode points to a measurement mode buffer + * @param[in] *handle pointer to a bmp180 handle structure + * @param[out] *mode pointer to a measurement mode buffer * @return status code * - 0 success * - 2 handle is NULL @@ -350,9 +350,9 @@ uint8_t bmp180_get_mode(bmp180_handle_t *handle, bmp180_mode_t *mode) /** * @brief read the pressure data - * @param[in] *handle points to a bmp180 handle structure - * @param[out] *raw points to a raw pressure buffer - * @param[out] *pa points to a converted pressure buffer + * @param[in] *handle pointer to a bmp180 handle structure + * @param[out] *raw pointer to a raw pressure buffer + * @param[out] *pa pointer to a converted pressure buffer * @return status code * - 0 success * - 1 pressure read failed @@ -515,9 +515,9 @@ uint8_t bmp180_read_pressure(bmp180_handle_t *handle, uint32_t *raw, uint32_t *p /** * @brief read the temperature data - * @param[in] *handle points to a bmp180 handle structure - * @param[out] *raw points to a raw temperature buffer - * @param[out] *c points to a converted temperature buffer + * @param[in] *handle pointer to a bmp180 handle structure + * @param[out] *raw pointer to a raw temperature buffer + * @param[out] *c pointer to a converted temperature buffer * @return status code * - 0 success * - 1 temperature read failed @@ -593,11 +593,11 @@ uint8_t bmp180_read_temperature(bmp180_handle_t *handle, uint16_t *raw, float *c /** * @brief read the temperature and pressure data - * @param[in] *handle points to a bmp180 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 bmp180 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 @@ -763,9 +763,9 @@ uint8_t bmp180_read_temperature_pressure(bmp180_handle_t *handle, uint16_t *temp /** * @brief set the chip register - * @param[in] *handle points to a bmp180 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 bmp180 handle structure + * @param[in] reg iic register address + * @param[in] value data written to the register * @return status code * - 0 success * - 1 write failed @@ -789,9 +789,9 @@ uint8_t bmp180_set_reg(bmp180_handle_t *handle, uint8_t reg, uint8_t value) /** * @brief get the chip register - * @param[in] *handle points to a bmp180 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 bmp180 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 @@ -815,7 +815,7 @@ uint8_t bmp180_get_reg(bmp180_handle_t *handle, uint8_t reg, uint8_t *value) /** * @brief get chip's information - * @param[out] *info points to a bmp180 info structure + * @param[out] *info pointer to a bmp180 info structure * @return status code * - 0 success * - 2 handle is NULL diff --git a/src/driver_bmp180.h b/src/driver_bmp180.h index 35cd498..651c57b 100644 --- a/src/driver_bmp180.h +++ b/src/driver_bmp180.h @@ -123,56 +123,56 @@ typedef struct bmp180_info_s /** * @brief initialize bmp180_handle_t structure - * @param[in] HANDLE points to a bmp180 handle structure - * @param[in] STRUCTURE is bmp180_handle_t + * @param[in] HANDLE pointer to a bmp180 handle structure + * @param[in] STRUCTURE bmp180_handle_t * @note none */ #define DRIVER_BMP180_LINK_INIT(HANDLE, STRUCTURE) memset(HANDLE, 0, sizeof(STRUCTURE)) /** * @brief link iic_init function - * @param[in] HANDLE points to a bmp180 handle structure - * @param[in] FUC points to an iic_init function address + * @param[in] HANDLE pointer to a bmp180 handle structure + * @param[in] FUC pointer to an iic_init function address * @note none */ #define DRIVER_BMP180_LINK_IIC_INIT(HANDLE, FUC) (HANDLE)->iic_init = FUC /** * @brief link iic_deinit function - * @param[in] HANDLE points to a bmp180 handle structure - * @param[in] FUC points to an iic_deinit function address + * @param[in] HANDLE pointer to a bmp180 handle structure + * @param[in] FUC pointer to an iic_deinit function address * @note none */ #define DRIVER_BMP180_LINK_IIC_DEINIT(HANDLE, FUC) (HANDLE)->iic_deinit = FUC /** * @brief link iic_read function - * @param[in] HANDLE points to a bmp180 handle structure - * @param[in] FUC points to an iic_read function address + * @param[in] HANDLE pointer to a bmp180 handle structure + * @param[in] FUC pointer to an iic_read function address * @note none */ #define DRIVER_BMP180_LINK_IIC_READ(HANDLE, FUC) (HANDLE)->iic_read = FUC /** * @brief link iic_write function - * @param[in] HANDLE points to a bmp180 handle structure - * @param[in] FUC points to an iic_write function address + * @param[in] HANDLE pointer to a bmp180 handle structure + * @param[in] FUC pointer to an iic_write function address * @note none */ #define DRIVER_BMP180_LINK_IIC_WRITE(HANDLE, FUC) (HANDLE)->iic_write = FUC /** * @brief link delay_ms function - * @param[in] HANDLE points to a bmp180 handle structure - * @param[in] FUC points to a delay_ms function address + * @param[in] HANDLE pointer to a bmp180 handle structure + * @param[in] FUC pointer to a delay_ms function address * @note none */ #define DRIVER_BMP180_LINK_DELAY_MS(HANDLE, FUC) (HANDLE)->delay_ms = FUC /** * @brief link debug_print function - * @param[in] HANDLE points to a bmp180 handle structure - * @param[in] FUC points to a debug_print function address + * @param[in] HANDLE pointer to a bmp180 handle structure + * @param[in] FUC pointer to a debug_print function address * @note none */ #define DRIVER_BMP180_LINK_DEBUG_PRINT(HANDLE, FUC) (HANDLE)->debug_print = FUC @@ -190,7 +190,7 @@ typedef struct bmp180_info_s /** * @brief get chip's information - * @param[out] *info points to a bmp180 info structure + * @param[out] *info pointer to a bmp180 info structure * @return status code * - 0 success * - 2 handle is NULL @@ -200,7 +200,7 @@ uint8_t bmp180_info(bmp180_info_t *info); /** * @brief initialize the chip - * @param[in] *handle points to a bmp180 handle structure + * @param[in] *handle pointer to a bmp180 handle structure * @return status code * - 0 success * - 1 iic initialization failed @@ -214,7 +214,7 @@ uint8_t bmp180_init(bmp180_handle_t *handle); /** * @brief close the chip - * @param[in] *handle points to a bmp180 handle structure + * @param[in] *handle pointer to a bmp180 handle structure * @return status code * - 0 success * - 1 iic deinit failed @@ -226,11 +226,11 @@ uint8_t bmp180_deinit(bmp180_handle_t *handle); /** * @brief read the temperature and pressure data - * @param[in] *handle points to a bmp180 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 bmp180 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 @@ -243,9 +243,9 @@ uint8_t bmp180_read_temperature_pressure(bmp180_handle_t *handle, uint16_t *temp /** * @brief read the pressure data - * @param[in] *handle points to a bmp180 handle structure - * @param[out] *raw points to a raw pressure buffer - * @param[out] *pa points to a converted pressure buffer + * @param[in] *handle pointer to a bmp180 handle structure + * @param[out] *raw pointer to a raw pressure buffer + * @param[out] *pa pointer to a converted pressure buffer * @return status code * - 0 success * - 1 pressure read failed @@ -257,9 +257,9 @@ uint8_t bmp180_read_pressure(bmp180_handle_t *handle, uint32_t *raw, uint32_t *p /** * @brief read the temperature data - * @param[in] *handle points to a bmp180 handle structure - * @param[out] *raw points to a raw temperature buffer - * @param[out] *c points to a converted temperature buffer + * @param[in] *handle pointer to a bmp180 handle structure + * @param[out] *raw pointer to a raw temperature buffer + * @param[out] *c pointer to a converted temperature buffer * @return status code * - 0 success * - 1 temperature read failed @@ -271,8 +271,8 @@ uint8_t bmp180_read_temperature(bmp180_handle_t *handle, uint16_t *raw, float *c /** * @brief set the measurement mode - * @param[in] *handle points to a bmp180 handle structure - * @param[in] mode is the measurement mode + * @param[in] *handle pointer to a bmp180 handle structure + * @param[in] mode measurement mode * @return status code * - 0 success * - 2 handle is NULL @@ -283,8 +283,8 @@ uint8_t bmp180_set_mode(bmp180_handle_t *handle, bmp180_mode_t mode); /** * @brief get the measurement mode - * @param[in] *handle points to a bmp180 handle structure - * @param[out] *mode points to a measurement mode buffer + * @param[in] *handle pointer to a bmp180 handle structure + * @param[out] *mode pointer to a measurement mode buffer * @return status code * - 0 success * - 2 handle is NULL @@ -306,9 +306,9 @@ uint8_t bmp180_get_mode(bmp180_handle_t *handle, bmp180_mode_t *mode); /** * @brief set the chip register - * @param[in] *handle points to a bmp180 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 bmp180 handle structure + * @param[in] reg iic register address + * @param[in] value data written to the register * @return status code * - 0 success * - 1 write failed @@ -320,9 +320,9 @@ uint8_t bmp180_set_reg(bmp180_handle_t *handle, uint8_t reg, uint8_t value); /** * @brief get the chip register - * @param[in] *handle points to a bmp180 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 bmp180 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_bmp180_read_test.c b/test/driver_bmp180_read_test.c index e847d4e..2309786 100644 --- a/test/driver_bmp180_read_test.c +++ b/test/driver_bmp180_read_test.c @@ -41,7 +41,7 @@ static bmp180_handle_t gs_handle; /**< bmp180 handle */ /** * @brief read test - * @param[in] times is the read times + * @param[in] times test times * @return status code * - 0 success * - 1 test failed diff --git a/test/driver_bmp180_read_test.h b/test/driver_bmp180_read_test.h index ab8ffd0..220839c 100644 --- a/test/driver_bmp180_read_test.h +++ b/test/driver_bmp180_read_test.h @@ -51,7 +51,7 @@ extern "C"{ /** * @brief read test - * @param[in] times is the read times + * @param[in] times test times * @return status code * - 0 success * - 1 test failed