From a163882dae2f2935e19ec96f0d2a85d1c652be35 Mon Sep 17 00:00:00 2001
From: Ayush Awasthi <kolaveridi87@gmail.com>
Date: Fri, 4 Jan 2013 13:09:14 -0600
Subject: libmisc: Doxygen Clean Up Task #1 Conflicts occured durning this
 patch and modifications in the repo were favored over the patch.

---
 cpukit/libmisc/stackchk/stackchk.h | 42 ++++++++++++++++++++------------------
 1 file changed, 22 insertions(+), 20 deletions(-)

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

diff --git a/cpukit/libmisc/stackchk/stackchk.h b/cpukit/libmisc/stackchk/stackchk.h
index a5a9bca534..0c7e6c5bb5 100644
--- a/cpukit/libmisc/stackchk/stackchk.h
+++ b/cpukit/libmisc/stackchk/stackchk.h
@@ -1,8 +1,10 @@
 /**
  * @file rtems/stackchk.h
  *
- * @brief Information Necessary to Utilize and Install the
- * Stack Checker Mechanism
+ * @defgroup libmisc_stackchk Stack Checker Mechanism
+ *
+ * @ingroup libmisc
+ * @brief Stack Checker Information
  *
  * This include file contains information necessary to utilize
  * and install the stack checker mechanism.
@@ -36,37 +38,37 @@ extern "C" {
 #endif
 
 /**
- *  @brief Checks if current task is 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.
+ * This method is used to determine if the current stack pointer
+ * of the currently executing task is within bounds.
  *
- *  @return This method returns true if the currently executing task
- *  has blown its stack.
+ * @retval This method returns true if the currently executing task
+ * has blown its stack.
  *
  */
 bool rtems_stack_checker_is_blown( void );
 
 /**
- *  @brief Print the stack usage report using printk.
+ * @brief Print the stack usage report using printk.
  *
- *  This method prints a stack usage report for the curently executing
- *  task.
+ * This method prints a stack usage report for the curently executing
+ * task.
  *
- *  @note It uses printk to print the report.
+ * @note It uses printk to print the report.
  */
 void rtems_stack_checker_report_usage( void );
 
 /**
- *  @brief Print the stack usage report using caller's routine.
+ * @brief Print the stack usage report using caller's routine.
  *
- *  This method prints a stack usage report for the curently executing
- *  task.
+ * This method prints a stack usage report for the curently executing
+ * task.
  *
- *  @param[in] context is the context to pass to the print handler
- *  @param[in] print is the print handler
+ * @param[in] context is the context to pass to the print handler
+ * @param[in] print is the print handler
  *
- *  @note It uses the caller's routine to print the report.
+ * @note It uses the caller's routine to print the report.
  */
 void rtems_stack_checker_report_usage_with_plugin(
   void                  *context,
@@ -80,7 +82,7 @@ void rtems_stack_checker_report_usage_with_plugin(
  *************************************************************/
 
 /**
- *  @brief Stack Checker Task Create Extension
+ * @brief Stack Checker Task Create Extension
  *
  * This method is the task create extension for the stack checker.
  *
@@ -96,7 +98,7 @@ bool rtems_stack_checker_create_extension(
 );
 
 /**
- *  @brief Stack Checker Task Begin Extension
+ * @brief Stack Checker Task Begin Extension
  *
  * This method is the task begin extension for the stack checker.
  *
@@ -109,7 +111,7 @@ void rtems_stack_checker_begin_extension(
 );
 
 /**
- *  @brief Stack Checker Task Context Switch Extension
+ * @brief Stack Checker Task Context Switch Extension
  *
  * This method is the task context switch extension for the stack checker.
  *
-- 
cgit v1.2.3