posix: Doxygen Enhancement Task #2

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

5 files changed, 48 insertions, 23 deletions

diff --git a/cpukit/posix/include/mqueue.h b/cpukit/posix/include/mqueue.h
index f41866bfe5..a35d94ccc4 100644
--- a/cpukit/posix/include/mqueue.h
+++ b/cpukit/posix/include/mqueue.h
@@ -172,11 +172,12 @@ ssize_t mq_timedreceive(
 
 #if defined(_POSIX_REALTIME_SIGNALS)
 
-/*
- *  15.2.6 Notify Process that a Message is Available on a Queue,
- *         P1003.1b-1993, p. 280
+/**
+ * @brief Notify Process that a Message is Available on a Queue
+ *
+ * 15.2.6 Notify Process that a Message is Available on a Queue,
+ *        P1003.1b-1993, p. 280
  */
-
 int mq_notify(
   mqd_t                  mqdes,
   const struct sigevent *notification
@@ -184,10 +185,11 @@ int mq_notify(
 
 #endif /* _POSIX_REALTIME_SIGNALS */
 
-/*
- *  15.2.7 Set Message Queue Attributes, P1003.1b-1993, p. 281
+/**
+ * @brief Set Message Queue Attributes
+ *
+ * 15.2.7 Set Message Queue Attributes, P1003.1b-1993, p. 281
  */
-
 int mq_setattr(
   mqd_t                 mqdes,
   const struct mq_attr *mqstat,
diff --git a/cpukit/posix/include/rtems/posix/cond.h b/cpukit/posix/include/rtems/posix/cond.h
index b089abe4a9..93b5b4cf2a 100644
--- a/cpukit/posix/include/rtems/posix/cond.h
+++ b/cpukit/posix/include/rtems/posix/cond.h
@@ -148,15 +148,14 @@ int _POSIX_Condition_variables_Signal_support(
   bool                       is_broadcast
 );
 
-/*
- *  _POSIX_Condition_variables_Wait_support
+/**
+ * @brief POSIX Condition Variables Wait Support
  *
- *  DESCRIPTION:
+ * DESCRIPTION:
  *
- *  A support routine which implements guts of the blocking, non-blocking, and
- *  timed wait version of condition variable wait routines.
+ * A support routine which implements guts of the blocking, non-blocking, and
+ * timed wait version of condition variable wait routines.
  */
-
 int _POSIX_Condition_variables_Wait_support(
   pthread_cond_t            *cond,
   pthread_mutex_t           *mutex,
diff --git a/cpukit/posix/include/rtems/posix/psignalimpl.h b/cpukit/posix/include/rtems/posix/psignalimpl.h
index b8e5e1e0ea..daeb92771d 100644
--- a/cpukit/posix/include/rtems/posix/psignalimpl.h
+++ b/cpukit/posix/include/rtems/posix/psignalimpl.h
@@ -81,6 +81,11 @@ static inline void _POSIX_signals_Add_post_switch_extension(void)
   _API_extensions_Add_post_switch( &_POSIX_signals_Post_switch );
 }
 
+/**
+ * @brief POSIX Signals Thread Unlock
+ *
+ * XXX this routine could probably be cleaned up
+ */
 bool _POSIX_signals_Unblock_thread(
   Thread_Control  *the_thread,
   int              signo,
diff --git a/cpukit/posix/include/rtems/posix/pthread.h b/cpukit/posix/include/rtems/posix/pthread.h
index 910bdc97ed..5932d45a39 100644
--- a/cpukit/posix/include/rtems/posix/pthread.h
+++ b/cpukit/posix/include/rtems/posix/pthread.h
@@ -30,6 +30,15 @@
 #ifdef __cplusplus
 extern "C" {
 #endif
+
+/**
+ * @defgroup POSIX_PTHREAD POSIX Threads Support
+ *
+ * @ingroup POSIX
+ *
+ * @brief Private Support Information for POSIX Threads
+ */
+
 /**
  *  The following sets the minimum stack size for POSIX threads.
  */
@@ -170,10 +179,10 @@ int _POSIX_Thread_Translate_sched_param(
 );
 
 /**
- *  @brief  _POSIX_Threads_Initialize_user_threads_body
+ * @brief POSIX Threads Initialize User Threads Body
  *
- *  This routine creates and starts all configured user
- *  initialization threads.
+ * This routine creates and starts all configured user
+ * initialization threads.
  */
 extern void _POSIX_Threads_Initialize_user_threads_body(void);
 
diff --git a/cpukit/posix/include/semaphore.h b/cpukit/posix/include/semaphore.h
index 17c583240c..59ed9e6703 100644
--- a/cpukit/posix/include/semaphore.h
+++ b/cpukit/posix/include/semaphore.h
@@ -74,15 +74,24 @@ sem_t *sem_open(
   ...
 );
 
-/*
- *  11.2.4 Close a Named Semaphore, P1003.1b-1993, p.224
+/**
+ * @brief Close a Named Semaphore
+ *
+ * Routine to close a semaphore that has been opened or initialized.
+ *
+ * 11.2.4 Close a Named Semaphore, P1003.1b-1993, p.224
  */
 int sem_close(
   sem_t *sem
 );
 
-/*
- *  11.2.5 Remove a Named Semaphore, P1003.1b-1993, p.225
+/**
+ * @brief Remove a Named Semaphore
+ *
+ * Unlinks a named semaphore, sem_close must also be called to remove
+ * the semaphore.
+ *
+ * 11.2.5 Remove a Named Semaphore, P1003.1b-1993, p.225
  */
 int sem_unlink(
   const char *name
@@ -124,10 +133,11 @@ int sem_post(
   sem_t  *sem
 );
 
-/*
- *  11.2.8 Get the Value of a Semaphore, P1003.1b-1993, p.229
+/**
+ * @brief Get the Value of a Semaphore
+ *
+ * 11.2.8 Get the Value of a Semaphore, P1003.1b-1993, p.229
  */
-
 int sem_getvalue(
   sem_t  *sem,
   int    *sval