[rtems commit] rtems: Fix documentation in <rtems/rtems/part.h>
Sebastian Huber
sebh at rtems.org
Tue Dec 1 13:42:43 UTC 2020
Module: rtems
Branch: master
Commit: 7995329f5cdc3900d0f71746341408a7d0974ddd
Changeset: http://git.rtems.org/rtems/commit/?id=7995329f5cdc3900d0f71746341408a7d0974ddd
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Tue Dec 1 14:39:43 2020 +0100
rtems: Fix documentation in <rtems/rtems/part.h>
Update #3993.
---
cpukit/include/rtems/rtems/part.h | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/cpukit/include/rtems/rtems/part.h b/cpukit/include/rtems/rtems/part.h
index 5d62052..b476825 100644
--- a/cpukit/include/rtems/rtems/part.h
+++ b/cpukit/include/rtems/rtems/part.h
@@ -247,9 +247,9 @@ rtems_status_code rtems_partition_create(
*
* @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
*
- * @retval ::RTEMS_INVALID_ADDRESS The id parameter was NULL.
+ * @retval ::RTEMS_INVALID_ADDRESS The ``id`` parameter was NULL.
*
- * @retval ::RTEMS_INVALID_NAME The name parameter was 0.
+ * @retval ::RTEMS_INVALID_NAME The ``name`` parameter was 0.
*
* @retval ::RTEMS_INVALID_NAME There was no object with the specified name on
* the specified nodes.
@@ -270,7 +270,7 @@ rtems_status_code rtems_partition_ident(
*
* @brief Deletes the partition.
*
- * This directive deletes the partition specified by the id parameter. The
+ * This directive deletes the partition specified by the ``id`` parameter. The
* partition cannot be deleted if any of its buffers are still allocated. The
* PTCB for the deleted partition is reclaimed by RTEMS.
*
More information about the vc
mailing list