buffer_tree: Improve documentation of btr_no_parent().

diff --git a/buffer_tree.c b/buffer_tree.c
index fd0a59cad58c0027e3911b08eb5f0bd20a176ed5..9ae4d34c9fb6dfd38676e83416a0bcf6d244f25a 100644 (file)
--- 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.
  *
  *
  * \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)
 {
  */
 bool btr_no_parent(struct btr_node *btrn)
 {