diff options
| author | Alex Ivanov <alexivanov97@gmail.com> | 2012-12-05 18:16:48 -0500 |
|---|---|---|
| committer | Gedare Bloom <gedare@rtems.org> | 2012-12-05 18:16:48 -0500 |
| commit | a6500136a9f30603f7dff766d7b98766851c7204 (patch) | |
| tree | 852061b300cada7facff9025868b143565058dc2 /cpukit/rtems/include/rtems/rtems/part.h | |
| parent | rtems misc: Clean up Doxygen GCI Task #6 (diff) | |
| download | rtems-a6500136a9f30603f7dff766d7b98766851c7204.tar.bz2 | |
rtems misc: Clean up Doxygen GCI Task #7
http://www.google-melange.com/gci/task/view/google/gci2012/7950206
Diffstat (limited to '')
| -rw-r--r-- | cpukit/rtems/include/rtems/rtems/part.h | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/part.h b/cpukit/rtems/include/rtems/rtems/part.h index d46be0a6c4..ebdc845bea 100644 --- a/cpukit/rtems/include/rtems/rtems/part.h +++ b/cpukit/rtems/include/rtems/rtems/part.h @@ -135,10 +135,17 @@ rtems_status_code rtems_partition_ident( ); /** - * @brief rtems_partition_delete + * @brief RTEMS Delete Partition * * This routine implements the rtems_partition_delete directive. The - * partition indicated by ID is deleted. + * partition indicated by ID is deleted, provided that none of its buffers + * are still allocated. + * + * @param[in] id is the partition id + * + * @return This method returns RTEMS_SUCCESSFUL if there was not an + * error. Otherwise, a status code is returned indicating the + * source of the error. */ rtems_status_code rtems_partition_delete( rtems_id id |