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/object.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/object.h | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/cpukit/include/rtems/rtems/object.h b/cpukit/include/rtems/rtems/object.h index 5f3e050b3c..e80303da28 100644 --- a/cpukit/include/rtems/rtems/object.h +++ b/cpukit/include/rtems/rtems/object.h @@ -304,9 +304,9 @@ rtems_name rtems_build_name( char c1, char c2, char c3, char c4 ); * * @param id is the object identifier to get the name. * - * @param[out] name is the pointer to an object name variable. When the + * @param[out] name is the pointer to an ::rtems_name object. When the * directive call is successful, the object name associated with the object - * identifier will be stored in this variable. + * identifier will be stored in this object. * * @retval ::RTEMS_SUCCESSFUL The requested operation was successful. * @@ -730,9 +730,9 @@ const char *rtems_object_get_api_class_name( int the_api, int the_class ); * @param the_class is the object class of the object API to get the class * information. * - * @param info is the pointer to an object class information variable. When - * the directive call is successful, the object class information of the - * class of the API will be stored in this variable. + * @param[out] info is the pointer to an rtems_object_api_class_information + * object. When the directive call is successful, the object class + * information of the class of the API will be stored in this object. * * @retval ::RTEMS_SUCCESSFUL The requested operation was successful. * |