rtems: Doxygen Clean Up Task #2

1 files changed, 108 insertions, 105 deletions

diff --git a/cpukit/rtems/include/rtems/rtems/timer.h b/cpukit/rtems/include/rtems/rtems/timer.h
index 29c9f092ec..f27f958d9a 100644
--- a/cpukit/rtems/include/rtems/rtems/timer.h
+++ b/cpukit/rtems/include/rtems/rtems/timer.h
@@ -1,38 +1,41 @@
 /**
  * @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
- *  fire at specified intervals of time.
- *
- *  Directives provided are:
- *
- *     - create a timer
- *     - get an ID of a timer
- *     - delete a timer
- *     - set timer to fire in context of clock tick
- *        - after a number of ticks have passed
- *        - when a specified date and time has been reached
- *     - initiate the timer server task
- *     - set timer to fire in context of the timer server task
- *        - after a number of ticks have passed
- *        - when a specified date and time has been reached
- *     - reset a timer
- *     - cancel a time
+ * @defgroup ClassicTimer Timers
+ *
+ * @ingroup ClassicRTEMS
+ * @brief Instantiate RTEMS Timer Data
+ *
+ * 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
+ * fire at specified intervals of time.
+ *
+ * Directives provided are:
+ *
+ * - create a timer
+ * - get an ID of a timer
+ * - delete a timer
+ * - set timer to fire in context of clock tick
+ * - after a number of ticks have passed
+ * - when a specified date and time has been reached
+ * - initiate the timer server task
+ * - set timer to fire in context of the timer server task
+ * - after a number of ticks have passed
+ * - when a specified date and time has been reached
+ * - reset a timer
+ * - cancel a time
  */
 
 /*
- *  COPYRIGHT (c) 1989-2011.
- *  On-Line Applications Research Corporation (OAR).
+ * COPYRIGHT (c) 1989-2011.
+ * On-Line Applications Research Corporation (OAR).
  *
- *  Copyright (c) 2009 embedded brains GmbH.
+ * Copyright (c) 2009 embedded brains GmbH.
  *
- *  The license and distribution terms for this file may be
- *  found in the file LICENSE in this distribution or at
- *  http://www.rtems.com/license/LICENSE.
+ * The license and distribution terms for this file may be
+ * found in the file LICENSE in this distribution or at
+ * http://www.rtems.com/license/LICENSE.
  */
 
 #ifndef _RTEMS_RTEMS_TIMER_H
@@ -231,16 +234,16 @@ RTEMS_TIMER_EXTERN Objects_Information  _Timer_Information;
 void _Timer_Manager_initialization(void);
 
 /**
- *  @brief RTEMS Create Timer
+ * @brief RTEMS Create Timer
  *
- *  This routine implements the rtems_timer_create directive.  The
- *  timer will have the name name.  It returns the id of the
- *  created timer in ID.
+ * This routine implements the rtems_timer_create directive. The
+ * timer will have the name name. It returns the id of the
+ * created timer in ID.
  *
- *  @param[in] name is the timer name
- *  @param[out] id is the pointer to timer id
+ * @param[in] name is the timer name
+ * @param[out] id is the pointer to timer id
  *
- *  @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful
+ * @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful
  */
 rtems_status_code rtems_timer_create(
   rtems_name    name,
@@ -248,18 +251,18 @@ rtems_status_code rtems_timer_create(
 );
 
 /**
- *  @brief RTEMS Timer Name to Id
+ * @brief RTEMS Timer Name to Id
  *
- *  This routine implements the rtems_timer_ident directive.
- *  This directive returns the timer ID associated with name.
- *  If more than one timer is named name, then the timer
- *  to which the ID belongs is arbitrary.
+ * This routine implements the rtems_timer_ident directive.
+ * This directive returns the timer ID associated with name.
+ * If more than one timer is named name, then the timer
+ * to which the ID belongs is arbitrary.
  *
- *  @param[in] name is the user defined message queue name
- *  @param[in] id is the pointer to timer id
+ * @param[in] name is the user defined message queue name
+ * @param[in] id is the pointer to timer id
  *
- *  @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and
- *  id filled with the message queue id
+ * @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful and
+ * id filled with the message queue id
  */
 rtems_status_code rtems_timer_ident(
   rtems_name    name,
@@ -277,38 +280,38 @@ rtems_status_code rtems_timer_cancel(
 );
 
 /**
- *  @brief RTEMS Delete Timer
+ * @brief RTEMS Delete Timer
  *
- *  This routine implements the rtems_timer_delete directive.  The
- *  timer indicated by ID is deleted.
+ * This routine implements the rtems_timer_delete directive. The
+ * timer indicated by ID is deleted.
  *
- *  @param[in] id is the timer id
+ * @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.
+ * @retval 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
- *
- *  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.
+ * @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
+ *
+ * @retval 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,
@@ -318,22 +321,22 @@ rtems_status_code rtems_timer_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.
+ * @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
+ *
+ * @retval 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,
@@ -343,22 +346,22 @@ rtems_status_code rtems_timer_server_fire_after(
 );
 
 /**
- *  @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.
+ * @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
+ *
+ * @retval 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,
@@ -435,16 +438,16 @@ typedef struct {
 } rtems_timer_information;
 
 /**
- *  @brief RTEMS Get Timer Information
+ * @brief RTEMS Get Timer Information
  *
- *  This routine implements the rtems_timer_get_information directive.
- *  This directive returns information about the timer.
+ * This routine implements the rtems_timer_get_information directive.
+ * This directive returns information about the timer.
  *
- *  @param[in] id is the timer id
- *  @param[in] the_info is the pointer to timer information block
+ * @param[in] id is the timer id
+ * @param[in] the_info is the pointer to timer information block
  *
- *  @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and
- *  		*the_info region information block filled in
+ * @retval RTEMS_SUCCESSFUL if successful or error code if unsuccessful and
+ * 		*the_info region information block filled in
  */
 rtems_status_code rtems_timer_get_information(
   rtems_id                 id,