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, 116 insertions, 15 deletions

diff --git a/cpukit/rtems/include/rtems/rtems/attr.h b/cpukit/rtems/include/rtems/rtems/attr.h
index 8c1bf99b2d..23ddce1bad 100644
--- a/cpukit/rtems/include/rtems/rtems/attr.h
+++ b/cpukit/rtems/include/rtems/rtems/attr.h
@@ -5,7 +5,7 @@
  *  Handler.
  */
 
-/*  COPYRIGHT (c) 1989-1999.
+/*  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
@@ -29,51 +29,152 @@ extern "C" {
  */
 /**@{*/
 
-/* types */
-
+/**
+ *  This defines the type used to contain Classic API attributes.  These
+ *  are primarily used when creating objects.
+ */
 typedef uint32_t   rtems_attribute;
 
-/* constants */
+/** This is the default value for an attribute set. */
 
 #define RTEMS_DEFAULT_ATTRIBUTES  0x00000000
 
-#define RTEMS_LOCAL               0x00000000 /* local resource */
-#define RTEMS_GLOBAL              0x00000002 /* global resource */
+/**
+ *  This is the attribute constant to indicate local resource.
+ */
+#define RTEMS_LOCAL               0x00000000
 
-#define RTEMS_FIFO                0x00000000 /* process RTEMS_FIFO */
-#define RTEMS_PRIORITY            0x00000004 /* process by priority */
+/**
+ *  This is the attribute constant to indicate global resource.
+ */
+#define RTEMS_GLOBAL              0x00000002
 
-        /* RTEMS Task Specific Attributes */
-#define RTEMS_NO_FLOATING_POINT   0x00000000 /* don't use FP HW */
-#define RTEMS_FLOATING_POINT      0x00000001 /* utilize coprocessor */
+/** 
+ *  This is the attribute constant which reflects that blocking
+ *  tasks will be managed using FIFO discipline.
+ */
+#define RTEMS_FIFO                0x00000000
 
-        /* RTEMS Semaphore Specific Attributes */
-#define RTEMS_SEMAPHORE_CLASS         0x00000030 /* mask */
+/** 
+ *  This is the attribute constant which reflects that blocking
+ *  tasks will be managed using task priority discipline.
+ */
+#define RTEMS_PRIORITY            0x00000004
+
+/******************** RTEMS Task Specific Attributes *********************/
+
+/**
+ *  This attribute constant indicates that the task will not use the
+ *  floating point hardware.  If the architecture permits it, then
+ *  the FPU will be disabled when the task is executing.
+ */
+#define RTEMS_NO_FLOATING_POINT   0x00000000
+
+/**
+ *  This attribute constant indicates that the task will use the
+ *  floating point hardware.  There will be a floating point
+ *  context associated with this task.
+ */
+#define RTEMS_FLOATING_POINT      0x00000001
+
+/***************** RTEMS Semaphore Specific Attributes ********************/
+
+/**
+ *  This is the mask for the attribute bits associated with the
+ *  Classic API Semaphore Manager.
+ */
+#define RTEMS_SEMAPHORE_CLASS         0x00000030
+
+/**
+ *  This attribute constant indicates that the Classic API Semaphore
+ *  instance created will be a counting semaphore.
+ */
 #define RTEMS_COUNTING_SEMAPHORE      0x00000000
+
+/**
+ *  This attribute constant indicates that the Classic API Semaphore
+ *  instance created will be a proper binary semaphore or mutex.
+ */
 #define RTEMS_BINARY_SEMAPHORE        0x00000010
+
+/**
+ *  This attribute constant indicates that the Classic API Semaphore
+ *  instance created will be a simple binary semaphore.
+ */
 #define RTEMS_SIMPLE_BINARY_SEMAPHORE 0x00000020
 
+/**
+ *  This attribute constant indicates that the Classic API Semaphore
+ *  instance created will NOT use the Priority Inheritance Protocol.
+ */
 #define RTEMS_NO_INHERIT_PRIORITY     0x00000000
+
+/**
+ *  This attribute constant indicates that the Classic API Semaphore
+ *  instance created will use the Priority Inheritance Protocol.
+ *
+ *  @note The semaphore instance must be a binary semaphore.
+ */
 #define RTEMS_INHERIT_PRIORITY        0x00000040
 
+/**
+ *  This attribute constant indicates that the Classic API Semaphore
+ *  instance created will NOT use the Priority Ceiling Protocol.
+ */
 #define RTEMS_NO_PRIORITY_CEILING     0x00000000
+
+/**
+ *  This attribute constant indicates that the Classic API Semaphore
+ *  instance created will use the Priority Ceiling Protocol.
+ *
+ *  @note The semaphore instance must be a binary semaphore.
+ */
 #define RTEMS_PRIORITY_CEILING        0x00000080
 
-        /* RTEMS Barrier Specific Attributes */
+/******************** RTEMS Barrier Specific Attributes ********************/
+
+/**
+ *  This attribute constant indicates that the Classic API Barrier
+ *  instance created will use an automatic release protocol.
+ */
 #define RTEMS_BARRIER_AUTOMATIC_RELEASE 0x00000010
+
+/**
+ *  This attribute constant indicates that the Classic API Barrier
+ *  instance created will use the manual release protocol.
+ */
 #define RTEMS_BARRIER_MANUAL_RELEASE    0x00000000
 
-        /* RTEMS Internal Task Specific Attributes */
+/**************** RTEMS Internal Task Specific Attributes ****************/
+
+/**
+ *  This attribute constant indicates that the task was created
+ *  by the application using normal Classic API methods.
+ */
 #define RTEMS_APPLICATION_TASK        0x00000000
+
+/**
+ *  This attribute constant indicates that the task was created
+ *  by RTEMS as a support task.
+ */
 #define RTEMS_SYSTEM_TASK             0x00008000
 
+/****************** Forced Attributes in Configuration ****************/
 
+/**
+ *  This attribute constant indicates the attributes that are not
+ *  supportable given the hardware configuration.
+ */
 #if ( CPU_HARDWARE_FP == TRUE ) || ( CPU_SOFTWARE_FP == TRUE )
 #define ATTRIBUTES_NOT_SUPPORTED       0
 #else
 #define ATTRIBUTES_NOT_SUPPORTED       RTEMS_FLOATING_POINT
 #endif
 
+/**
+ *  This attribute constant indicates the attributes that are
+ *  required given the hardware configuration.
+ */
 #if ( CPU_ALL_TASKS_ARE_FP == TRUE )
 #define ATTRIBUTES_REQUIRED            RTEMS_FLOATING_POINT
 #else