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/region.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/region.h | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/region.h b/cpukit/rtems/include/rtems/rtems/region.h index f58bdff53d..b183b9dfcc 100644 --- a/cpukit/rtems/include/rtems/rtems/region.h +++ b/cpukit/rtems/include/rtems/rtems/region.h @@ -170,11 +170,20 @@ rtems_status_code rtems_region_get_information( ); /** - * @brief rtems_region_get_free_information + * @brief RTEMS Get Region Free Information * * This routine implements the rtems_region_get_free_information directive. * This directive returns information about the free blocks in the - * heap associated with this region. + * heap associated with this region. Information about the used blocks + * will be returned as zero. + * + * @param[in] id is the region id + * @param[in] the_info is the pointer to region information block + * + * @return This method returns RTEMS_SUCCESSFUL if there was not an + * error. Otherwise, a status code is returned indicating the + * source of the error. If successful, the the_info will + * be filled in with the region information block. */ rtems_status_code rtems_region_get_free_information( rtems_id id, |