From fc08208b886f5d05c6d89b076ba9c351c67f853c Mon Sep 17 00:00:00 2001 From: =?utf8?q?R=C3=A9mi=20Denis-Courmont?= Date: Fri, 17 Sep 2010 06:10:04 +0300 Subject: [PATCH] Improve vlc_readdir documentation --- src/text/filesystem.c | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/text/filesystem.c b/src/text/filesystem.c index 65fafcbce8..ff08e1e934 100644 --- a/src/text/filesystem.c +++ b/src/text/filesystem.c @@ -311,8 +311,9 @@ DIR *vlc_opendir( const char *dirname ) * * @param dir The directory that is being read * - * @return a UTF-8 string of the directory entry. - * Use free() to free this memory. + * @return a UTF-8 string of the directory entry. Use free() to release it. + * If there are no more entries in the directory, NULL is returned. + * If an error occurs, errno is set and NULL is returned. */ char *vlc_readdir( DIR *dir ) { -- 2.39.2