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/barrier.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/barrier.h | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/cpukit/include/rtems/rtems/barrier.h b/cpukit/include/rtems/rtems/barrier.h index 0f692e1995..6327a7c831 100644 --- a/cpukit/include/rtems/rtems/barrier.h +++ b/cpukit/include/rtems/rtems/barrier.h @@ -88,9 +88,9 @@ extern "C" { * @param maximum_waiters is the maximum count of waiters on an automatic * release barrier. * - * @param id is the pointer to an object identifier variable. When the - * directive call is successful, the identifier of the created barrier will - * be stored in this variable. + * @param id is the pointer to an ::rtems_id object. When the directive call + * is successful, the identifier of the created barrier will be stored in + * this object. * * This directive creates a barrier which resides on the local node. The * barrier has the user-defined object name specified in ``name`` and the @@ -178,9 +178,9 @@ rtems_status_code rtems_barrier_create( * * @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 barrier identifier associated with the barrier name * specified in ``name``. @@ -318,9 +318,9 @@ rtems_status_code rtems_barrier_wait( rtems_id id, rtems_interval timeout ); * * @param id is the barrier identifier. * - * @param[out] released is the pointer to an integer variable. When the + * @param[out] released is the pointer to an uint32_t object. When the * directive call is successful, the number of released tasks will be stored - * in this variable. + * in this object. * * This directive releases the barrier specified by ``id``. All tasks waiting * at the barrier will be unblocked. The number of released tasks will be |