summaryrefslogtreecommitdiffstats
path: root/cpukit/score/src/rbtreeget.c
diff options
context:
space:
mode:
authorDaniel Georgiev <daniel.georgiev95@gmail.com>2012-12-01 09:53:45 -0500
committerGedare Bloom <gedare@rtems.org>2012-12-01 09:53:45 -0500
commit5a58b1e4988eb1a0fb6311b25fd12c91bb7237d7 (patch)
tree842558afb925e4f9fe5a0ac74a7f25a7d6b181be /cpukit/score/src/rbtreeget.c
parentscore misc: Score misc: Clean up Doxygen #10 (GCI 2012) (diff)
downloadrtems-5a58b1e4988eb1a0fb6311b25fd12c91bb7237d7.tar.bz2
score misc: Score misc: Clean up Doxygen #11 (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/8013204
Diffstat (limited to 'cpukit/score/src/rbtreeget.c')
-rw-r--r--cpukit/score/src/rbtreeget.c25
1 files changed, 7 insertions, 18 deletions
diff --git a/cpukit/score/src/rbtreeget.c b/cpukit/score/src/rbtreeget.c
index 81e9161a37..1570d472c8 100644
--- a/cpukit/score/src/rbtreeget.c
+++ b/cpukit/score/src/rbtreeget.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Obtain the min or max node of a rbtree
+ * @ingroup ScoreRBTree
+ */
+
/*
* Copyright (c) 2010 Gedare Bloom.
*
@@ -15,24 +22,6 @@
#include <rtems/score/rbtree.h>
#include <rtems/score/isr.h>
-/*
- * _RBTree_Get
- *
- * This kernel routine returns a pointer to a node taken from the
- * given rbtree.
- *
- * Input parameters:
- * the_rbtree - pointer to rbtree header
- * dir - specifies min (0) or max (1)
- *
- * Output parameters:
- * return_node - pointer to node in rbtree allocated
- * NULL - if no nodes available
- *
- * INTERRUPT LATENCY:
- * only case
- */
-
RBTree_Node *_RBTree_Get(
RBTree_Control *the_rbtree,
RBTree_Direction dir