posix: Doxygen Clean Up Task #2

10 files changed, 125 insertions, 78 deletions

diff --git a/cpukit/posix/inline/rtems/posix/barrier.inl b/cpukit/posix/inline/rtems/posix/barrier.inl
index f78e432b07..6e439d8c66 100644
--- a/cpukit/posix/inline/rtems/posix/barrier.inl
+++ b/cpukit/posix/inline/rtems/posix/barrier.inl
@@ -1,8 +1,10 @@
 /**
- * @file rtems/posix/barrier.inl
+ * @file
+ * 
+ * @brief Inlined Routines from the POSIX Barrier Manager
  *
- *  This file contains the static inlin implementation of the inlined
- *  routines from the POSIX Barrier Manager.
+ * This file contains the static inlin implementation of the inlined
+ * routines from the POSIX Barrier Manager.
  */
 
 /*
@@ -24,10 +26,10 @@
 #include <pthread.h>
 
 /**
- *  @brief _POSIX_Barrier_Allocate
+ * @brief Allocate a barrier control block.
  *
- *  This function allocates a barrier control block from
- *  the inactive chain of free barrier control blocks.
+ * This function allocates a barrier control block from
+ * the inactive chain of free barrier control blocks.
  */
 RTEMS_INLINE_ROUTINE POSIX_Barrier_Control *_POSIX_Barrier_Allocate( void )
 {
@@ -36,10 +38,10 @@ RTEMS_INLINE_ROUTINE POSIX_Barrier_Control *_POSIX_Barrier_Allocate( void )
 }
 
 /**
- *  @brief _POSIX_Barrier_Free
+ * @brief Free a barrier control block.
  *
- *  This routine frees a barrier control block to the
- *  inactive chain of free barrier control blocks.
+ * This routine frees a barrier control block to the
+ * inactive chain of free barrier control blocks.
  */
 RTEMS_INLINE_ROUTINE void _POSIX_Barrier_Free (
   POSIX_Barrier_Control *the_barrier
@@ -49,15 +51,15 @@ RTEMS_INLINE_ROUTINE void _POSIX_Barrier_Free (
 }
 
 /**
- *  @brief _POSIX_Barrier_Get
+ * @brief Get a barrier control block.
  *
- *  This function maps barrier IDs to barrier control blocks.
- *  If ID corresponds to a local barrier, then it returns
- *  the_barrier control pointer which maps to ID and location
- *  is set to OBJECTS_LOCAL.  if the barrier ID is global and
- *  resides on a remote node, then location is set to OBJECTS_REMOTE,
- *  and the_barrier is undefined.  Otherwise, location is set
- *  to OBJECTS_ERROR and the_barrier is undefined.
+ * This function maps barrier IDs to barrier control blocks.
+ * If ID corresponds to a local barrier, then it returns
+ * the_barrier control pointer which maps to ID and location
+ * is set to OBJECTS_LOCAL.  if the barrier ID is global and
+ * resides on a remote node, then location is set to OBJECTS_REMOTE,
+ * and the_barrier is undefined.  Otherwise, location is set
+ * to OBJECTS_ERROR and the_barrier is undefined.
  */
 RTEMS_INLINE_ROUTINE POSIX_Barrier_Control *_POSIX_Barrier_Get (
   pthread_barrier_t *barrier,
@@ -72,9 +74,16 @@ RTEMS_INLINE_ROUTINE POSIX_Barrier_Control *_POSIX_Barrier_Get (
 }
 
 /**
- *  @brief _POSIX_Barrier_Is_null
+ * @brief Check if a barrier control block is NULL.
  *
- *  This function returns TRUE if the_barrier is NULL and FALSE otherwise.
+ * This function returns @c TRUE if the_barrier is @c NULL and @c FALSE
+ * otherwise.
+ * 
+ * @param[in] the_barrier is the pointer to the barrier control block
+ * to be checked.
+ * 
+ * @retval TRUE The barrier control block is @c NULL.
+ * @retval FALSE The barrier control block is not @c NULL.
  */
 RTEMS_INLINE_ROUTINE bool _POSIX_Barrier_Is_null (
   POSIX_Barrier_Control *the_barrier
diff --git a/cpukit/posix/inline/rtems/posix/key.inl b/cpukit/posix/inline/rtems/posix/key.inl
index 4c2466be57..ce5601b06d 100644
--- a/cpukit/posix/inline/rtems/posix/key.inl
+++ b/cpukit/posix/inline/rtems/posix/key.inl
@@ -1,8 +1,10 @@
 /**
- *  @file rtems/posix/key.inl
+ * @file
+ * 
+ * @brief Private Inlined Routines for POSIX Key's
  *
- *  This include file contains the static inline implementation of the private 
- *  inlined routines for POSIX key's.
+ * This include file contains the static inline implementation of the private 
+ * inlined routines for POSIX key's.
  */
 
 /*
@@ -22,10 +24,10 @@
 #define _RTEMS_POSIX_KEY_INL
  
 /**
- *  @brief _POSIX_Keys_Allocate
+ * @brief Allocate a keys control block.
  *
- *  This function allocates a keys control block from
- *  the inactive chain of free keys control blocks.
+ * This function allocates a keys control block from
+ * the inactive chain of free keys control blocks.
  */
  
 RTEMS_INLINE_ROUTINE POSIX_Keys_Control *_POSIX_Keys_Allocate( void )
@@ -34,10 +36,10 @@ RTEMS_INLINE_ROUTINE POSIX_Keys_Control *_POSIX_Keys_Allocate( void )
 }
  
 /**
- *  @brief _POSIX_Keys_Free
+ * @brief Free a keys control block.
  *
- *  This routine frees a keys control block to the
- *  inactive chain of free keys control blocks.
+ * This routine frees a keys control block to the
+ * inactive chain of free keys control blocks.
  */
 RTEMS_INLINE_ROUTINE void _POSIX_Keys_Free (
   POSIX_Keys_Control *the_key
@@ -47,15 +49,15 @@ RTEMS_INLINE_ROUTINE void _POSIX_Keys_Free (
 }
  
 /**
- *  @brief _POSIX_Keys_Get
+ * @brief Get a keys control block.
  *
- *  This function maps key IDs to key control blocks.
- *  If ID corresponds to a local keys, then it returns
- *  the_key control pointer which maps to ID and location
- *  is set to OBJECTS_LOCAL.  if the keys ID is global and
- *  resides on a remote node, then location is set to OBJECTS_REMOTE,
- *  and the_key is undefined.  Otherwise, location is set
- *  to OBJECTS_ERROR and the_key is undefined.
+ * This function maps key IDs to key control blocks.
+ * If ID corresponds to a local keys, then it returns
+ * the_key control pointer which maps to ID and location
+ * is set to OBJECTS_LOCAL.  if the keys ID is global and
+ * resides on a remote node, then location is set to OBJECTS_REMOTE,
+ * and the_key is undefined.  Otherwise, location is set
+ * to OBJECTS_ERROR and the_key is undefined.
  */
  
 RTEMS_INLINE_ROUTINE POSIX_Keys_Control *_POSIX_Keys_Get (
@@ -68,9 +70,15 @@ RTEMS_INLINE_ROUTINE POSIX_Keys_Control *_POSIX_Keys_Get (
 }
  
 /**
- *  @brief _POSIX_Keys_Is_null
+ * @brief Check if a keys control block is NULL.
  *
- *  This function returns TRUE if the_key is NULL and FALSE otherwise.
+ * This function returns @c TRUE if the_key is @c NULL and @c FALSE
+ * otherwise.
+ * 
+ * @param[in] the_key is the pointer to the key control block to be checked.
+ * 
+ * @retval TRUE The key control block is @c NULL.
+ * @retval FALSE The key control block is not @c NULL.
  */
 RTEMS_INLINE_ROUTINE bool _POSIX_Keys_Is_null (
   POSIX_Keys_Control *the_key
diff --git a/cpukit/posix/inline/rtems/posix/mqueue.inl b/cpukit/posix/inline/rtems/posix/mqueue.inl
index ed345125af..e27efcacfe 100644
--- a/cpukit/posix/inline/rtems/posix/mqueue.inl
+++ b/cpukit/posix/inline/rtems/posix/mqueue.inl
@@ -1,6 +1,8 @@
 /**
- * @file rtems/posix/mqueue.inl
+ * @file
  *
+ * @brief Private Inlined Routines for POSIX Message Queue
+ * 
  * This include file contains the static inline implementation of the private 
  * inlined routines for POSIX Message Queue.
  */
diff --git a/cpukit/posix/inline/rtems/posix/mutex.inl b/cpukit/posix/inline/rtems/posix/mutex.inl
index 033a4ccfcf..e5c68016bd 100644
--- a/cpukit/posix/inline/rtems/posix/mutex.inl
+++ b/cpukit/posix/inline/rtems/posix/mutex.inl
@@ -1,6 +1,8 @@
 /**
- * @file rtems/posix/mutex.inl
+ * @file
  *
+ * @brief Private Inlined Routines for POSIX Mutex's.
+ * 
  * This include file contains the static inline implementation of the private 
  * inlined routines for POSIX mutex's.
  */
diff --git a/cpukit/posix/inline/rtems/posix/priority.inl b/cpukit/posix/inline/rtems/posix/priority.inl
index b1eb9b8da5..cae2242c78 100644
--- a/cpukit/posix/inline/rtems/posix/priority.inl
+++ b/cpukit/posix/inline/rtems/posix/priority.inl
@@ -1,6 +1,8 @@
 /**
- * @file rtems/posix/priority.inl
+ * @file
  *
+ * @brief Inline Methods Related to POSIX Priority Management
+ * 
  * This defines the static inline methods related to POSIX priority management.
  */
 
diff --git a/cpukit/posix/inline/rtems/posix/pthread.inl b/cpukit/posix/inline/rtems/posix/pthread.inl
index 1127841586..2df49804b0 100644
--- a/cpukit/posix/inline/rtems/posix/pthread.inl
+++ b/cpukit/posix/inline/rtems/posix/pthread.inl
@@ -1,5 +1,7 @@
 /**
- * @file rtems/posix/pthread.inl
+ * @file
+ * 
+ * @brief Private Inlined Routines for POSIX Threads
  *
  * This include file contains the static inline implementation of the private 
  * inlined routines for POSIX threads.
diff --git a/cpukit/posix/inline/rtems/posix/rwlock.inl b/cpukit/posix/inline/rtems/posix/rwlock.inl
index 5f1ef7e477..ac641c926b 100644
--- a/cpukit/posix/inline/rtems/posix/rwlock.inl
+++ b/cpukit/posix/inline/rtems/posix/rwlock.inl
@@ -1,5 +1,7 @@
 /**
- * @file rtems/posix/rwlock.inl
+ * @file
+ * 
+ * @brief Inlined Routines from the POSIX RWLock Manager
  *
  * This file contains the static inlin implementation of the inlined
  * routines from the POSIX RWLock Manager.
@@ -24,10 +26,10 @@
 #include <pthread.h>
 
 /**
- *  @brief _POSIX_RWLock_Allocate
+ * @brief Allocate a RWLock control block.
  *
- *  This function allocates a RWLock control block from
- *  the inactive chain of free RWLock control blocks.
+ * This function allocates a RWLock control block from
+ * the inactive chain of free RWLock control blocks.
  */
 RTEMS_INLINE_ROUTINE POSIX_RWLock_Control *_POSIX_RWLock_Allocate( void )
 {
@@ -36,10 +38,10 @@ RTEMS_INLINE_ROUTINE POSIX_RWLock_Control *_POSIX_RWLock_Allocate( void )
 }
 
 /**
- *  @brief _POSIX_RWLock_Free
+ * @brief Free a RWLock control block.
  *
- *  This routine frees a RWLock control block to the
- *  inactive chain of free RWLock control blocks.
+ * This routine frees a RWLock control block to the
+ * inactive chain of free RWLock control blocks.
  */
 RTEMS_INLINE_ROUTINE void _POSIX_RWLock_Free (
   POSIX_RWLock_Control *the_RWLock
@@ -49,15 +51,15 @@ RTEMS_INLINE_ROUTINE void _POSIX_RWLock_Free (
 }
 
 /**
- *  @brief _POSIX_RWLock_Get
+ * @brief Get a RWLock control block.
  *
- *  This function maps RWLock IDs to RWLock control blocks.
- *  If ID corresponds to a local RWLock, then it returns
- *  the_RWLock control pointer which maps to ID and location
- *  is set to OBJECTS_LOCAL.  if the RWLock ID is global and
- *  resides on a remote node, then location is set to OBJECTS_REMOTE,
- *  and the_RWLock is undefined.  Otherwise, location is set
- *  to OBJECTS_ERROR and the_RWLock is undefined.
+ * This function maps RWLock IDs to RWLock control blocks.
+ * If ID corresponds to a local RWLock, then it returns
+ * the_RWLock control pointer which maps to ID and location
+ * is set to OBJECTS_LOCAL.  if the RWLock ID is global and
+ * resides on a remote node, then location is set to OBJECTS_REMOTE,
+ * and the_RWLock is undefined.  Otherwise, location is set
+ * to OBJECTS_ERROR and the_RWLock is undefined.
  */
 RTEMS_INLINE_ROUTINE POSIX_RWLock_Control *_POSIX_RWLock_Get (
   pthread_rwlock_t *RWLock,
@@ -72,9 +74,16 @@ RTEMS_INLINE_ROUTINE POSIX_RWLock_Control *_POSIX_RWLock_Get (
 }
 
 /**
- *  @brief _POSIX_RWLock_Is_null
+ * @brief Check if a RWLock control block is NULL.
  *
- *  This function returns TRUE if the_RWLock is NULL and FALSE otherwise.
+ * This function returns @c TRUE if the_RWLock is @c NULL and @c FALSE
+ * otherwise.
+ * 
+ * @param[in] the_RWLock is the pointer to the RWLock control block
+ * to be checked.
+ * 
+ * @retval TRUE The RWLock control block is @c NULL.
+ * @retval FALSE The RWLock control block is not @c NULL.
  */
 RTEMS_INLINE_ROUTINE bool _POSIX_RWLock_Is_null (
   POSIX_RWLock_Control *the_RWLock
diff --git a/cpukit/posix/inline/rtems/posix/semaphore.inl b/cpukit/posix/inline/rtems/posix/semaphore.inl
index 4828bcd5ea..8c7d6700a9 100644
--- a/cpukit/posix/inline/rtems/posix/semaphore.inl
+++ b/cpukit/posix/inline/rtems/posix/semaphore.inl
@@ -1,5 +1,7 @@
 /**
- * @file rtems/posix/semaphore.inl
+ * @file
+ * 
+ * @brief Private Inlined Routines for POSIX Semaphores
  *
  * This include file contains the static inline implementation of the private 
  * inlined routines for POSIX Semaphores.
diff --git a/cpukit/posix/inline/rtems/posix/spinlock.inl b/cpukit/posix/inline/rtems/posix/spinlock.inl
index 0924e5ad3d..b8ababda02 100644
--- a/cpukit/posix/inline/rtems/posix/spinlock.inl
+++ b/cpukit/posix/inline/rtems/posix/spinlock.inl
@@ -1,5 +1,7 @@
 /**
- * @file rtems/posix/spinlock.inl
+ * @file
+ * 
+ * @brief Inlined Routines from the POSIX Spinlock Manager
  *
  * This file contains the static inlin implementation of the inlined
  * routines from the POSIX Spinlock Manager.
@@ -24,10 +26,10 @@
 #include <pthread.h>
 
 /**
- *  @brief _POSIX_Spinlock_Allocate
+ * @brief Allocate a spinlock control block.
  *
- *  This function allocates a spinlock control block from
- *  the inactive chain of free spinlock control blocks.
+ * This function allocates a spinlock control block from
+ * the inactive chain of free spinlock control blocks.
  */
 RTEMS_INLINE_ROUTINE POSIX_Spinlock_Control *_POSIX_Spinlock_Allocate( void )
 {
@@ -36,10 +38,10 @@ RTEMS_INLINE_ROUTINE POSIX_Spinlock_Control *_POSIX_Spinlock_Allocate( void )
 }
 
 /**
- *  @brief _POSIX_Spinlock_Free
+ * @brief Free a spinlock control block.
  *
- *  This routine frees a spinlock control block to the
- *  inactive chain of free spinlock control blocks.
+ * This routine frees a spinlock control block to the
+ * inactive chain of free spinlock control blocks.
  */
 RTEMS_INLINE_ROUTINE void _POSIX_Spinlock_Free (
   POSIX_Spinlock_Control *the_spinlock
@@ -49,15 +51,15 @@ RTEMS_INLINE_ROUTINE void _POSIX_Spinlock_Free (
 }
 
 /**
- *  @brief _POSIX_Spinlock_Get
+ * @brief Get a spinlock control block.
  *
- *  This function maps spinlock IDs to spinlock control blocks.
- *  If ID corresponds to a local spinlock, then it returns
- *  the_spinlock control pointer which maps to ID and location
- *  is set to OBJECTS_LOCAL.  if the spinlock ID is global and
- *  resides on a remote node, then location is set to OBJECTS_REMOTE,
- *  and the_spinlock is undefined.  Otherwise, location is set
- *  to OBJECTS_ERROR and the_spinlock is undefined.
+ * This function maps spinlock IDs to spinlock control blocks.
+ * If ID corresponds to a local spinlock, then it returns
+ * the_spinlock control pointer which maps to ID and location
+ * is set to OBJECTS_LOCAL.  if the spinlock ID is global and
+ * resides on a remote node, then location is set to OBJECTS_REMOTE,
+ * and the_spinlock is undefined.  Otherwise, location is set
+ * to OBJECTS_ERROR and the_spinlock is undefined.
  */
 RTEMS_INLINE_ROUTINE POSIX_Spinlock_Control *_POSIX_Spinlock_Get (
   pthread_spinlock_t *spinlock,
@@ -72,9 +74,16 @@ RTEMS_INLINE_ROUTINE POSIX_Spinlock_Control *_POSIX_Spinlock_Get (
 }
 
 /**
- *  @brief _POSIX_Spinlock_Is_null
+ * @brief Check if a spinlock control block is NULL.
  *
- *  This function returns TRUE if the_spinlock is NULL and FALSE otherwise.
+ * This function returns @c TRUE if the_spinlock is @c NULL and @c FALSE
+ * otherwise.
+ * 
+ * @param[in] the_spinlock is the pointer to the spinlock control block
+ * to be checked.
+ * 
+ * @retval TRUE The spinlock control block is @c NULL.
+ * @retval FALSE The spinlock control block is not @c NULL.
  */
 RTEMS_INLINE_ROUTINE bool _POSIX_Spinlock_Is_null (
   POSIX_Spinlock_Control *the_spinlock
diff --git a/cpukit/posix/inline/rtems/posix/timer.inl b/cpukit/posix/inline/rtems/posix/timer.inl
index 03377252fe..bc1db80c88 100644
--- a/cpukit/posix/inline/rtems/posix/timer.inl
+++ b/cpukit/posix/inline/rtems/posix/timer.inl
@@ -1,6 +1,8 @@
 /**
- * @file rtems/posix/timer.inl
+ * @file
  *
+ * @brief Inlined Routines from the POSIX Timer Manager
+ * 
  * This file contains the static inline implementation of the inlined routines
  * from the POSIX Timer Manager.
  */