summaryrefslogtreecommitdiffstats
path: root/cpukit/posix/include/rtems/posix/cancel.h
diff options
context:
space:
mode:
authorAlex Ivanov <alexivanov97@gmail.com>2013-01-07 08:53:43 -0600
committerJennifer Averett <jennifer.averett@oarcorp.com>2013-01-07 08:53:43 -0600
commitcf301c96061bf0eedc327abdc7851216c37112c5 (patch)
tree16614a66d4cff9b614f4e5c530fd85ca2ad8f3a8 /cpukit/posix/include/rtems/posix/cancel.h
parentscore: Doxygen Clean Up Task #11 (diff)
downloadrtems-cf301c96061bf0eedc327abdc7851216c37112c5.tar.bz2
posix: Doxygen Clean Up Task #1
Diffstat (limited to 'cpukit/posix/include/rtems/posix/cancel.h')
-rw-r--r--cpukit/posix/include/rtems/posix/cancel.h24
1 files changed, 13 insertions, 11 deletions
diff --git a/cpukit/posix/include/rtems/posix/cancel.h b/cpukit/posix/include/rtems/posix/cancel.h
index 06b8efd645..c1fff9c04d 100644
--- a/cpukit/posix/include/rtems/posix/cancel.h
+++ b/cpukit/posix/include/rtems/posix/cancel.h
@@ -1,5 +1,7 @@
/**
- * @file rtems/posix/cancel.h
+ * @file
+ *
+ * @brief POSIX Thread Cancelation Support
*
* This file contains the prototypes and data types used to implement
* POSIX thread cancelation.
@@ -20,7 +22,7 @@
#include <rtems/posix/threadsup.h>
/**
- * This structure is used to manage the cancelation handlers.
+ * This structure is used to manage the cancelation handlers.
*/
typedef struct {
/** This field is the Chain Node so we can put these on lists. */
@@ -32,25 +34,25 @@ typedef struct {
} POSIX_Cancel_Handler_control;
/**
- * @brief _POSIX_Threads_cancel_run
+ * @brief POSIX run thread cancelation.
*
- * This support routine runs through the chain of cancel handlers that
- * have been registered and executes them.
+ * This support routine runs through the chain of cancel handlers that
+ * have been registered and executes them.
*
- * @param[in] the_thread is the thread whose cancelation handlers
- * should be run
+ * @param[in] the_thread is a pointer to the thread whose cancelation handlers
+ * should be run
*/
void _POSIX_Threads_cancel_run(
Thread_Control *the_thread
);
/**
- * @brief _POSIX_Thread_Evaluate_cancellation_and_enable_dispatch
+ * @brief POSIX evaluate thread cancelation and enable dispatch.
*
- * This routine separates a piece of code that existed as part of
- * another routine, but had to be separated to improve coverage.
+ * This routine separates a piece of code that existed as part of
+ * another routine, but had to be separated to improve coverage.
*
- * @param[in] the_thread is the thread to evaluate canceling
+ * @param[in] the_thread is a pointer to the thread to evaluate canceling
*/
void _POSIX_Thread_Evaluate_cancellation_and_enable_dispatch (
Thread_Control *the_thread