[FFmpeg-cvslog] avformat/avio: Document the end of list case in avio_read_dir()

[Michael Niedermayer]

ffmpeg | branch: master | Michael Niedermayer <michaelni at gmx.at> | Fri Mar 27 21:17:30 2015 +0100| [d03b998c48a8f20fb8dc2be2508d22c2dec0a7ed] | committer: Michael Niedermayer

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 at gmx.at>

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=d03b998c48a8f20fb8dc2be2508d22c2dec0a7ed
---

 libavformat/avio.h |    3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/libavformat/avio.h b/libavformat/avio.h
index bbd482a..f61a8f8 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);