diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-12-02 08:32:44 +0100 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-12-02 08:33:11 +0100 |
| commit | 1af4493bdb20cda2879af65e92bc97bf9c60c3b5 (patch) | |
| tree | c0bfcc0b5aea0c3986f24eebe25951bfece630ef | |
| parent | rtems: Clarify rtems_partition_delete() (diff) | |
| download | rtems-1af4493bdb20cda2879af65e92bc97bf9c60c3b5.tar.bz2 | |
rtems: Clarify invalid identifier descriptions
Update #3993.
Diffstat (limited to '')
| -rw-r--r-- | cpukit/include/rtems/rtems/event.h | 3 | ||||
| -rw-r--r-- | cpukit/include/rtems/rtems/part.h | 12 |
2 files changed, 8 insertions, 7 deletions
diff --git a/cpukit/include/rtems/rtems/event.h b/cpukit/include/rtems/rtems/event.h index 2a58b9840b..78d84213f7 100644 --- a/cpukit/include/rtems/rtems/event.h +++ b/cpukit/include/rtems/rtems/event.h @@ -622,7 +622,8 @@ static inline rtems_status_code rtems_event_transient_send( rtems_id id ) * * @retval ::RTEMS_SUCCESSFUL The requested operation was successful. * - * @retval ::RTEMS_INVALID_ID There was no task with the specified identifier. + * @retval ::RTEMS_INVALID_ID There was no task associated with the identifier + * specified by ``id``. */ rtems_status_code rtems_event_send( rtems_id id, rtems_event_set event_in ); diff --git a/cpukit/include/rtems/rtems/part.h b/cpukit/include/rtems/rtems/part.h index 83c8e5a519..aeb4de64c5 100644 --- a/cpukit/include/rtems/rtems/part.h +++ b/cpukit/include/rtems/rtems/part.h @@ -292,8 +292,8 @@ rtems_status_code rtems_partition_ident( * * @retval ::RTEMS_SUCCESSFUL The requested operation was successful. * - * @retval ::RTEMS_INVALID_ID There was no partition with the specified - * identifier. + * @retval ::RTEMS_INVALID_ID There was no partition associated with the + * identifier specified by ``id``. * * @retval ::RTEMS_ILLEGAL_ON_REMOTE_OBJECT The partition resided on a remote * node. @@ -333,8 +333,8 @@ rtems_status_code rtems_partition_delete( rtems_id id ); * * @retval ::RTEMS_SUCCESSFUL The requested operation was successful. * - * @retval ::RTEMS_INVALID_ID There was no partition with the specified - * identifier. + * @retval ::RTEMS_INVALID_ID There was no partition associated with the + * identifier specified by ``id``. * * @retval ::RTEMS_INVALID_ADDRESS The ``buffer`` parameter was NULL. * @@ -368,8 +368,8 @@ rtems_status_code rtems_partition_get_buffer( rtems_id id, void **buffer ); * * @retval ::RTEMS_SUCCESSFUL The requested operation was successful. * - * @retval ::RTEMS_INVALID_ID There was no partition with the specified - * identifier. + * @retval ::RTEMS_INVALID_ID There was no partition associated with the + * identifier specified by ``id``. * * @retval ::RTEMS_INVALID_ADDRESS The buffer referenced by ``buffer`` was not * in the partition. |