diff --git a/CHANGELOG.md b/CHANGELOG.md index 5ee2231..f9aadae 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## 1.0.2 (2024-12-21) + +## Bug Fixes + +- fix doc errors + ## 1.0.0 (2024-08-30) ## Features diff --git a/doc/html/group__scd30__basic__driver.html b/doc/html/group__scd30__basic__driver.html index d79a7ad..6b7d06a 100644 --- a/doc/html/group__scd30__basic__driver.html +++ b/doc/html/group__scd30__basic__driver.html @@ -329,7 +329,7 @@

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

Parameters
- - + +
[in]*handlepoints to an scd30 handle structure
[out]*mpoints to a meter buffer
[in]*handlepointer to an scd30 handle structure
[out]*mpointer to a meter buffer
@@ -423,8 +423,8 @@

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

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

Parameters
- - + +
[in]*handlepoints to an scd30 handle structure
[out]*versionpoints to a version buffer
[in]*handlepointer to an scd30 handle structure
[out]*versionpointer to a version buffer
@@ -564,8 +564,8 @@

Parameters
- - + +
[in]*handlepoints to an scd30 handle structure
[out]*co2_ppmpoints to a co2 ppm buffer
[in]*handlepointer to an scd30 handle structure
[out]*co2_ppmpointer to a co2 ppm buffer
@@ -611,8 +611,8 @@

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

Parameters
- - + +
[in]*handlepoints to an scd30 handle structure
[out]*secondpoints to a second buffer
[in]*handlepointer to an scd30 handle structure
[out]*secondpointer to a second buffer
@@ -703,8 +703,8 @@

Parameters
- - + +
[in]*handlepoints to an scd30 handle structure
[out]*degpoints to a degree buffer
[in]*handlepointer to an scd30 handle structure
[out]*degpointer to a degree buffer
@@ -740,7 +740,7 @@

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

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

Parameters
- - + +
[in]*handlepoints to an scd30 handle structure
[out]*datapoints to an scd30 data structure
[in]*handlepointer to an scd30 handle structure
[out]*datapointer to an scd30 data structure
@@ -869,8 +869,8 @@

Parameters
- - + +
[in]*handlepoints to an scd30 handle structure
[in]mis the set meter
[in]*handlepointer to an scd30 handle structure
[in]mset meter
@@ -916,8 +916,8 @@

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

Parameters
- - + +
[in]*handlepoints to an scd30 handle structure
[in]co2_ppmis the set co2 ppm
[in]*handlepointer to an scd30 handle structure
[in]co2_ppmset co2 ppm
@@ -1011,8 +1011,8 @@

Parameters
- - + +
[in]*handlepoints to an scd30 handle structure
[in]interfaceis the chip interface
[in]*handlepointer to an scd30 handle structure
[in]interfacechip interface
@@ -1056,8 +1056,8 @@

Parameters
- - + +
[in]*handlepoints to an scd30 handle structure
[in]secondis the set interval
[in]*handlepointer to an scd30 handle structure
[in]secondset interval
@@ -1104,8 +1104,8 @@

Parameters
- - + +
[in]*handlepoints to an scd30 handle structure
[in]degis the set degree
[in]*handlepointer to an scd30 handle structure
[in]degset degree
@@ -1141,7 +1141,7 @@

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

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

Parameters
- - + +
[in]*handlepoints to an scd30 handle structure
[in]mbaris the ambient pressure compensation
[in]*handlepointer to an scd30 handle structure
[in]mbarambient pressure compensation
@@ -1261,7 +1261,7 @@

Parameters
- +
[in]*handlepoints to an scd30 handle structure
[in]*handlepointer to an scd30 handle structure
@@ -1313,9 +1313,9 @@

Parameters
- - - + + +
[in]*handlepoints to an scd30 handle structure
[in]regis the register raw data
[out]*degpoints to a degree buffer
[in]*handlepointer to an scd30 handle structure
[in]regregister raw data
[out]*degpointer to a degree buffer
@@ -1366,9 +1366,9 @@

Parameters
- - - + + +
[in]*handlepoints to an scd30 handle structure
[in]degis the degree
[out]*regpoints to a register raw buffer
[in]*handlepointer to an scd30 handle structure
[in]degdegree
[out]*regpointer to a register raw buffer
diff --git a/doc/html/group__scd30__example__driver.html b/doc/html/group__scd30__example__driver.html index 3d5853c..c0b5ea6 100644 --- a/doc/html/group__scd30__example__driver.html +++ b/doc/html/group__scd30__example__driver.html @@ -218,8 +218,8 @@

Parameters
- - + +
[out]*majorpoints to a major buffer
[out]*minorpoints to a minor buffer
[out]*majorpointer to a major buffer
[out]*minorpointer to a minor buffer
@@ -263,8 +263,8 @@

Parameters
- - + +
[in]interfaceis the chip interface
[in]mbaris the pressure compensation
[in]interfacechip interface
[in]mbarpressure compensation
@@ -298,7 +298,7 @@

Parameters
- +
[out]*datapoints to a scd30_data_t structure
[out]*datapointer to a scd30_data_t structure
diff --git a/doc/html/group__scd30__extern__driver.html b/doc/html/group__scd30__extern__driver.html index 6817257..6ef2ef8 100644 --- a/doc/html/group__scd30__extern__driver.html +++ b/doc/html/group__scd30__extern__driver.html @@ -150,10 +150,10 @@

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

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

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

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

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

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

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

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

Parameters
- - + +
[in]*bufpoints to a data buffer
[in]lenis the length of the data buffer
[in]*bufpointer to a data buffer
[in]lenlength of the data buffer
diff --git a/doc/html/group__scd30__link__driver.html b/doc/html/group__scd30__link__driver.html index 39fa366..51fbddf 100644 --- a/doc/html/group__scd30__link__driver.html +++ b/doc/html/group__scd30__link__driver.html @@ -165,8 +165,8 @@

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

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

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

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

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

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

Parameters
- - + +
[in]HANDLEpoints to an scd30 handle structure
[in]STRUCTUREis scd30_handle_t
[in]HANDLEpointer to an scd30 handle structure
[in]STRUCTUREscd30_handle_t
@@ -445,8 +445,8 @@

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

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

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

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

