posix: Doxygen Enhancement Task #1

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

4 files changed, 44 insertions, 3 deletions

diff --git a/cpukit/posix/include/rtems/posix/mutex.h b/cpukit/posix/include/rtems/posix/mutex.h
index dc133d5421..0d73022f95 100644
--- a/cpukit/posix/include/rtems/posix/mutex.h
+++ b/cpukit/posix/include/rtems/posix/mutex.h
@@ -21,6 +21,14 @@
 extern "C" {
 #endif
 
+/**
+ * @defgroup POSIX_MUTEX POSIX Mutex Support
+ *
+ * @ingroup POSIX
+ *
+ * @brief Private Support Information for POSIX Mutex
+ */
+
 #include <rtems/score/coremutex.h>
 #include <pthread.h>
 
@@ -129,13 +137,17 @@ int _POSIX_Mutex_Lock_support(
   Watchdog_Interval          timeout
 );
 
-/*
- *  _POSIX_Mutex_Translate_core_mutex_return_code
+/**
+ *  @brief POSIX Mutex Translate Core Mutex Return Code
  *
  *  DESCRIPTION:
  *
  *  A support routine which converts core mutex status codes into the
  *  appropriate POSIX status values.
+ * 
+ *  @param[in] the_mutex_status is the mutex status code to translate
+ * 
+ *  @return the translated POSIX status code
  */
 
 int _POSIX_Mutex_Translate_core_mutex_return_code(
diff --git a/cpukit/posix/include/rtems/posix/priority.h b/cpukit/posix/include/rtems/posix/priority.h
index 62ec9fbe2d..a6a3c289da 100644
--- a/cpukit/posix/include/rtems/posix/priority.h
+++ b/cpukit/posix/include/rtems/posix/priority.h
@@ -17,6 +17,14 @@
 #ifndef _RTEMS_POSIX_PRIORITY_H
 #define _RTEMS_POSIX_PRIORITY_H
 
+/**
+ * @defgroup POSIX_PRIORITY POSIX Priority Support
+ *
+ * @ingroup POSIX
+ *
+ * @brief Interface to the POSIX Priority Implementation
+ */
+
 #include <rtems/score/priority.h>
 
 /**
@@ -44,6 +52,8 @@
 #define POSIX_SCHEDULER_MINIMUM_PRIORITY (1)
 
 /**
+ *  @brief POSIX Is Priority Valid
+ * 
  *  1003.1b-1993,2.2.2.80 definition of priority, p. 19
  *
  *  "Numerically higher values represent higher priorities."
diff --git a/cpukit/posix/include/rtems/posix/psignalimpl.h b/cpukit/posix/include/rtems/posix/psignalimpl.h
index 6c46f3c49c..d9ba88427a 100644
--- a/cpukit/posix/include/rtems/posix/psignalimpl.h
+++ b/cpukit/posix/include/rtems/posix/psignalimpl.h
@@ -16,6 +16,14 @@
 #ifndef _RTEMS_POSIX_PSIGNALIMPL_H
 #define _RTEMS_POSIX_PSIGNALIMPL_H
 
+/**
+ * @defgroup POSIX_SIGNALS POSIX Signals Support
+ *
+ * @ingroup POSIX
+ *
+ * @brief Internal Information about POSIX Signals
+ */
+
 #include <rtems/posix/psignal.h>
 #include <rtems/posix/pthread.h>
 #include <rtems/posix/sigset.h>
@@ -76,6 +84,9 @@ bool _POSIX_signals_Unblock_thread(
   siginfo_t       *info
 );
 
+/**
+ *  @brief POSIX Signals Check Signal
+ */
 bool _POSIX_signals_Check_signal(
   POSIX_API_Control  *api,
   int                 signo,
diff --git a/cpukit/posix/include/rtems/posix/rwlock.h b/cpukit/posix/include/rtems/posix/rwlock.h
index c4f2d7e146..411384c2c6 100644
--- a/cpukit/posix/include/rtems/posix/rwlock.h
+++ b/cpukit/posix/include/rtems/posix/rwlock.h
@@ -27,6 +27,14 @@
 extern "C" {
 #endif
 
+/**
+ * @defgroup POSIX_RWLOCK POSIX RWLock Manager
+ *
+ * @ingroup POSIX
+ *
+ * @brief Constants and Structures Associated with the POSIX RWLock Manager
+ */
+
 #include <rtems/score/object.h>
 #include <rtems/score/corerwlock.h>
 
@@ -60,7 +68,7 @@ POSIX_EXTERN Objects_Information  _POSIX_RWLock_Information;
 void _POSIX_RWLock_Manager_initialization(void);
 
 /**
- *  @brief _POSIX_RWLock_Translate_core_RWLock_return_code (
+ *  @brief POSIX RWLock Translate Core RWLock Return Code
  *
  *  This routine translates SuperCore RWLock status codes into the
  *  corresponding POSIX ones.