From 080dd095a5113a2454d4a0b050f233befb7eab1a Mon Sep 17 00:00:00 2001
From: Max Kellermann <max@duempel.org>
Date: Wed, 4 Feb 2009 21:09:37 +0100
Subject: playlist_print: added API documentation

---
 src/playlist_print.h | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'src')

diff --git a/src/playlist_print.h b/src/playlist_print.h
index 68ffb2032..3cedeaa7d 100644
--- a/src/playlist_print.h
+++ b/src/playlist_print.h
@@ -23,6 +23,14 @@
 
 struct client;
 
+/**
+ * Send the stored playlist to the client.
+ *
+ * @param client the client which requested the playlist
+ * @param name_utf8 the name of the stored playlist in UTF-8 encoding
+ * @param detail true if all details should be printed
+ * @return true on success, false if the playlist does not exist
+ */
 bool
 spl_print(struct client *client, const char *name_utf8, bool detail);
 
-- 
cgit v1.2.3