posix: Doxygen enhancement task #4

http://www.google-melange.com/gci/task/view/google/gci2012/7955219

6 files changed, 56 insertions, 6 deletions

diff --git a/cpukit/posix/include/rtems/posix/cond.h b/cpukit/posix/include/rtems/posix/cond.h
index 4b22dff942..b089abe4a9 100644
--- a/cpukit/posix/include/rtems/posix/cond.h
+++ b/cpukit/posix/include/rtems/posix/cond.h
@@ -17,6 +17,12 @@
 #ifndef _RTEMS_POSIX_COND_H
 #define _RTEMS_POSIX_COND_H
 
+/**
+ *  @defgroup POSIX_COND_VARS Condition Variables
+ *
+ *  @ingroup POSIX
+ */
+/**@{*/
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -56,6 +62,8 @@ POSIX_EXTERN Objects_Information  _POSIX_Condition_variables_Information;
 extern const pthread_condattr_t _POSIX_Condition_variables_Default_attributes;
 
 /*
+ * @brief Initialization Necessary for this Manager
+ *
  *  _POSIX_Condition_variables_Manager_initialization
  *
  *  DESCRIPTION:
@@ -125,6 +133,8 @@ RTEMS_INLINE_ROUTINE bool _POSIX_Condition_variables_Is_null (
 );
 
 /*
+ * @brief Implements wake up version of the "signal" operation
+ *
  *  _POSIX_Condition_variables_Signal_support
  *
  *  DESCRIPTION:
@@ -174,6 +184,6 @@ POSIX_Condition_variables_Control *_POSIX_Condition_variables_Get (
 #ifdef __cplusplus
 }
 #endif
-
+/**@}*/
 #endif
 /*  end of include file */
diff --git a/cpukit/posix/include/rtems/posix/key.h b/cpukit/posix/include/rtems/posix/key.h
index e056d8d89a..ce4f093b13 100644
--- a/cpukit/posix/include/rtems/posix/key.h
+++ b/cpukit/posix/include/rtems/posix/key.h
@@ -19,6 +19,12 @@
 
 #include <rtems/score/object.h>
 
+/**
+ *  @defgroup POSIX_KEY Key
+ *
+ *  @ingroup POSIX
+ */
+/**@{*/
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -45,7 +51,7 @@ typedef struct {
 POSIX_EXTERN Objects_Information  _POSIX_Keys_Information;
 
 /**
- *  @brief _POSIX_Keys_Manager_initialization
+ *  @brief POSIX Keys Manager Initialization
  *
  *  This routine performs the initialization necessary for this manager.
  */
@@ -95,6 +101,6 @@ RTEMS_INLINE_ROUTINE void _POSIX_Keys_Free (
 #ifdef __cplusplus
 }
 #endif
-
+/**@}*/
 #endif
 /*  end of include file */
diff --git a/cpukit/posix/include/rtems/posix/ptimer.h b/cpukit/posix/include/rtems/posix/ptimer.h
index 046a7af477..a7c083711a 100644
--- a/cpukit/posix/include/rtems/posix/ptimer.h
+++ b/cpukit/posix/include/rtems/posix/ptimer.h
@@ -20,6 +20,12 @@
 #ifndef _RTEMS_POSIX_PTIMER_H
 #define _RTEMS_POSIX_PTIMER_H
 
+/**
+ *  @defgroup POSIX_PRIV_TIMERS Timers
+ *
+ *  @ingroup POSIX
+ */
+/**@{*/
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -37,6 +43,8 @@ extern "C" {
 void _POSIX_Timer_Manager_initialization(void);
 
 /*
+ *  @brief Create a Per-Process Timer
+ *
  *  14.2.2 Create a Per-Process Timer, P1003.1b-1993, p. 264
  *
  *  timer_create
@@ -90,5 +98,5 @@ int timer_gettime(
 int timer_getoverrun(
   timer_t   timerid
 );
-
+/**@}*/
 #endif
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 <rtems/score/coresem.h>
 #include <rtems/score/tqdata.h>
 
+/**
+ *  @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 */
diff --git a/cpukit/posix/include/rtems/posix/time.h b/cpukit/posix/include/rtems/posix/time.h
index 104997fcf8..d0dc4a27fe 100644
--- a/cpukit/posix/include/rtems/posix/time.h
+++ b/cpukit/posix/include/rtems/posix/time.h
@@ -19,6 +19,12 @@
 
 #include <rtems/score/timespec.h>
 #include <rtems/score/watchdog.h>
+/**
+ *  @defgroup POSIX_TIMETYPES Time Types
+ *
+ *  @ingroup POSIX
+ */
+/**@{*/
 
 /**
  *  @brief Absolute Timeout Conversion Results
@@ -59,3 +65,4 @@ POSIX_Absolute_timeout_conversion_results_t _POSIX_Absolute_timeout_to_ticks(
 );
 
 #endif
+/**@}*/
diff --git a/cpukit/posix/include/rtems/posix/timer.h b/cpukit/posix/include/rtems/posix/timer.h
index d193a88b87..1298178e95 100644
--- a/cpukit/posix/include/rtems/posix/timer.h
+++ b/cpukit/posix/include/rtems/posix/timer.h
@@ -21,6 +21,12 @@
 #include <rtems/score/object.h>
 #include <rtems/score/watchdog.h> /* Watchdog_Control */
 
+/**
+ *  @defgroup POSIX_INTERNAL_TIMERS Timers
+ *
+ *  @ingroup POSIX
+ */
+/**@{*/
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -75,6 +81,8 @@ typedef struct {
 void _POSIX_Timer_Manager_initialization(void);
 
 /*
+ *  @brief Operation that is run when a timer expires
+ *
  *  Timer TSR
  */
 void _POSIX_Timer_TSR(Objects_Id timer, void *data);
@@ -103,6 +111,6 @@ POSIX_EXTERN Objects_Information  _POSIX_Timer_Information;
 #ifdef __cplusplus
 }
 #endif
-
+/**@}*/
 #endif
 /* end of include file */