Backport from default branch: corrected PHYSFS_enumerateFiles() documentation.

(transplanted from aaa1204a4426c5412d9c2814e41e0b7066db060c)
This commit is contained in:
Ryan C. Gordon 2014-08-14 21:27:00 -04:00
parent 9977f5c9b4
commit e095ee4303
1 changed files with 3 additions and 2 deletions

View File

@ -897,8 +897,9 @@ __EXPORT__ const char *PHYSFS_getRealDir(const char *filename);
* We've got [z.sav].
* We've got [w.sav].\endverbatim
*
* Feel free to sort the list however you like. We only promise there will
* be no duplicates, but not what order the final list will come back in.
* 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.
*
* Don't forget to call PHYSFS_freeList() with the return value from this
* function when you are done with it.