summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/include/rtems/rtems/timer.h
diff options
context:
space:
mode:
authorAlex Ivanov <alexivanov97@gmail.com>2012-12-03 13:18:33 -0600
committerJennifer Averett <jennifer.averett@oarcorp.com>2012-12-03 13:18:33 -0600
commit205dbb9df9c8d39c955d6b807a59e258c319ad3d (patch)
tree0b7a58bd55153a920f3a0aacabbdc06c069bed07 /cpukit/rtems/include/rtems/rtems/timer.h
parentdosfs: Fix msdos_format() (diff)
downloadrtems-205dbb9df9c8d39c955d6b807a59e258c319ad3d.tar.bz2
cpukit: Clean up Doxygen #3 (GCI 2012)
Diffstat (limited to '')
-rw-r--r--cpukit/rtems/include/rtems/rtems/timer.h7
1 files changed, 6 insertions, 1 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/timer.h b/cpukit/rtems/include/rtems/rtems/timer.h
index 982f5dabd0..b75a474358 100644
--- a/cpukit/rtems/include/rtems/rtems/timer.h
+++ b/cpukit/rtems/include/rtems/rtems/timer.h
@@ -227,11 +227,16 @@ RTEMS_TIMER_EXTERN Objects_Information _Timer_Information;
void _Timer_Manager_initialization(void);
/**
- * @brief rtems_timer_create
+ * @brief RTEMS Create Timer
*
* This routine implements the rtems_timer_create directive. The
* timer will have the name name. It returns the id of the
* created timer in ID.
+ *
+ * @param[in] name is the timer name
+ * @param[out] id is the pointer to timer id
+ *
+ * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful
*/
rtems_status_code rtems_timer_create(
rtems_name name,