summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/src/ratemonperiod.c
diff options
context:
space:
mode:
authorMathew Kallada <matkallada@gmail.com>2012-12-02 16:59:17 -0600
committerJoel Sherrill <joel.sherrill@oarcorp.com>2012-12-02 16:59:17 -0600
commitc05d75020d231aa193444a84c84d5ecaa1a4cefa (patch)
tree9c536c3693cdeb925364d06235918f993e2b9d9f /cpukit/rtems/src/ratemonperiod.c
parentscore misc: Clean up Doxygen #13 (GCI 2012) (diff)
downloadrtems-c05d75020d231aa193444a84c84d5ecaa1a4cefa.tar.bz2
score misc: Clean up Doxygen #14 (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/8025204
Diffstat (limited to 'cpukit/rtems/src/ratemonperiod.c')
-rw-r--r--cpukit/rtems/src/ratemonperiod.c24
1 files changed, 7 insertions, 17 deletions
diff --git a/cpukit/rtems/src/ratemonperiod.c b/cpukit/rtems/src/ratemonperiod.c
index 14cd2d5a8e..91f457bbb6 100644
--- a/cpukit/rtems/src/ratemonperiod.c
+++ b/cpukit/rtems/src/ratemonperiod.c
@@ -1,6 +1,11 @@
-/*
- * Rate Monotonic Manager - Period Blocking and Status
+/**
+ * @file
*
+ * @brief Rate Monotonic Support
+ * @ingroup ClassicRateMon
+ */
+
+/*
* COPYRIGHT (c) 1989-2010.
* On-Line Applications Research Corporation (OAR).
*
@@ -224,21 +229,6 @@ static void _Rate_monotonic_Update_statistics(
#endif
}
-
-/*
- * rtems_rate_monotonic_period
- *
- * This directive allows a thread to manipulate a rate monotonic timer.
- *
- * Input parameters:
- * id - rate monotonic id
- * length - length of period (in ticks)
- *
- * Output parameters:
- * RTEMS_SUCCESSFUL - if successful
- * error code - if unsuccessful
- */
-
rtems_status_code rtems_rate_monotonic_period(
rtems_id id,
rtems_interval length