diff options
| author | Alex Ivanov <alexivanov97@gmail.com> | 2012-11-28 08:11:31 -0600 |
|---|---|---|
| committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2012-11-28 08:17:26 -0600 |
| commit | f7f1d776decf9d46f27d0242e43ce85d67f32df1 (patch) | |
| tree | 3e00b3401f0663707da851e7a35c3c5d1ef8f627 /cpukit/score/src/corerwlockobtainwrite.c | |
| parent | score: Add CPU_Exception_frame (diff) | |
| download | rtems-f7f1d776decf9d46f27d0242e43ce85d67f32df1.tar.bz2 | |
score misc: Clean up Doxygen (GCI 2012)
This patch is a task from GCI 2012 which improves the Doxygen
comments in the RTEMS source.
https://google-melange.appspot.com/gci/task/view/google/gci2012/7978208
Diffstat (limited to 'cpukit/score/src/corerwlockobtainwrite.c')
| -rw-r--r-- | cpukit/score/src/corerwlockobtainwrite.c | 23 |
1 files changed, 7 insertions, 16 deletions
diff --git a/cpukit/score/src/corerwlockobtainwrite.c b/cpukit/score/src/corerwlockobtainwrite.c index 0dac3333a2..e2b8806028 100644 --- a/cpukit/score/src/corerwlockobtainwrite.c +++ b/cpukit/score/src/corerwlockobtainwrite.c @@ -1,6 +1,11 @@ -/* - * SuperCore RWLock Handler -- Obtain RWLock for writing +/** + * @file * + * @brief RWLock Obtain for Writing + * @ingroup ScoreRWLock + */ + +/* * 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_writing - * - * 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_writing( CORE_RWLock_Control *the_rwlock, Objects_Id id, |