diff options
| author | Alex Ivanov <alexivanov97@gmail.com> | 2012-11-28 08:11:31 -0600 |
|---|---|---|
| committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2012-11-28 08:17:26 -0600 |
| commit | f7f1d776decf9d46f27d0242e43ce85d67f32df1 (patch) | |
| tree | 3e00b3401f0663707da851e7a35c3c5d1ef8f627 /cpukit/score/src/rbtreefind.c | |
| parent | score: Add CPU_Exception_frame (diff) | |
| download | rtems-f7f1d776decf9d46f27d0242e43ce85d67f32df1.tar.bz2 | |
score misc: Clean up Doxygen (GCI 2012)
This patch is a task from GCI 2012 which improves the Doxygen
comments in the RTEMS source.
https://google-melange.appspot.com/gci/task/view/google/gci2012/7978208
Diffstat (limited to 'cpukit/score/src/rbtreefind.c')
| -rw-r--r-- | cpukit/score/src/rbtreefind.c | 26 |
1 files changed, 7 insertions, 19 deletions
diff --git a/cpukit/score/src/rbtreefind.c b/cpukit/score/src/rbtreefind.c index 07cbb3f6ca..2e8cdc3bff 100644 --- a/cpukit/score/src/rbtreefind.c +++ b/cpukit/score/src/rbtreefind.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Find the control structure of the tree containing the given node + * @ingroup ScoreRBTree + */ + /* * Copyright (c) 2010 Gedare Bloom. * @@ -15,25 +22,6 @@ #include <rtems/score/rbtree.h> #include <rtems/score/isr.h> -/* - * _RBTree_Find - * - * This kernel routine returns a pointer to the rbtree node containing the - * given key within the given tree, if it exists, or NULL otherwise. - * - * Input parameters: - * the_rbtree - pointer to rbtree control - * search_node - node with the key to search for - * - * Output parameters: - * return_node - pointer to control header of rbtree - * NULL - if there is no control header available (the node is not part - * of a tree) - * - * INTERRUPT LATENCY: - * only case - */ - RBTree_Node *_RBTree_Find( RBTree_Control *the_rbtree, RBTree_Node *search_node |