From d15beae3fc3db7c501004282a5cda9e97bc39cd9 Mon Sep 17 00:00:00 2001 From: lishifeng Date: Thu, 17 Apr 2025 22:33:03 +0800 Subject: [PATCH] fix: fix doc errors --- CHANGELOG.md | 6 ++++++ Doxyfile | 2 +- README.md | 2 +- doc/html/annotated.html | 2 +- doc/html/classes.html | 2 +- doc/html/dir_11ec664f88f5f079ad4de1adb8458c37.html | 2 +- doc/html/dir_13e138d54eb8818da29c3992edef070a.html | 2 +- doc/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html | 2 +- doc/html/dir_b31d54d5631803016a26f28213a41162.html | 2 +- doc/html/dir_cfafba98a580ce4b62f8a6fa96d7cbb0.html | 2 +- doc/html/dir_e68e8157741866f444e17edd764ebbae.html | 2 +- doc/html/driver__dht11_8c.html | 2 +- doc/html/driver__dht11_8c_source.html | 2 +- doc/html/driver__dht11_8h.html | 2 +- doc/html/driver__dht11_8h_source.html | 2 +- doc/html/driver__dht11__basic_8c.html | 2 +- doc/html/driver__dht11__basic_8c_source.html | 2 +- doc/html/driver__dht11__basic_8h.html | 2 +- doc/html/driver__dht11__basic_8h_source.html | 2 +- doc/html/driver__dht11__interface_8h.html | 2 +- doc/html/driver__dht11__interface_8h_source.html | 2 +- doc/html/driver__dht11__interface__template_8c.html | 2 +- doc/html/driver__dht11__interface__template_8c_source.html | 2 +- doc/html/driver__dht11__read__test_8c.html | 2 +- doc/html/driver__dht11__read__test_8c_source.html | 2 +- doc/html/driver__dht11__read__test_8h.html | 2 +- doc/html/driver__dht11__read__test_8h_source.html | 2 +- doc/html/files.html | 2 +- doc/html/functions.html | 2 +- doc/html/functions_vars.html | 2 +- doc/html/globals.html | 2 +- doc/html/globals_defs.html | 2 +- doc/html/globals_func.html | 2 +- doc/html/globals_type.html | 2 +- doc/html/group__dht11__base__driver.html | 2 +- doc/html/group__dht11__driver.html | 2 +- doc/html/group__dht11__example__driver.html | 2 +- doc/html/group__dht11__interface__driver.html | 2 +- doc/html/group__dht11__link__driver.html | 2 +- doc/html/group__dht11__test__driver.html | 2 +- doc/html/index.html | 6 +++--- doc/html/mainpage_8h.html | 2 +- doc/html/mainpage_8h_source.html | 2 +- doc/html/modules.html | 2 +- doc/html/structdht11__handle__s.html | 2 +- doc/html/structdht11__info__s.html | 2 +- doc/mainpage/mainpage.h | 4 ++-- 47 files changed, 55 insertions(+), 49 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6bfa9d7..b84c7fe 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## 2.0.5 (2025-04-16) + +## Bug Fixes + +- fix doc errors + ## 2.0.4 (2025-03-02) ## Bug Fixes diff --git a/Doxyfile b/Doxyfile index 114771a..2215433 100644 --- a/Doxyfile +++ b/Doxyfile @@ -44,7 +44,7 @@ PROJECT_NUMBER = 2.0.0 # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. -PROJECT_BRIEF = "DHT11 full function driver" +PROJECT_BRIEF = "DHT11 full-featured driver" # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 diff --git a/README.md b/README.md index 60314d3..d28e39f 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ DHT11 digital temperature and humidity sensor is a temperature and humidity composite sensor with calibrated digital signal output. It uses special digital module acquisition technology and temperature and humidity sensing technology to ensure that the product has high reliability and excellent long-term stability. The sensor consists of a capacitive humidity sensor and a NTC temperature sensor, and is connected with a high-performance 8-bit MCU. The sensor has the advantages of low cost, long-term stability, relative humidity and temperature measurement, excellent quality, ultra fast response, strong anti-interference ability, ultra long signal transmission distance, digital signal output and accurate calibration. It is used in HVAC, dehumidifier, agriculture, cold chain storage, test and detection equipment, consumer goods, automobile, automatic control, data recorder, weather station, household appliances, humidity regulator, medical treatment, and other related humidity detection and control. -LibDriver DHT11 is the full function driver of DHT11 launched by LibDriver.It provides the function of reading temperature and relative humidity. LibDriver is MISRA compliant. +LibDriver DHT11 is a full-featured driver of DHT11 launched by LibDriver.It provides the function of reading temperature and relative humidity. LibDriver is MISRA compliant. ### Table of Contents diff --git a/doc/html/annotated.html b/doc/html/annotated.html index 1cde4c3..00d3ffd 100644 --- a/doc/html/annotated.html +++ b/doc/html/annotated.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/classes.html b/doc/html/classes.html index dd4cae3..1c2272f 100644 --- a/doc/html/classes.html +++ b/doc/html/classes.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/dir_11ec664f88f5f079ad4de1adb8458c37.html b/doc/html/dir_11ec664f88f5f079ad4de1adb8458c37.html index 0002399..da2492d 100644 --- a/doc/html/dir_11ec664f88f5f079ad4de1adb8458c37.html +++ b/doc/html/dir_11ec664f88f5f079ad4de1adb8458c37.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/dir_13e138d54eb8818da29c3992edef070a.html b/doc/html/dir_13e138d54eb8818da29c3992edef070a.html index f4b5fa7..b6b2227 100644 --- a/doc/html/dir_13e138d54eb8818da29c3992edef070a.html +++ b/doc/html/dir_13e138d54eb8818da29c3992edef070a.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/doc/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html index 1a7aa22..5b7285d 100644 --- a/doc/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html +++ b/doc/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/dir_b31d54d5631803016a26f28213a41162.html b/doc/html/dir_b31d54d5631803016a26f28213a41162.html index e20dcfa..1d05976 100644 --- a/doc/html/dir_b31d54d5631803016a26f28213a41162.html +++ b/doc/html/dir_b31d54d5631803016a26f28213a41162.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/dir_cfafba98a580ce4b62f8a6fa96d7cbb0.html b/doc/html/dir_cfafba98a580ce4b62f8a6fa96d7cbb0.html index 8eab1f6..6b28279 100644 --- a/doc/html/dir_cfafba98a580ce4b62f8a6fa96d7cbb0.html +++ b/doc/html/dir_cfafba98a580ce4b62f8a6fa96d7cbb0.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/dir_e68e8157741866f444e17edd764ebbae.html b/doc/html/dir_e68e8157741866f444e17edd764ebbae.html index 16bba4c..7031312 100644 --- a/doc/html/dir_e68e8157741866f444e17edd764ebbae.html +++ b/doc/html/dir_e68e8157741866f444e17edd764ebbae.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/driver__dht11_8c.html b/doc/html/driver__dht11_8c.html index b55cff3..e6516e0 100644 --- a/doc/html/driver__dht11_8c.html +++ b/doc/html/driver__dht11_8c.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/driver__dht11_8c_source.html b/doc/html/driver__dht11_8c_source.html index f615c47..521f317 100644 --- a/doc/html/driver__dht11_8c_source.html +++ b/doc/html/driver__dht11_8c_source.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/driver__dht11_8h.html b/doc/html/driver__dht11_8h.html index 0fae0d4..5eb2ff9 100644 --- a/doc/html/driver__dht11_8h.html +++ b/doc/html/driver__dht11_8h.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/driver__dht11_8h_source.html b/doc/html/driver__dht11_8h_source.html index 2845062..59294f7 100644 --- a/doc/html/driver__dht11_8h_source.html +++ b/doc/html/driver__dht11_8h_source.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/driver__dht11__basic_8c.html b/doc/html/driver__dht11__basic_8c.html index b2db8e7..bc0f2db 100644 --- a/doc/html/driver__dht11__basic_8c.html +++ b/doc/html/driver__dht11__basic_8c.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/driver__dht11__basic_8c_source.html b/doc/html/driver__dht11__basic_8c_source.html index 68cb37e..7f509f1 100644 --- a/doc/html/driver__dht11__basic_8c_source.html +++ b/doc/html/driver__dht11__basic_8c_source.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/driver__dht11__basic_8h.html b/doc/html/driver__dht11__basic_8h.html index 62e05ac..1877992 100644 --- a/doc/html/driver__dht11__basic_8h.html +++ b/doc/html/driver__dht11__basic_8h.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/driver__dht11__basic_8h_source.html b/doc/html/driver__dht11__basic_8h_source.html index 72699ad..5b7cc00 100644 --- a/doc/html/driver__dht11__basic_8h_source.html +++ b/doc/html/driver__dht11__basic_8h_source.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/driver__dht11__interface_8h.html b/doc/html/driver__dht11__interface_8h.html index 8d3f83e..f447d64 100644 --- a/doc/html/driver__dht11__interface_8h.html +++ b/doc/html/driver__dht11__interface_8h.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/driver__dht11__interface_8h_source.html b/doc/html/driver__dht11__interface_8h_source.html index 1fe3905..435d4b5 100644 --- a/doc/html/driver__dht11__interface_8h_source.html +++ b/doc/html/driver__dht11__interface_8h_source.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/driver__dht11__interface__template_8c.html b/doc/html/driver__dht11__interface__template_8c.html index 29909b7..017d12a 100644 --- a/doc/html/driver__dht11__interface__template_8c.html +++ b/doc/html/driver__dht11__interface__template_8c.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/driver__dht11__interface__template_8c_source.html b/doc/html/driver__dht11__interface__template_8c_source.html index c8ea9c5..c2a5ced 100644 --- a/doc/html/driver__dht11__interface__template_8c_source.html +++ b/doc/html/driver__dht11__interface__template_8c_source.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/driver__dht11__read__test_8c.html b/doc/html/driver__dht11__read__test_8c.html index 9603a93..668266d 100644 --- a/doc/html/driver__dht11__read__test_8c.html +++ b/doc/html/driver__dht11__read__test_8c.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/driver__dht11__read__test_8c_source.html b/doc/html/driver__dht11__read__test_8c_source.html index e4ed7bb..a4f6bd2 100644 --- a/doc/html/driver__dht11__read__test_8c_source.html +++ b/doc/html/driver__dht11__read__test_8c_source.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/driver__dht11__read__test_8h.html b/doc/html/driver__dht11__read__test_8h.html index 3893202..6cb0970 100644 --- a/doc/html/driver__dht11__read__test_8h.html +++ b/doc/html/driver__dht11__read__test_8h.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/driver__dht11__read__test_8h_source.html b/doc/html/driver__dht11__read__test_8h_source.html index f9cfc3e..d57803a 100644 --- a/doc/html/driver__dht11__read__test_8h_source.html +++ b/doc/html/driver__dht11__read__test_8h_source.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/files.html b/doc/html/files.html index e5f54e9..72e4fda 100644 --- a/doc/html/files.html +++ b/doc/html/files.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/functions.html b/doc/html/functions.html index 0d5fd41..ffcc4be 100644 --- a/doc/html/functions.html +++ b/doc/html/functions.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/functions_vars.html b/doc/html/functions_vars.html index 8c9ae04..6d15188 100644 --- a/doc/html/functions_vars.html +++ b/doc/html/functions_vars.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/globals.html b/doc/html/globals.html index 289c30a..57d06b3 100644 --- a/doc/html/globals.html +++ b/doc/html/globals.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/globals_defs.html b/doc/html/globals_defs.html index 3ca3092..33777ae 100644 --- a/doc/html/globals_defs.html +++ b/doc/html/globals_defs.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/globals_func.html b/doc/html/globals_func.html index 9302138..8d0177d 100644 --- a/doc/html/globals_func.html +++ b/doc/html/globals_func.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/globals_type.html b/doc/html/globals_type.html index f3776de..f553ce9 100644 --- a/doc/html/globals_type.html +++ b/doc/html/globals_type.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/group__dht11__base__driver.html b/doc/html/group__dht11__base__driver.html index c909514..b808276 100644 --- a/doc/html/group__dht11__base__driver.html +++ b/doc/html/group__dht11__base__driver.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/group__dht11__driver.html b/doc/html/group__dht11__driver.html index 4f59260..3d18841 100644 --- a/doc/html/group__dht11__driver.html +++ b/doc/html/group__dht11__driver.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/group__dht11__example__driver.html b/doc/html/group__dht11__example__driver.html index 9410d45..989fde1 100644 --- a/doc/html/group__dht11__example__driver.html +++ b/doc/html/group__dht11__example__driver.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/group__dht11__interface__driver.html b/doc/html/group__dht11__interface__driver.html index 0177f0f..dff82eb 100644 --- a/doc/html/group__dht11__interface__driver.html +++ b/doc/html/group__dht11__interface__driver.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/group__dht11__link__driver.html b/doc/html/group__dht11__link__driver.html index afc4140..270ed13 100644 --- a/doc/html/group__dht11__link__driver.html +++ b/doc/html/group__dht11__link__driver.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/group__dht11__test__driver.html b/doc/html/group__dht11__test__driver.html index 455b529..5aa23ed 100644 --- a/doc/html/group__dht11__test__driver.html +++ b/doc/html/group__dht11__test__driver.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/index.html b/doc/html/index.html index 8f9fd86..cc5dc14 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
@@ -88,9 +88,9 @@
LibDriver DHT11
-

