summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/include/rtems/rtems/ratemon.h
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/include/rtems/rtems/ratemon.h
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 '')
-rw-r--r--cpukit/rtems/include/rtems/rtems/ratemon.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/ratemon.h b/cpukit/rtems/include/rtems/rtems/ratemon.h
index c7193a08f8..c3892092d3 100644
--- a/cpukit/rtems/include/rtems/rtems/ratemon.h
+++ b/cpukit/rtems/include/rtems/rtems/ratemon.h
@@ -391,7 +391,7 @@ rtems_status_code rtems_rate_monotonic_period(
);
/**
- * @brief _Rate_monotonic_Timeout
+ * @brief Rate Monotonic Timeout
*
* This routine is invoked when the period represented
* by ID expires. If the thread which owns this period is blocked
@@ -399,6 +399,8 @@ rtems_status_code rtems_rate_monotonic_period(
* period is restarted. If the owning thread is not waiting for the
* period to expire, then the period is placed in the EXPIRED
* state and not restarted.
+ *
+ * @param[in] id is the period id
*/
void _Rate_monotonic_Timeout(
rtems_id id,