You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by ja...@apache.org on 2020/10/06 10:29:16 UTC
[mynewt-core] 02/02: docs: Fix doxygen warnings
This is an automated email from the ASF dual-hosted git repository.
janc pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-core.git
commit ef11ede09ccd39c929b34301d11acda5563da7e8
Author: Casper Meijn <ca...@meijn.net>
AuthorDate: Thu Oct 1 21:08:55 2020 +0200
docs: Fix doxygen warnings
---
encoding/json/include/json/json.h | 6 ------
fs/fcb/include/fcb/fcb.h | 4 ++++
fs/fcb2/include/fcb/fcb2.h | 4 ++++
hw/sensor/include/sensor/sensor.h | 12 ++++++------
kernel/os/include/os/os_callout.h | 2 +-
kernel/os/include/os/os_heap.h | 2 +-
kernel/os/include/os/os_mutex.h | 5 +++++
7 files changed, 21 insertions(+), 14 deletions(-)
diff --git a/encoding/json/include/json/json.h b/encoding/json/include/json/json.h
index 0ff7819..f6a4d06 100644
--- a/encoding/json/include/json/json.h
+++ b/encoding/json/include/json/json.h
@@ -248,9 +248,3 @@ int json_read_array(struct json_buffer *, const struct json_array_t *);
#endif
#endif /* _JSON_H_ */
-
-/**
- * @} OSEncoding
- * @} OSJSON
- */
-
diff --git a/fs/fcb/include/fcb/fcb.h b/fs/fcb/include/fcb/fcb.h
index 5b854d9..aa6aae0 100644
--- a/fs/fcb/include/fcb/fcb.h
+++ b/fs/fcb/include/fcb/fcb.h
@@ -151,3 +151,7 @@ int fcb_area_info(struct fcb *fcb, struct flash_area *fa, int *elemsp,
#endif
#endif /* __SYS_FLASHVAR_H_ */
+
+/**
+ * @} FCB
+ */
diff --git a/fs/fcb2/include/fcb/fcb2.h b/fs/fcb2/include/fcb/fcb2.h
index da824a4..e089fcc 100644
--- a/fs/fcb2/include/fcb/fcb2.h
+++ b/fs/fcb2/include/fcb/fcb2.h
@@ -314,3 +314,7 @@ int fcb2_area_info(struct fcb2 *fcb, int sector, int *elemsp, int *bytesp);
#endif
#endif /* __SYS_FLASHVAR_H_ */
+
+/**
+ * @} FCB2
+ */
diff --git a/hw/sensor/include/sensor/sensor.h b/hw/sensor/include/sensor/sensor.h
index 05ccb85..99c3592 100644
--- a/hw/sensor/include/sensor/sensor.h
+++ b/hw/sensor/include/sensor/sensor.h
@@ -35,8 +35,8 @@
extern "C" {
#endif
-/**
- * @defgroup SensorAPI
+/**
+ * @defgroup SensorAPI Sensor API
* @{
*/
@@ -702,7 +702,7 @@ void sensor_unlock(struct sensor *sensor);
*/
/**
- * @defgroup SensorListenerAPI
+ * @defgroup SensorListenerAPI Sensor listener API
* @{
*/
@@ -749,7 +749,7 @@ int sensor_register_err_func(struct sensor *sensor,
*/
/**
- * @defgroup SensorNotifierAPI
+ * @defgroup SensorNotifierAPI Sensor notifier API
* @{
*/
@@ -781,7 +781,7 @@ int sensor_unregister_notifier(struct sensor *sensor, struct sensor_notifier *no
*/
/**
- * @defgroup SensorAPI
+ * @defgroup SensorAPI Sensor API
* @{
*/
@@ -887,7 +887,7 @@ sensor_get_config(struct sensor *sensor, sensor_type_t type,
/**
- * @defgroup SensorManagerAPI
+ * @defgroup SensorManagerAPI Sensor manager API
@{
*/
diff --git a/kernel/os/include/os/os_callout.h b/kernel/os/include/os/os_callout.h
index 5783204..b407f3f 100644
--- a/kernel/os/include/os/os_callout.h
+++ b/kernel/os/include/os/os_callout.h
@@ -22,7 +22,7 @@
/**
* @addtogroup OSKernel
* @{
- * @defgroup OSCallouts
+ * @defgroup OSCallouts OS Callouts
* @{
*/
diff --git a/kernel/os/include/os/os_heap.h b/kernel/os/include/os/os_heap.h
index 473810a..7fca96a 100644
--- a/kernel/os/include/os/os_heap.h
+++ b/kernel/os/include/os/os_heap.h
@@ -21,7 +21,7 @@
/**
* @addtogroup OSKernel
* @{
- * @defgroup OSMalloc
+ * @defgroup OSMalloc OS malloc
* @{
*/
diff --git a/kernel/os/include/os/os_mutex.h b/kernel/os/include/os/os_mutex.h
index 9993534..7fb67fa 100644
--- a/kernel/os/include/os/os_mutex.h
+++ b/kernel/os/include/os/os_mutex.h
@@ -127,3 +127,8 @@ static inline uint16_t os_mutex_get_level(struct os_mutex *mu)
#endif
#endif /* _OS_MUTEX_H_ */
+
+/**
+ * @} OSMutex
+ * @} OSKernel
+ */