From e43f4758af5414a28f82c8178f2b53d23031376a Mon Sep 17 00:00:00 2001
From: Alex Ivanov <alexivanov97@gmail.com>
Date: Sat, 15 Dec 2012 07:25:05 -0500
Subject: posix: Doxygen Enhancement Task #1

http://www.google-melange.com/gci/task/view/google/gci2012/7987220
---
 cpukit/posix/src/prwlockdestroy.c | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

(limited to 'cpukit/posix/src/prwlockdestroy.c')

diff --git a/cpukit/posix/src/prwlockdestroy.c b/cpukit/posix/src/prwlockdestroy.c
index 684e173e18..9b644ba943 100644
--- a/cpukit/posix/src/prwlockdestroy.c
+++ b/cpukit/posix/src/prwlockdestroy.c
@@ -1,6 +1,10 @@
-/*
- *  POSIX RWLock Manager -- Destroy a RWLock
+/**
+ *  @file
  *
+ *  @brief Destroy a RWLock
+ *  @ingroup POSIX
+ */
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -19,21 +23,17 @@
 #include <rtems/system.h>
 #include <rtems/posix/rwlock.h>
 
-/*
- *  pthread_rwlock_destroy
- *
+/**
  *  This directive allows a thread to delete a rwlock specified by
  *  the rwlock id.  The rwlock is freed back to the inactive
  *  rwlock chain.
  *
- *  Input parameters:
- *    rwlock - rwlock id
+ *  @param[in] rwlock is the rwlock id
  *
- *  Output parameters:
- *    0           - if successful
- *    error code  - if unsuccessful
+ *  @return This method returns 0 if there was not an
+ *  error. Otherwise, a status code is returned indicating the
+ *  source of the error.
  */
-
 int pthread_rwlock_destroy(
   pthread_rwlock_t *rwlock
 )
-- 
cgit v1.2.3