From 3db64b098184e08bfac7939775ad9db9ebfc72fb Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Sun, 10 Oct 2010 18:17:53 +0200 Subject: [PATCH] Add missing documentation of moods_event_handler() and btr_free_node(). --- buffer_tree.c | 2 ++ mood.c | 12 +++++++++++- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/buffer_tree.c b/buffer_tree.c index d92d9863..3f1cc716 100644 --- a/buffer_tree.c +++ b/buffer_tree.c @@ -670,6 +670,8 @@ static void flush_input_queue(struct btr_node *btrn) /** * Free all resources allocated by btr_new_node(). * + * \param btrn Pointer to a btr node obtained by \ref btr_new_node(). + * * Like free(3), it is OK to call this with a \p NULL pointer argument. */ void btr_free_node(struct btr_node *btrn) diff --git a/mood.c b/mood.c index d24eac91..89ad80d9 100644 --- a/mood.c +++ b/mood.c @@ -890,6 +890,17 @@ static int reload_current_mood(void) return ret; } +/** + * Notification callback for the moods table. + * + * \param event Type of the event just occurred. + * \param pb Unused. + * \param data Its type depends on the event. + * + * This function performs actions required due to the occurrence of the given + * event. Possible actions include reload of the current mood and update of the + * score of an audio file. + */ int moods_event_handler(enum afs_events event, __a_unused struct para_buffer *pb, void *data) { @@ -926,4 +937,3 @@ int moods_event_handler(enum afs_events event, __a_unused struct para_buffer *pb return 1; } } - -- 2.39.5