Browse Source

Sync SDL3 wiki -> header

[ci skip]
SDL Wiki Bot 9 months ago
parent
commit
3922bcec95
2 changed files with 10 additions and 6 deletions
  1. 5 3
      include/SDL3/SDL_filesystem.h
  2. 5 3
      include/SDL3/SDL_storage.h

+ 5 - 3
include/SDL3/SDL_filesystem.h

@@ -306,11 +306,13 @@ 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 either SDL_ENUM_SUCCESS or SDL_ENUM_FAILURE.
+ * 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 SDL_ENUM_FAILURE. A successful return means a callback returned SDL_ENUM_SUCCESS to
- * halt enumeration, or all directory entries were enumerated.
+ * callback returns SDL_ENUM_FAILURE. A successful return means a callback
+ * returned SDL_ENUM_SUCCESS to 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.
  * \param callback a function that is called for each entry in the directory.
  * \param callback a function that is called for each entry in the directory.

+ 5 - 3
include/SDL3/SDL_storage.h

@@ -318,11 +318,13 @@ 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 either SDL_ENUM_SUCCESS or SDL_ENUM_FAILURE.
+ * 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 SDL_ENUM_FAILURE. A successful return means a callback returned SDL_ENUM_SUCCESS to
- * halt enumeration, or all directory entries were enumerated.
+ * callback returns SDL_ENUM_FAILURE. A successful return means a callback
+ * returned SDL_ENUM_SUCCESS to halt enumeration, or all directory entries
+ * were enumerated.
  *
  *
  * \param storage a storage container.
  * \param storage a storage container.
  * \param path the path of the directory to enumerate.
  * \param path the path of the directory to enumerate.