From f9293dfaf13a21fcb3bf285159d37211ceeb1c4c Mon Sep 17 00:00:00 2001
From: Joel Sherrill <joel.sherrill@OARcorp.com>
Date: Fri, 18 Apr 2008 20:08:08 +0000
Subject: 2008-04-18	Joel Sherrill <joel.sherrill@oarcorp.com>

	* rtems/Doxyfile, rtems/include/rtems/rtems/asr.h,
	rtems/include/rtems/rtems/attr.h,
	rtems/include/rtems/rtems/barrier.h,
	rtems/include/rtems/rtems/barriermp.h,
	rtems/include/rtems/rtems/cache.h,
	rtems/include/rtems/rtems/config.h,
	rtems/include/rtems/rtems/dpmem.h, rtems/include/rtems/rtems/event.h,
	rtems/include/rtems/rtems/eventmp.h,
	rtems/include/rtems/rtems/eventset.h,
	rtems/include/rtems/rtems/intr.h,
	rtems/include/rtems/rtems/message.h,
	rtems/include/rtems/rtems/modes.h, rtems/include/rtems/rtems/mp.h,
	rtems/include/rtems/rtems/msgmp.h,
	rtems/include/rtems/rtems/options.h,
	rtems/include/rtems/rtems/part.h, rtems/include/rtems/rtems/partmp.h,
	rtems/include/rtems/rtems/ratemon.h,
	rtems/include/rtems/rtems/region.h,
	rtems/include/rtems/rtems/regionmp.h,
	rtems/include/rtems/rtems/rtemsapi.h,
	rtems/include/rtems/rtems/sem.h, rtems/include/rtems/rtems/semmp.h,
	rtems/include/rtems/rtems/signal.h,
	rtems/include/rtems/rtems/signalmp.h,
	rtems/include/rtems/rtems/status.h,
	rtems/include/rtems/rtems/support.h,
	rtems/include/rtems/rtems/taskmp.h,
	rtems/include/rtems/rtems/tasks.h, rtems/include/rtems/rtems/timer.h,
	rtems/include/rtems/rtems/types.h, rtems/inline/rtems/rtems/asr.inl,
	rtems/inline/rtems/rtems/attr.inl,
	rtems/inline/rtems/rtems/barrier.inl,
	rtems/inline/rtems/rtems/dpmem.inl,
	rtems/inline/rtems/rtems/event.inl,
	rtems/inline/rtems/rtems/message.inl,
	rtems/inline/rtems/rtems/modes.inl,
	rtems/inline/rtems/rtems/options.inl,
	rtems/inline/rtems/rtems/part.inl,
	rtems/inline/rtems/rtems/ratemon.inl,
	rtems/inline/rtems/rtems/region.inl,
	rtems/inline/rtems/rtems/sem.inl,
	rtems/inline/rtems/rtems/status.inl,
	rtems/inline/rtems/rtems/support.inl,
	rtems/inline/rtems/rtems/timer.inl: More Doxygen improvements.
---
 cpukit/rtems/include/rtems/rtems/message.h | 25 ++++++++++++++++++++++---
 1 file changed, 22 insertions(+), 3 deletions(-)

(limited to 'cpukit/rtems/include/rtems/rtems/message.h')

diff --git a/cpukit/rtems/include/rtems/rtems/message.h b/cpukit/rtems/include/rtems/rtems/message.h
index 4cd6b7ba94..af81e7ea60 100644
--- a/cpukit/rtems/include/rtems/rtems/message.h
+++ b/cpukit/rtems/include/rtems/rtems/message.h
@@ -17,7 +17,7 @@
  *     - flush all messages on a queue
  */
 
-/*  COPYRIGHT (c) 1989-2007.
+/*  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
@@ -30,6 +30,12 @@
 #ifndef _RTEMS_RTEMS_MESSAGE_H
 #define _RTEMS_RTEMS_MESSAGE_H
 
+/**
+ *  This constant is defined to extern most of the time when using 
+ *  this header file.  However by defining it to nothing, the data
+ *  declared in this header file can be instantiated.  This is done
+ *  in a single per manager file.
+ */
 #ifndef RTEMS_MESSAGE_EXTERN
 #define RTEMS_MESSAGE_EXTERN extern
 #endif
@@ -52,13 +58,21 @@ extern "C" {
  */
 /**@{*/
 
-/*
+/**
  *  The following enumerated type details the modes in which a message
  *  may be submitted to a message queue.  The message may be posted
  *  in a send or urgent fashion.
  */
 typedef enum {
+  /**
+   *  This value indicates the user wants to send the message using the
+   *  normal message insertion protocol (FIFO or priority).
+   */
   MESSAGE_QUEUE_SEND_REQUEST   = 0,
+  /**
+   *  This value indicates the user considers the message to be urgent
+   *  and wants it inserted at the head of the pending message queue.
+   */
   MESSAGE_QUEUE_URGENT_REQUEST = 1
 }  Message_queue_Submit_types;
 
@@ -67,12 +81,15 @@ typedef enum {
  *  each message queue.
  */
 typedef struct {
+  /** This field is the inherited obejct characteristics. */
   Objects_Control             Object;
+  /** This field is the attribute set as defined by the API. */
   rtems_attribute             attribute_set;
+  /** This field is the instance of the SuperCore Message Queue. */
   CORE_message_queue_Control  message_queue;
 }   Message_queue_Control;
 
-/*
+/**
  *  The following defines the information control block used to
  *  manage this class of objects.
  */
@@ -292,5 +309,7 @@ void  _Message_queue_Core_message_queue_mp_support (
 }
 #endif
 
+/**@}*/
+
 #endif
 /* end of include file */
-- 
cgit v1.2.3