summaryrefslogtreecommitdiffstats
path: root/cpukit/score/src/coresemseize.c
diff options
context:
space:
mode:
authorChristopher Kerl <zargyyoyo@gmail.com>2012-11-28 13:31:53 -0600
committerJoel Sherrill <joel.sherrill@oarcorp.com>2012-11-28 13:31:53 -0600
commitd4d7899bb2730dc77331db202a2473818a7ea351 (patch)
treefc3204f40c34ba4da1e6db310dbdf82c81c8c6a7 /cpukit/score/src/coresemseize.c
parentscore misc: Clean up Doxygen (GCI 2012) (diff)
downloadrtems-d4d7899bb2730dc77331db202a2473818a7ea351.tar.bz2
score misc: Clean up Doxygen #2 (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/7986213
Diffstat (limited to 'cpukit/score/src/coresemseize.c')
-rw-r--r--cpukit/score/src/coresemseize.c29
1 files changed, 7 insertions, 22 deletions
diff --git a/cpukit/score/src/coresemseize.c b/cpukit/score/src/coresemseize.c
index 925290b8da..5ceaea72c2 100644
--- a/cpukit/score/src/coresemseize.c
+++ b/cpukit/score/src/coresemseize.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 Core Semaphore Seize
*
+ * @ingroup ScoreSemaphore
+ */
+
+/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
@@ -27,21 +27,6 @@
#include <rtems/score/threadq.h>
#if defined(RTEMS_SCORE_CORESEM_ENABLE_SEIZE_BODY)
-/*
- * This routine attempts to allocate a core semaphore to the calling thread.
- *
- * Input parameters:
- * the_semaphore - pointer to semaphore control block
- * id - id of object to wait on
- * wait - true if wait is allowed, false otherwise
- * timeout - number of ticks to wait (0 means forever)
- *
- * Output parameters: NONE
- *
- * INTERRUPT LATENCY:
- * available
- * wait
- */
void _CORE_semaphore_Seize(
CORE_semaphore_Control *the_semaphore,