diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-06-14 09:57:51 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-06-15 10:39:47 +0200 |
| commit | 6abdd89f191a5e6d64055093f68a4fce10554f82 (patch) | |
| tree | c8861a2f162c906862fde844c8b56487f259b6f1 /cpukit/include/rtems/rtems/support.h | |
| parent | score: Add PER_CPU_DATA_NEED_INITIALIZATION() (diff) | |
| download | rtems-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/support.h | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/cpukit/include/rtems/rtems/support.h b/cpukit/include/rtems/rtems/support.h index 829548aae2..60e090ccec 100644 --- a/cpukit/include/rtems/rtems/support.h +++ b/cpukit/include/rtems/rtems/support.h @@ -228,9 +228,9 @@ static inline void rtems_name_to_characters( * * @param bytes is the number of bytes to allocated. * - * @param[out] pointer is the pointer to a pointer variable. When the + * @param[out] pointer is the pointer to a ``void`` pointer object. When the * directive call is successful, the begin address of the allocated memory - * area will be stored in this variable. + * area will be stored in this object. * * @return Returns true, if the allocation was successful, otherwise false. * @@ -286,9 +286,9 @@ bool rtems_workspace_free( void *pointer ); * * @brief Gets information about the RTEMS Workspace. * - * @param the_info is the pointer to a heap information variable. When the - * directive call is successful, the heap information will be stored in this - * variable. + * @param[out] the_info is the pointer to a Heap_Information_block object. + * When the directive call is successful, the heap information will be stored + * in this object. * * @return Returns true, if getting the information was successful, otherwise * false. |