Mirrors_Framework/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2026-06-04 06:12:04 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

SDL_dialog.h: Remove verbose docs on callback param from several functions.

Browse Source 
In the wiki, one can click on SDL_DialogFileCallback for these details, or
grep for the symbol in the headers to find the information.

Fixes #11504.
This commit is contained in:
Ryan C. Gordon
2024-11-20 23:41:37 -05:00
parent 587384756f
commit ecae3789ab
1 changed files with 7 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/SDL3/SDL_dialog.h
+7 -33
View File
@@ -76,7 +76,7 @@ typedef struct SDL_DialogFileFilter
* is a null-terminated list of pointers to C strings, each containing a * is a null-terminated list of pointers to C strings, each containing a
* path. * path.
* *
* The filelist argument does not need to be freed; it will automatically be * The filelist argument should not be freed; it will automatically be
* freed when the callback returns. * freed when the callback returns.
* *
* The filter argument is the index of the filter that was selected, or -1 if * The filter argument is the index of the filter that was selected, or -1 if
@@ -118,19 +118,9 @@ typedef void (SDLCALL *SDL_DialogFileCallback)(void *userdata, const char * cons
* requires an event-handling loop. Apps that do not use SDL to handle events * requires an event-handling loop. Apps that do not use SDL to handle events
* should add a call to SDL_PumpEvents in their main loop. * should add a call to SDL_PumpEvents in their main loop.
* *
* \param callback an SDL_DialogFileCallback to be invoked when the user * \param callback a function pointer to be invoked when the user
* selects a file and accepts, or cancels the dialog, or an * selects a file and accepts, or cancels the dialog, or an
* error occurs. The first argument is a null-terminated list * error occurs.
* of C strings, representing the paths chosen by the user.
* The list will be empty if the user canceled the dialog, and
* it will be NULL if an error occurred. If an error occurred,
* it can be fetched with SDL_GetError(). The second argument
* is the userdata pointer passed to the function. The third
* argument is the index of the filter selected by the user,
* or one past the index of the last filter (therefore the
* index of the terminating NULL filter) if no filter was
* chosen, or -1 if the platform does not support detecting
* the selected filter.
* \param userdata an optional pointer to pass extra data to the callback when * \param userdata an optional pointer to pass extra data to the callback when
* it will be invoked. * it will be invoked.
* \param window the window that the dialog should be modal for, may be NULL. * \param window the window that the dialog should be modal for, may be NULL.
@@ -175,19 +165,9 @@ extern SDL_DECLSPEC void SDLCALL SDL_ShowOpenFileDialog(SDL_DialogFileCallback c
* requires an event-handling loop. Apps that do not use SDL to handle events * requires an event-handling loop. Apps that do not use SDL to handle events
* should add a call to SDL_PumpEvents in their main loop. * should add a call to SDL_PumpEvents in their main loop.
* *
* \param callback an SDL_DialogFileCallback to be invoked when the user * \param callback a function pointer to be invoked when the user
* selects a file and accepts, or cancels the dialog, or an * selects a file and accepts, or cancels the dialog, or an
* error occurs. The first argument is a null-terminated list * error occurs.
* of C strings, representing the paths chosen by the user.
* The list will be empty if the user canceled the dialog, and
* it will be NULL if an error occurred. If an error occurred,
* it can be fetched with SDL_GetError(). The second argument
* is the userdata pointer passed to the function. The third
* argument is the index of the filter selected by the user,
* or one past the index of the last filter (therefore the
* index of the terminating NULL filter) if no filter was
* chosen, or -1 if the platform does not support detecting
* the selected filter.
* \param userdata an optional pointer to pass extra data to the callback when * \param userdata an optional pointer to pass extra data to the callback when
* it will be invoked. * it will be invoked.
* \param window the window that the dialog should be modal for, may be NULL. * \param window the window that the dialog should be modal for, may be NULL.
@@ -230,15 +210,9 @@ extern SDL_DECLSPEC void SDLCALL SDL_ShowSaveFileDialog(SDL_DialogFileCallback c
* requires an event-handling loop. Apps that do not use SDL to handle events * requires an event-handling loop. Apps that do not use SDL to handle events
* should add a call to SDL_PumpEvents in their main loop. * should add a call to SDL_PumpEvents in their main loop.
* *
* \param callback an SDL_DialogFileCallback to be invoked when the user * \param callback a function pointer to be invoked when the user
* selects a file and accepts, or cancels the dialog, or an * selects a file and accepts, or cancels the dialog, or an
* error occurs. The first argument is a null-terminated list * error occurs.
* of C strings, representing the paths chosen by the user.
* The list will be empty if the user canceled the dialog, and
* it will be NULL if an error occurred. If an error occurred,
* it can be fetched with SDL_GetError(). The second argument
* is the userdata pointer passed to the function. The third
* argument is always -1 for SDL_ShowOpenFolderDialog.
* \param userdata an optional pointer to pass extra data to the callback when * \param userdata an optional pointer to pass extra data to the callback when
* it will be invoked. * it will be invoked.
* \param window the window that the dialog should be modal for, may be NULL. * \param window the window that the dialog should be modal for, may be NULL.