libfs: Doxygen Clean Up Task #1

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

Patch committed with fixes for whitespace issues.

1 files changed, 21 insertions, 14 deletions

diff --git a/cpukit/libfs/src/rfs/rtems-rfs-mutex.h b/cpukit/libfs/src/rfs/rtems-rfs-mutex.h
index ac04aeea1a..edf67f4f7b 100644
--- a/cpukit/libfs/src/rfs/rtems-rfs-mutex.h
+++ b/cpukit/libfs/src/rfs/rtems-rfs-mutex.h
@@ -41,27 +41,33 @@ typedef uint32_t rtems_rfs_mutex; /* place holder */
 #endif
 
 /**
- * Create the mutex.
+ * @brief Create the mutex.
+ *
+ * @param [in] mutex is pointer to the mutex handle returned to the caller.
+ *
+ * @retval 0 Successful operation.
+ * @retval EIO An error occurred.
  *
- * @param mutex Reference to the mutex handle returned to the caller.
- * @return int The error number (errno). No error if 0.
  */
 int rtems_rfs_mutex_create (rtems_rfs_mutex* mutex);
 
 /**
- * Create the mutex.
+ * @brief Destroy the mutex.
+ *
+ * @param[in] mutex Reference to the mutex handle returned to the caller.
  *
- * @param mutex Reference to the mutex handle returned to the caller.
- * @return int The error number (errno). No error if 0.
+ * @retval 0 Successful operation.
+ * @retval EIO An error occurred.
  */
 int rtems_rfs_mutex_destroy (rtems_rfs_mutex* mutex);
 
 /**
- * Lock the mutex.
+ * @brief Lock the mutex.
  *
- * @param mutex The mutex to lock.
- * @retval true The mutex is locked.
- * @retval false The mutex could not be locked.
+ * @param[in] mutex is a pointer to the mutex to lock.
+ *
+ * @retval 0 Successful operation.
+ * @retval EIO An error occurred.
  */
 static inline int
 rtems_rfs_mutex_lock (rtems_rfs_mutex* mutex)
@@ -82,11 +88,12 @@ rtems_rfs_mutex_lock (rtems_rfs_mutex* mutex)
 }
 
 /**
- * Unlock the mutex.
+ * @brief Unlock the mutex.
+ *
+ * @param[in] mutex is a pointer to the mutex to unlock.
  *
- * @param mutex The mutex to unlock.
- * @retval true The mutex is unlocked.
- * @retval false The mutex could not be unlocked.
+ * @retval 0 Successful operation.
+ * @retval EIO An error occurred.
  */
 static inline int
 rtems_rfs_mutex_unlock (rtems_rfs_mutex* mutex)