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

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

15 files changed, 48 insertions, 18 deletions

diff --git a/cpukit/rtems/include/rtems/rtems/asr.h b/cpukit/rtems/include/rtems/rtems/asr.h
index dae0dd8474..372f4c7073 100644
--- a/cpukit/rtems/include/rtems/rtems/asr.h
+++ b/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.
diff --git a/cpukit/rtems/include/rtems/rtems/barrier.h b/cpukit/rtems/include/rtems/rtems/barrier.h
index 340c6a16ac..b7e74839a5 100644
--- a/cpukit/rtems/include/rtems/rtems/barrier.h
+++ b/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.
  *
diff --git a/cpukit/rtems/include/rtems/rtems/cache.h b/cpukit/rtems/include/rtems/rtems/cache.h
index 2c266c5774..95cf14f741 100644
--- a/cpukit/rtems/include/rtems/rtems/cache.h
+++ b/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
  */
 
@@ -152,7 +154,7 @@ void rtems_cache_disable_instruction( void );
  *  integral number of cache blocks.
  */
 void *rtems_cache_aligned_malloc ( size_t nbytes );
-  
+
 #ifdef __cplusplus
 }
 #endif
diff --git a/cpukit/rtems/include/rtems/rtems/clock.h b/cpukit/rtems/include/rtems/rtems/clock.h
index 7eaa2cbf3e..549dc798c9 100644
--- a/cpukit/rtems/include/rtems/rtems/clock.h
+++ b/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.
@@ -257,7 +259,7 @@ time_t rtems_clock_get_uptime_seconds( void );
  *  @param[in] the_tod is the TOD structure to validate
  *
  *  @return This method returns true if the TOD is valid and false otherwise.
