diff options
| author | Alex Ivanov <alexivanov97@gmail.com> | 2012-12-03 13:18:33 -0600 |
|---|---|---|
| committer | Jennifer Averett <jennifer.averett@oarcorp.com> | 2012-12-03 13:18:33 -0600 |
| commit | 205dbb9df9c8d39c955d6b807a59e258c319ad3d (patch) | |
| tree | 0b7a58bd55153a920f3a0aacabbdc06c069bed07 /cpukit/rtems/include/rtems/rtems/part.h | |
| parent | dosfs: Fix msdos_format() (diff) | |
| download | rtems-205dbb9df9c8d39c955d6b807a59e258c319ad3d.tar.bz2 | |
cpukit: Clean up Doxygen #3 (GCI 2012)
Diffstat (limited to '')
| -rw-r--r-- | cpukit/rtems/include/rtems/rtems/part.h | 7 |
1 files changed, 6 insertions, 1 deletions
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, |