diff options
| author | Mathew Kallada <matkallada@gmail.com> | 2012-12-21 11:13:06 -0600 |
|---|---|---|
| committer | Jennifer Averett <jennifer.averett@oarcorp.com> | 2012-12-21 11:13:06 -0600 |
| commit | f5f267682478f7ccca40c9751ccc0dc01e76bd86 (patch) | |
| tree | 912dbe12a0b467bfedfc8b07d0b562cc4dc9d8f5 /cpukit/libmisc/stackchk/stackchk.h | |
| parent | libblock: Use rtems_blkdev_create_partition() (diff) | |
| download | rtems-f5f267682478f7ccca40c9751ccc0dc01e76bd86.tar.bz2 | |
libmisc: Doxygen Enhancement Task #1
Diffstat (limited to '')
| -rw-r--r-- | cpukit/libmisc/stackchk/stackchk.h | 14 |
1 files changed, 10 insertions, 4 deletions
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 */ |