RTOS/rtems
1
0
Fork 0
forked from Imagelibrary/rtems
Code Pull Requests Activity

libmisc: Doxygen Clean Up Task #1

Browse Source 
Conflicts occured durning this patch and modifications in
the repo were favored over the patch.
This commit is contained in:
Ayush Awasthi
2013-01-04 13:09:14 -06:00
committed by Jennifer Averett
parent 436f86e142
commit a163882dae
12 changed files with 354 additions and 301 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
cpukit/libmisc/stackchk/stackchk.h
View File

@@ -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.
*