summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/include/rtems/rtems/region.h
diff options
context:
space:
mode:
authorAlex Ivanov <alexivanov97@gmail.com>2012-12-02 16:59:17 -0600
committerJoel Sherrill <joel.sherrill@oarcorp.com>2012-12-02 17:40:27 -0600
commit88c47041f9ecb5c1e47ce5953f84e64f92048d49 (patch)
tree9c536c3693cdeb925364d06235918f993e2b9d9f /cpukit/rtems/include/rtems/rtems/region.h
parentscore misc: Clean up Doxygen #13 (GCI 2012) (diff)
downloadrtems-88c47041f9ecb5c1e47ce5953f84e64f92048d49.tar.bz2
score misc: Clean up Doxygen #14 (GCI 2012)
This patch is a task from GCI 2012 which improves the Doxygen comments in the RTEMS source. http://www.google-melange.com/gci/task/view/google/gci2012/8025204
Diffstat (limited to '')
-rw-r--r--cpukit/rtems/include/rtems/rtems/region.h12
1 files changed, 10 insertions, 2 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/region.h b/cpukit/rtems/include/rtems/rtems/region.h
index c14c3489b6..a35acf97e2 100644
--- a/cpukit/rtems/include/rtems/rtems/region.h
+++ b/cpukit/rtems/include/rtems/rtems/region.h
@@ -136,11 +136,17 @@ rtems_status_code rtems_region_ident(
);
/**
- * @brief rtems_region_get_information
+ * @brief RTEMS Get Region Information
*
* This routine implements the rtems_region_get_information directive.
* This directive returns information about the heap associated with
* this region.
+ *
+ * @param[in] id is the region id
+ * @param[in] the_info is the pointer to region information block
+ *
+ * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and
+ * *id filled with the region information block
*/
rtems_status_code rtems_region_get_information(
rtems_id id,
@@ -249,11 +255,13 @@ rtems_status_code rtems_region_resize_segment(
#ifndef __RTEMS_APPLICATION__
#include <rtems/rtems/region.inl>
/**
- * @brief Region_Process_queue
+ * @brief Process Region Queue
*
* This is a helper routine which is invoked any time memory is
* freed. It looks at the set of waiting tasks and attempts to
* satisfy all outstanding requests.
+ *
+ * @param[in] the_region is the the region
*/
extern void _Region_Process_queue(Region_Control *the_region);