diff options
| author | Mathew Kallada <matkallada@gmail.com> | 2012-12-02 16:59:17 -0600 |
|---|---|---|
| committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2012-12-02 16:59:17 -0600 |
| commit | c05d75020d231aa193444a84c84d5ecaa1a4cefa (patch) | |
| tree | 9c536c3693cdeb925364d06235918f993e2b9d9f /cpukit/rtems/src/ratemoncancel.c | |
| parent | score misc: Clean up Doxygen #13 (GCI 2012) (diff) | |
| download | rtems-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/ratemoncancel.c')
| -rw-r--r-- | cpukit/rtems/src/ratemoncancel.c | 22 |
1 files changed, 7 insertions, 15 deletions
diff --git a/cpukit/rtems/src/ratemoncancel.c b/cpukit/rtems/src/ratemoncancel.c index b0b8c04671..af6a972a8e 100644 --- a/cpukit/rtems/src/ratemoncancel.c +++ b/cpukit/rtems/src/ratemoncancel.c @@ -1,6 +1,11 @@ -/* - * Rate Monotonic Manager -- Cancel a Period +/** + * @file * + * @brief RTEMS Rate Monotonic Cancel + * @ingroup ClassicRateMon + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -21,19 +26,6 @@ #include <rtems/rtems/ratemon.h> #include <rtems/score/thread.h> -/* - * rtems_rate_monotonic_cancel - * - * This directive allows a thread to cancel a rate monotonic timer. - * - * Input parameters: - * id - rate monotonic id - * - * Output parameters: - * RTEMS_SUCCESSFUL - if successful and caller is not the owning thread - * error code - if unsuccessful - */ - rtems_status_code rtems_rate_monotonic_cancel( rtems_id id ) |