From cde823b8c072f5baac17fa43a0e5608e09936d72 Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Sat, 6 Jul 2013 20:25:17 +0200 Subject: [PATCH] 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. --- buffer_tree.c | 10 ++++++++++ 1 file changed, 10 insertions(+) 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; -- 2.39.5