summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/include/rtems/rtems/timer.h
diff options
context:
space:
mode:
Diffstat (limited to 'cpukit/rtems/include/rtems/rtems/timer.h')
-rw-r--r--cpukit/rtems/include/rtems/rtems/timer.h8
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 c0e1e5ba86..ea09bc09d4 100644
--- a/cpukit/rtems/include/rtems/rtems/timer.h
+++ b/cpukit/rtems/include/rtems/rtems/timer.h
@@ -383,10 +383,16 @@ typedef struct {
} rtems_timer_information;
/**
- * @brief rtems_timer_get_information
+ * @brief RTEMS Get Timer Information
*
* This routine implements the rtems_timer_get_information directive.
* This directive returns information about the timer.
+ *
+ * @param[in] id is the timer id
+ * @param[in] the_info is the pointer to timer information block
+ *
+ * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and
+ * *the_info region information block filled in
*/
rtems_status_code rtems_timer_get_information(
rtems_id id,