[vlc-commits] commit: Improve vlc_readdir documentation ( Rémi Denis-Courmont )

[git at videolan.org]

vlc | branch: master | Rémi Denis-Courmont <remi at remlab.net> | Fri Sep 17 06:10:04 2010 +0300| [fc08208b886f5d05c6d89b076ba9c351c67f853c] | committer: Rémi Denis-Courmont 

Improve vlc_readdir documentation

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

 src/text/filesystem.c |    5 +++--
 1 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/text/filesystem.c b/src/text/filesystem.c
index 65fafcb..ff08e1e 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 )
 {