From 6f2206fe569cb0ea6cd826cda00037b87450518e Mon Sep 17 00:00:00 2001 From: LibDriver <704839379@qq.com> Date: Sun, 1 Dec 2024 20:20:51 +0800 Subject: [PATCH] fix: fix doc errors --- CHANGELOG.md | 6 ++ doc/html/group__dht11__base__driver.html | 28 ++++---- doc/html/group__dht11__example__driver.html | 4 +- doc/html/group__dht11__interface__driver.html | 10 +-- doc/html/group__dht11__link__driver.html | 40 +++++------ doc/html/group__dht11__test__driver.html | 2 +- example/driver_dht11_basic.c | 4 +- example/driver_dht11_basic.h | 4 +- interface/driver_dht11_interface.h | 10 +-- interface/driver_dht11_interface_template.c | 10 +-- .../raspberrypi4b_driver_dht11_interface.c | 10 +-- project/raspberrypi4b/src/main.c | 8 +-- .../src/stm32f407_driver_dht11_interface.c | 10 +-- project/stm32f407/usr/src/main.c | 4 +- src/driver_dht11.c | 38 +++++------ src/driver_dht11.h | 68 +++++++++---------- test/driver_dht11_read_test.c | 2 +- test/driver_dht11_read_test.h | 2 +- 18 files changed, 133 insertions(+), 127 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 33fc030..ab59935 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__dht11__base__driver.html b/doc/html/group__dht11__base__driver.html index b2c4dee..c909514 100644 --- a/doc/html/group__dht11__base__driver.html +++ b/doc/html/group__dht11__base__driver.html @@ -190,7 +190,7 @@

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

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

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

Parameters
- - - + + +
[in]*handlepoints to a dht11 handle structure
[out]*rawpoints to a raw humidity buffer
[out]*spoints to a converted humidity buffer
[in]*handlepointer to a dht11 handle structure
[out]*rawpointer to a raw humidity buffer
[out]*spointer to a converted humidity buffer
@@ -367,9 +367,9 @@

Parameters
- - - + + +
[in]*handlepoints to a dht11 handle structure
[out]*rawpoints to a raw temperature buffer
[out]*spoints to a converted temperature buffer
[in]*handlepointer to a dht11 handle structure
[out]*rawpointer to a raw temperature buffer
[out]*spointer to a converted temperature buffer
@@ -433,11 +433,11 @@

Parameters
- - - - - + + + + +
[in]*handlepoints to a dht11 handle structure
[out]*temperature_rawpoints to a raw temperature buffer
[out]*temperature_spoints to a converted temperature buffer
[out]*humidity_rawpoints to a raw humidity buffer
[out]*humidity_spoints to a converted humidity buffer
[in]*handlepointer to a dht11 handle structure
[out]*temperature_rawpointer to a raw temperature buffer
[out]*temperature_spointer to a converted temperature buffer
[out]*humidity_rawpointer to a raw humidity buffer
[out]*humidity_spointer to a converted humidity buffer
diff --git a/doc/html/group__dht11__example__driver.html b/doc/html/group__dht11__example__driver.html index 7e24da0..9410d45 100644 --- a/doc/html/group__dht11__example__driver.html +++ b/doc/html/group__dht11__example__driver.html @@ -194,8 +194,8 @@

Parameters
- - + +
[out]*temperaturepoints to a converted temperature buffer
[out]*humiditypoints to a converted humidity buffer
[out]*temperaturepointer to a converted temperature buffer
[out]*humiditypointer to a converted humidity buffer
diff --git a/doc/html/group__dht11__interface__driver.html b/doc/html/group__dht11__interface__driver.html index 7231e74..0177f0f 100644 --- a/doc/html/group__dht11__interface__driver.html +++ b/doc/html/group__dht11__interface__driver.html @@ -156,7 +156,7 @@

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

Parameters
- +
[in]ms
[in]mstime
@@ -242,7 +242,7 @@

Parameters
- +
[in]us
[in]ustime
@@ -345,7 +345,7 @@

Parameters
- +
[out]*valuepoints to a value buffer
[out]*valuepointer to a value buffer
@@ -379,7 +379,7 @@

Parameters
- +
[in]valueis the written value
[in]valuewritten value
diff --git a/doc/html/group__dht11__link__driver.html b/doc/html/group__dht11__link__driver.html index 79189dc..afc4140 100644 --- a/doc/html/group__dht11__link__driver.html +++ b/doc/html/group__dht11__link__driver.html @@ -159,8 +159,8 @@

