[PATCH] cpuuse: Add implementation Doxygen group
Sebastian Huber
sebastian.huber at embedded-brains.de
Wed Mar 15 09:07:38 UTC 2023
---
cpukit/libmisc/cpuuse/cpuusagedata.c | 2 +-
cpukit/libmisc/cpuuse/cpuusagereport.c | 2 +-
cpukit/libmisc/cpuuse/cpuusagereset.c | 2 +-
cpukit/libmisc/cpuuse/cpuusagetop.c | 2 +-
cpukit/libmisc/cpuuse/cpuuseimpl.h | 26 ++++++++++++++++++++++++++
5 files changed, 30 insertions(+), 4 deletions(-)
diff --git a/cpukit/libmisc/cpuuse/cpuusagedata.c b/cpukit/libmisc/cpuuse/cpuusagedata.c
index b28ba5c3ad..fa39a6d754 100644
--- a/cpukit/libmisc/cpuuse/cpuusagedata.c
+++ b/cpukit/libmisc/cpuuse/cpuusagedata.c
@@ -3,7 +3,7 @@
/**
* @file
*
- * @ingroup RTEMSAPICPUUsageReporting
+ * @ingroup RTEMSImplCPUUsageReporting
*
* @brief This source file contains the definition of
* ::CPU_usage_Uptime_at_last_reset.
diff --git a/cpukit/libmisc/cpuuse/cpuusagereport.c b/cpukit/libmisc/cpuuse/cpuusagereport.c
index 69e9c78518..bdeee375e3 100644
--- a/cpukit/libmisc/cpuuse/cpuusagereport.c
+++ b/cpukit/libmisc/cpuuse/cpuusagereport.c
@@ -3,7 +3,7 @@
/**
* @file
*
- * @ingroup RTEMSAPICPUUsageReporting
+ * @ingroup RTEMSImplCPUUsageReporting
*
* @brief This source file contains the definition of
* rtems_cpu_usage_report() and rtems_cpu_usage_report_with_plugin().
diff --git a/cpukit/libmisc/cpuuse/cpuusagereset.c b/cpukit/libmisc/cpuuse/cpuusagereset.c
index e8b76cd189..e56ab3cded 100644
--- a/cpukit/libmisc/cpuuse/cpuusagereset.c
+++ b/cpukit/libmisc/cpuuse/cpuusagereset.c
@@ -3,7 +3,7 @@
/**
* @file
*
- * @ingroup RTEMSAPICPUUsageReporting
+ * @ingroup RTEMSImplCPUUsageReporting
*
* @brief This source file contains the definition of
* rtems_cpu_usage_reset().
diff --git a/cpukit/libmisc/cpuuse/cpuusagetop.c b/cpukit/libmisc/cpuuse/cpuusagetop.c
index 1ee3a5571c..eed89ad211 100644
--- a/cpukit/libmisc/cpuuse/cpuusagetop.c
+++ b/cpukit/libmisc/cpuuse/cpuusagetop.c
@@ -3,7 +3,7 @@
/**
* @file
*
- * @ingroup RTEMSAPICPUUsageReporting
+ * @ingroup RTEMSImplCPUUsageReporting
*
* @brief This source file contains the definition of
* rtems_cpu_usage_top() and rtems_cpu_usage_top_with_plugin().
diff --git a/cpukit/libmisc/cpuuse/cpuuseimpl.h b/cpukit/libmisc/cpuuse/cpuuseimpl.h
index 1162d1e892..8c6c407b4b 100644
--- a/cpukit/libmisc/cpuuse/cpuuseimpl.h
+++ b/cpukit/libmisc/cpuuse/cpuuseimpl.h
@@ -1,5 +1,14 @@
/* SPDX-License-Identifier: BSD-2-Clause */
+/**
+ * @file
+ *
+ * @ingroup RTEMSImplCPUUsageReporting
+ *
+ * @brief This header file provides interfaces of the
+ * @ref RTEMSImplCPUUsageReporting implementation.
+ */
+
/*
* COPYRIGHT (c) 1989-2011.
* On-Line Applications Research Corporation (OAR).
@@ -35,8 +44,25 @@
extern "C" {
#endif
+/**
+ * @defgroup RTEMSImplCPUUsageReporting CPU Usage Reporting
+ *
+ * @ingroup RTEMSImpl
+ *
+ * @brief This group contains the implementation of
+ * @ref RTEMSAPICPUUsageReporting.
+ *
+ * @{
+ */
+
+/**
+ * @brief This object provides the uptime timestamp at the last CPU usage
+ * reset.
+ */
extern Timestamp_Control CPU_usage_Uptime_at_last_reset;
+/** @} */
+
#ifdef __cplusplus
}
#endif
--
2.35.3
More information about the devel
mailing list