Przeglądaj źródła

Fixed documentation for return lfs_dir_read return value.

lfs_dir_read breaks the convention of returning non-zero on success,
this feature should be at least documented.
Ladislav Láska 6 lat temu
rodzic
commit
26d25608b6
1 zmienionych plików z 2 dodań i 1 usunięć
  1. 2 1
      lfs.h

+ 2 - 1
lfs.h

@@ -448,7 +448,8 @@ int lfs_dir_close(lfs_t *lfs, lfs_dir_t *dir);
 // Read an entry in the directory
 //
 // Fills out the info structure, based on the specified file or directory.
-// Returns a negative error code on failure.
+// Returns a positive value on success, 0 at the end of directory,
+// or a negative error code on failure.
 int lfs_dir_read(lfs_t *lfs, lfs_dir_t *dir, struct lfs_info *info);
 
 // Change the position of the directory