vfs: fix readdir return value documentation

RIOT-OS · Apr 3, 2017 · e56c4f3 · e56c4f3
1 parent dab3de5
commit e56c4f3
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/sys/include/vfs.h b/sys/include/vfs.h
@@ -652,7 +652,8 @@ int vfs_opendir(vfs_DIR *dirp, const char *dirname);
  * @param[in]  dirp     pointer to open directory
  * @param[out] entry    directory entry information
  *
- * @return 0 on success
+ * @return 1 if @p entry was updated
+ * @return 0 if @p dirp has reached the end of the directory index
  * @return <0 on error
  */
 int vfs_readdir(vfs_DIR *dirp, vfs_dirent_t *entry);