Minor cleanup

This commit is contained in:
Sam Lantinga
2024-09-27 14:10:46 -07:00
parent 1088ea55fa
commit 3f446d8fb5
4 changed files with 65 additions and 68 deletions

View File

@@ -42,21 +42,6 @@ extern "C" {
/* Function prototypes */
/**
* Retrieve the list of mime types available in the clipboard.
*
* \param num_mime_types a pointer filled with the number of mime types. May
* be NULL.
* \returns a null terminated array of strings with mime types, or NULL on
* failure; call SDL_GetError() for more information. This should be
* freed with SDL_free() when it is no longer needed.
*
* \since This function is available since SDL 3.0.0.
*
* \sa SDL_SetClipboardData
*/
extern SDL_DECLSPEC char ** SDLCALL SDL_GetClipboardMimeTypes(size_t *num_mime_types);
/**
* Put UTF-8 text into the clipboard.
*
@@ -255,6 +240,21 @@ extern SDL_DECLSPEC void * SDLCALL SDL_GetClipboardData(const char *mime_type, s
*/
extern SDL_DECLSPEC bool SDLCALL SDL_HasClipboardData(const char *mime_type);
/**
* Retrieve the list of mime types available in the clipboard.
*
* \param num_mime_types a pointer filled with the number of mime types, may
* be NULL.
* \returns a null terminated array of strings with mime types, or NULL on
* failure; call SDL_GetError() for more information. This should be
* freed with SDL_free() when it is no longer needed.
*
* \since This function is available since SDL 3.0.0.
*
* \sa SDL_SetClipboardData
*/
extern SDL_DECLSPEC char ** SDLCALL SDL_GetClipboardMimeTypes(size_t *num_mime_types);
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
}

View File

@@ -133,14 +133,13 @@ typedef void (SDLCALL *SDL_DialogFileCallback)(void *userdata, const char * cons
* the selected filter.
* \param userdata an optional pointer to pass extra data to the callback when
* 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.
* Not all platforms support this option.
* \param filters a list of SDL_DialogFileFilter's. May be NULL. Not all
* \param filters a list of SDL_DialogFileFilter's, may be NULL. Not all
* platforms support this option, and platforms that do support
* it may allow the user to ignore the filters.
* \param nfilters the number of filters. Ignored if filters is NULL.
* \param default_location the default folder or file to start the dialog at.
* May be NULL. Not all platforms support this option.
* \param default_location the default folder or file to start the dialog at, may be NULL. Not all platforms support this option.
* \param allow_many if non-zero, the user will be allowed to select multiple
* entries. Not all platforms support this option.
*
@@ -190,14 +189,13 @@ extern SDL_DECLSPEC void SDLCALL SDL_ShowOpenFileDialog(SDL_DialogFileCallback c
* the selected filter.
* \param userdata an optional pointer to pass extra data to the callback when
* 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.
* Not all platforms support this option.
* \param filters a list of SDL_DialogFileFilter's. May be NULL. Not all
* \param filters a list of SDL_DialogFileFilter's, may be NULL. Not all
* platforms support this option, and platforms that do support
* it may allow the user to ignore the filters.
* \param nfilters the number of filters. Ignored if filters is NULL.
* \param default_location the default folder or file to start the dialog at.
* May be NULL. Not all platforms support this option.
* \param default_location the default folder or file to start the dialog at, may be NULL. Not all platforms support this option.
*
* \since This function is available since SDL 3.0.0.
*
@@ -241,10 +239,9 @@ extern SDL_DECLSPEC void SDLCALL SDL_ShowSaveFileDialog(SDL_DialogFileCallback c
* argument is always -1 for SDL_ShowOpenFolderDialog.
* \param userdata an optional pointer to pass extra data to the callback when
* 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.
* Not all platforms support this option.
* \param default_location the default folder or file to start the dialog at.
* May be NULL. Not all platforms support this option.
* \param default_location the default folder or file to start the dialog at, may be NULL. Not all platforms support this option.
* \param allow_many if non-zero, the user will be allowed to select multiple
* entries. Not all platforms support this option.
*

View File

@@ -4048,7 +4048,7 @@ size_t wcslcat(wchar_t *dst, const wchar_t *src, size_t size);
*
* \param a the multiplicand.
* \param b the multiplier.
* \param ret on non-overflow output, stores the multiplication result. May
* \param ret on non-overflow output, stores the multiplication result, may
* not be NULL.
* \returns false on overflow, true if result is multiplied without overflow.
*
@@ -4087,7 +4087,7 @@ SDL_FORCE_INLINE bool SDL_size_mul_check_overflow_builtin(size_t a, size_t b, si
*
* \param a the first addend.
* \param b the second addend.
* \param ret on non-overflow output, stores the addition result. May not be
* \param ret on non-overflow output, stores the addition result, may not be
* NULL.
* \returns false on overflow, true if result is added without overflow.
*