aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorMax Kellermann <max@duempel.org>2009-02-04 21:09:37 +0100
committerMax Kellermann <max@duempel.org>2009-02-04 21:09:37 +0100
commit080dd095a5113a2454d4a0b050f233befb7eab1a (patch)
tree027db87fed6b5b20b589339ce3f17384c428e77d /src
parent60bec7766494b2f904658006dfc217d241f44ce8 (diff)
downloadmpd-080dd095a5113a2454d4a0b050f233befb7eab1a.tar.gz
mpd-080dd095a5113a2454d4a0b050f233befb7eab1a.tar.xz
mpd-080dd095a5113a2454d4a0b050f233befb7eab1a.zip
playlist_print: added API documentation
Diffstat (limited to '')
-rw-r--r--src/playlist_print.h8
1 files changed, 8 insertions, 0 deletions
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);