diff options
| author | Alex Ivanov <alexivanov97@gmail.com> | 2012-11-29 17:14:28 -0600 |
|---|---|---|
| committer | Joel Sherrill <joel.sherrill@oarcorp.com> | 2012-11-29 17:14:28 -0600 |
| commit | f2f63d15488312ec053dec8842a2a25a8f957305 (patch) | |
| tree | 87e76f60a6f7ceda5c4a7f1562529c0a35429e23 /cpukit/score/include/rtems/score/rbtree.h | |
| parent | score misc: Score misc: Clean up Doxygen #6 (GCI 2012) (diff) | |
| download | rtems-f2f63d15488312ec053dec8842a2a25a8f957305.tar.bz2 | |
score misc: Score misc: Clean up Doxygen #7 (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/7986214
Diffstat (limited to '')
| -rw-r--r-- | cpukit/score/include/rtems/score/rbtree.h | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/cpukit/score/include/rtems/score/rbtree.h b/cpukit/score/include/rtems/score/rbtree.h index 5f7a103d5e..5a03d7ca8d 100644 --- a/cpukit/score/include/rtems/score/rbtree.h +++ b/cpukit/score/include/rtems/score/rbtree.h @@ -189,6 +189,11 @@ RBTree_Node name = RBTREE_NODE_INITIALIZER_EMPTY(name) * This routine initializes @a the_rbtree structure to manage the * contiguous array of @a number_nodes nodes which starts at * @a starting_address. Each node is of @a node_size bytes. + * + * @param[in] the_rbtree is the pointer to rbtree header + * @param[in] starting_address is the starting address of first node + * @param[in] number_nodes is the number of nodes in rbtree + * @param[in] node_size is the size of node in bytes */ void _RBTree_Initialize( RBTree_Control *the_rbtree, |