diff options
author | Daniel Georgiev <daniel.georgiev95@gmail.com> | 2012-12-01 09:53:45 -0500 |
---|---|---|
committer | Gedare Bloom <gedare@rtems.org> | 2012-12-01 09:53:45 -0500 |
commit | 5a58b1e4988eb1a0fb6311b25fd12c91bb7237d7 (patch) | |
tree | 842558afb925e4f9fe5a0ac74a7f25a7d6b181be /cpukit/score/src/coremutex.c | |
parent | score misc: Score misc: Clean up Doxygen #10 (GCI 2012) (diff) | |
download | rtems-5a58b1e4988eb1a0fb6311b25fd12c91bb7237d7.tar.bz2 |
score misc: Score misc: Clean up Doxygen #11 (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/8013204
Diffstat (limited to 'cpukit/score/src/coremutex.c')
-rw-r--r-- | cpukit/score/src/coremutex.c | 28 |
1 files changed, 7 insertions, 21 deletions
diff --git a/cpukit/score/src/coremutex.c b/cpukit/score/src/coremutex.c index 596fa3f256..951bec63cd 100644 --- a/cpukit/score/src/coremutex.c +++ b/cpukit/score/src/coremutex.c @@ -1,11 +1,11 @@ -/* - * Mutex Handler - * - * DESCRIPTION: - * - * This package is the implementation of the Mutex Handler. - * This handler provides synchronization and mutual exclusion capabilities. +/** + * @file * + * @brief Initialize a Core Mutex + * @ingroup ScoreMutex + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * @@ -25,20 +25,6 @@ #include <rtems/score/thread.h> #include <rtems/score/threadq.h> -/* - * _CORE_mutex_Initialize - * - * This routine initializes a mutex at create time and set the control - * structure according to the values passed. - * - * Input parameters: - * the_mutex - the mutex control block to initialize - * the_mutex_attributes - the mutex attributes specified at create time - * initial_lock - mutex initial lock or unlocked status - * - * Output parameters: NONE - */ - CORE_mutex_Status _CORE_mutex_Initialize( CORE_mutex_Control *the_mutex, CORE_mutex_Attributes *the_mutex_attributes, |