diff options
author | Mathew Kallada <matkallada@gmail.com> | 2012-12-02 16:59:17 -0600 |
---|---|---|
committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2012-12-02 16:59:17 -0600 |
commit | c05d75020d231aa193444a84c84d5ecaa1a4cefa (patch) | |
tree | 9c536c3693cdeb925364d06235918f993e2b9d9f /cpukit/rtems/src/regiongetinfo.c | |
parent | score misc: Clean up Doxygen #13 (GCI 2012) (diff) | |
download | rtems-c05d75020d231aa193444a84c84d5ecaa1a4cefa.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 'cpukit/rtems/src/regiongetinfo.c')
-rw-r--r-- | cpukit/rtems/src/regiongetinfo.c | 25 |
1 files changed, 7 insertions, 18 deletions
diff --git a/cpukit/rtems/src/regiongetinfo.c b/cpukit/rtems/src/regiongetinfo.c index a1d7d60c0c..fef9f500f7 100644 --- a/cpukit/rtems/src/regiongetinfo.c +++ b/cpukit/rtems/src/regiongetinfo.c @@ -1,7 +1,11 @@ -/* - * Region Manager - * +/** + * @file * + * @brief RTEMS Get Region Information + * @ingroup ClassicRegion + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -24,21 +28,6 @@ #include <rtems/score/apimutex.h> #include <rtems/score/thread.h> -/* - * rtems_region_get_information - * - * This directive will return information about the region specified. - * - * Input parameters: - * id - region id - * the_info - pointer to region information block - * - * Output parameters: - * *the_info - region information block filled in - * RTEMS_SUCCESSFUL - if successful - * error code - if unsuccessful - */ - rtems_status_code rtems_region_get_information( rtems_id id, Heap_Information_block *the_info |