From: Rémi Denis-Courmont <remi@remlab.net>
Date: Fri, 17 Sep 2010 03:10:04 +0000 (+0300)
Subject: Improve vlc_readdir documentation
X-Git-Tag: 1.2.0-pre1~5256
X-Git-Url: https://git.sesse.net/?a=commitdiff_plain;h=fc08208b886f5d05c6d89b076ba9c351c67f853c;p=vlc

Improve vlc_readdir documentation
---

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