From 6a074363a2657a86b5f1ea0fc1185f68ad9f3c08 Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Mon, 16 Jan 2006 15:13:58 +0000 Subject: 2006-01-16 Joel Sherrill 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. --- cpukit/score/inline/rtems/score/coremutex.inl | 52 +++++++++++++++++++-------- 1 file changed, 38 insertions(+), 14 deletions(-) (limited to 'cpukit/score/inline/rtems/score/coremutex.inl') diff --git a/cpukit/score/inline/rtems/score/coremutex.inl b/cpukit/score/inline/rtems/score/coremutex.inl index e186b197cd..2bde4a888f 100644 --- a/cpukit/score/inline/rtems/score/coremutex.inl +++ b/cpukit/score/inline/rtems/score/coremutex.inl @@ -6,7 +6,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 @@ -25,10 +25,15 @@ */ /** + * @brief Is Mutex Locked + * * This routine returns TRUE if the mutex specified is locked and FALSE * otherwise. + * + * @param[in] the_mutex is the mutex to check + * + * @return This method returns TRUE if the mutex is locked. */ - RTEMS_INLINE_ROUTINE boolean _CORE_mutex_Is_locked( CORE_mutex_Control *the_mutex ) @@ -37,10 +42,15 @@ RTEMS_INLINE_ROUTINE boolean _CORE_mutex_Is_locked( } /** + * @brief Does Core Mutex Use FIFO Blocking + * * This routine returns TRUE if the mutex's wait discipline is FIFO and FALSE * otherwise. + * + * @param[in] the_attribute is the attribute set of the mutex + * + * @return This method returns TRUE if the mutex is using FIFO blocking order. */ - RTEMS_INLINE_ROUTINE boolean _CORE_mutex_Is_fifo( CORE_mutex_Attributes *the_attribute ) @@ -49,10 +59,16 @@ RTEMS_INLINE_ROUTINE boolean _CORE_mutex_Is_fifo( } /** + * @brief Doex Core Mutex Use Priority Blocking + * * This routine returns TRUE if the mutex's wait discipline is PRIORITY and * FALSE otherwise. + * + * @param[in] the_attribute is the attribute set of the mutex + * + * @return This method returns TRUE if the mutex is using + * priority blocking order. */ - RTEMS_INLINE_ROUTINE boolean _CORE_mutex_Is_priority( CORE_mutex_Attributes *the_attribute ) @@ -61,10 +77,16 @@ RTEMS_INLINE_ROUTINE boolean _CORE_mutex_Is_priority( } /** + * @brief Does Mutex Use Priority Inheritance + * * This routine returns TRUE if the mutex's wait discipline is * INHERIT_PRIORITY and FALSE otherwise. + * + * @param[in] the_attribute is the attribute set of the mutex + * + * @return This method returns TRUE if the mutex is using priority + * inheritance. */ - RTEMS_INLINE_ROUTINE boolean _CORE_mutex_Is_inherit_priority( CORE_mutex_Attributes *the_attribute ) @@ -73,10 +95,16 @@ RTEMS_INLINE_ROUTINE boolean _CORE_mutex_Is_inherit_priority( } /** + * @brief Does Mutex Use Priority Ceiling + * * This routine returns TRUE if the mutex's wait discipline is * PRIORITY_CEILING and FALSE otherwise. + * + * @param[in] the_attribute is the attribute set of the mutex + * + * @return This method returns TRUE if the mutex is using priority + * ceiling. */ - RTEMS_INLINE_ROUTINE boolean _CORE_mutex_Is_priority_ceiling( CORE_mutex_Attributes *the_attribute ) @@ -85,14 +113,10 @@ RTEMS_INLINE_ROUTINE boolean _CORE_mutex_Is_priority_ceiling( } /* - * This routine returns 0 if "trylock" can resolve whether or not the - * mutex is immediately obtained or there was an error attempting to - * get it. It returns 1 to indicate that the caller cannot obtain - * the mutex and will have to block to do so. - * - * NOTE: There is no MACRO version of this routine. - * A body is in coremutexseize.c that is duplicated - * from the .inl by hand. + * Seize Mutex with Quick Success Path + * + * NOTE: There is no MACRO version of this routine. A body is in + * coremutexseize.c that is duplicated from the .inl by hand. * * NOTE: The Doxygen for this routine is in the .h file. */ -- cgit v1.2.3