Browse Source

SDL_Enumerate[Storage]Directory() comments: Use enum constant names instead of integers.

Petar Popovic 9 months ago
parent
commit
04a478b6a9
2 changed files with 4 additions and 4 deletions
  1. 2 2
      include/SDL3/SDL_filesystem.h
  2. 2 2
      include/SDL3/SDL_storage.h

+ 2 - 2
include/SDL3/SDL_filesystem.h

@@ -306,10 +306,10 @@ typedef SDL_EnumerationResult (SDLCALL *SDL_EnumerateDirectoryCallback)(void *us
  *
  *
  * This function provides every directory entry through an app-provided
  * This function provides every directory entry through an app-provided
  * callback, called once for each directory entry, until all results have been
  * callback, called once for each directory entry, until all results have been
- * provided or the callback returns <= 0.
+ * provided or the callback returns either SDL_ENUM_SUCCESS or SDL_ENUM_FAILURE.
  *
  *
  * This will return false if there was a system problem in general, or if a
  * This will return false if there was a system problem in general, or if a
- * callback returns -1. A successful return means a callback returned 1 to
+ * callback returns SDL_ENUM_FAILURE. A successful return means a callback returned SDL_ENUM_SUCCESS to
  * halt enumeration, or all directory entries were enumerated.
  * halt enumeration, or all directory entries were enumerated.
  *
  *
  * \param path the path of the directory to enumerate.
  * \param path the path of the directory to enumerate.

+ 2 - 2
include/SDL3/SDL_storage.h

@@ -318,10 +318,10 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CreateStorageDirectory(SDL_Storage *storage
  *
  *
  * This function provides every directory entry through an app-provided
  * This function provides every directory entry through an app-provided
  * callback, called once for each directory entry, until all results have been
  * callback, called once for each directory entry, until all results have been
- * provided or the callback returns <= 0.
+ * provided or the callback returns either SDL_ENUM_SUCCESS or SDL_ENUM_FAILURE.
  *
  *
  * This will return false if there was a system problem in general, or if a
  * This will return false if there was a system problem in general, or if a
- * callback returns -1. A successful return means a callback returned 1 to
+ * callback returns SDL_ENUM_FAILURE. A successful return means a callback returned SDL_ENUM_SUCCESS to
  * halt enumeration, or all directory entries were enumerated.
  * halt enumeration, or all directory entries were enumerated.
  *
  *
  * \param storage a storage container.
  * \param storage a storage container.