mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-09-06 03:18:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Petar Popovic
2024-10-27 20:34:32 +01:00
committed by Sam Lantinga
parent 5c3d42aade
commit 04a478b6a9
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
include/SDL3/SDL_filesystem.h
View File

@@ -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.

4
include/SDL3/SDL_storage.h
View File

@@ -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.