diff options
author | Joel Sherrill <joel.sherrill@OARcorp.com> | 2006-01-16 15:13:58 +0000 |
---|---|---|
committer | Joel Sherrill <joel.sherrill@OARcorp.com> | 2006-01-16 15:13:58 +0000 |
commit | 6a074363a2657a86b5f1ea0fc1185f68ad9f3c08 (patch) | |
tree | 3785d2da164f2c26988014ad5dbae6e35aa24147 /cpukit/score/include/rtems/score/apimutex.h | |
parent | 2006-01-16 Joel Sherrill <joel@OARcorp.com> (diff) | |
download | rtems-6a074363a2657a86b5f1ea0fc1185f68ad9f3c08.tar.bz2 |
2006-01-16 Joel Sherrill <joel@OARcorp.com>
Large patch to improve Doxygen output. As a side-effect, grammar and
spelling errors were corrected, spacing errors were address, and some
variable names were improved.
* libmisc/monitor/mon-object.c, libmisc/monitor/monitor.h:
Account for changing OBJECTS_NO_CLASS to OBJECTS_CLASSIC_NO_CLASS.
* score/Doxyfile: Set output directory. Predefine some macro values.
Turn on graphical output.
* score/include/rtems/debug.h, score/include/rtems/seterr.h,
score/include/rtems/system.h, score/include/rtems/score/address.h,
score/include/rtems/score/apiext.h,
score/include/rtems/score/apimutex.h,
score/include/rtems/score/bitfield.h,
score/include/rtems/score/chain.h,
score/include/rtems/score/context.h,
score/include/rtems/score/coremsg.h,
score/include/rtems/score/coremutex.h,
score/include/rtems/score/coresem.h,
score/include/rtems/score/heap.h, score/include/rtems/score/interr.h,
score/include/rtems/score/isr.h, score/include/rtems/score/mpci.h,
score/include/rtems/score/mppkt.h,
score/include/rtems/score/object.h,
score/include/rtems/score/objectmp.h,
score/include/rtems/score/priority.h,
score/include/rtems/score/stack.h,
score/include/rtems/score/states.h,
score/include/rtems/score/sysstate.h,
score/include/rtems/score/thread.h,
score/include/rtems/score/threadmp.h,
score/include/rtems/score/threadq.h, score/include/rtems/score/tod.h,
score/include/rtems/score/tqdata.h,
score/include/rtems/score/userext.h,
score/include/rtems/score/watchdog.h,
score/include/rtems/score/wkspace.h,
score/inline/rtems/score/address.inl,
score/inline/rtems/score/chain.inl,
score/inline/rtems/score/coremutex.inl,
score/inline/rtems/score/coresem.inl,
score/inline/rtems/score/heap.inl,
score/inline/rtems/score/object.inl,
score/inline/rtems/score/stack.inl,
score/inline/rtems/score/thread.inl,
score/inline/rtems/score/tqdata.inl, score/macros/README,
score/src/heap.c, score/src/threadmp.c, score/src/threadready.c,
score/src/threadstartmultitasking.c: Improve generated Doxygen
output. Fix spelling and grammar errors in comments. Correct names of
some variables and propagate changes.
Diffstat (limited to '')
-rw-r--r-- | cpukit/score/include/rtems/score/apimutex.h | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/cpukit/score/include/rtems/score/apimutex.h b/cpukit/score/include/rtems/score/apimutex.h index 914207fc81..ea257f4a7e 100644 --- a/cpukit/score/include/rtems/score/apimutex.h +++ b/cpukit/score/include/rtems/score/apimutex.h @@ -7,7 +7,7 @@ */ /* - * COPYRIGHT (c) 1989-2004. + * COPYRIGHT (c) 1989-2006. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -23,7 +23,7 @@ /** * @defgroup ScoreAPIMutex API Mutex Handler * - * This group contains functionality which provides mutexes to be used + * This handler encapsulates functionality which provides mutexes to be used * in the implementation of API functionality. */ /**@{*/ @@ -56,7 +56,7 @@ SCORE_EXTERN Objects_Information _API_Mutex_Information; /** * This routine performs the initialization necessary for this handler. * - * @param _maximum_mutexes (in) is the maximum number of API mutexes + * @param[in] _maximum_mutexes is the maximum number of API mutexes * that may exist at any time */ #if defined(RTEMS_MULTIPROCESSING) @@ -88,7 +88,7 @@ SCORE_EXTERN Objects_Information _API_Mutex_Information; /** * This routine allocates an API mutex from the inactive set. * - * @param _the_mutex (out) will contain the allocated mutex. + * @param[out] _the_mutex will contain the allocated mutex. */ #define _API_Mutex_Allocate( _the_mutex ) \ do { \ @@ -104,7 +104,7 @@ SCORE_EXTERN Objects_Information _API_Mutex_Information; /** * This routine acquires the specified API mutex. * - * @param _the_mutex (in) is the mutex to acquire. + * @param[in] _the_mutex is the mutex to acquire. */ #define _API_Mutex_Lock( _the_mutex ) \ do { \ @@ -117,7 +117,7 @@ SCORE_EXTERN Objects_Information _API_Mutex_Information; /** * This routine releases the specified API mutex. * - * @param _the_mutex (in) is the mutex to release. + * @param[in] _the_mutex is the mutex to release. */ #define _API_Mutex_Unlock( _the_mutex ) \ |