X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=buffer_tree.c;h=b1eeb0363e3741d288656e8c5cea5aa9d186c0ab;hp=aa9f1cdb0c95b77635981cea0e6bb1588bbcdc03;hb=74145aabe851ba5b7eff47b650f401f49b5c740d;hpb=282a5e463090205ef8a12f50a9ecf6498b860e88 diff --git a/buffer_tree.c b/buffer_tree.c index aa9f1cdb..b1eeb036 100644 --- a/buffer_tree.c +++ b/buffer_tree.c @@ -544,14 +544,16 @@ static bool btr_no_children(struct btr_node *btrn) } /** - * Find out whether a node is an orphan node. + * Find out whether a node is an orphan. * * \param btrn The buffer tree node. * * \return True if \a btrn has no parent. * - * This function will always return true for the root node. However in case - * nodes have been removed from the tree, other nodes may become orphans too. + * This function returns true for the root node and false for any other node. + * + * After a (non-leaf) node was removed removed from the tree, the function + * returns true for all child nodes. */ bool btr_no_parent(struct btr_node *btrn) {