FIXME removal: document enumerateFiles() sorting promises.
authorRyan C. Gordon <icculus@icculus.org>
Sat, 12 Aug 2017 02:24:38 -0400
changeset 1561 422fbc7f1816
parent 1560 6db57d6bff9a
child 1562 2d0eab83ebb7
FIXME removal: document enumerateFiles() sorting promises.
src/physfs.h
--- a/src/physfs.h	Sat Aug 12 02:21:11 2017 -0400
+++ b/src/physfs.h	Sat Aug 12 02:24:38 2017 -0400
@@ -1107,7 +1107,7 @@
  *
  * 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
- *  (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
  *  function when you are done with it.
@@ -2592,10 +2592,6 @@
  * PHYSFS_enumerate("/some/path", printDir, NULL);
  * \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.
  *  There is no sorting done at this level, and if you need that, you should
  *  probably use PHYSFS_enumerateFiles() instead, which guarantees