Improve vlc_readdir documentation

fc08208b · Rémi Denis-Courmont · 2c7fa286 · fc08208b
Commit fc08208b authored Sep 17, 2010 by Rémi Denis-Courmont
Hide whitespace changes
Inline Side-by-side

Showing with 3 additions and 2 deletions

src/text/filesystem.c src/text/filesystem.c +3 -2

No files found.
--- 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 )
 {