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/include/rtems/score/rbtree.h | |
| 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/include/rtems/score/rbtree.h')
| -rw-r--r-- | cpukit/score/include/rtems/score/rbtree.h | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/cpukit/score/include/rtems/score/rbtree.h b/cpukit/score/include/rtems/score/rbtree.h index 82bdb6df7f..e601208c58 100644 --- a/cpukit/score/include/rtems/score/rbtree.h +++ b/cpukit/score/include/rtems/score/rbtree.h @@ -223,6 +223,15 @@ RBTree_Node *_RBTree_Get( * This function returns a pointer to the node with key equal to a key * of @a the_node if it exists in the Red-Black Tree @a the_rbtree, * and NULL if not. + * + * @param[in] the_rbtree pointer to rbtree control + * @param[in] the_node node with the key to search for + * @return This method returns pointer to control header of rbtree. * + * If there is no control header available (the node is not part + * of a tree), then NULL is returned. * + * + * - INTERRUPT LATENCY: + * + single case */ RBTree_Node *_RBTree_Find( RBTree_Control *the_rbtree, |