Add more documentation.

[paraslash.git] / playlist.c

diff --git a/playlist.c b/playlist.c
index 6f9f9669618377370daa1f330dd1b76f464eeb7e..ba99fad269ff740934ecec731166b01d3efdd7d1 100644 (file)
--- a/playlist.c
+++ b/playlist.c
@@ -122,6 +122,14 @@ static int check_playlist(struct osl_row *row, void *data)
        return 1;
 }
 
+/**
+ * Check the playlist table for inconsistencies.
+ *
+ * \param query Unused.
+ * \param result Contains messages about inconsistencies.
+ *
+ * \return The return value of the underlying call to osl_rbtree_loop().
+ */
 int playlist_check_callback(__a_unused const struct osl_object *query,
                struct osl_object *result)
 {