Parameters
- - + +
[in]HANDLEpoints to an scd30 handle structure
[in]FUCpoints to a uart_write function address
[in]HANDLEpointer to an scd30 handle structure
[in]FUCpointer to a uart_write function address
diff --git a/doc/html/group__scd30__test__driver.html b/doc/html/group__scd30__test__driver.html index 8709f27..8e4bb6b 100644 --- a/doc/html/group__scd30__test__driver.html +++ b/doc/html/group__scd30__test__driver.html @@ -135,8 +135,8 @@

Parameters
- - + +
[in]interfaceis the chip interface
[in]timesis the test times
[in]interfacechip interface
[in]timestest times
@@ -170,7 +170,7 @@

Parameters
- +
[in]interfaceis the chip interface
[in]interfacechip interface
diff --git a/example/driver_scd30_basic.c b/example/driver_scd30_basic.c index ab38f53..0e1021f 100644 --- a/example/driver_scd30_basic.c +++ b/example/driver_scd30_basic.c @@ -40,8 +40,8 @@ static scd30_handle_t gs_handle; /**< scd30 handle */ /** * @brief basic example init - * @param[in] interface is the chip interface - * @param[in] mbar is the pressure compensation + * @param[in] interface chip interface + * @param[in] mbar pressure compensation * @return status code * - 0 success * - 1 init failed @@ -190,7 +190,7 @@ uint8_t scd30_basic_deinit(void) /** * @brief basic example read - * @param[out] *data points to a scd30_data_t structure + * @param[out] *data pointer to a scd30_data_t structure * @return status code * - 0 success * - 1 read failed @@ -229,8 +229,8 @@ uint8_t scd30_basic_reset(void) /** * @brief basic example get the version - * @param[out] *major points to a major buffer - * @param[out] *minor points to a minor buffer + * @param[out] *major pointer to a major buffer + * @param[out] *minor pointer to a minor buffer * @return status code * - 0 success * - 1 get version failed diff --git a/example/driver_scd30_basic.h b/example/driver_scd30_basic.h index 069f8dc..64fc30c 100644 --- a/example/driver_scd30_basic.h +++ b/example/driver_scd30_basic.h @@ -58,8 +58,8 @@ extern "C"{ /** * @brief basic example init - * @param[in] interface is the chip interface - * @param[in] mbar is the pressure compensation + * @param[in] interface chip interface + * @param[in] mbar pressure compensation * @return status code * - 0 success * - 1 init failed @@ -78,7 +78,7 @@ uint8_t scd30_basic_deinit(void); /** * @brief basic example read - * @param[out] *data points to a scd30_data_t structure + * @param[out] *data pointer to a scd30_data_t structure * @return status code * - 0 success * - 1 read failed @@ -97,8 +97,8 @@ uint8_t scd30_basic_reset(void); /** * @brief basic example get the version - * @param[out] *major points to a major buffer - * @param[out] *minor points to a minor buffer + * @param[out] *major pointer to a major buffer + * @param[out] *minor pointer to a minor buffer * @return status code * - 0 success * - 1 get version failed diff --git a/interface/driver_scd30_interface.h b/interface/driver_scd30_interface.h index b24f47d..c80e6ba 100644 --- a/interface/driver_scd30_interface.h +++ b/interface/driver_scd30_interface.h @@ -70,9 +70,9 @@ uint8_t scd30_interface_iic_deinit(void); /** * @brief interface iic bus read - * @param[in] addr is the iic device write address - * @param[out] *buf points to a data buffer - * @param[in] len is the length of the data buffer + * @param[in] addr iic device write address + * @param[out] *buf pointer to a data buffer + * @param[in] len length of the data buffer * @return status code * - 0 success * - 1 read failed @@ -82,9 +82,9 @@ uint8_t scd30_interface_iic_read_cmd(uint8_t addr, uint8_t *buf, uint16_t len); /** * @brief interface iic bus write - * @param[in] addr is the iic device write address - * @param[in] *buf points to a data buffer - * @param[in] len is the length of the data buffer + * @param[in] addr iic device write address + * @param[in] *buf pointer to a data buffer + * @param[in] len length of the data buffer * @return status code * - 0 success * - 1 write failed @@ -112,8 +112,8 @@ uint8_t scd30_interface_uart_deinit(void); /** * @brief interface uart read - * @param[out] *buf points to a data buffer - * @param[in] len is the length of the data buffer + * @param[out] *buf pointer to a data buffer + * @param[in] len length of the data buffer * @return status code * - 0 success * - 1 read failed @@ -123,8 +123,8 @@ uint16_t scd30_interface_uart_read(uint8_t *buf, uint16_t len); /** * @brief interface uart write - * @param[in] *buf points to a data buffer - * @param[in] len is the length of the data buffer + * @param[in] *buf pointer to a data buffer + * @param[in] len length of the data buffer * @return status code * - 0 success * - 1 write failed @@ -143,14 +143,14 @@ uint8_t scd30_interface_uart_flush(void); /** * @brief interface delay ms - * @param[in] ms + * @param[in] ms time * @note none */ void scd30_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 scd30_interface_debug_print(const char *const fmt, ...); diff --git a/interface/driver_scd30_interface_template.c b/interface/driver_scd30_interface_template.c index da90bfd..1f52bf4 100644 --- a/interface/driver_scd30_interface_template.c +++ b/interface/driver_scd30_interface_template.c @@ -62,9 +62,9 @@ uint8_t scd30_interface_iic_deinit(void) /** * @brief interface iic bus read - * @param[in] addr is the iic device write address - * @param[out] *buf points to a data buffer - * @param[in] len is the length of the data buffer + * @param[in] addr iic device write address + * @param[out] *buf pointer to a data buffer + * @param[in] len length of the data buffer * @return status code * - 0 success * - 1 read failed @@ -77,9 +77,9 @@ uint8_t scd30_interface_iic_read_cmd(uint8_t addr, uint8_t *buf, uint16_t len) /** * @brief interface iic bus write - * @param[in] addr is the iic device write address - * @param[in] *buf points to a data buffer - * @param[in] len is the length of the data buffer + * @param[in] addr iic device write address + * @param[in] *buf pointer to a data buffer + * @param[in] len length of the data buffer * @return status code * - 0 success * - 1 write failed @@ -116,8 +116,8 @@ uint8_t scd30_interface_uart_deinit(void) /** * @brief interface uart read - * @param[out] *buf points to a data buffer - * @param[in] len is the length of the data buffer + * @param[out] *buf pointer to a data buffer + * @param[in] len length of the data buffer * @return status code * - 0 success * - 1 read failed @@ -130,8 +130,8 @@ uint16_t scd30_interface_uart_read(uint8_t *buf, uint16_t len) /** * @brief interface uart write - * @param[in] *buf points to a data buffer - * @param[in] len is the length of the data buffer + * @param[in] *buf pointer to a data buffer + * @param[in] len length of the data buffer * @return status code * - 0 success * - 1 write failed @@ -156,7 +156,7 @@ uint8_t scd30_interface_uart_flush(void) /** * @brief interface delay ms - * @param[in] ms + * @param[in] ms time * @note none */ void scd30_interface_delay_ms(uint32_t ms) @@ -166,7 +166,7 @@ void scd30_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 scd30_interface_debug_print(const char *const fmt, ...) diff --git a/project/raspberrypi4b/driver/src/raspberrypi4b_driver_scd30_interface.c b/project/raspberrypi4b/driver/src/raspberrypi4b_driver_scd30_interface.c index 955a8ab..3bea483 100644 --- a/project/raspberrypi4b/driver/src/raspberrypi4b_driver_scd30_interface.c +++ b/project/raspberrypi4b/driver/src/raspberrypi4b_driver_scd30_interface.c @@ -85,9 +85,9 @@ uint8_t scd30_interface_iic_deinit(void) /** * @brief interface iic bus read - * @param[in] addr is the iic device write address - * @param[out] *buf points to a data buffer - * @param[in] len is the length of the data buffer + * @param[in] addr iic device write address + * @param[out] *buf pointer to a data buffer + * @param[in] len length of the data buffer * @return status code * - 0 success * - 1 read failed @@ -100,9 +100,9 @@ uint8_t scd30_interface_iic_read_cmd(uint8_t addr, uint8_t *buf, uint16_t len) /** * @brief interface iic bus write - * @param[in] addr is the iic device write address - * @param[in] *buf points to a data buffer - * @param[in] len is the length of the data buffer + * @param[in] addr iic device write address + * @param[in] *buf pointer to a data buffer + * @param[in] len length of the data buffer * @return status code * - 0 success * - 1 write failed @@ -139,8 +139,8 @@ uint8_t scd30_interface_uart_deinit(void) /** * @brief interface uart read - * @param[out] *buf points to a data buffer - * @param[in] len is the length of the data buffer + * @param[out] *buf pointer to a data buffer + * @param[in] len length of the data buffer * @return status code * - 0 success * - 1 read failed @@ -162,8 +162,8 @@ uint16_t scd30_interface_uart_read(uint8_t *buf, uint16_t len) /** * @brief interface uart write - * @param[in] *buf points to a data buffer - * @param[in] len is the length of the data buffer + * @param[in] *buf pointer to a data buffer + * @param[in] len length of the data buffer * @return status code * - 0 success * - 1 write failed @@ -197,7 +197,7 @@ uint8_t scd30_interface_uart_flush(void) /** * @brief interface delay ms - * @param[in] ms + * @param[in] ms time * @note none */ void scd30_interface_delay_ms(uint32_t ms) @@ -207,7 +207,7 @@ void scd30_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 scd30_interface_debug_print(const char *const fmt, ...) diff --git a/project/raspberrypi4b/src/main.c b/project/raspberrypi4b/src/main.c index 93d9bd7..9716f94 100644 --- a/project/raspberrypi4b/src/main.c +++ b/project/raspberrypi4b/src/main.c @@ -42,8 +42,8 @@ /** * @brief scd30 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 @@ -363,8 +363,8 @@ uint8_t scd30(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_scd30_interface.c b/project/stm32f407/driver/src/stm32f407_driver_scd30_interface.c index 0ce0a06..c8720bd 100644 --- a/project/stm32f407/driver/src/stm32f407_driver_scd30_interface.c +++ b/project/stm32f407/driver/src/stm32f407_driver_scd30_interface.c @@ -66,9 +66,9 @@ uint8_t scd30_interface_iic_deinit(void) /** * @brief interface iic bus read - * @param[in] addr is the iic device write address - * @param[out] *buf points to a data buffer - * @param[in] len is the length of the data buffer + * @param[in] addr iic device write address + * @param[out] *buf pointer to a data buffer + * @param[in] len length of the data buffer * @return status code * - 0 success * - 1 read failed @@ -81,9 +81,9 @@ uint8_t scd30_interface_iic_read_cmd(uint8_t addr, uint8_t *buf, uint16_t len) /** * @brief interface iic bus write - * @param[in] addr is the iic device write address - * @param[in] *buf points to a data buffer - * @param[in] len is the length of the data buffer + * @param[in] addr iic device write address + * @param[in] *buf pointer to a data buffer + * @param[in] len length of the data buffer * @return status code * - 0 success * - 1 write failed @@ -120,8 +120,8 @@ uint8_t scd30_interface_uart_deinit(void) /** * @brief interface uart read - * @param[out] *buf points to a data buffer - * @param[in] len is the length of the data buffer + * @param[out] *buf pointer to a data buffer + * @param[in] len length of the data buffer * @return status code * - 0 success * - 1 read failed @@ -134,8 +134,8 @@ uint16_t scd30_interface_uart_read(uint8_t *buf, uint16_t len) /** * @brief interface uart write - * @param[in] *buf points to a data buffer - * @param[in] len is the length of the data buffer + * @param[in] *buf pointer to a data buffer + * @param[in] len length of the data buffer * @return status code * - 0 success * - 1 write failed @@ -160,7 +160,7 @@ uint8_t scd30_interface_uart_flush(void) /** * @brief interface delay ms - * @param[in] ms + * @param[in] ms time * @note none */ void scd30_interface_delay_ms(uint32_t ms) @@ -170,7 +170,7 @@ void scd30_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 scd30_interface_debug_print(const char *const fmt, ...) diff --git a/src/driver_scd30.c b/src/driver_scd30.c index 08726e4..ca398f5 100644 --- a/src/driver_scd30.c +++ b/src/driver_scd30.c @@ -133,8 +133,8 @@ static const uint8_t gs_crc_table_lo[] = /** * @brief generate the crc16 - * @param[in] *data points to a data buffer - * @param[in] count is the data length + * @param[in] *data pointer to a data buffer + * @param[in] count data length * @return crc * @note none */ @@ -156,8 +156,8 @@ static uint16_t a_scd30_generate_crc16(uint8_t *data, uint16_t count) /** * @brief generate the crc8 - * @param[in] *data points to a data buffer - * @param[in] count is the data length + * @param[in] *data pointer to a data buffer + * @param[in] count data length * @return crc * @note none */ @@ -188,11 +188,11 @@ static uint8_t a_scd30_generate_crc8(uint8_t *data, uint8_t count) /** * @brief read bytes - * @param[in] *handle points to an scd30 handle structure - * @param[in] reg is the iic register address - * @param[out] *data points to a data buffer - * @param[in] len is the data length - * @param[in] delay_ms is the delay time in ms + * @param[in] *handle pointer to an scd30 handle structure + * @param[in] reg iic register address + * @param[out] *data pointer to a data buffer + * @param[in] len data length + * @param[in] delay_ms delay time in ms * @return status code * - 0 success * - 1 read failed @@ -219,11 +219,11 @@ static uint8_t a_scd30_iic_read(scd30_handle_t *handle, uint16_t reg, uint8_t *d /** * @brief write bytes - * @param[in] *handle points to an scd30 handle structure - * @param[in] reg is the iic register address - * @param[in] *data points to a data buffer - * @param[in] len is the data length - * @param[in] delay_ms is the delay time in ms + * @param[in] *handle pointer to an scd30 handle structure + * @param[in] reg iic register address + * @param[in] *data pointer to a data buffer + * @param[in] len data length + * @param[in] delay_ms delay time in ms * @return status code * - 0 success * - 1 write failed @@ -251,12 +251,12 @@ static uint8_t a_scd30_iic_write(scd30_handle_t *handle, uint16_t reg, uint8_t * /** * @brief write read bytes - * @param[in] *handle points to an scd30 handle structure - * @param[in] *input points to an input buffer - * @param[in] in_len is the input length - * @param[in] delay_ms is the delay time in ms - * @param[out] *output points to an output buffer - * @param[in] out_len is the output length + * @param[in] *handle pointer to an scd30 handle structure + * @param[in] *input pointer to an input buffer + * @param[in] in_len input length + * @param[in] delay_ms delay time in ms + * @param[out] *output pointer to an output buffer + * @param[in] out_len output length * @return status code * - 0 success * - 1 write read failed @@ -287,8 +287,8 @@ static uint8_t a_scd30_uart_write_read(scd30_handle_t *handle, uint8_t *input, u /** * @brief get data ready status - * @param[in] *handle points to an scd30 handle structure - * @param[out] *status points to a status buffer + * @param[in] *handle pointer to an scd30 handle structure + * @param[out] *status pointer to a status buffer * @return status code * - 0 success * - 1 get data ready status failed @@ -373,8 +373,8 @@ static uint8_t a_scd30_get_data_ready_status(scd30_handle_t *handle, uint16_t *s /** * @brief set the chip interface - * @param[in] *handle points to an scd30 handle structure - * @param[in] interface is the chip interface + * @param[in] *handle pointer to an scd30 handle structure + * @param[in] interface chip interface * @return status code * - 0 success * - 2 handle is NULL @@ -394,8 +394,8 @@ uint8_t scd30_set_interface(scd30_handle_t *handle, scd30_interface_t interface) /** * @brief get the chip interface - * @param[in] *handle points to an scd30 handle structure - * @param[out] *interface points to a chip interface buffer + * @param[in] *handle pointer to an scd30 handle structure + * @param[out] *interface pointer to a chip interface buffer * @return status code * - 0 success * - 2 handle is NULL @@ -415,8 +415,8 @@ uint8_t scd30_get_interface(scd30_handle_t *handle, scd30_interface_t *interface /** * @brief start the measurement with pressure compensation - * @param[in] *handle points to an scd30 handle structure - * @param[in] mbar is the ambient pressure compensation + * @param[in] *handle pointer to an scd30 handle structure + * @param[in] mbar ambient pressure compensation * @return status code * - 0 success * - 1 start measurement failed @@ -502,7 +502,7 @@ uint8_t scd30_start_measurement_with_pressure_compensation(scd30_handle_t *handl /** * @brief start the measurement - * @param[in] *handle points to an scd30 handle structure + * @param[in] *handle pointer to an scd30 handle structure * @return status code * - 0 success * - 1 start measurement failed @@ -581,7 +581,7 @@ uint8_t scd30_start_measurement(scd30_handle_t *handle) /** * @brief stop the measurement - * @param[in] *handle points to an scd30 handle structure + * @param[in] *handle pointer to an scd30 handle structure * @return status code * - 0 success * - 1 stop measurement failed @@ -655,8 +655,8 @@ uint8_t scd30_stop_measurement(scd30_handle_t *handle) /** * @brief set the measurement interval - * @param[in] *handle points to an scd30 handle structure - * @param[in] second is the set interval + * @param[in] *handle pointer to an scd30 handle structure + * @param[in] second set interval * @return status code * - 0 success * - 1 set measurement interval failed @@ -742,8 +742,8 @@ uint8_t scd30_set_measurement_interval(scd30_handle_t *handle, uint16_t second) /** * @brief get the measurement interval - * @param[in] *handle points to an scd30 handle structure - * @param[out] *second points to a second buffer + * @param[in] *handle pointer to an scd30 handle structure + * @param[out] *second pointer to a second buffer * @return status code * - 0 success * - 1 get measurement interval failed @@ -839,8 +839,8 @@ uint8_t scd30_get_measurement_interval(scd30_handle_t *handle, uint16_t *second) /** * @brief get data ready status - * @param[in] *handle points to an scd30 handle structure - * @param[out] *status points to a status buffer + * @param[in] *handle pointer to an scd30 handle structure + * @param[out] *status pointer to a status buffer * @return status code * - 0 success * - 1 get data ready status failed @@ -936,8 +936,8 @@ uint8_t scd30_get_data_ready_status(scd30_handle_t *handle, uint16_t *status) /** * @brief set automatic self calibration - * @param[in] *handle points to an scd30 handle structure - * @param[in] enable is a bool value + * @param[in] *handle pointer to an scd30 handle structure + * @param[in] enable bool value * @return status code * - 0 success * - 1 set automatic self calibration failed @@ -1016,8 +1016,8 @@ uint8_t scd30_set_automatic_self_calibration(scd30_handle_t *handle, scd30_bool_ /** * @brief get automatic self calibration - * @param[in] *handle points to an scd30 handle structure - * @param[out] *enable points to a bool buffer + * @param[in] *handle pointer to an scd30 handle structure + * @param[out] *enable pointer to a bool buffer * @return status code * - 0 success * - 1 get automatic self calibration failed @@ -1113,8 +1113,8 @@ uint8_t scd30_get_automatic_self_calibration(scd30_handle_t *handle, scd30_bool_ /** * @brief set forced recalibration - * @param[in] *handle points to an scd30 handle structure - * @param[in] co2_ppm is the set co2 ppm + * @param[in] *handle pointer to an scd30 handle structure + * @param[in] co2_ppm set co2 ppm * @return status code * - 0 success * - 1 set forced recalibration failed @@ -1200,8 +1200,8 @@ uint8_t scd30_set_forced_recalibration(scd30_handle_t *handle, uint16_t co2_ppm) /** * @brief get forced recalibration - * @param[in] *handle points to an scd30 handle structure - * @param[out] *co2_ppm points to a co2 ppm buffer + * @param[in] *handle pointer to an scd30 handle structure + * @param[out] *co2_ppm pointer to a co2 ppm buffer * @return status code * - 0 success * - 1 get forced recalibration failed @@ -1297,8 +1297,8 @@ uint8_t scd30_get_forced_recalibration(scd30_handle_t *handle, uint16_t *co2_ppm /** * @brief set temperature offset - * @param[in] *handle points to an scd30 handle structure - * @param[in] deg is the set degree + * @param[in] *handle pointer to an scd30 handle structure + * @param[in] deg set degree * @return status code * - 0 success * - 1 set temperature offset failed @@ -1377,8 +1377,8 @@ uint8_t scd30_set_temperature_offset(scd30_handle_t *handle, uint16_t deg) /** * @brief get temperature offset - * @param[in] *handle points to an scd30 handle structure - * @param[out] *deg points to a degree buffer + * @param[in] *handle pointer to an scd30 handle structure + * @param[out] *deg pointer to a degree buffer * @return status code * - 0 success * - 1 get temperature offset failed @@ -1474,9 +1474,9 @@ uint8_t scd30_get_temperature_offset(scd30_handle_t *handle, uint16_t *deg) /** * @brief convert the temperature offset to the register raw data - * @param[in] *handle points to an scd30 handle structure - * @param[in] deg is the degree - * @param[out] *reg points to a register raw buffer + * @param[in] *handle pointer to an scd30 handle structure + * @param[in] deg degree + * @param[out] *reg pointer to a register raw buffer * @return status code * - 0 success * - 2 handle is NULL @@ -1501,9 +1501,9 @@ uint8_t scd30_temperature_offset_convert_to_register(scd30_handle_t *handle, flo /** * @brief convert the register raw data to the temperature offset - * @param[in] *handle points to an scd30 handle structure - * @param[in] reg is the register raw data - * @param[out] *deg points to a degree buffer + * @param[in] *handle pointer to an scd30 handle structure + * @param[in] reg register raw data + * @param[out] *deg pointer to a degree buffer * @return status code * - 0 success * - 2 handle is NULL @@ -1528,8 +1528,8 @@ uint8_t scd30_temperature_offset_convert_to_data(scd30_handle_t *handle, uint16_ /** * @brief set altitude compensation - * @param[in] *handle points to an scd30 handle structure - * @param[in] m is the set meter + * @param[in] *handle pointer to an scd30 handle structure + * @param[in] m set meter * @return status code * - 0 success * - 1 set altitude compensation failed @@ -1608,8 +1608,8 @@ uint8_t scd30_set_altitude_compensation(scd30_handle_t *handle, uint16_t m) /** * @brief get altitude compensation - * @param[in] *handle points to an scd30 handle structure - * @param[out] *m points to a meter buffer + * @param[in] *handle pointer to an scd30 handle structure + * @param[out] *m pointer to a meter buffer * @return status code * - 0 success * - 1 get altitude compensation failed @@ -1705,8 +1705,8 @@ uint8_t scd30_get_altitude_compensation(scd30_handle_t *handle, uint16_t *m) /** * @brief get firmware version - * @param[in] *handle points to an scd30 handle structure - * @param[out] *version points to a version buffer + * @param[in] *handle pointer to an scd30 handle structure + * @param[out] *version pointer to a version buffer * @return status code * - 0 success * - 1 get firmware version failed @@ -1802,7 +1802,7 @@ uint8_t scd30_get_firmware_version(scd30_handle_t *handle, uint16_t *version) /** * @brief soft reset - * @param[in] *handle points to an scd30 handle structure + * @param[in] *handle pointer to an scd30 handle structure * @return status code * - 0 success * - 1 soft reset failed @@ -1877,8 +1877,8 @@ uint8_t scd30_soft_reset(scd30_handle_t *handle) /** * @brief read the result - * @param[in] *handle points to an scd30 handle structure - * @param[out] *data points to an scd30 data structure + * @param[in] *handle pointer to an scd30 handle structure + * @param[out] *data pointer to an scd30 data structure * @return status code * - 0 success * - 1 read failed @@ -2058,7 +2058,7 @@ uint8_t scd30_read(scd30_handle_t *handle, scd30_data_t *data) /** * @brief initialize the chip - * @param[in] *handle points to an scd30 handle structure + * @param[in] *handle pointer to an scd30 handle structure * @return status code * - 0 success * - 1 iic or uart initialization failed @@ -2208,7 +2208,7 @@ uint8_t scd30_init(scd30_handle_t *handle) /** * @brief close the chip - * @param[in] *handle points to an scd30 handle structure + * @param[in] *handle pointer to an scd30 handle structure * @return status code * - 0 success * - 1 iic or uart deinit failed @@ -2298,11 +2298,11 @@ uint8_t scd30_deinit(scd30_handle_t *handle) /** * @brief set and get the chip register with uart interface - * @param[in] *handle points to an scd30 handle structure - * @param[in] *input points to an input buffer - * @param[in] in_len is the input length - * @param[out] *output points to an output buffer - * @param[in] out_len is the output length + * @param[in] *handle pointer to an scd30 handle structure + * @param[in] *input pointer to an input buffer + * @param[in] in_len input length + * @param[out] *output pointer to an output buffer + * @param[in] out_len output length * @return status code * - 0 success * - 1 write read failed @@ -2333,10 +2333,10 @@ uint8_t scd30_set_get_reg_uart(scd30_handle_t *handle, uint8_t *input, uint16_t /** * @brief set the chip register with iic interface - * @param[in] *handle points to an scd30 handle structure - * @param[in] reg is the iic register address - * @param[in] *buf points to a data buffer - * @param[in] len is the data buffer length + * @param[in] *handle pointer to an scd30 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 @@ -2369,10 +2369,10 @@ uint8_t scd30_set_reg_iic(scd30_handle_t *handle, uint16_t reg, uint8_t *buf, ui /** * @brief get the chip register with iic interface - * @param[in] *handle points to an scd30 handle structure - * @param[in] reg is the iic register address - * @param[out] *buf points to a data buffer - * @param[in] len is the data buffer length + * @param[in] *handle pointer to an scd30 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 @@ -2405,7 +2405,7 @@ uint8_t scd30_get_reg_iic(scd30_handle_t *handle, uint16_t reg, uint8_t *buf, ui /** * @brief get chip information - * @param[out] *info points to an scd30 info structure + * @param[out] *info pointer to an scd30 info structure * @return status code * - 0 success * - 2 handle is NULL diff --git a/src/driver_scd30.h b/src/driver_scd30.h index fc18884..9082c7e 100644 --- a/src/driver_scd30.h +++ b/src/driver_scd30.h @@ -136,96 +136,96 @@ typedef struct scd30_info_s /** * @brief initialize scd30_handle_t structure - * @param[in] HANDLE points to an scd30 handle structure - * @param[in] STRUCTURE is scd30_handle_t + * @param[in] HANDLE pointer to an scd30 handle structure + * @param[in] STRUCTURE scd30_handle_t * @note none */ #define DRIVER_SCD30_LINK_INIT(HANDLE, STRUCTURE) memset(HANDLE, 0, sizeof(STRUCTURE)) /** * @brief link uart_init function - * @param[in] HANDLE points to an scd30 handle structure - * @param[in] FUC points to a uart_init function address + * @param[in] HANDLE pointer to an scd30 handle structure + * @param[in] FUC pointer to a uart_init function address * @note none */ #define DRIVER_SCD30_LINK_UART_INIT(HANDLE, FUC) (HANDLE)->uart_init = FUC /** * @brief link uart_deinit function - * @param[in] HANDLE points to an scd30 handle structure - * @param[in] FUC points to a uart_deinit function address + * @param[in] HANDLE pointer to an scd30 handle structure + * @param[in] FUC pointer to a uart_deinit function address * @note none */ #define DRIVER_SCD30_LINK_UART_DEINIT(HANDLE, FUC) (HANDLE)->uart_deinit = FUC /** * @brief link uart_read function - * @param[in] HANDLE points to an scd30 handle structure - * @param[in] FUC points to a uart_read function address + * @param[in] HANDLE pointer to an scd30 handle structure + * @param[in] FUC pointer to a uart_read function address * @note none */ #define DRIVER_SCD30_LINK_UART_READ(HANDLE, FUC) (HANDLE)->uart_read = FUC /** * @brief link uart_write function - * @param[in] HANDLE points to an scd30 handle structure - * @param[in] FUC points to a uart_write function address + * @param[in] HANDLE pointer to an scd30 handle structure + * @param[in] FUC pointer to a uart_write function address * @note none */ #define DRIVER_SCD30_LINK_UART_WRITE(HANDLE, FUC) (HANDLE)->uart_write = FUC /** * @brief link uart_flush function - * @param[in] HANDLE points to an scd30 handle structure - * @param[in] FUC points to a uart_flush function address + * @param[in] HANDLE pointer to an scd30 handle structure + * @param[in] FUC pointer to a uart_flush function address * @note none */ #define DRIVER_SCD30_LINK_UART_FLUSH(HANDLE, FUC) (HANDLE)->uart_flush = FUC /** * @brief link iic_init function - * @param[in] HANDLE points to an scd30 handle structure - * @param[in] FUC points to an iic_init function address + * @param[in] HANDLE pointer to an scd30 handle structure + * @param[in] FUC pointer to an iic_init function address * @note none */ #define DRIVER_SCD30_LINK_IIC_INIT(HANDLE, FUC) (HANDLE)->iic_init = FUC /** * @brief link iic_deinit function - * @param[in] HANDLE points to an scd30 handle structure - * @param[in] FUC points to an iic_deinit function address + * @param[in] HANDLE pointer to an scd30 handle structure + * @param[in] FUC pointer to an iic_deinit function address * @note none */ #define DRIVER_SCD30_LINK_IIC_DEINIT(HANDLE, FUC) (HANDLE)->iic_deinit = FUC /** * @brief link iic_write_cmd function - * @param[in] HANDLE points to an scd30 handle structure - * @param[in] FUC points to an iic_write_cmd function address + * @param[in] HANDLE pointer to an scd30 handle structure + * @param[in] FUC pointer to an iic_write_cmd function address * @note none */ #define DRIVER_SCD30_LINK_IIC_WRITE_COMMAND(HANDLE, FUC) (HANDLE)->iic_write_cmd = FUC /** * @brief link iic_read_cmd function - * @param[in] HANDLE points to an scd30 handle structure - * @param[in] FUC points to an iic_read_cmd function address + * @param[in] HANDLE pointer to an scd30 handle structure + * @param[in] FUC pointer to an iic_read_cmd function address * @note none */ #define DRIVER_SCD30_LINK_IIC_READ_COMMAND(HANDLE, FUC) (HANDLE)->iic_read_cmd = FUC /** * @brief link delay_ms function - * @param[in] HANDLE points to an scd30 handle structure - * @param[in] FUC points to a delay_ms function address + * @param[in] HANDLE pointer to an scd30 handle structure + * @param[in] FUC pointer to a delay_ms function address * @note none */ #define DRIVER_SCD30_LINK_DELAY_MS(HANDLE, FUC) (HANDLE)->delay_ms = FUC /** * @brief link debug_print function - * @param[in] HANDLE points to an scd30 handle structure - * @param[in] FUC points to a debug_print function address + * @param[in] HANDLE pointer to an scd30 handle structure + * @param[in] FUC pointer to a debug_print function address * @note none */ #define DRIVER_SCD30_LINK_DEBUG_PRINT(HANDLE, FUC) (HANDLE)->debug_print = FUC @@ -243,7 +243,7 @@ typedef struct scd30_info_s /** * @brief get chip information - * @param[out] *info points to an scd30 info structure + * @param[out] *info pointer to an scd30 info structure * @return status code * - 0 success * - 2 handle is NULL @@ -253,8 +253,8 @@ uint8_t scd30_info(scd30_info_t *info); /** * @brief set the chip interface - * @param[in] *handle points to an scd30 handle structure - * @param[in] interface is the chip interface + * @param[in] *handle pointer to an scd30 handle structure + * @param[in] interface chip interface * @return status code * - 0 success * - 2 handle is NULL @@ -264,8 +264,8 @@ uint8_t scd30_set_interface(scd30_handle_t *handle, scd30_interface_t interface) /** * @brief get the chip interface - * @param[in] *handle points to an scd30 handle structure - * @param[out] *interface points to a chip interface buffer + * @param[in] *handle pointer to an scd30 handle structure + * @param[out] *interface pointer to a chip interface buffer * @return status code * - 0 success * - 2 handle is NULL @@ -275,7 +275,7 @@ uint8_t scd30_get_interface(scd30_handle_t *handle, scd30_interface_t *interface /** * @brief initialize the chip - * @param[in] *handle points to an scd30 handle structure + * @param[in] *handle pointer to an scd30 handle structure * @return status code * - 0 success * - 1 iic or uart initialization failed @@ -288,7 +288,7 @@ uint8_t scd30_init(scd30_handle_t *handle); /** * @brief close the chip - * @param[in] *handle points to an scd30 handle structure + * @param[in] *handle pointer to an scd30 handle structure * @return status code * - 0 success * - 1 iic or uart deinit failed @@ -301,8 +301,8 @@ uint8_t scd30_deinit(scd30_handle_t *handle); /** * @brief read the result - * @param[in] *handle points to an scd30 handle structure - * @param[out] *data points to an scd30 data structure + * @param[in] *handle pointer to an scd30 handle structure + * @param[out] *data pointer to an scd30 data structure * @return status code * - 0 success * - 1 read failed @@ -315,8 +315,8 @@ uint8_t scd30_read(scd30_handle_t *handle, scd30_data_t *data); /** * @brief start the measurement with pressure compensation - * @param[in] *handle points to an scd30 handle structure - * @param[in] mbar is the ambient pressure compensation + * @param[in] *handle pointer to an scd30 handle structure + * @param[in] mbar ambient pressure compensation * @return status code * - 0 success * - 1 start measurement failed @@ -329,7 +329,7 @@ uint8_t scd30_start_measurement_with_pressure_compensation(scd30_handle_t *handl /** * @brief start the measurement - * @param[in] *handle points to an scd30 handle structure + * @param[in] *handle pointer to an scd30 handle structure * @return status code * - 0 success * - 1 start measurement failed @@ -341,7 +341,7 @@ uint8_t scd30_start_measurement(scd30_handle_t *handle); /** * @brief stop the measurement - * @param[in] *handle points to an scd30 handle structure + * @param[in] *handle pointer to an scd30 handle structure * @return status code * - 0 success * - 1 stop measurement failed @@ -353,8 +353,8 @@ uint8_t scd30_stop_measurement(scd30_handle_t *handle); /** * @brief set the measurement interval - * @param[in] *handle points to an scd30 handle structure - * @param[in] second is the set interval + * @param[in] *handle pointer to an scd30 handle structure + * @param[in] second set interval * @return status code * - 0 success * - 1 set measurement interval failed @@ -367,8 +367,8 @@ uint8_t scd30_set_measurement_interval(scd30_handle_t *handle, uint16_t second); /** * @brief get the measurement interval - * @param[in] *handle points to an scd30 handle structure - * @param[out] *second points to a second buffer + * @param[in] *handle pointer to an scd30 handle structure + * @param[out] *second pointer to a second buffer * @return status code * - 0 success * - 1 get measurement interval failed @@ -380,8 +380,8 @@ uint8_t scd30_get_measurement_interval(scd30_handle_t *handle, uint16_t *second) /** * @brief get data ready status - * @param[in] *handle points to an scd30 handle structure - * @param[out] *status points to a status buffer + * @param[in] *handle pointer to an scd30 handle structure + * @param[out] *status pointer to a status buffer * @return status code * - 0 success * - 1 get data ready status failed @@ -393,8 +393,8 @@ uint8_t scd30_get_data_ready_status(scd30_handle_t *handle, uint16_t *status); /** * @brief set automatic self calibration - * @param[in] *handle points to an scd30 handle structure - * @param[in] enable is a bool value + * @param[in] *handle pointer to an scd30 handle structure + * @param[in] enable bool value * @return status code * - 0 success * - 1 set automatic self calibration failed @@ -406,8 +406,8 @@ uint8_t scd30_set_automatic_self_calibration(scd30_handle_t *handle, scd30_bool_ /** * @brief get automatic self calibration - * @param[in] *handle points to an scd30 handle structure - * @param[out] *enable points to a bool buffer + * @param[in] *handle pointer to an scd30 handle structure + * @param[out] *enable pointer to a bool buffer * @return status code * - 0 success * - 1 get automatic self calibration failed @@ -419,8 +419,8 @@ uint8_t scd30_get_automatic_self_calibration(scd30_handle_t *handle, scd30_bool_ /** * @brief set forced recalibration - * @param[in] *handle points to an scd30 handle structure - * @param[in] co2_ppm is the set co2 ppm + * @param[in] *handle pointer to an scd30 handle structure + * @param[in] co2_ppm set co2 ppm * @return status code * - 0 success * - 1 set forced recalibration failed @@ -433,8 +433,8 @@ uint8_t scd30_set_forced_recalibration(scd30_handle_t *handle, uint16_t co2_ppm) /** * @brief get forced recalibration - * @param[in] *handle points to an scd30 handle structure - * @param[out] *co2_ppm points to a co2 ppm buffer + * @param[in] *handle pointer to an scd30 handle structure + * @param[out] *co2_ppm pointer to a co2 ppm buffer * @return status code * - 0 success * - 1 get forced recalibration failed @@ -446,8 +446,8 @@ uint8_t scd30_get_forced_recalibration(scd30_handle_t *handle, uint16_t *co2_ppm /** * @brief set temperature offset - * @param[in] *handle points to an scd30 handle structure - * @param[in] deg is the set degree + * @param[in] *handle pointer to an scd30 handle structure + * @param[in] deg set degree * @return status code * - 0 success * - 1 set temperature offset failed @@ -459,8 +459,8 @@ uint8_t scd30_set_temperature_offset(scd30_handle_t *handle, uint16_t deg); /** * @brief get temperature offset - * @param[in] *handle points to an scd30 handle structure - * @param[out] *deg points to a degree buffer + * @param[in] *handle pointer to an scd30 handle structure + * @param[out] *deg pointer to a degree buffer * @return status code * - 0 success * - 1 get temperature offset failed @@ -472,9 +472,9 @@ uint8_t scd30_get_temperature_offset(scd30_handle_t *handle, uint16_t *deg); /** * @brief convert the temperature offset to the register raw data - * @param[in] *handle points to an scd30 handle structure - * @param[in] deg is the degree - * @param[out] *reg points to a register raw buffer + * @param[in] *handle pointer to an scd30 handle structure + * @param[in] deg degree + * @param[out] *reg pointer to a register raw buffer * @return status code * - 0 success * - 2 handle is NULL @@ -485,9 +485,9 @@ uint8_t scd30_temperature_offset_convert_to_register(scd30_handle_t *handle, flo /** * @brief convert the register raw data to the temperature offset - * @param[in] *handle points to an scd30 handle structure - * @param[in] reg is the register raw data - * @param[out] *deg points to a degree buffer + * @param[in] *handle pointer to an scd30 handle structure + * @param[in] reg register raw data + * @param[out] *deg pointer to a degree buffer * @return status code * - 0 success * - 2 handle is NULL @@ -498,8 +498,8 @@ uint8_t scd30_temperature_offset_convert_to_data(scd30_handle_t *handle, uint16_ /** * @brief set altitude compensation - * @param[in] *handle points to an scd30 handle structure - * @param[in] m is the set meter + * @param[in] *handle pointer to an scd30 handle structure + * @param[in] m set meter * @return status code * - 0 success * - 1 set altitude compensation failed @@ -511,8 +511,8 @@ uint8_t scd30_set_altitude_compensation(scd30_handle_t *handle, uint16_t m); /** * @brief get altitude compensation - * @param[in] *handle points to an scd30 handle structure - * @param[out] *m points to a meter buffer + * @param[in] *handle pointer to an scd30 handle structure + * @param[out] *m pointer to a meter buffer * @return status code * - 0 success * - 1 get altitude compensation failed @@ -524,8 +524,8 @@ uint8_t scd30_get_altitude_compensation(scd30_handle_t *handle, uint16_t *m); /** * @brief get firmware version - * @param[in] *handle points to an scd30 handle structure - * @param[out] *version points to a version buffer + * @param[in] *handle pointer to an scd30 handle structure + * @param[out] *version pointer to a version buffer * @return status code * - 0 success * - 1 get firmware version failed @@ -537,7 +537,7 @@ uint8_t scd30_get_firmware_version(scd30_handle_t *handle, uint16_t *version); /** * @brief soft reset - * @param[in] *handle points to an scd30 handle structure + * @param[in] *handle pointer to an scd30 handle structure * @return status code * - 0 success * - 1 soft reset failed @@ -560,10 +560,10 @@ uint8_t scd30_soft_reset(scd30_handle_t *handle); /** * @brief set the chip register with iic interface - * @param[in] *handle points to an scd30 handle structure - * @param[in] reg is the iic register address - * @param[in] *buf points to a data buffer - * @param[in] len is the data buffer length + * @param[in] *handle pointer to an scd30 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 @@ -575,10 +575,10 @@ uint8_t scd30_set_reg_iic(scd30_handle_t *handle, uint16_t reg, uint8_t *buf, ui /** * @brief get the chip register with iic interface - * @param[in] *handle points to an scd30 handle structure - * @param[in] reg is the iic register address - * @param[out] *buf points to a data buffer - * @param[in] len is the data buffer length + * @param[in] *handle pointer to an scd30 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 @@ -590,11 +590,11 @@ uint8_t scd30_get_reg_iic(scd30_handle_t *handle, uint16_t reg, uint8_t *buf, ui /** * @brief set and get the chip register with uart interface - * @param[in] *handle points to an scd30 handle structure - * @param[in] *input points to an input buffer - * @param[in] in_len is the input length - * @param[out] *output points to an output buffer - * @param[in] out_len is the output length + * @param[in] *handle pointer to an scd30 handle structure + * @param[in] *input pointer to an input buffer + * @param[in] in_len input length + * @param[out] *output pointer to an output buffer + * @param[in] out_len output length * @return status code * - 0 success * - 1 write read failed diff --git a/test/driver_scd30_read_test.c b/test/driver_scd30_read_test.c index 7956d7c..e3c4ff5 100644 --- a/test/driver_scd30_read_test.c +++ b/test/driver_scd30_read_test.c @@ -40,8 +40,8 @@ static scd30_handle_t gs_handle; /**< scd30 handle */ /** * @brief read test - * @param[in] interface is the chip interface - * @param[in] times is the test times + * @param[in] interface chip interface + * @param[in] times test times * @return status code * - 0 success * - 1 test failed diff --git a/test/driver_scd30_read_test.h b/test/driver_scd30_read_test.h index e830034..f21a3ec 100644 --- a/test/driver_scd30_read_test.h +++ b/test/driver_scd30_read_test.h @@ -50,8 +50,8 @@ extern "C"{ /** * @brief read test - * @param[in] interface is the chip interface - * @param[in] times is the test times + * @param[in] interface chip interface + * @param[in] times test times * @return status code * - 0 success * - 1 test failed diff --git a/test/driver_scd30_register_test.c b/test/driver_scd30_register_test.c index b70c5cd..5d93aef 100644 --- a/test/driver_scd30_register_test.c +++ b/test/driver_scd30_register_test.c @@ -41,7 +41,7 @@ static scd30_handle_t gs_handle; /**< scd30 handle */ /** * @brief register test - * @param[in] interface is the chip interface + * @param[in] interface chip interface * @return status code * - 0 success * - 1 test failed diff --git a/test/driver_scd30_register_test.h b/test/driver_scd30_register_test.h index ab74b80..a4baf6c 100644 --- a/test/driver_scd30_register_test.h +++ b/test/driver_scd30_register_test.h @@ -52,7 +52,7 @@ extern "C"{ /** * @brief register test - * @param[in] interface is the chip interface + * @param[in] interface chip interface * @return status code * - 0 success * - 1 test failed