walkero
/
physfs
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

FIXME removal: document enumerateFiles() sorting promises.

This commit is contained in:
Ryan C. Gordon 2017-08-12 02:24:38 -04:00
parent db2201e4e1
commit f6a8533ba2
1 changed files with 1 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/physfs.h
View File

@ -1107,7 +1107,7 @@ PHYSFS_DECL const char *PHYSFS_getRealDir(const char *filename);
* *
* Feel free to sort the list however you like. However, the returned data * Feel free to sort the list however you like. However, the returned data
* will always contain no duplicates, and will be always sorted in alphabetic * will always contain no duplicates, and will be always sorted in alphabetic
* (rather: Unicode) order for you. * (rather: case-sensitive Unicode) order for you.
* *
* Don't forget to call PHYSFS_freeList() with the return value from this * Don't forget to call PHYSFS_freeList() with the return value from this
* function when you are done with it. * function when you are done with it.
@ -2592,10 +2592,6 @@ typedef int (*PHYSFS_EnumerateCallback)(void *data, const char *origdir,
* PHYSFS_enumerate("/some/path", printDir, NULL); * PHYSFS_enumerate("/some/path", printDir, NULL);
* \endcode * \endcode
* *
* !!! FIXME-3.0: enumerateFiles() does not promise alphabetical sorting by
* !!! FIXME: case-sensitivity in the code, and doesn't promise sorting at
* !!! FIXME: all in the above docs.
*
* Items sent to the callback are not guaranteed to be in any order whatsoever. * Items sent to the callback are not guaranteed to be in any order whatsoever.
* There is no sorting done at this level, and if you need that, you should * There is no sorting done at this level, and if you need that, you should
* probably use PHYSFS_enumerateFiles() instead, which guarantees * probably use PHYSFS_enumerateFiles() instead, which guarantees