summaryrefslogtreecommitdiffstats
path: root/cpukit/include/rtems/rtems/part.h
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-12-01 16:35:05 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-12-02 08:16:03 +0100
commit8756d5ce06d8d5f8f9f205601cd051211681d470 (patch)
tree6f1fc7fb6365fb6b50ebe308a87bce3fe068fae1 /cpukit/include/rtems/rtems/part.h
parentrtems: Fix Doxygen group name (diff)
downloadrtems-8756d5ce06d8d5f8f9f205601cd051211681d470.tar.bz2
rtems: Clarify rtems_partition_create()
The rtems_partition_create() returns an object identifier and not just a partition identifier. Update #3993.
Diffstat (limited to '')
-rw-r--r--cpukit/include/rtems/rtems/part.h12
1 files changed, 6 insertions, 6 deletions
diff --git a/cpukit/include/rtems/rtems/part.h b/cpukit/include/rtems/rtems/part.h
index 16f7effd6c..db861a8df0 100644
--- a/cpukit/include/rtems/rtems/part.h
+++ b/cpukit/include/rtems/rtems/part.h
@@ -97,9 +97,9 @@ extern "C" {
* This directive creates a partition of fixed size buffers from a physically
* contiguous memory space which starts at ``starting_address`` and is
* ``length`` bytes in size. Each allocated buffer is to be of ``buffer_size``
- * in bytes. The assigned partition identifier is returned in ``id``. This
- * partition identifier is used to access the partition with other partition
- * related directives.
+ * in bytes. The assigned object identifier is returned in ``id``. This
+ * identifier is used to access the partition with other partition related
+ * directives.
*
* The **attribute set** specified in ``attribute_set`` is built through a
* *bitwise or* of the attribute constants described below. Attributes not
@@ -161,9 +161,9 @@ extern "C" {
*
* @param attribute_set is the attribute set of the partition.
*
- * @param id is the pointer to an object identifier variable. The identifier
- * of the created partition object will be stored in this variable, in case
- * of a successful operation.
+ * @param[out] id is the pointer to an object identifier variable. The
+ * identifier of the created partition object will be stored in this
+ * variable, in case of a successful operation.
*
* @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
*