aboutsummaryrefslogtreecommitdiffstats
path: root/libavformat/avio.h
diff options
context:
space:
mode:
authorMichael Niedermayer <michaelni@gmx.at>2015-03-27 21:17:30 +0100
committerMichael Niedermayer <michaelni@gmx.at>2015-03-27 21:34:23 +0100
commitd03b998c48a8f20fb8dc2be2508d22c2dec0a7ed (patch)
tree000e74dee21fd16b8b309dd65708411ac06465b0 /libavformat/avio.h
parentfff78717725bd5b5f22f084c3e7427e1b7dad7b6 (diff)
downloadffmpeg-d03b998c48a8f20fb8dc2be2508d22c2dec0a7ed.tar.gz
avformat/avio: Document the end of list case in avio_read_dir()
This was mentioned in a previous review Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
Diffstat (limited to 'libavformat/avio.h')
-rw-r--r--libavformat/avio.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/libavformat/avio.h b/libavformat/avio.h
index bbd482a52e..f61a8f8763 100644
--- a/libavformat/avio.h
+++ b/libavformat/avio.h
@@ -240,7 +240,8 @@ int avio_open_dir(AVIODirContext **s, const char *url, AVDictionary **options);
*
* @param s directory read context.
* @param[out] next next entry or NULL when no more entries.
- * @return >=0 on success or negative on error.
+ * @return >=0 on success or negative on error. End of list is not considered an
+ * error.
*/
int avio_read_dir(AVIODirContext *s, AVIODirEntry **next);