From a0e6c73850390b97a1f620173fa78802440d2168 Mon Sep 17 00:00:00 2001 From: Mathew Kallada Date: Thu, 13 Dec 2012 20:51:15 -0500 Subject: posix: Doxygen enhancement task #4 http://www.google-melange.com/gci/task/view/google/gci2012/7955219 --- cpukit/posix/include/rtems/posix/threadsup.h | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) (limited to 'cpukit/posix/include/rtems/posix/threadsup.h') diff --git a/cpukit/posix/include/rtems/posix/threadsup.h b/cpukit/posix/include/rtems/posix/threadsup.h index 82f82b40c3..c5a2e3db7e 100644 --- a/cpukit/posix/include/rtems/posix/threadsup.h +++ b/cpukit/posix/include/rtems/posix/threadsup.h @@ -20,6 +20,12 @@ #include #include +/** + * @defgroup POSIX_THREAD Thread API Extension + * + * @ingroup POSIX + */ +/**@{*/ #ifdef __cplusplus extern "C" { #endif @@ -75,12 +81,17 @@ typedef struct { /*! * @brief POSIX Thread Exit Shared Helper * + * 16.1.5.1 Thread Termination, p1003.1c/Draft 10, p. 150 + * * This method is a helper routine which ensures that all * POSIX thread calls which result in a thread exiting will * do so in the same manner. * * @param[in] the_thread is the thread exiting or being canceled * @param[in] value_ptr is the value to be returned by the thread + * + * NOTE: Key destructors are executed in the POSIX api delete extension. + * */ void _POSIX_Thread_Exit( Thread_Control *the_thread, @@ -90,6 +101,6 @@ void _POSIX_Thread_Exit( #ifdef __cplusplus } #endif - +/**@}*/ #endif /* end of include file */ -- cgit v1.2.3