From 3f97ae6c928596a15fc4e7e0b0fbf754347165f8 Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Wed, 4 Sep 2013 22:13:49 +0000 Subject: [PATCH] buffer_tree: Improve documentation of btr_no_parent(). --- buffer_tree.c | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/buffer_tree.c b/buffer_tree.c index fd0a59ca..9ae4d34c 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) { -- 2.39.2