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.

1 files changed, 24 insertions, 5 deletions

diff --git a/cpukit/rtems/include/rtems/rtems/options.h b/cpukit/rtems/include/rtems/rtems/options.h
index a0f5c444d6..240854519c 100644
--- a/cpukit/rtems/include/rtems/rtems/options.h
+++ b/cpukit/rtems/include/rtems/rtems/options.h
@@ -5,7 +5,7 @@
  *  options available on many directives.
  */
 
-/*  COPYRIGHT (c) 1989-1999.
+/*  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
@@ -41,11 +41,28 @@ typedef uint32_t   rtems_option;
  */
 #define RTEMS_DEFAULT_OPTIONS   0x00000000
 
-#define RTEMS_WAIT      0x00000000        /* wait on resource */
-#define RTEMS_NO_WAIT   0x00000001        /* do not wait on resource */
+/**
+ *  This option constants indicates that the task is to wait on resource.
+ */
+#define RTEMS_WAIT      0x00000000
+/**
+ *  This option constants indicates that the task is to not wait on
+ *  the resource.  If it is not available, return immediately with
+ *  a status to indicate unsatisfied.
+ */
+#define RTEMS_NO_WAIT   0x00000001
+
+/**
+ *  This option constants indicates that the task wishes to wait until
+ *  all events of interest are available.
+ */
+#define RTEMS_EVENT_ALL 0x00000000
 
-#define RTEMS_EVENT_ALL 0x00000000        /* wait for all events */
-#define RTEMS_EVENT_ANY 0x00000002        /* wait on any event */
+/**
+ *  This option constants indicates that the task wishes to wait until
+ *  ANY events of interest are available.
+ */
+#define RTEMS_EVENT_ANY 0x00000002
 
 #ifndef __RTEMS_APPLICATION__
 #include <rtems/rtems/options.inl>
@@ -55,5 +72,7 @@ typedef uint32_t   rtems_option;
 }
 #endif
 
+/**@}*/
+
 #endif
 /* end of include file */