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>

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);