From: Andre Noll <maan@systemlinux.org>
Date: Sat, 6 Jul 2013 18:25:17 +0000 (+0200)
Subject: buffer_tree.c: Add documentation of btr_parent().
X-Git-Tag: v0.4.13~8
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=cde823b8c072f5baac17fa43a0e5608e09936d72;p=paraslash.git

buffer_tree.c: Add documentation of btr_parent().

This function was introduced in commit 37e0dfe7 (check_wav: Ask parent
nodes before falling back to defaults) without documentation.
---

diff --git a/buffer_tree.c b/buffer_tree.c
index f0a7b224..fd0a59ca 100644
--- a/buffer_tree.c
+++ b/buffer_tree.c
@@ -1230,6 +1230,16 @@ void btr_get_node_start(struct btr_node *btrn, struct timeval *tv)
 	*tv = btrn->start;
 }
 
+/**
+ * Get the parent node of a buffer tree node.
+ *
+ * \param btrn The node whose parent should be returned.
+ *
+ * \a btrn must not be \p NULL.
+ *
+ * \return The parent of \a btrn, or \p NULL if \a btrn is the
+ * root node of the buffer tree.
+ */
 struct btr_node *btr_parent(struct btr_node *btrn)
 {
 	return btrn->parent;