From 60ceb6133e96d2754f415c67fae769ba7a0bb1bd Mon Sep 17 00:00:00 2001
From: Alex Ivanov <alexivanov97@gmail.com>
Date: Wed, 5 Dec 2012 18:15:32 -0500
Subject: rtems misc: Clean up Doxygen GCI Task #6

http://www.google-melange.com/gci/task/view/google/gci2012/8019205
---
 cpukit/rtems/include/rtems/rtems/timer.h | 24 +++++++++++++++++++++---
 1 file changed, 21 insertions(+), 3 deletions(-)

(limited to 'cpukit/rtems/include/rtems/rtems/timer.h')

diff --git a/cpukit/rtems/include/rtems/rtems/timer.h b/cpukit/rtems/include/rtems/rtems/timer.h
index ee35fecce8..b7ab2e2743 100644
--- a/cpukit/rtems/include/rtems/rtems/timer.h
+++ b/cpukit/rtems/include/rtems/rtems/timer.h
@@ -222,7 +222,7 @@ RTEMS_TIMER_EXTERN Timer_server_Control *volatile _Timer_server;
 RTEMS_TIMER_EXTERN Objects_Information  _Timer_Information;
 
 /**
- *  @brief _Timer_Manager_initialization
+ *  @brief Timer Manager Initialization
  *
  *  This routine performs the initialization necessary for this manager.
  */
@@ -301,13 +301,22 @@ rtems_status_code rtems_timer_fire_after(
 );
 
 /**
- *  @brief rtems_timer_server_fire_after
+ *  @brief RTEMS Timer Server Fire After
  *
  *  This routine implements the rtems_timer_server_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 by the
  *  Timer Server in the context of a task NOT IN THE CONTEXT of the
  *  clock tick interrupt.
+ * 
+ *  @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_server_fire_after(
   rtems_id                           id,
@@ -317,13 +326,22 @@ rtems_status_code rtems_timer_server_fire_after(
 );
 
 /**
- *  @brief rtems_timer_fire_when
+ *  @brief RTEMS Timer Fire When
  *
  *  This routine implements the rtems_timer_fire_when directive.  It
  *  initiates the timer associated with ID to fire at wall_time
  *  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] wall_time is the time of day to fire timer
+ *  @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_when(
   rtems_id                            id,
-- 
cgit v1.2.3