rtems misc: Clean up Doxygen GCI Task #7

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

10 files changed, 114 insertions, 21 deletions

diff --git a/cpukit/rtems/include/rtems/rtems/clock.h b/cpukit/rtems/include/rtems/rtems/clock.h
index c841d1a4f8..fc6a584ab9 100644
--- a/cpukit/rtems/include/rtems/rtems/clock.h
+++ b/cpukit/rtems/include/rtems/rtems/clock.h
@@ -243,7 +243,7 @@ void rtems_clock_get_uptime_timeval( struct timeval *uptime );
 time_t rtems_clock_get_uptime_seconds( void );
 
 /**
- *  @brief _TOD_Validate
+ *  @brief TOD Validate
  *
  *  This support function returns true if @a the_tod contains
  *  a valid time of day, and false otherwise.
@@ -251,6 +251,8 @@ 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(
   const rtems_time_of_day *the_tod
diff --git a/cpukit/rtems/include/rtems/rtems/dpmem.h b/cpukit/rtems/include/rtems/rtems/dpmem.h
index e305b31823..5186fa1049 100644
--- a/cpukit/rtems/include/rtems/rtems/dpmem.h
+++ b/cpukit/rtems/include/rtems/rtems/dpmem.h
@@ -166,11 +166,20 @@ rtems_status_code rtems_port_external_to_internal(
 );
 
 /**
- *  @brief rtems_port_internal_to_external
+ *  @brief RTEMS Port Internal to External
  *
  *  This routine implements the Port_internal_to_external directive.
  *  It returns the external port address which maps to the provided
- *  internal port address for the specified port ID.
+ *  internal port address for the specified port ID.  If the given
+ *  internal address is an invalid dual-ported address, then the
+ *  external address is set to the given internal address.
+ * 
+ *  @param[in] id is the id of dual-ported memory object
+ *  @param[in] internal is the internal address to set
+ *  @param[in] external is the pointer to external address
+ * 
+ *  @return RTEMS_SUCCESSFUL and the external will be filled in 
+ *  with the external addresses
  */
 rtems_status_code rtems_port_internal_to_external(
   rtems_id     id,
diff --git a/cpukit/rtems/include/rtems/rtems/message.h b/cpukit/rtems/include/rtems/rtems/message.h
index 9990b146da..10da6023d6 100644
--- a/cpukit/rtems/include/rtems/rtems/message.h
+++ b/cpukit/rtems/include/rtems/rtems/message.h
@@ -234,7 +234,7 @@ rtems_status_code rtems_message_queue_broadcast(
 );
 
 /**
- *  @brief rtems_message_queue_receive
+ *  @brief RTEMS Message Queue Receive
  *
  *  This routine implements the rtems_message_queue_receive directive.
  *  This directive is invoked when the calling task wishes to receive
@@ -242,7 +242,17 @@ rtems_status_code rtems_message_queue_broadcast(
  *  message is to be placed in buffer.  If no messages are outstanding
  *  and the option_set indicates that the task is willing to block,
  *  then the task will be blocked until a message arrives or until,
- *  optionally, timeout clock ticks have passed.
+ *  optionally, timeout clock ticks have passed. 
+ * 
+ *  @param[in] id is the queue id
+ *  @param[in] buffer is the pointer to message buffer
+ *  @param[in] size is the size of message receive
+ *  @param[in] option_set is the options on receive
+ *  @param[in] timeout is the number of ticks to wait
+ * 
+ *  @return This method returns RTEMS_SUCCESSFUL if there was not an
+ *          error.  Otherwise, a status code is returned indicating the
+ *          source of the error.
  */
 rtems_status_code rtems_message_queue_receive(
   rtems_id        id,
diff --git a/cpukit/rtems/include/rtems/rtems/part.h b/cpukit/rtems/include/rtems/rtems/part.h
index d46be0a6c4..ebdc845bea 100644
--- a/cpukit/rtems/include/rtems/rtems/part.h
+++ b/cpukit/rtems/include/rtems/rtems/part.h
@@ -135,10 +135,17 @@ rtems_status_code rtems_partition_ident(
 );
 
 /**
- *  @brief rtems_partition_delete
+ *  @brief RTEMS Delete Partition
  *
  *  This routine implements the rtems_partition_delete directive.  The
- *  partition indicated by ID is deleted.
+ *  partition indicated by ID is deleted, provided that none of its buffers
+ *  are still allocated.
+ * 
+ *  @param[in] id is the partition 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.
  */
 rtems_status_code rtems_partition_delete(
   rtems_id id
diff --git a/cpukit/rtems/include/rtems/rtems/ratemon.h b/cpukit/rtems/include/rtems/rtems/ratemon.h
index 93c8e26ba5..9b0d1de5f9 100644
--- a/cpukit/rtems/include/rtems/rtems/ratemon.h
+++ b/cpukit/rtems/include/rtems/rtems/ratemon.h
@@ -269,6 +269,8 @@ RTEMS_RATEMON_EXTERN Objects_Information _Rate_monotonic_Information;
  *  @brief Rate Monotonic Manager Initialization
  *
  *  This routine performs the initialization necessary for this manager.
+ * 
+ *  @note The Rate Monotonic Manager is built on top of the Watchdog Handler
  */
 void _Rate_monotonic_Manager_initialization(void);
 
@@ -285,11 +287,19 @@ rtems_status_code rtems_rate_monotonic_create(
 );
 
 /**
- *  @brief rtems_rate_monotonic_ident
+ *  @brief RTEMS Rate Monotonic Name to Id
  *
  *  This routine implements the rtems_rate_monotonic_ident directive.
  *  It returns the period ID associated with name.  If more than one period
  *  is named name, then the period to which the ID belongs is arbitrary.
+ * 
+ *  @param[in] name is the user defined period name
+ *  @param[in] id is the pointer to period 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
+ *          be filled in with the region id.
  */
 rtems_status_code rtems_rate_monotonic_ident(
   rtems_name    name,
@@ -314,10 +324,16 @@ rtems_status_code rtems_rate_monotonic_cancel(
 );
 
 /**
- *  @brief rtems_rate_monotonic_delete
+ *  @brief RTEMS Delete Rate Monotonic
  *
  *  This routine implements the rtems_rate_monotonic_delete directive.  The
  *  period indicated by ID is deleted.
+ * 
+ *  @param[in] id is the rate monotonic 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.
  */
 rtems_status_code rtems_rate_monotonic_delete(
   rtems_id   id
@@ -328,6 +344,13 @@ rtems_status_code rtems_rate_monotonic_delete(
  *
  *  This routine implements the rtems_rate_monotonic_get_status directive.
  *  Information about the period indicated by ID is returned.
+ * 
+ *  @param[in] id is the rate monotonic id
+ *  @param[in] status is the pointer to status control 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.
  *
  */
 rtems_status_code rtems_rate_monotonic_get_status(
@@ -370,10 +393,13 @@ rtems_status_code rtems_rate_monotonic_reset_statistics(
 void rtems_rate_monotonic_reset_all_statistics( void );
 
 /**
- *  @brief rtems_rate_monotonic_report_statistics
+ *  @brief RTEMS Report Rate Monotonic Statistics
  *
  *  This routine allows a thread to print the statistics information
  *  on ALL period instances which have non-zero counts using printk.
+ *  The implementation of this directive straddles the fence between
+ *  inside and outside of RTEMS.  It is presented as part of the Manager
+ *  but actually uses other services of the Manager.
  */
 void rtems_rate_monotonic_report_statistics_with_plugin(
   void                  *context,
@@ -381,7 +407,7 @@ void rtems_rate_monotonic_report_statistics_with_plugin(
 );
 
 /**
- *  @brief rtems_rate_monotonic_report_statistics
+ *  @brief RTEMS Report Rate Monotonic Statistics
  *
  *  This routine allows a thread to print the statistics information
  *  on ALL period instances which have non-zero counts using printk.
diff --git a/cpukit/rtems/include/rtems/rtems/region.h b/cpukit/rtems/include/rtems/rtems/region.h
index f58bdff53d..b183b9dfcc 100644
--- a/cpukit/rtems/include/rtems/rtems/region.h
+++ b/cpukit/rtems/include/rtems/rtems/region.h
@@ -170,11 +170,20 @@ rtems_status_code rtems_region_get_information(
 );
 
 /**
- *  @brief rtems_region_get_free_information
+ *  @brief RTEMS Get Region Free Information
  *
  *  This routine implements the rtems_region_get_free_information directive.
  *  This directive returns information about the free blocks in the
- *  heap associated with this region.
+ *  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
+ *          be filled in with the region information block.
  */
 rtems_status_code rtems_region_get_free_information(
   rtems_id                id,
diff --git a/cpukit/rtems/include/rtems/rtems/sem.h b/cpukit/rtems/include/rtems/rtems/sem.h
index aedc5ea961..4fcf93e94c 100644
--- a/cpukit/rtems/include/rtems/rtems/sem.h
+++ b/cpukit/rtems/include/rtems/rtems/sem.h
@@ -168,7 +168,7 @@ rtems_status_code rtems_semaphore_delete(
 );
 
 /**
- *  @brief rtems_semaphore_obtain
+ *  @brief RTEMS Obtain Semaphore
  *
  *  This routine implements the rtems_semaphore_obtain directive.  It
  *  attempts to obtain a unit from the semaphore associated with ID.
@@ -177,6 +177,14 @@ rtems_status_code rtems_semaphore_delete(
  *  block waiting for a unit with an optional timeout of timeout
  *  clock ticks.  Whether the task blocks or returns immediately
  *  is based on the RTEMS_NO_WAIT option in the option_set.
+ * 
+ *  @param[in] id is the semaphore id
+ *  @param[in] option_set is the wait option
+ *  @param[in] timeout is the number of ticks to wait (0 means wait forever)
+ * 
+ *  @return This method returns RTEMS_SUCCESSFUL if there was not an
+ *          error.  Otherwise, a status code is returned indicating the
+ *          source of the error.
  */
 rtems_status_code rtems_semaphore_obtain(
   rtems_id       id,
diff --git a/cpukit/rtems/include/rtems/rtems/support.h b/cpukit/rtems/include/rtems/rtems/support.h
index 99bf405a21..30716de72f 100644
--- a/cpukit/rtems/include/rtems/rtems/support.h
+++ b/cpukit/rtems/include/rtems/rtems/support.h
@@ -63,7 +63,7 @@ extern "C" {
  */
 
 /**
- * @brief Gets workspace information.
+ * @brief Gets Workspace Information
  *
  * Returns information about the heap that is used as the RTEMS Executive
  * Workspace in @a the_info.
@@ -75,7 +75,7 @@ bool rtems_workspace_get_information(
 );
 
 /**
- * @brief Allocates memory from the workspace.
+ * @brief Allocates Memory from the Workspace
  *
  * A number of @a bytes bytes will be allocated from the RTEMS Executive
  * Workspace and returned in @a pointer.
@@ -88,7 +88,7 @@ bool rtems_workspace_allocate(
 );
 
 /**
- * @brief Frees memory allocated from the workspace.
+ * @brief Frees Memory Allocated from the Workspace
  *
  * This frees the memory indicated by @a pointer that was allocated from the
  * RTEMS Executive Workspace.
diff --git a/cpukit/rtems/include/rtems/rtems/tasks.h b/cpukit/rtems/include/rtems/rtems/tasks.h
index abd7d1f946..7ec65a9fbe 100644
--- a/cpukit/rtems/include/rtems/rtems/tasks.h
+++ b/cpukit/rtems/include/rtems/rtems/tasks.h
@@ -362,12 +362,19 @@ rtems_status_code rtems_task_set_note(
 );
 
 /**
- *  @brief rtems_task_mode
+ *  @brief RTEMS Task Mode
  *
  *  This routine implements the rtems_task_mode directive.  The current
  *  values of the modes indicated by mask of the calling task are changed
  *  to that indicated in mode_set.  The former mode of the task is
  *  returned in mode_set.
+ * 
+ *  @param[in] mode_set is the new mode
+ *  @param[in] mask is the mask
+ *  @param[in] previous_mode_set is the address of previous mode set
+ * 
+ *  @return RTEMS_SUCCESSFUL and previous_mode_set filled in with the 
+ *  previous mode set
  */
 rtems_status_code rtems_task_mode(
   rtems_mode  mode_set,
@@ -499,7 +506,7 @@ rtems_status_code rtems_task_is_suspended(
 );
 
 /**
- *  @brief rtems_task_variable_add
+ *  @brief RTEMS Add Task Variable
  *
  *  This directive adds a per task variable.
  */
diff --git a/cpukit/rtems/include/rtems/rtems/timer.h b/cpukit/rtems/include/rtems/rtems/timer.h
index b7ab2e2743..5a908eb475 100644
--- a/cpukit/rtems/include/rtems/rtems/timer.h
+++ b/cpukit/rtems/include/rtems/rtems/timer.h
@@ -275,23 +275,38 @@ rtems_status_code rtems_timer_cancel(
 );
 
 /**
- *  @brief rtems_timer_delete
+ *  @brief RTEMS Delete Timer
  *
  *  This routine implements the rtems_timer_delete directive.  The
  *  timer indicated by ID is deleted.
+ * 
+ *  @param[in] id is the timer 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.
  */
 rtems_status_code rtems_timer_delete(
   rtems_id   id
 );
 
 /**
- *  @brief rtems_timer_fire_after
+ *  @brief RTEMS Timer Fire After
  *
  *  This routine implements the rtems_timer_fire_after directive.  It
  *  initiates the timer associated with ID to fire in ticks clock ticks.
  *  When the timer fires, the routine will be invoked in the context
  *  of the rtems_clock_tick directive which is normally invoked as
  *  part of servicing a periodic interupt.
+ * 
+ *  @param[in] id is the timer id
+ *  @param[in] ticks is the interval until routine is fired
+ *  @param[in] routine is the routine to schedule
+ *  @param[in] user_data is the passed as argument to routine when it is fired
+ * 
+ *  @return This method returns RTEMS_SUCCESSFUL if there was not an
+ *          error.  Otherwise, a status code is returned indicating the
+ *          source of the error.
  */
 rtems_status_code rtems_timer_fire_after(
   rtems_id                           id,