diff options
| author | Alex Ivanov <alexivanov97@gmail.com> | 2012-12-02 16:59:17 -0600 |
|---|---|---|
| committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2012-12-02 17:40:27 -0600 |
| commit | 88c47041f9ecb5c1e47ce5953f84e64f92048d49 (patch) | |
| tree | 9c536c3693cdeb925364d06235918f993e2b9d9f /cpukit/rtems/include/rtems/rtems/timer.h | |
| parent | score misc: Clean up Doxygen #13 (GCI 2012) (diff) | |
| download | rtems-88c47041f9ecb5c1e47ce5953f84e64f92048d49.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 '')
| -rw-r--r-- | cpukit/rtems/include/rtems/rtems/timer.h | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/timer.h b/cpukit/rtems/include/rtems/rtems/timer.h index ea09bc09d4..982f5dabd0 100644 --- a/cpukit/rtems/include/rtems/rtems/timer.h +++ b/cpukit/rtems/include/rtems/rtems/timer.h @@ -239,12 +239,18 @@ rtems_status_code rtems_timer_create( ); /** - * @brief rtems_timer_ident + * @brief RTEMS Timer Name to Id * * This routine implements the rtems_timer_ident directive. * This directive returns the timer ID associated with name. * If more than one timer is named name, then the timer * to which the ID belongs is arbitrary. + * + * @param[in] name is the user defined message queue name + * @param[in] id is the pointer to timer id + * + * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and + * id filled with the message queue id */ rtems_status_code rtems_timer_ident( rtems_name name, |