diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-06-14 09:57:51 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-06-15 10:39:47 +0200 |
commit | 6abdd89f191a5e6d64055093f68a4fce10554f82 (patch) | |
tree | c8861a2f162c906862fde844c8b56487f259b6f1 /cpukit/include/rtems/rtems/timer.h | |
parent | score: Add PER_CPU_DATA_NEED_INITIALIZATION() (diff) | |
download | rtems-6abdd89f191a5e6d64055093f68a4fce10554f82.tar.bz2 |
Use a common phrase for pointer parameters
Mention the type of the pointer in the parameter description. Use the
more general term "object" instead of "variable".
Update #3993.
Diffstat (limited to '')
-rw-r--r-- | cpukit/include/rtems/rtems/timer.h | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/cpukit/include/rtems/rtems/timer.h b/cpukit/include/rtems/rtems/timer.h index eb8bef2532..0f13c04bda 100644 --- a/cpukit/include/rtems/rtems/timer.h +++ b/cpukit/include/rtems/rtems/timer.h @@ -191,9 +191,9 @@ typedef struct { * * @param id is the timer identifier. * - * @param[out] the_info is the pointer to a timer information variable. When - * the directive call is successful, the information about the timer will be - * stored in this variable. + * @param[out] the_info is the pointer to an rtems_timer_information object. + * When the directive call is successful, the information about the timer + * will be stored in this object. * * This directive returns information about the timer. * @@ -267,9 +267,9 @@ typedef rtems_timer_service_routine ( *rtems_timer_service_routine_entry )( rtem * * @param name is the object name of the timer. * - * @param[out] id is the pointer to an object identifier variable. When the - * directive call is successful, the identifier of the created timer will be - * stored in this variable. + * @param[out] id is the pointer to an ::rtems_id object. When the directive + * call is successful, the identifier of the created timer will be stored in + * this object. * * This directive creates a timer which resides on the local node. The timer * has the user-defined object name specified in ``name``. The assigned object @@ -326,9 +326,9 @@ rtems_status_code rtems_timer_create( rtems_name name, rtems_id *id ); * * @param name is the object name to look up. * - * @param[out] id is the pointer to an object identifier variable. When the - * directive call is successful, the object identifier of an object with the - * specified name will be stored in this variable. + * @param[out] id is the pointer to an ::rtems_id object. When the directive + * call is successful, the object identifier of an object with the specified + * name will be stored in this object. * * This directive obtains a timer identifier associated with the timer name * specified in ``name``. |