[rtems commit] rtems: Clarify object services documentation

Sebastian Huber sebh at rtems.org
Wed Feb 17 19:26:41 UTC 2021


Module:    rtems
Branch:    master
Commit:    97825daf9c4f80f3f228f92f63d29d02c6ccf3f4
Changeset: http://git.rtems.org/rtems/commit/?id=97825daf9c4f80f3f228f92f63d29d02c6ccf3f4

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Mon Feb 15 13:57:37 2021 +0100

rtems: Clarify object services documentation

Unify the wording across similar directives of other managers.

Update #3993.

---

 cpukit/include/rtems/rtems/object.h | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/cpukit/include/rtems/rtems/object.h b/cpukit/include/rtems/rtems/object.h
index f3edabb..5f3e050 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.  The object name
- *   associated with the object identifier will be stored in this variable, in
- *   case of a successful operation.
+ * @param[out] name is the pointer to an object name variable.  When the
+ *   directive call is successful, the object name associated with the object
+ *   identifier will be stored in this variable.
  *
  * @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.  The
- *   object class information of the class of the API will be stored in this
- *   variable, in case of a successful operation.
+ * @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.
  *
  * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
  *



More information about the vc mailing list