Parameters
- - + +
[in]HANDLEpoints to a dht11 handle structure
[in]FUCpoints to a bus_deinit function address
[in]HANDLEpointer to a dht11 handle structure
[in]FUCpointer to a bus_deinit function address
@@ -199,8 +199,8 @@

Parameters
- - + +
[in]HANDLEpoints to a dht11 handle structure
[in]FUCpoints to a bus_init function address
[in]HANDLEpointer to a dht11 handle structure
[in]FUCpointer to a bus_init function address
@@ -239,8 +239,8 @@

Parameters
- - + +
[in]HANDLEpoints to a dht11 handle structure
[in]FUCpoints to a bus_read function address
[in]HANDLEpointer to a dht11 handle structure
[in]FUCpointer to a bus_read function address
@@ -279,8 +279,8 @@

Parameters
- - + +
[in]HANDLEpoints to a dht11 handle structure
[in]FUCpoints to a bus_write function address
[in]HANDLEpointer to a dht11 handle structure
[in]FUCpointer to a bus_write function address
@@ -319,8 +319,8 @@

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

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

Parameters
- - + +
[in]HANDLEpoints to a dht11 handle structure
[in]FUCpoints to a delay_us function address
[in]HANDLEpointer to a dht11 handle structure
[in]FUCpointer to a delay_us function address
@@ -439,8 +439,8 @@

Parameters
- - + +
[in]HANDLEpoints to a dht11 handle structure
[in]FUCpoints to a disable_irq function address
[in]HANDLEpointer to a dht11 handle structure
[in]FUCpointer to a disable_irq function address
@@ -479,8 +479,8 @@

Parameters
- - + +
[in]HANDLEpoints to a dht11 handle structure
[in]FUCpoints to an enable_irq function address
[in]HANDLEpointer to a dht11 handle structure
[in]FUCpointer to an enable_irq function address
@@ -519,8 +519,8 @@

Parameters
- - + +
[in]HANDLEpoints to a dht11 handle structure
[in]STRUCTUREis dht11_handle_t
[in]HANDLEpointer to a dht11 handle structure
[in]STRUCTUREdht11_handle_t
diff --git a/doc/html/group__dht11__test__driver.html b/doc/html/group__dht11__test__driver.html index ed28ca8..455b529 100644 --- a/doc/html/group__dht11__test__driver.html +++ b/doc/html/group__dht11__test__driver.html @@ -122,7 +122,7 @@

