summaryrefslogtreecommitdiffstats
path: root/cpukit/score/src/coresemsurrender.c
diff options
context:
space:
mode:
authorChristopher Kerl <zargyyoyo@gmail.com>2012-12-01 09:47:07 -0500
committerGedare Bloom <gedare@rtems.org>2012-12-01 09:47:07 -0500
commitf839bf5ae259fe53353a00046adf2c9413df502a (patch)
treee636813af9a1b5af09df27c1a9a07873cb56a565 /cpukit/score/src/coresemsurrender.c
parentPrint MCSR and ESR. (diff)
downloadrtems-f839bf5ae259fe53353a00046adf2c9413df502a.tar.bz2
score misc: Score misc: Clean up Doxygen #10 (GCI 2012)
This patch is a task from GCI 2012 which improves the Doxygen comments in the RTEMS source. http://www.google-melange.com/gci/task/view/google/gci2012/7983216
Diffstat (limited to 'cpukit/score/src/coresemsurrender.c')
-rw-r--r--cpukit/score/src/coresemsurrender.c29
1 files changed, 7 insertions, 22 deletions
diff --git a/cpukit/score/src/coresemsurrender.c b/cpukit/score/src/coresemsurrender.c
index 69e71687e2..3d306f82a8 100644
--- a/cpukit/score/src/coresemsurrender.c
+++ b/cpukit/score/src/coresemsurrender.c
@@ -1,12 +1,12 @@
-/*
- * CORE Semaphore Handler
- *
- * DESCRIPTION:
+/**
+ * @file
*
- * This package is the implementation of the CORE Semaphore Handler.
- * This core object utilizes standard Dijkstra counting semaphores to provide
- * synchronization and mutual exclusion capabilities.
+ * @brief Surrenders a Unit to a Semaphore
*
+ * @ingroup ScoreSemaphore
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -26,21 +26,6 @@
#include <rtems/score/thread.h>
#include <rtems/score/threadq.h>
-/*
- * _CORE_semaphore_Surrender
- *
- * Input parameters:
- * the_semaphore - the semaphore to be flushed
- * id - id of parent semaphore
- * api_semaphore_mp_support - api dependent MP support actions
- *
- * Output parameters:
- * CORE_SEMAPHORE_STATUS_SUCCESSFUL - if successful
- * core error code - if unsuccessful
- *
- * Output parameters:
- */
-
CORE_semaphore_Status _CORE_semaphore_Surrender(
CORE_semaphore_Control *the_semaphore,
Objects_Id id,