diff options
author | Mathew Kallada <matkallada@gmail.com> | 2012-12-08 08:48:37 -0500 |
---|---|---|
committer | Gedare Bloom <gedare@rtems.org> | 2012-12-08 08:48:37 -0500 |
commit | 4c90eb4a43fbc4380fe4d9deafb4fbcbd13c30d0 (patch) | |
tree | 0b2339f4cdcd434c2cf30b2dbacbdd87fe8d9a33 /cpukit/rtems/include/rtems/rtems/ratemon.h | |
parent | score misc: Clean up Doxygen GCI Task #12 (diff) | |
download | rtems-4c90eb4a43fbc4380fe4d9deafb4fbcbd13c30d0.tar.bz2 |
misc rtems: Clean up Doxygen GCI Task #8
http://www.google-melange.com/gci/task/view/google/gci2012/8024203
Diffstat (limited to 'cpukit/rtems/include/rtems/rtems/ratemon.h')
-rw-r--r-- | cpukit/rtems/include/rtems/rtems/ratemon.h | 22 |
1 files changed, 13 insertions, 9 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/ratemon.h b/cpukit/rtems/include/rtems/rtems/ratemon.h index 799ebbef08..475a90a5be 100644 --- a/cpukit/rtems/include/rtems/rtems/ratemon.h +++ b/cpukit/rtems/include/rtems/rtems/ratemon.h @@ -271,13 +271,15 @@ RTEMS_RATEMON_EXTERN Objects_Information _Rate_monotonic_Information; * @brief Rate Monotonic Manager Initialization * * This routine performs the initialization necessary for this manager. - * + * * @note The Rate Monotonic Manager is built on top of the Watchdog Handler */ void _Rate_monotonic_Manager_initialization(void); /** - * @brief rtems_rate_monotonic_create + * @brief Create a Period + * + * Rate Monotonic Manager * * This routine implements the rate_monotonic_create directive. The * period will have the name name. It returns the id of the @@ -294,10 +296,10 @@ rtems_status_code rtems_rate_monotonic_create( * This routine implements the rtems_rate_monotonic_ident directive. * It returns the period ID associated with name. If more than one period * is named name, then the period to which the ID belongs is arbitrary. - * + * * @param[in] name is the user defined period name * @param[in] id is the pointer to period id - * + * * @return This method returns RTEMS_SUCCESSFUL if there was not an * error. Otherwise, a status code is returned indicating the * source of the error. If successful, the id will @@ -330,9 +332,9 @@ rtems_status_code rtems_rate_monotonic_cancel( * * This routine implements the rtems_rate_monotonic_delete directive. The * period indicated by ID is deleted. - * + * * @param[in] id is the rate monotonic id - * + * * @return This method returns RTEMS_SUCCESSFUL if there was not an * error. Otherwise, a status code is returned indicating the * source of the error. @@ -346,10 +348,10 @@ rtems_status_code rtems_rate_monotonic_delete( * * This routine implements the rtems_rate_monotonic_get_status directive. * Information about the period indicated by ID is returned. - * + * * @param[in] id is the rate monotonic id * @param[in] status is the pointer to status control block - * + * * @return This method returns RTEMS_SUCCESSFUL if there was not an * error. Otherwise, a status code is returned indicating the * source of the error. @@ -377,7 +379,9 @@ rtems_status_code rtems_rate_monotonic_get_statistics( ); /** - * @brief rtems_rate_monotonic_reset_statistics + * @brief RTEMS Rate Monotonic Reset Statistics + * + * Rate Monotonic Manager -- Reset Statistics * * This routine allows a thread to reset the statistics information * on a specific period instance. |