summaryrefslogtreecommitdiffstats
path: root/cpukit/libmisc/cpuuse/cpuuse.h
diff options
context:
space:
mode:
authorMathew Kallada <matkallada@gmail.com>2012-12-21 11:13:06 -0600
committerJennifer Averett <jennifer.averett@oarcorp.com>2012-12-21 11:13:06 -0600
commitf5f267682478f7ccca40c9751ccc0dc01e76bd86 (patch)
tree912dbe12a0b467bfedfc8b07d0b562cc4dc9d8f5 /cpukit/libmisc/cpuuse/cpuuse.h
parentlibblock: Use rtems_blkdev_create_partition() (diff)
downloadrtems-f5f267682478f7ccca40c9751ccc0dc01e76bd86.tar.bz2
libmisc: Doxygen Enhancement Task #1
Diffstat (limited to '')
-rw-r--r--cpukit/libmisc/cpuuse/cpuuse.h20
1 files changed, 15 insertions, 5 deletions
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 */