LibDriver DHT11 is a full function driver of DHT11 and it can run in both MCU and Linux platform.

Version
2.0.0
+

LibDriver DHT11 is a full-featured driver of DHT11 and it can run in both MCU and Linux platform.

Version
2.0.0
Author
Shifeng Li
-

history

+

History

diff --git a/doc/html/mainpage_8h.html b/doc/html/mainpage_8h.html index 648195d..7e4bf8b 100644 --- a/doc/html/mainpage_8h.html +++ b/doc/html/mainpage_8h.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/mainpage_8h_source.html b/doc/html/mainpage_8h_source.html index 6cb8a98..6321d8b 100644 --- a/doc/html/mainpage_8h_source.html +++ b/doc/html/mainpage_8h_source.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/modules.html b/doc/html/modules.html index 8f904d9..6e1fff6 100644 --- a/doc/html/modules.html +++ b/doc/html/modules.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/structdht11__handle__s.html b/doc/html/structdht11__handle__s.html index fc93575..2e41d46 100644 --- a/doc/html/structdht11__handle__s.html +++ b/doc/html/structdht11__handle__s.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/html/structdht11__info__s.html b/doc/html/structdht11__info__s.html index e0add56..6719d0c 100644 --- a/doc/html/structdht11__info__s.html +++ b/doc/html/structdht11__info__s.html @@ -29,7 +29,7 @@
LibDriver DHT11  2.0.0
-
DHT11 full function driver
+
DHT11 full-featured driver
diff --git a/doc/mainpage/mainpage.h b/doc/mainpage/mainpage.h index bee7d36..4d70943 100644 --- a/doc/mainpage/mainpage.h +++ b/doc/mainpage/mainpage.h @@ -1,10 +1,10 @@ /** * @mainpage LibDriver DHT11 - * @brief LibDriver DHT11 is a full function driver of DHT11 and it can run in both MCU and Linux platform. + * @brief LibDriver DHT11 is a full-featured driver of DHT11 and it can run in both MCU and Linux platform. * @version 2.0.0 * @author Shifeng Li * - *

history

+ *

History

*
Date Version Author Description
*
Date Version Author Description *
2021/03/12 2.0 Shifeng Li format the code