From baff4dafe1ff85d128a55e7b73780ca28f5c7faf Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Mon, 1 Nov 2004 13:22:41 +0000 Subject: 2004-11-01 Joel Sherrill * score/cpu/no_cpu/rtems/score/cpu.h, 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/copyrt.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/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/coremsg.inl, score/inline/rtems/score/coremutex.inl, score/inline/rtems/score/coresem.inl, score/inline/rtems/score/heap.inl, score/inline/rtems/score/isr.inl, score/inline/rtems/score/mppkt.inl, score/inline/rtems/score/objectmp.inl, score/inline/rtems/score/priority.inl, score/inline/rtems/score/stack.inl, score/inline/rtems/score/states.inl, score/inline/rtems/score/sysstate.inl, score/inline/rtems/score/thread.inl, score/inline/rtems/score/threadmp.inl, score/inline/rtems/score/tod.inl, score/inline/rtems/score/tqdata.inl, score/inline/rtems/score/userext.inl, score/inline/rtems/score/watchdog.inl, score/inline/rtems/score/wkspace.inl: Add Doxygen comments -- working modifications which are not complete and may have broken code. Committing so work and testing can proceed. * score/Doxyfile, score/mainpage.h: New files. --- cpukit/score/inline/rtems/score/coremsg.inl | 100 +++++++--------------------- 1 file changed, 25 insertions(+), 75 deletions(-) (limited to 'cpukit/score/inline/rtems/score/coremsg.inl') diff --git a/cpukit/score/inline/rtems/score/coremsg.inl b/cpukit/score/inline/rtems/score/coremsg.inl index 7d152aec6b..56dea73b6d 100644 --- a/cpukit/score/inline/rtems/score/coremsg.inl +++ b/cpukit/score/inline/rtems/score/coremsg.inl @@ -1,9 +1,12 @@ -/* coremsg.inl +/** + * @file coremsg.inl * * This include file contains the static inline implementation of all * inlined routines in the Core Message Handler. - * - * COPYRIGHT (c) 1989-1999. + */ + +/* + * COPYRIGHT (c) 1989-2004. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -16,14 +19,14 @@ #ifndef __CORE_MESSAGE_QUEUE_inl #define __CORE_MESSAGE_QUEUE_inl +/** + * @addtogroup ScoreMessageQueue + * @{ + */ + #include /* needed for memcpy */ -/*PAGE - * - * _CORE_message_queue_Send - * - * DESCRIPTION: - * +/** * This routine sends a message to the end of the specified message queue. */ @@ -53,12 +56,7 @@ RTEMS_INLINE_ROUTINE CORE_message_queue_Status _CORE_message_queue_Send( ); } -/*PAGE - * - * _CORE_message_queue_Urgent - * - * DESCRIPTION: - * +/** * This routine sends a message to the front of the specified message queue. */ @@ -88,12 +86,7 @@ RTEMS_INLINE_ROUTINE CORE_message_queue_Status _CORE_message_queue_Urgent( ); } -/*PAGE - * - * _CORE_message_queue_Copy_buffer - * - * DESCRIPTION: - * +/** * This routine copies the contents of the source message buffer * to the destination message buffer. */ @@ -107,12 +100,7 @@ RTEMS_INLINE_ROUTINE void _CORE_message_queue_Copy_buffer ( memcpy(destination, source, size); } -/*PAGE - * - * _CORE_message_queue_Allocate_message_buffer - * - * DESCRIPTION: - * +/** * This function allocates a message buffer from the inactive * message buffer chain. */ @@ -126,12 +114,7 @@ _CORE_message_queue_Allocate_message_buffer ( _Chain_Get( &the_message_queue->Inactive_messages ); } -/*PAGE - * - * _CORE_message_queue_Free_message_buffer - * - * DESCRIPTION: - * +/** * This routine frees a message buffer to the inactive * message buffer chain. */ @@ -144,12 +127,7 @@ RTEMS_INLINE_ROUTINE void _CORE_message_queue_Free_message_buffer ( _Chain_Append( &the_message_queue->Inactive_messages, &the_message->Node ); } -/*PAGE - * - * _CORE_message_queue_Get_pending_message - * - * DESCRIPTION: - * +/** * This function removes the first message from the_message_queue * and returns a pointer to it. */ @@ -163,12 +141,7 @@ RTEMS_INLINE_ROUTINE _Chain_Get_unprotected( &the_message_queue->Pending_messages ); } -/*PAGE - * - * _CORE_message_queue_Is_priority - * - * DESCRIPTION: - * +/** * This function returns TRUE if the priority attribute is * enabled in the attribute_set and FALSE otherwise. */ @@ -180,12 +153,7 @@ RTEMS_INLINE_ROUTINE boolean _CORE_message_queue_Is_priority( return (the_attribute->discipline == CORE_MESSAGE_QUEUE_DISCIPLINES_PRIORITY); } -/*PAGE - * - * _CORE_message_queue_Append - * - * DESCRIPTION: - * +/** * This routine places the_message at the rear of the outstanding * messages on the_message_queue. */ @@ -198,12 +166,7 @@ RTEMS_INLINE_ROUTINE void _CORE_message_queue_Append ( _Chain_Append( &the_message_queue->Pending_messages, &the_message->Node ); } -/*PAGE - * - * _CORE_message_queue_Prepend - * - * DESCRIPTION: - * +/** * This routine places the_message at the front of the outstanding * messages on the_message_queue. */ @@ -219,12 +182,7 @@ RTEMS_INLINE_ROUTINE void _CORE_message_queue_Prepend ( ); } -/*PAGE - * - * _CORE_message_queue_Is_null - * - * DESCRIPTION: - * +/** * This function returns TRUE if the_message_queue is TRUE and FALSE otherwise. */ @@ -235,12 +193,7 @@ RTEMS_INLINE_ROUTINE boolean _CORE_message_queue_Is_null ( return ( the_message_queue == NULL ); } -/*PAGE - * - * _CORE_message_queue_Is_notify_enabled - * - * DESCRIPTION: - * +/** * This function returns TRUE if notification is enabled on this message * queue and FALSE otherwise. */ @@ -252,12 +205,7 @@ RTEMS_INLINE_ROUTINE boolean _CORE_message_queue_Is_notify_enabled ( return (the_message_queue->notify_handler != NULL); } -/*PAGE - * - * _CORE_message_queue_Set_notify - * - * DESCRIPTION: - * +/** * This routine initializes the notification information for the_message_queue. */ @@ -271,5 +219,7 @@ RTEMS_INLINE_ROUTINE void _CORE_message_queue_Set_notify ( the_message_queue->notify_argument = the_argument; } +/**@}*/ + #endif /* end of include file */ -- cgit v1.2.3