summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/src/regiongetsegment.c
diff options
context:
space:
mode:
authorAlex Ivanov <alexivanov97@gmail.com>2012-12-04 17:59:11 -0500
committerGedare Bloom <gedare@rtems.org>2012-12-04 17:59:11 -0500
commitc18e0ba12799ea40693428b0a731bb561e61cab0 (patch)
tree20e76592df6ad8f0ae2efb5c27f0b6870a33086e /cpukit/rtems/src/regiongetsegment.c
parentcpukit: Clean up Doxygen #3 (GCI 2012) (diff)
downloadrtems-c18e0ba12799ea40693428b0a731bb561e61cab0.tar.bz2
rtems misc: Clean up Doxygen GCI Task #4
http://www.google-melange.com/gci/task/view/google/gci2012/7950205
Diffstat (limited to 'cpukit/rtems/src/regiongetsegment.c')
-rw-r--r--cpukit/rtems/src/regiongetsegment.c28
1 files changed, 7 insertions, 21 deletions
diff --git a/cpukit/rtems/src/regiongetsegment.c b/cpukit/rtems/src/regiongetsegment.c
index 81d363a065..1f38e5cbce 100644
--- a/cpukit/rtems/src/regiongetsegment.c
+++ b/cpukit/rtems/src/regiongetsegment.c
@@ -1,7 +1,11 @@
-/*
- * Region Manager
- *
+/**
+ * @file
*
+ * @brief RTEMS Get Region Segment
+ * @ingroup ClassicRegion
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
@@ -24,24 +28,6 @@
#include <rtems/score/thread.h>
#include <rtems/score/apimutex.h>
-/*
- * rtems_region_get_segment
- *
- * This directive will obtain a segment from the given region.
- *
- * Input parameters:
- * id - region id
- * size - segment size in bytes
- * option_set - wait option
- * timeout - number of ticks to wait (0 means wait forever)
- * segment - pointer to segment address
- *
- * Output parameters:
- * segment - pointer to segment address filled in
- * RTEMS_SUCCESSFUL - if successful
- * error code - if unsuccessful
- */
-
rtems_status_code rtems_region_get_segment(
rtems_id id,
uintptr_t size,