- * 
+ *
  *  @note This routine only works for leap-years through 2099.
  */
 bool _TOD_Validate(
diff --git a/cpukit/rtems/include/rtems/rtems/config.h b/cpukit/rtems/include/rtems/rtems/config.h
index be3a14248c..e4ac509d88 100644
--- a/cpukit/rtems/include/rtems/rtems/config.h
+++ b/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.
  */
diff --git a/cpukit/rtems/include/rtems/rtems/event.h b/cpukit/rtems/include/rtems/rtems/event.h
index c099f9b88e..6c265c3f40 100644
--- a/cpukit/rtems/include/rtems/rtems/event.h
+++ b/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.
diff --git a/cpukit/rtems/include/rtems/rtems/eventset.h b/cpukit/rtems/include/rtems/rtems/eventset.h
index d543ba5583..632e217c79 100644
--- a/cpukit/rtems/include/rtems/rtems/eventset.h
+++ b/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.
diff --git a/cpukit/rtems/include/rtems/rtems/message.h b/cpukit/rtems/include/rtems/rtems/message.h
index 4f44f730b1..9ad1e9b9ef 100644
--- a/cpukit/rtems/include/rtems/rtems/message.h
+++ b/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.
diff --git a/cpukit/rtems/include/rtems/rtems/modes.h b/cpukit/rtems/include/rtems/rtems/modes.h
index f80cb449cc..6ac7d15773 100644
--- a/cpukit/rtems/include/rtems/rtems/modes.h
+++ b/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.
  */
diff --git a/cpukit/rtems/include/rtems/rtems/options.h b/cpukit/rtems/include/rtems/rtems/options.h
index 8746e5516e..6b30cc3044 100644
--- a/cpukit/rtems/include/rtems/rtems/options.h
+++ b/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.
  */
diff --git a/cpukit/rtems/include/rtems/rtems/part.h b/cpukit/rtems/include/rtems/rtems/part.h
index e62e9043fc..ff1cedd823 100644
--- a/cpukit/rtems/include/rtems/rtems/part.h
+++ b/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
diff --git a/cpukit/rtems/include/rtems/rtems/ratemon.h b/cpukit/rtems/include/rtems/rtems/ratemon.h
index 475a90a5be..2ea3d23a13 100644
--- a/cpukit/rtems/include/rtems/rtems/ratemon.h
+++ b/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
diff --git a/cpukit/rtems/include/rtems/rtems/region.h b/cpukit/rtems/include/rtems/rtems/region.h
index 5ab0e47347..73d66d290d 100644
--- a/cpukit/rtems/include/rtems/rtems/region.h
+++ b/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.
@@ -123,11 +125,11 @@ rtems_status_code rtems_region_create(
  *  region will have the name name.  The memory area managed by
  *  the region will be attempted to be grown by length bytes using
  *  the memory starting at starting_address.
- * 
+ *
  *  @param[in] id is the id of region to grow
  *  @param[in] starting_address starting address of memory area for extension
  *  @param[in] length is the physical length in bytes to grow the region
- * 
+ *
  *  @return This method returns RTEMS_SUCCESSFUL if there was not an
  *          error.  Otherwise, a status code is returned indicating the
  *          source of the error.
@@ -145,10 +147,10 @@ rtems_status_code rtems_region_extend(
  *  This directive returns the region ID associated with name.
  *  If more than one region is named name, then the region
  *  to which the ID belongs is arbitrary.
- * 
+ *
  *  @param[in] name is the user defined region name
  *  @param[in] id is the pointer to region id
- * 
+ *
  *  @return This method returns RTEMS_SUCCESSFUL if there was not an
  *          error.  Otherwise, a status code is returned indicating the
  *          source of the error.  If successful, the id will
@@ -184,10 +186,10 @@ rtems_status_code rtems_region_get_information(
  *  This directive returns information about the free blocks in the
  *  heap associated with this region.  Information about the used blocks
  *  will be returned as zero.
- * 
+ *
  *  @param[in] id is the region id
  *  @param[in] the_info is the pointer to region information block
- * 
+ *
  *  @return This method returns RTEMS_SUCCESSFUL if there was not an
  *          error.  Otherwise, a status code is returned indicating the
  *          source of the error.  If successful, the the_info will
@@ -204,9 +206,9 @@ rtems_status_code rtems_region_get_free_information(
  *  This routine implements the rtems_region_delete directive.  The
  *  region indicated by ID is deleted, provided that none of its segments are
  *  still allocated.
- * 
+ *
  *  @param[in] id is the region id
- * 
+ *
  *  @return This method returns RTEMS_SUCCESSFUL if there was not an
  *          error.  Otherwise, a status code is returned indicating the
  *          source of the error.
@@ -225,17 +227,17 @@ rtems_status_code rtems_region_delete(
  *  may return immediately or block waiting for a segment with an optional
  *  timeout of @a timeout clock ticks.  Whether the task blocks or returns
  *  immediately is based on the no_wait option in the @a option_set.
- * 
+ *
  *  @param[in] id is the region id
  *  @param[in] size is the segment size in bytes
  *  @param[in] option_set is the wait option
  *  @param[in] timeout is the number of ticks to wait (0 means wait forever)
  *  @param[in] segment is the pointer to segment address
- * 
+ *
  *  @return This method returns RTEMS_SUCCESSFUL if there was not an
  *          error.  Otherwise, a status code is returned indicating the
  *          source of the error.  If successful, the segment will
- *          be filled in with the segment address. 
+ *          be filled in with the segment address.
  */
 rtems_status_code rtems_region_get_segment(
   rtems_id           id,
@@ -250,11 +252,11 @@ rtems_status_code rtems_region_get_segment(
  *
  *  This routine implements the rtems_region_get_segment_size directive.  It
  *  returns the size in bytes of the specified user memory area.
- *  
+ *
  *  @param[in] id is the region id
  *  @param[in] segment is the segment address
  *  @param[in] size is the pointer to segment size in bytes
- * 
+ *
  *  @return This method returns RTEMS_SUCCESSFUL if there was not an
  *          error.  Otherwise, a status code is returned indicating the
  *          source of the error.  If successful, the size will
@@ -276,10 +278,10 @@ rtems_status_code rtems_region_get_segment_size(
  *  rtems_region_get_segment of the first blocked task, then that task and as
  *  many subsequent tasks as possible will be unblocked with their requests
  *  satisfied.
- *  
+ *
  *  @param[in] id is the region id
  *  @param[in] segment is the pointer to segment address
- * 
+ *
  *  @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful
  */
 rtems_status_code rtems_region_return_segment(
diff --git a/cpukit/rtems/include/rtems/rtems/status.h b/cpukit/rtems/include/rtems/rtems/status.h
index bb2646e24e..98923a0d53 100644
--- a/cpukit/rtems/include/rtems/rtems/status.h
+++ b/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.
  */
@@ -184,7 +186,7 @@ typedef enum {
 
 /**
  *  @brief Status Object Name Errors to Status Array
- * 
+ *
  *  This array is used to map SuperCore Object Handler return
  *  codes to Classic API status codes.
  */
diff --git a/cpukit/rtems/include/rtems/rtems/timer.h b/cpukit/rtems/include/rtems/rtems/timer.h
index d8c7760403..29c9f092ec 100644
--- a/cpukit/rtems/include/rtems/rtems/timer.h
+++ b/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