summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/inline/rtems/rtems/message.inl
diff options
context:
space:
mode:
Diffstat (limited to 'cpukit/rtems/inline/rtems/rtems/message.inl')
-rw-r--r--cpukit/rtems/inline/rtems/rtems/message.inl40
1 files changed, 17 insertions, 23 deletions
diff --git a/cpukit/rtems/inline/rtems/rtems/message.inl b/cpukit/rtems/inline/rtems/rtems/message.inl
index 06ccc32e1e..98665c5dac 100644
--- a/cpukit/rtems/inline/rtems/rtems/message.inl
+++ b/cpukit/rtems/inline/rtems/rtems/message.inl
@@ -1,12 +1,11 @@
/**
* @file rtems/rtems/message.inl
- */
-
-/*
+ *
* This include file contains the static inline implementation of all
* inlined routines in the Message Manager.
- *
- * COPYRIGHT (c) 1989-1999.
+ */
+
+/* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -21,16 +20,17 @@
#include <rtems/score/wkspace.h>
-/*PAGE
- *
- * _Message_queue_Is_null
- *
- * DESCRIPTION:
+/**
+ * @addtogroup ClassicMessageQueue
+ * @{
+ */
+
+/**
+ * @brief Message_queue_Is_null
*
* This function places the_message at the rear of the outstanding
* messages on the_message_queue.
*/
-
RTEMS_INLINE_ROUTINE boolean _Message_queue_Is_null (
Message_queue_Control *the_message_queue
)
@@ -39,16 +39,12 @@ RTEMS_INLINE_ROUTINE boolean _Message_queue_Is_null (
}
-/*PAGE
- *
- * _Message_queue_Free
- *
- * DESCRIPTION:
+/**
+ * @brief Message_queue_Free
*
* This routine deallocates a message queue control block into
* the inactive chain of free message queue control blocks.
*/
-
RTEMS_INLINE_ROUTINE void _Message_queue_Free (
Message_queue_Control *the_message_queue
)
@@ -56,11 +52,8 @@ RTEMS_INLINE_ROUTINE void _Message_queue_Free (
_Objects_Free( &_Message_queue_Information, &the_message_queue->Object );
}
-/*PAGE
- *
- * _Message_queue_Get
- *
- * DESCRIPTION:
+/**
+ * @brief Message_queue_Get
*
* This function maps message queue IDs to message queue control
* blocks. If ID corresponds to a local message queue, then it
@@ -71,7 +64,6 @@ RTEMS_INLINE_ROUTINE void _Message_queue_Free (
* Otherwise, location is set to OBJECTS_ERROR and
* the_message_queue is undefined.
*/
-
RTEMS_INLINE_ROUTINE Message_queue_Control *_Message_queue_Get (
Objects_Id id,
Objects_Locations *location
@@ -81,5 +73,7 @@ RTEMS_INLINE_ROUTINE Message_queue_Control *_Message_queue_Get (
_Objects_Get( &_Message_queue_Information, id, location );
}
+/**@}*/
+
#endif
/* end of include file */