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>
This commit is contained in:
Michael Niedermayer 2015-03-27 21:17:30 +01:00
parent fff7871772
commit d03b998c48

View File

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