From 205dbb9df9c8d39c955d6b807a59e258c319ad3d Mon Sep 17 00:00:00 2001 From: Alex Ivanov Date: Mon, 3 Dec 2012 13:18:33 -0600 Subject: cpukit: Clean up Doxygen #3 (GCI 2012) --- cpukit/rtems/include/rtems/rtems/part.h | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'cpukit/rtems/include/rtems/rtems/part.h') diff --git a/cpukit/rtems/include/rtems/rtems/part.h b/cpukit/rtems/include/rtems/rtems/part.h index 8415f9ca5b..b6b5b3a3dc 100644 --- a/cpukit/rtems/include/rtems/rtems/part.h +++ b/cpukit/rtems/include/rtems/rtems/part.h @@ -145,11 +145,16 @@ rtems_status_code rtems_partition_delete( ); /** - * @brief rtems_partition_get_buffer + * @brief RTEMS Get Partition Buffer * * This routine implements the rtems_partition_get_buffer directive. It * attempts to allocate a buffer from the partition associated with ID. * If a buffer is allocated, its address is returned in buffer. + * + * @param[in] id is the partition id + * @param[out] buffer is the pointer to buffer address + * + * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful */ rtems_status_code rtems_partition_get_buffer( rtems_id id, -- cgit v1.2.3