diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-01-25 09:27:22 +0100 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-01-27 06:01:48 +0100 |
| commit | b35ac9901caac823c5aa4aeeb81c4bb2c6bc58fd (patch) | |
| tree | fe1061be42fa3aa4c18182e1d91c7ec7a83fe7f0 /cpukit/include/rtems/rtems/status.h | |
| parent | heap: Fix _Heap_Area_overhead() (diff) | |
| download | rtems-b35ac9901caac823c5aa4aeeb81c4bb2c6bc58fd.tar.bz2 | |
rtems: Add "Notes" paragraph header
Place the paragraphs in the same order as the directive documentation in
the RTEMS Classic API Guide.
Update #3993.
Diffstat (limited to 'cpukit/include/rtems/rtems/status.h')
| -rw-r--r-- | cpukit/include/rtems/rtems/status.h | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/cpukit/include/rtems/rtems/status.h b/cpukit/include/rtems/rtems/status.h index 35752442d9..872bb9b2b3 100644 --- a/cpukit/include/rtems/rtems/status.h +++ b/cpukit/include/rtems/rtems/status.h @@ -252,6 +252,7 @@ typedef enum { * This is referred to as proxying operations and this status indicates that * the operation could not be completed immediately and the proxy is blocking. * + * @par Notes * This status will not be returned to the user. */ RTEMS_PROXY_BLOCKING = 29 @@ -364,10 +365,10 @@ static inline bool rtems_is_status_successful( rtems_status_code status_code ) * * @brief Maps the status code to a descriptive text. * - * The text for each status code is the enumerator constant. - * * @param status_code is the status code. * + * The text for each status code is the enumerator constant. + * * @retval "?" The status code is invalid. * * @return Returns a text describing the status code, if the status code is |