aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMax Kellermann <max@duempel.org>2008-11-09 22:10:48 +0100
committerMax Kellermann <max@duempel.org>2008-11-09 22:10:48 +0100
commitc9c7dc6e0069e7e7392701e97043d19f4e21016c (patch)
tree57fae507fb3792a654aad3f59ff6baebe12d2158
parentab24e203cdcf4028eaedbe7dc701322069853ebe (diff)
downloadmpd-c9c7dc6e0069e7e7392701e97043d19f4e21016c.tar.gz
mpd-c9c7dc6e0069e7e7392701e97043d19f4e21016c.tar.xz
mpd-c9c7dc6e0069e7e7392701e97043d19f4e21016c.zip
decoder: updated API documentation
Updated documentation on the stream_decode() and file_decode() return values.
Diffstat (limited to '')
-rw-r--r--src/decoder_api.h8
1 files changed, 6 insertions, 2 deletions
diff --git a/src/decoder_api.h b/src/decoder_api.h
index f4ef49525..ab480599b 100644
--- a/src/decoder_api.h
+++ b/src/decoder_api.h
@@ -70,7 +70,9 @@ struct decoder_plugin {
* this will be used to decode InputStreams, and is
* recommended for files and networked (HTTP) connections.
*
- * returns false on error, true on success
+ * @return false if the plugin cannot decode the stream, and
+ * true if it was able to do so (even if an error occured
+ * during playback)
*/
bool (*stream_decode)(struct decoder *, struct input_stream *);
@@ -79,7 +81,9 @@ struct decoder_plugin {
* a filename or handle as input, and will not allow callbacks
* to be set (like Ogg-Vorbis and FLAC libraries allow)
*
- * returns -1 on error, 0 on success
+ * @return false if the plugin cannot decode the file, and
+ * true if it was able to do so (even if an error occured
+ * during playback)
*/
bool (*file_decode)(struct decoder *, const char *path);