cpukit/rtems: Header File Doxygen Enhancement GCI Task #8

http://www.google-melange.com/gci/task/view/google/gci2012/7948217

cpukit/rtems/include/rtems/rtems/asr.h

@@ -1,6 +1,8 @@
 /**
  * @file rtems/rtems/asr.h
  *
+ * @brief Constants and Structures Associated with the Asynchronous Signal Handler
+ *
  *  This include file contains all the constants and structures associated
  *  with the Asynchronous Signal Handler.  This Handler provides the low-level
  *  support required by the Signal Manager.

cpukit/rtems/include/rtems/rtems/barrier.h

@@ -1,6 +1,8 @@
 /**
  * @file rtems/rtems/barrier.h
  *
+ * @brief Constants and Structures Associated with the Barrier Manager
+ *
  *  This include file contains all the constants and structures associated
  *  with the Barrier Manager.
  *

cpukit/rtems/include/rtems/rtems/cache.h

@@ -1,6 +1,8 @@
 /**
  * @file rtems/rtems/cache.h
  *
+ * @brief Functionality Associated with the Cache Manager
+ *
  *  Cache Manager
  */
 

cpukit/rtems/include/rtems/rtems/clock.h

@@ -1,6 +1,8 @@
 /**
  * @file rtems/rtems/clock.h
  *
+ * @brief Constants and Structures Associated with the Clock Manager
+ *
  *  This include file contains all the constants and structures associated
  *  with the Clock Manager.  This manager provides facilities to set, obtain,
  *  and continually update the current date and time.

cpukit/rtems/include/rtems/rtems/config.h

@@ -1,6 +1,8 @@
 /**
  * @file rtems/rtems/config.h
  *
+ * @brief Records Which Define the Configuration Table
+ *
  *  This include file contains the table of user defined configuration
  *  parameters specific for the RTEMS API.
  */

cpukit/rtems/include/rtems/rtems/event.h

@@ -1,6 +1,8 @@
 /**
  * @file rtems/rtems/event.h
  *
+ * @brief Information Related to the Event Manager
+ *
  *  This include file contains the information pertaining to the Event
  *  Manager.  This manager provides a high performance method of communication
  *  and synchronization.

cpukit/rtems/include/rtems/rtems/eventset.h

@@ -1,6 +1,8 @@
 /**
  * @file rtems/rtems/eventset.h
  *
+ * @brief Information Related to the Event Sets Handler
+ *
  *  This include file contains the information pertaining to the
  *  Event Sets Handler.  This handler provides methods for the manipulation
  *  of event sets which will be sent and received by tasks.

cpukit/rtems/include/rtems/rtems/message.h

@@ -1,6 +1,8 @@
 /**
  * @file rtems/rtems/message.h
  *
+ * @brief Constants and Structures Associated with the Message Queue Manager
+ *
  *  This include file contains all the constants and structures associated
  *  with the Message Queue Manager.  This manager provides a mechanism for
  *  communication and synchronization between tasks using messages.

cpukit/rtems/include/rtems/rtems/modes.h

@@ -1,6 +1,8 @@
 /**
  * @file rtems/rtems/modes.h
  *
+ * @brief Constants and Structures Associated with the RTEMS thread and RTEMS_ASR modes
+ *
  *  This include file contains all constants and structures associated
  *  with the RTEMS thread and RTEMS_ASR modes.
  */

cpukit/rtems/include/rtems/rtems/options.h

@@ -1,6 +1,8 @@
 /**
  * @file rtems/rtems/options.h
  *
+ * @brief Information Which Defines the Options Available on Many Directives.
+ *
  *  This include file contains information which defines the
  *  options available on many directives.
  */

cpukit/rtems/include/rtems/rtems/part.h

@@ -1,6 +1,8 @@
 /**
  * @file rtems/rtems/part.h
  *
+ * @brief Constants and Structures Associated with the Partition Manager
+ *
  *  This include file contains all the constants and structures associated
  *  with the Partition Manager.  This manager provides facilities to
  *  dynamically allocate memory in fixed-sized units which are returned

cpukit/rtems/include/rtems/rtems/ratemon.h

@@ -1,6 +1,8 @@
 /**
  * @file rtems/rtems/ratemon.h
  *
+ * @brief Constants, Structures, and Prototypes Associated to the Classic API Rate Monotonic Manager.
+ *
  *  This include file contains all the constants, structures, and
  *  prototypes associated with the Rate Monotonic Manager.  This manager
  *  provides facilities to implement threads which execute in a periodic

cpukit/rtems/include/rtems/rtems/region.h

@@ -1,6 +1,8 @@
 /**
  * @file rtems/rtems/region.h
  *
+ * @brief Constants and Structures Associated with the Region Manager
+ *
  *  This include file contains all the constants and structures associated
  *  with the Region Manager.  This manager provides facilities to dynamically
  *  allocate memory in variable sized units which are returned as segments.

cpukit/rtems/include/rtems/rtems/status.h

@@ -1,6 +1,8 @@
 /**
  * @file rtems/rtems/status.h
  *
+ * @brief Status Codes Returned from the Executive Directives
+ *
  *  This include file contains the status codes returned from the
  *  executive directives.
  */

cpukit/rtems/include/rtems/rtems/timer.h

@@ -1,6 +1,8 @@
 /**
  * @file rtems/rtems/timer.h
  *
+ * @brief Constants, Structures, and Prototypes Associated with the Timer Manager
+ *
  *  This include file contains all the constants, structures, and
  *  prototypes associated with the Timer Manager.  This manager provides
  *  facilities to configure, initiate, cancel, and delete timers which will