From e49a36cb0b37cc3ad1c3f191fb439b17f6365539 Mon Sep 17 00:00:00 2001
From: Alex Ivanov <alexivanov97@gmail.com>
Date: Sat, 15 Dec 2012 09:54:10 -0500
Subject: posix: Doxygen Enhancement Task #5

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

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

diff --git a/cpukit/posix/src/pspindestroy.c b/cpukit/posix/src/pspindestroy.c
index c5574c0c7b..97745b6b77 100644
--- a/cpukit/posix/src/pspindestroy.c
+++ b/cpukit/posix/src/pspindestroy.c
@@ -1,6 +1,11 @@
-/*
- *  POSIX Spinlock Manager -- Destroy a Spinlock
+/**
+ *  @file
  *
+ *  @brief Destroy a Spinlock
+ *  @ingroup POSIX
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -19,21 +24,17 @@
 #include <rtems/system.h>
 #include <rtems/posix/spinlock.h>
 
-/*
- *  pthread_spin_destroy
- *
+/**
  *  This directive allows a thread to delete a spinlock specified by
  *  the spinlock id.  The spinlock is freed back to the inactive
  *  spinlock chain.
  *
- *  Input parameters:
- *    spinlock - spinlock id
+ *  @param[in] spinlock is the spinlock 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_spin_destroy(
   pthread_spinlock_t *spinlock
 )
-- 
cgit v1.2.3