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/corerwlockobtainread.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/corerwlockobtainread.c')
-rw-r--r-- | cpukit/score/src/corerwlockobtainread.c | 23 |
1 files changed, 7 insertions, 16 deletions
diff --git a/cpukit/score/src/corerwlockobtainread.c b/cpukit/score/src/corerwlockobtainread.c index a8ea78ba1e..18df39d296 100644 --- a/cpukit/score/src/corerwlockobtainread.c +++ b/cpukit/score/src/corerwlockobtainread.c @@ -1,6 +1,11 @@ +/** + * @file + * + * @brief Obtain RWLock for reading + * @ingroup ScoreRWLock + */ + /* - * SuperCore RWLock Handler -- Obtain RWLock for reading - * * COPYRIGHT (c) 1989-2006. * On-Line Applications Research Corporation (OAR). * @@ -19,20 +24,6 @@ #include <rtems/score/thread.h> #include <rtems/score/watchdog.h> -/* - * _CORE_rwlock_Obtain_for_reading - * - * This function waits for the rwlock to become available. Optionally, - * a limit may be placed on the duration of the spin. - * - * Input parameters: - * the_rwlock - the rwlock control block to initialize - * timeout_allowed - true if timeout allowed - * timeout - the maximum number of ticks to spin - * - * Output parameters: NONE - */ - void _CORE_RWLock_Obtain_for_reading( CORE_RWLock_Control *the_rwlock, Objects_Id id, |