summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/src/ratemontimeout.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/ratemontimeout.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/ratemontimeout.c')
-rw-r--r--cpukit/rtems/src/ratemontimeout.c23
1 files changed, 7 insertions, 16 deletions
diff --git a/cpukit/rtems/src/ratemontimeout.c b/cpukit/rtems/src/ratemontimeout.c
index 9ab0c59044..183e62fdcc 100644
--- a/cpukit/rtems/src/ratemontimeout.c
+++ b/cpukit/rtems/src/ratemontimeout.c
@@ -1,6 +1,11 @@
-/*
- * Rate Monotonic Manager -- Period End Timeout Handler
+/**
+ * @file
*
+ * @brief Rate Monotonic Timeout
+ * @ingroup ClassicRateMon
+ */
+
+/*
* COPYRIGHT (c) 1989-2009.
* On-Line Applications Research Corporation (OAR).
*
@@ -21,20 +26,6 @@
#include <rtems/rtems/ratemon.h>
#include <rtems/score/thread.h>
-/*
- * _Rate_monotonic_Timeout
- *
- * This routine processes a period ending. If the owning thread
- * is waiting for the period, that thread is unblocked and the
- * period reinitiated. Otherwise, the period is expired.
- * This routine is called by the watchdog handler.
- *
- * Input parameters:
- * id - period id
- *
- * Output parameters: NONE
- */
-
void _Rate_monotonic_Timeout(
Objects_Id id,
void *ignored