summaryrefslogtreecommitdiffstats
path: root/cpukit/include/rtems/rtems/part.h
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2021-06-14 09:57:51 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2021-06-15 10:39:47 +0200
commit6abdd89f191a5e6d64055093f68a4fce10554f82 (patch)
treec8861a2f162c906862fde844c8b56487f259b6f1 /cpukit/include/rtems/rtems/part.h
parentfad01e6cf95f98adaca3157faa8b96c19296a68e (diff)
downloadrtems-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/part.h16
1 files changed, 8 insertions, 8 deletions
diff --git a/cpukit/include/rtems/rtems/part.h b/cpukit/include/rtems/rtems/part.h
index 7a829d96af..10091b48f4 100644
--- a/cpukit/include/rtems/rtems/part.h
+++ b/cpukit/include/rtems/rtems/part.h
@@ -112,9 +112,9 @@ extern "C" {
*
* @param attribute_set is the attribute set of the partition.
*
- * @param[out] id is the pointer to an object identifier variable. When the
- * directive call is successful, the identifier of the created partition 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 partition will be stored
+ * in this object.
*
* This directive creates a partition of fixed size buffers from a physically
* contiguous memory space which starts at ``starting_address`` and is
@@ -252,9 +252,9 @@ rtems_status_code rtems_partition_create(
*
* @param node is the node or node set to search for a matching object.
*
- * @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 partition identifier associated with the partition
* name specified in ``name``.
@@ -388,9 +388,9 @@ rtems_status_code rtems_partition_delete( rtems_id id );
*
* @param id is the partition identifier.
*
- * @param[out] buffer is the pointer to a buffer pointer variable. When the
+ * @param[out] buffer is the pointer to a ``void`` pointer object. When the
* directive call is successful, the pointer to the allocated buffer will be
- * stored in this variable.
+ * stored in this object.
*
* This directive allows a buffer to be obtained from the partition specified
* by ``id``. The address of the allocated buffer is returned through the