libmisc: Doxygen Enhancement Task #1

4 files changed, 38 insertions, 11 deletions

diff --git a/cpukit/libmisc/cpuuse/cpuusagedata.c b/cpukit/libmisc/cpuuse/cpuusagedata.c
index cc3f13e0d7..fd3993d37d 100644
--- a/cpukit/libmisc/cpuuse/cpuusagedata.c
+++ b/cpukit/libmisc/cpuuse/cpuusagedata.c
@@ -1,6 +1,13 @@
-/*
- *  CPU Usage Reporter - Shared Data
+/**
+ * @file
+ *
+ * @brief CPU Usage Data
+ * @ingroup libmisc_cpuuse CPU Usage
  *
+ * CPU Usage Reporter - Shared Data
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2009
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/libmisc/cpuuse/cpuusagereport.c b/cpukit/libmisc/cpuuse/cpuusagereport.c
index e884d44e12..0255c19848 100644
--- a/cpukit/libmisc/cpuuse/cpuusagereport.c
+++ b/cpukit/libmisc/cpuuse/cpuusagereport.c
@@ -1,6 +1,11 @@
-/*
- *  CPU Usage Reporter
+/**
+ * @file
  *
+ * @brief CPU Usage Report
+ * @ingroup libmisc_cpuuse CPU Usage
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2010.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/libmisc/cpuuse/cpuusagereset.c b/cpukit/libmisc/cpuuse/cpuusagereset.c
index 6c5f13e702..92497d75cd 100644
--- a/cpukit/libmisc/cpuuse/cpuusagereset.c
+++ b/cpukit/libmisc/cpuuse/cpuusagereset.c
@@ -1,6 +1,11 @@
-/*
- *  CPU Usage Reporter
+/**
+ * @file
  *
+ * @brief CPU Usage Reset
+ * @ingroup libmisc_cpuuse CPU Usage
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2009
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/libmisc/cpuuse/cpuuse.h b/cpukit/libmisc/cpuuse/cpuuse.h
index b63e3fa476..7dfe5ba388 100644
--- a/cpukit/libmisc/cpuuse/cpuuse.h
+++ b/cpukit/libmisc/cpuuse/cpuuse.h
@@ -24,6 +24,12 @@
   #include <rtems/score/timestamp.h>
 #endif
 
+/**
+ *  @defgroup libmisc_cpuuse CPU Usage
+ *
+ *  @ingroup libmisc
+ */
+/**@{*/
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -43,14 +49,18 @@ void rtems_cpu_usage_report_with_plugin(
   rtems_printk_plugin_t  handler
 );
 
-/*
- *  rtems_cpu_usage_report
+/**
+ *  @brief Report CPU usage.
+ *
+ *  CPU Usage Reporter
  */
 
 void rtems_cpu_usage_report( void );
 
-/*
- *  rtems_cpu_usage_reset
+/**
+ *  @brief Reset CPU usage.
+ *
+ *  CPU Usage Reporter
  */
 
 void rtems_cpu_usage_reset( void );
@@ -58,6 +68,6 @@ void rtems_cpu_usage_reset( void );
 #ifdef __cplusplus
 }
 #endif
-
+/**@}*/
 #endif
 /* end of include file */