summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/src/timerfirewhen.c
diff options
context:
space:
mode:
Diffstat (limited to 'cpukit/rtems/src/timerfirewhen.c')
-rw-r--r--cpukit/rtems/src/timerfirewhen.c26
1 files changed, 7 insertions, 19 deletions
diff --git a/cpukit/rtems/src/timerfirewhen.c b/cpukit/rtems/src/timerfirewhen.c
index df24e2aad3..487471ffc3 100644
--- a/cpukit/rtems/src/timerfirewhen.c
+++ b/cpukit/rtems/src/timerfirewhen.c
@@ -1,7 +1,11 @@
-/*
- * Timer Manager - rtems_timer_fire_when directive
- *
+/**
+ * @file
*
+ * @brief RTEMS Timer Fire When
+ * @ingroup ClassicTimer
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
@@ -23,22 +27,6 @@
#include <rtems/score/tod.h>
#include <rtems/score/watchdog.h>
-/*
- * rtems_timer_fire_when
- *
- * This directive allows a thread to start a timer.
- *
- * Input parameters:
- * id - timer id
- * wall_time - time of day to fire timer
- * routine - routine to schedule
- * user_data - passed as argument to routine when it is fired
- *
- * Output parameters:
- * RTEMS_SUCCESSFUL - if successful
- * error code - if unsuccessful
- */
-
rtems_status_code rtems_timer_fire_when(
rtems_id id,
rtems_time_of_day *wall_time,