buffer_tree: Improve documentation of btr_no_parent().
authorAndre Noll <maan@systemlinux.org>
Wed, 4 Sep 2013 22:13:49 +0000 (22:13 +0000)
committerAndre Noll <maan@systemlinux.org>
Wed, 4 Sep 2013 22:23:14 +0000 (22:23 +0000)
buffer_tree.c

index fd0a59c..9ae4d34 100644 (file)
@@ -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)
 {