summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/src/taskwakewhen.c
diff options
context:
space:
mode:
authorAlex Ivanov <alexivanov97@gmail.com>2012-12-02 10:03:09 -0600
committerJoel Sherrill <joel.sherrill@oarcorp.com>2012-12-02 10:03:09 -0600
commit52adc808422cf415027c07c54910086227bcb973 (patch)
tree74d6da54a3d4ca2cc9f41dd93bf482f9c44a77ef /cpukit/rtems/src/taskwakewhen.c
parentscore misc: Score misc: Clean up Doxygen #11 (GCI 2012) (diff)
downloadrtems-52adc808422cf415027c07c54910086227bcb973.tar.bz2
score misc: Clean up Doxygen #12 (GCI 2012)
This patch is a task from GCI 2012 which improves the Doxygen comments in the RTEMS source. http://www.google-melange.com/gci/task/view/google/gci2012/8025203
Diffstat (limited to 'cpukit/rtems/src/taskwakewhen.c')
-rw-r--r--cpukit/rtems/src/taskwakewhen.c24
1 files changed, 7 insertions, 17 deletions
diff --git a/cpukit/rtems/src/taskwakewhen.c b/cpukit/rtems/src/taskwakewhen.c
index 0a420b20b6..ffa5ddcaeb 100644
--- a/cpukit/rtems/src/taskwakewhen.c
+++ b/cpukit/rtems/src/taskwakewhen.c
@@ -1,7 +1,11 @@
-/*
- * RTEMS Task Manager
- *
+/**
+ * @file
*
+ * @brief RTEMS Task Wake When
+ * @ingroup ClassicTasks
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -30,20 +34,6 @@
#include <rtems/score/apiext.h>
#include <rtems/score/sysstate.h>
-/*
- * rtems_task_wake_when
- *
- * This directive blocks the requesting thread until the given date and
- * time is reached.
- *
- * Input parameters:
- * time_buffer - pointer to the time and date structure
- *
- * Output parameters:
- * RTEMS_SUCCESSFUL - if successful
- * error code - if unsuccessful
- */
-
rtems_status_code rtems_task_wake_when(
rtems_time_of_day *time_buffer
)