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/region.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/region.h | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/region.h b/cpukit/rtems/include/rtems/rtems/region.h index a35acf97e2..61162cbb99 100644 --- a/cpukit/rtems/include/rtems/rtems/region.h +++ b/cpukit/rtems/include/rtems/rtems/region.h @@ -207,7 +207,7 @@ rtems_status_code rtems_region_get_segment_size( ); /** - * @brief rtems_region_return_segment + * @brief RTEMS Return Region Segment * * This routine implements the rtems_region_return_segment directive. It * frees the segment to the region associated with ID. The segment must @@ -216,6 +216,11 @@ rtems_status_code rtems_region_get_segment_size( * rtems_region_get_segment of the first blocked task, then that task and as * many subsequent tasks as possible will be unblocked with their requests * satisfied. + * + * @param[in] id is the region id + * @param[in] segment is the pointer to segment address + * + * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful */ rtems_status_code rtems_region_return_segment( rtems_id id, |