From 6abdd89f191a5e6d64055093f68a4fce10554f82 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Mon, 14 Jun 2021 09:57:51 +0200 Subject: 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. --- cpukit/include/rtems/rtems/support.h | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'cpukit/include/rtems/rtems/support.h') 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. -- cgit v1.2.3