Parameters
- +
[in]timesis the test times
[in]timestest times
diff --git a/example/driver_dht11_basic.c b/example/driver_dht11_basic.c index 8400746..79b481a 100644 --- a/example/driver_dht11_basic.c +++ b/example/driver_dht11_basic.c @@ -76,8 +76,8 @@ uint8_t dht11_basic_init(void) /** * @brief basic example read - * @param[out] *temperature points to a converted temperature buffer - * @param[out] *humidity points to a converted humidity buffer + * @param[out] *temperature pointer to a converted temperature buffer + * @param[out] *humidity pointer to a converted humidity buffer * @return status code * - 0 success * - 1 read failed diff --git a/example/driver_dht11_basic.h b/example/driver_dht11_basic.h index fab40d3..2691dc3 100644 --- a/example/driver_dht11_basic.h +++ b/example/driver_dht11_basic.h @@ -71,8 +71,8 @@ uint8_t dht11_basic_deinit(void); /** * @brief basic example read - * @param[out] *temperature points to a converted temperature buffer - * @param[out] *humidity points to a converted humidity buffer + * @param[out] *temperature pointer to a converted temperature buffer + * @param[out] *humidity pointer to a converted humidity buffer * @return status code * - 0 success * - 1 read failed diff --git a/interface/driver_dht11_interface.h b/interface/driver_dht11_interface.h index 58d6ad9..3a7d99a 100644 --- a/interface/driver_dht11_interface.h +++ b/interface/driver_dht11_interface.h @@ -71,7 +71,7 @@ uint8_t dht11_interface_deinit(void); /** * @brief interface bus read - * @param[out] *value points to a value buffer + * @param[out] *value pointer to a value buffer * @return status code * - 0 success * - 1 read failed @@ -81,7 +81,7 @@ uint8_t dht11_interface_read(uint8_t *value); /** * @brief interface bus write - * @param[in] value is the written value + * @param[in] value written value * @return status code * - 0 success * - 1 write failed @@ -91,14 +91,14 @@ uint8_t dht11_interface_write(uint8_t value); /** * @brief interface delay ms - * @param[in] ms + * @param[in] ms time * @note none */ void dht11_interface_delay_ms(uint32_t ms); /** * @brief interface delay us - * @param[in] us + * @param[in] us time * @note none */ void dht11_interface_delay_us(uint32_t us); @@ -117,7 +117,7 @@ void dht11_interface_disable_irq(void); /** * @brief interface print format data - * @param[in] fmt is the format data + * @param[in] fmt format data * @note none */ void dht11_interface_debug_print(const char *const fmt, ...); diff --git a/interface/driver_dht11_interface_template.c b/interface/driver_dht11_interface_template.c index f05567f..59f9cfc 100644 --- a/interface/driver_dht11_interface_template.c +++ b/interface/driver_dht11_interface_template.c @@ -63,7 +63,7 @@ uint8_t dht11_interface_deinit(void) /** * @brief interface bus read - * @param[out] *value points to a value buffer + * @param[out] *value pointer to a value buffer * @return status code * - 0 success * - 1 read failed @@ -76,7 +76,7 @@ uint8_t dht11_interface_read(uint8_t *value) /** * @brief interface bus write - * @param[in] value is the written value + * @param[in] value written value * @return status code * - 0 success * - 1 write failed @@ -89,7 +89,7 @@ uint8_t dht11_interface_write(uint8_t value) /** * @brief interface delay ms - * @param[in] ms + * @param[in] ms time * @note none */ void dht11_interface_delay_ms(uint32_t ms) @@ -99,7 +99,7 @@ void dht11_interface_delay_ms(uint32_t ms) /** * @brief interface delay us - * @param[in] us + * @param[in] us time * @note none */ void dht11_interface_delay_us(uint32_t us) @@ -127,7 +127,7 @@ void dht11_interface_disable_irq(void) /** * @brief interface print format data - * @param[in] fmt is the format data + * @param[in] fmt format data * @note none */ void dht11_interface_debug_print(const char *const fmt, ...) diff --git a/project/raspberrypi4b/driver/src/raspberrypi4b_driver_dht11_interface.c b/project/raspberrypi4b/driver/src/raspberrypi4b_driver_dht11_interface.c index e9dea50..0bb096b 100644 --- a/project/raspberrypi4b/driver/src/raspberrypi4b_driver_dht11_interface.c +++ b/project/raspberrypi4b/driver/src/raspberrypi4b_driver_dht11_interface.c @@ -66,7 +66,7 @@ uint8_t dht11_interface_deinit(void) /** * @brief interface bus read - * @param[out] *value points to a value buffer + * @param[out] *value pointer to a value buffer * @return status code * - 0 success * - 1 read failed @@ -79,7 +79,7 @@ uint8_t dht11_interface_read(uint8_t *value) /** * @brief interface bus write - * @param[in] value is the written value + * @param[in] value written value * @return status code * - 0 success * - 1 write failed @@ -92,7 +92,7 @@ uint8_t dht11_interface_write(uint8_t value) /** * @brief interface delay ms - * @param[in] ms + * @param[in] ms time * @note none */ void dht11_interface_delay_ms(uint32_t ms) @@ -102,7 +102,7 @@ void dht11_interface_delay_ms(uint32_t ms) /** * @brief interface delay us - * @param[in] us + * @param[in] us time * @note none */ void dht11_interface_delay_us(uint32_t us) @@ -153,7 +153,7 @@ void dht11_interface_disable_irq(void) /** * @brief interface print format data - * @param[in] fmt is the format data + * @param[in] fmt format data * @note none */ void dht11_interface_debug_print(const char *const fmt, ...) diff --git a/project/raspberrypi4b/src/main.c b/project/raspberrypi4b/src/main.c index fb302c0..67ab4bb 100644 --- a/project/raspberrypi4b/src/main.c +++ b/project/raspberrypi4b/src/main.c @@ -41,8 +41,8 @@ /** * @brief dht11 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 @@ -265,8 +265,8 @@ uint8_t dht11(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_dht11_interface.c b/project/stm32f407/driver/src/stm32f407_driver_dht11_interface.c index 3aa34d8..d17d07e 100644 --- a/project/stm32f407/driver/src/stm32f407_driver_dht11_interface.c +++ b/project/stm32f407/driver/src/stm32f407_driver_dht11_interface.c @@ -67,7 +67,7 @@ uint8_t dht11_interface_deinit(void) /** * @brief interface bus read - * @param[out] *value points to a value buffer + * @param[out] *value pointer to a value buffer * @return status code * - 0 success * - 1 read failed @@ -80,7 +80,7 @@ uint8_t dht11_interface_read(uint8_t *value) /** * @brief interface bus write - * @param[in] value is the written value + * @param[in] value written value * @return status code * - 0 success * - 1 write failed @@ -93,7 +93,7 @@ uint8_t dht11_interface_write(uint8_t value) /** * @brief interface delay ms - * @param[in] ms + * @param[in] ms time * @note none */ void dht11_interface_delay_ms(uint32_t ms) @@ -103,7 +103,7 @@ void dht11_interface_delay_ms(uint32_t ms) /** * @brief interface delay us - * @param[in] us + * @param[in] us time * @note none */ void dht11_interface_delay_us(uint32_t us) @@ -131,7 +131,7 @@ void dht11_interface_disable_irq(void) /** * @brief interface print format data - * @param[in] fmt is the format data + * @param[in] fmt format data * @note none */ void dht11_interface_debug_print(const char *const fmt, ...) diff --git a/project/stm32f407/usr/src/main.c b/project/stm32f407/usr/src/main.c index 9658f12..14d1418 100644 --- a/project/stm32f407/usr/src/main.c +++ b/project/stm32f407/usr/src/main.c @@ -51,8 +51,8 @@ volatile uint16_t g_len; /**< uart buffer length */ /** * @brief dht11 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_dht11.c b/src/driver_dht11.c index be31667..53b27ff 100644 --- a/src/driver_dht11.c +++ b/src/driver_dht11.c @@ -51,7 +51,7 @@ /** * @brief reset the chip - * @param[in] *handle points to a dht11 handle structure + * @param[in] *handle pointer to a dht11 handle structure * @return status code * - 0 success * - 1 no response @@ -148,8 +148,8 @@ static uint8_t a_dht11_reset(dht11_handle_t *handle) /** * @brief read one bit - * @param[in] *handle points to a dht11 handle structure - * @param[out] *value points to a value buffer + * @param[in] *handle pointer to a dht11 handle structure + * @param[out] *value pointer to a value buffer * @return status code * - 0 success * - 1 read failed @@ -215,8 +215,8 @@ static uint8_t a_dht11_read_bit(dht11_handle_t *handle, uint8_t *value) /** * @brief read one byte - * @param[in] *handle points to a dht11 handle structure - * @param[out] *byte points to a byte buffer + * @param[in] *handle pointer to a dht11 handle structure + * @param[out] *byte pointer to a byte buffer * @return status code * - 0 success * - 1 read failed @@ -247,9 +247,9 @@ static uint8_t a_dht11_read_byte(dht11_handle_t *handle, uint8_t *byte) /** * @brief read the humidity data - * @param[in] *handle points to a dht11 handle structure - * @param[out] *raw points to a raw humidity buffer - * @param[out] *s points to a converted humidity buffer + * @param[in] *handle pointer to a dht11 handle structure + * @param[out] *raw pointer to a raw humidity buffer + * @param[out] *s pointer to a converted humidity buffer * @return status code * - 0 success * - 1 read humidity failed @@ -309,11 +309,11 @@ uint8_t dht11_read_humidity(dht11_handle_t *handle, uint16_t *raw, uint8_t *s) /** * @brief read the temperature and humidity data - * @param[in] *handle points to a dht11 handle structure - * @param[out] *temperature_raw points to a raw temperature buffer - * @param[out] *temperature_s points to a converted temperature buffer - * @param[out] *humidity_raw points to a raw humidity buffer - * @param[out] *humidity_s points to a converted humidity buffer + * @param[in] *handle pointer to a dht11 handle structure + * @param[out] *temperature_raw pointer to a raw temperature buffer + * @param[out] *temperature_s pointer to a converted temperature buffer + * @param[out] *humidity_raw pointer to a raw humidity buffer + * @param[out] *humidity_s pointer to a converted humidity buffer * @return status code * - 0 success * - 1 read temperature humidity failed @@ -385,9 +385,9 @@ uint8_t dht11_read_temperature_humidity(dht11_handle_t *handle, uint16_t *temper /** * @brief read the temperature data - * @param[in] *handle points to a dht11 handle structure - * @param[out] *raw points to a raw temperature buffer - * @param[out] *s points to a converted temperature buffer + * @param[in] *handle pointer to a dht11 handle structure + * @param[out] *raw pointer to a raw temperature buffer + * @param[out] *s pointer to a converted temperature buffer * @return status code * - 0 success * - 1 read temperature failed @@ -455,7 +455,7 @@ uint8_t dht11_read_temperature(dht11_handle_t *handle, uint16_t *raw, float *s) /** * @brief initialize the chip - * @param[in] *handle points to a dht11 handle structure + * @param[in] *handle pointer to a dht11 handle structure * @return status code * - 0 success * - 1 bus initialization failed @@ -543,7 +543,7 @@ uint8_t dht11_init(dht11_handle_t *handle) /** * @brief close the chip - * @param[in] *handle points to a dht11 handle structure + * @param[in] *handle pointer to a dht11 handle structure * @return status code * - 0 success * - 1 bus deinit failed @@ -575,7 +575,7 @@ uint8_t dht11_deinit(dht11_handle_t *handle) /** * @brief get chip's information - * @param[out] *info points to a dht11 info structure + * @param[out] *info pointer to a dht11 info structure * @return status code * - 0 success * - 2 handle is NULL diff --git a/src/driver_dht11.h b/src/driver_dht11.h index 0c89780..68f1c87 100644 --- a/src/driver_dht11.h +++ b/src/driver_dht11.h @@ -103,80 +103,80 @@ typedef struct dht11_info_s /** * @brief initialize dht11_handle_t structure - * @param[in] HANDLE points to a dht11 handle structure - * @param[in] STRUCTURE is dht11_handle_t + * @param[in] HANDLE pointer to a dht11 handle structure + * @param[in] STRUCTURE dht11_handle_t * @note none */ #define DRIVER_DHT11_LINK_INIT(HANDLE, STRUCTURE) memset(HANDLE, 0, sizeof(STRUCTURE)) /** * @brief link bus_init function - * @param[in] HANDLE points to a dht11 handle structure - * @param[in] FUC points to a bus_init function address + * @param[in] HANDLE pointer to a dht11 handle structure + * @param[in] FUC pointer to a bus_init function address * @note none */ #define DRIVER_DHT11_LINK_BUS_INIT(HANDLE, FUC) (HANDLE)->bus_init = FUC /** * @brief link bus_deinit function - * @param[in] HANDLE points to a dht11 handle structure - * @param[in] FUC points to a bus_deinit function address + * @param[in] HANDLE pointer to a dht11 handle structure + * @param[in] FUC pointer to a bus_deinit function address * @note none */ #define DRIVER_DHT11_LINK_BUS_DEINIT(HANDLE, FUC) (HANDLE)->bus_deinit = FUC /** * @brief link bus_read function - * @param[in] HANDLE points to a dht11 handle structure - * @param[in] FUC points to a bus_read function address + * @param[in] HANDLE pointer to a dht11 handle structure + * @param[in] FUC pointer to a bus_read function address * @note none */ #define DRIVER_DHT11_LINK_BUS_READ(HANDLE, FUC) (HANDLE)->bus_read = FUC /** * @brief link bus_write function - * @param[in] HANDLE points to a dht11 handle structure - * @param[in] FUC points to a bus_write function address + * @param[in] HANDLE pointer to a dht11 handle structure + * @param[in] FUC pointer to a bus_write function address * @note none */ #define DRIVER_DHT11_LINK_BUS_WRITE(HANDLE, FUC) (HANDLE)->bus_write = FUC /** * @brief link delay_ms function - * @param[in] HANDLE points to a dht11 handle structure - * @param[in] FUC points to a delay_ms function address + * @param[in] HANDLE pointer to a dht11 handle structure + * @param[in] FUC pointer to a delay_ms function address * @note none */ #define DRIVER_DHT11_LINK_DELAY_MS(HANDLE, FUC) (HANDLE)->delay_ms = FUC /** * @brief link delay_us function - * @param[in] HANDLE points to a dht11 handle structure - * @param[in] FUC points to a delay_us function address + * @param[in] HANDLE pointer to a dht11 handle structure + * @param[in] FUC pointer to a delay_us function address * @note none */ #define DRIVER_DHT11_LINK_DELAY_US(HANDLE, FUC) (HANDLE)->delay_us = FUC /** * @brief link enable_irq function - * @param[in] HANDLE points to a dht11 handle structure - * @param[in] FUC points to an enable_irq function address + * @param[in] HANDLE pointer to a dht11 handle structure + * @param[in] FUC pointer to an enable_irq function address * @note none */ #define DRIVER_DHT11_LINK_ENABLE_IRQ(HANDLE, FUC) (HANDLE)->enable_irq = FUC /** * @brief link disable_irq function - * @param[in] HANDLE points to a dht11 handle structure - * @param[in] FUC points to a disable_irq function address + * @param[in] HANDLE pointer to a dht11 handle structure + * @param[in] FUC pointer to a disable_irq function address * @note none */ #define DRIVER_DHT11_LINK_DISABLE_IRQ(HANDLE, FUC) (HANDLE)->disable_irq = FUC /** * @brief link debug_print function - * @param[in] HANDLE points to a dht11 handle structure - * @param[in] FUC points to a debug_print function address + * @param[in] HANDLE pointer to a dht11 handle structure + * @param[in] FUC pointer to a debug_print function address * @note none */ #define DRIVER_DHT11_LINK_DEBUG_PRINT(HANDLE, FUC) (HANDLE)->debug_print = FUC @@ -194,7 +194,7 @@ typedef struct dht11_info_s /** * @brief get chip's information - * @param[out] *info points to a dht11 info structure + * @param[out] *info pointer to a dht11 info structure * @return status code * - 0 success * - 2 handle is NULL @@ -204,7 +204,7 @@ uint8_t dht11_info(dht11_info_t *info); /** * @brief initialize the chip - * @param[in] *handle points to a dht11 handle structure + * @param[in] *handle pointer to a dht11 handle structure * @return status code * - 0 success * - 1 bus initialization failed @@ -217,7 +217,7 @@ uint8_t dht11_init(dht11_handle_t *handle); /** * @brief close the chip - * @param[in] *handle points to a dht11 handle structure + * @param[in] *handle pointer to a dht11 handle structure * @return status code * - 0 success * - 1 bus deinit failed @@ -229,11 +229,11 @@ uint8_t dht11_deinit(dht11_handle_t *handle); /** * @brief read the temperature and humidity data - * @param[in] *handle points to a dht11 handle structure - * @param[out] *temperature_raw points to a raw temperature buffer - * @param[out] *temperature_s points to a converted temperature buffer - * @param[out] *humidity_raw points to a raw humidity buffer - * @param[out] *humidity_s points to a converted humidity buffer + * @param[in] *handle pointer to a dht11 handle structure + * @param[out] *temperature_raw pointer to a raw temperature buffer + * @param[out] *temperature_s pointer to a converted temperature buffer + * @param[out] *humidity_raw pointer to a raw humidity buffer + * @param[out] *humidity_s pointer to a converted humidity buffer * @return status code * - 0 success * - 1 read temperature humidity failed @@ -246,9 +246,9 @@ uint8_t dht11_read_temperature_humidity(dht11_handle_t *handle, uint16_t *temper /** * @brief read the humidity data - * @param[in] *handle points to a dht11 handle structure - * @param[out] *raw points to a raw humidity buffer - * @param[out] *s points to a converted humidity buffer + * @param[in] *handle pointer to a dht11 handle structure + * @param[out] *raw pointer to a raw humidity buffer + * @param[out] *s pointer to a converted humidity buffer * @return status code * - 0 success * - 1 read humidity failed @@ -260,9 +260,9 @@ uint8_t dht11_read_humidity(dht11_handle_t *handle, uint16_t *raw, uint8_t *s); /** * @brief read the temperature data - * @param[in] *handle points to a dht11 handle structure - * @param[out] *raw points to a raw temperature buffer - * @param[out] *s points to a converted temperature buffer + * @param[in] *handle pointer to a dht11 handle structure + * @param[out] *raw pointer to a raw temperature buffer + * @param[out] *s pointer to a converted temperature buffer * @return status code * - 0 success * - 1 read temperature failed diff --git a/test/driver_dht11_read_test.c b/test/driver_dht11_read_test.c index f3c705a..07e29a6 100644 --- a/test/driver_dht11_read_test.c +++ b/test/driver_dht11_read_test.c @@ -41,7 +41,7 @@ static dht11_handle_t gs_handle; /**< dht11 handle */ /** * @brief read test - * @param[in] times is the test times + * @param[in] times test times * @return status code * - 0 success * - 1 read failed diff --git a/test/driver_dht11_read_test.h b/test/driver_dht11_read_test.h index d7dfbd7..679f985 100644 --- a/test/driver_dht11_read_test.h +++ b/test/driver_dht11_read_test.h @@ -53,7 +53,7 @@ extern "C"{ /** * @brief read test - * @param[in] times is the test times + * @param[in] times test times * @return status code * - 0 success * - 1 read failed