From f5f267682478f7ccca40c9751ccc0dc01e76bd86 Mon Sep 17 00:00:00 2001
From: Mathew Kallada <matkallada@gmail.com>
Date: Fri, 21 Dec 2012 11:13:06 -0600
Subject: libmisc: Doxygen Enhancement Task #1

---
 cpukit/libmisc/stackchk/stackchk.h | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

(limited to 'cpukit/libmisc/stackchk/stackchk.h')

diff --git a/cpukit/libmisc/stackchk/stackchk.h b/cpukit/libmisc/stackchk/stackchk.h
index efa029391b..e4931715c9 100644
--- a/cpukit/libmisc/stackchk/stackchk.h
+++ b/cpukit/libmisc/stackchk/stackchk.h
@@ -21,12 +21,18 @@
 #include <rtems/score/percpu.h> /* Thread_Control */
 #include <rtems/bspIo.h>
 
+/**
+ *  @defgroup libmisc_stackchk Stack Checker Mechanism
+ *
+ *  @ingroup libmisc
+ */
+/**@{*/
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 /**
- *  @brief Has Current Task Blown Its Stack
+ *  @brief Checks if current task is blown its stack.
  *
  *  This method is used to determine if the current stack pointer
  *  of the currently executing task is within bounds.
@@ -38,7 +44,7 @@ extern "C" {
 bool rtems_stack_checker_is_blown( void );
 
 /**
- *  @brief Print Stack Usage Report
+ *  @brief Print the stack usage report using printk.
  *
  *  This method prints a stack usage report for the curently executing
  *  task.
@@ -48,7 +54,7 @@ bool rtems_stack_checker_is_blown( void );
 void rtems_stack_checker_report_usage( void );
 
 /**
- *  @brief Print Stack Usage Report
+ *  @brief Print the stack usage report using caller's routine.
  *
  *  This method prints a stack usage report for the curently executing
  *  task.
@@ -135,6 +141,6 @@ void rtems_stack_checker_switch_extension(
 #ifdef __cplusplus
 }
 #endif
-
+/**@}*/
 #endif
 /* end of include file */
-- 
cgit v1.2.3