From 9625fb28326655fe2d18fe583b835779c2492d95 Mon Sep 17 00:00:00 2001 From: Sam Lantinga Date: Tue, 27 Dec 2022 05:28:18 -0800 Subject: [PATCH] Documentation cleanup --- WhatsNew.txt | 6 +++--- docs/README-migration.md | 8 +++----- include/SDL3/SDL_audio.h | 2 -- 3 files changed, 6 insertions(+), 10 deletions(-) diff --git a/WhatsNew.txt b/WhatsNew.txt index 2fce93b9c..81e5ab30b 100644 --- a/WhatsNew.txt +++ b/WhatsNew.txt @@ -15,11 +15,11 @@ General: * RW_SEEK_CUR -> SDL_RW_SEEK_CUR * RW_SEEK_END -> SDL_RW_SEEK_END * RW_SEEK_SET -> SDL_RW_SEEK_SET +* SDL_FreeWAV has been removed and calls can be replaced with SDL_free * The following functions have been renamed: - * SDL_FreeWAV => SDL_free * Removed the following functions from the API, see docs/README-migration.md for details: - * SDL_AudioInit - * SDL_AudioQuit + * SDL_AudioInit() + * SDL_AudioQuit() * SDL_CalculateGammaRamp() * SDL_CreateRGBSurface() * SDL_CreateRGBSurfaceFrom() diff --git a/docs/README-migration.md b/docs/README-migration.md index 7d5cde190..4399ef67d 100644 --- a/docs/README-migration.md +++ b/docs/README-migration.md @@ -42,15 +42,13 @@ The vi format comments have been removed from source code. Vim users can use the ## SDL_audio.h -- SDL_AudioInit() and SDL_AudioQuit() have been removed. Instead you can call SDL_InitSubSytem() and SDL_QuitSubSytem() with SDL_INIT_AUDIO, which will properly refcount the subsystems. - Also the hint SDL_AUDIO_DRIVER can help to choose a specific driver. +SDL_AudioInit() and SDL_AudioQuit() have been removed. Instead you can call SDL_InitSubSytem() and SDL_QuitSubSytem() with SDL_INIT_AUDIO, which will properly refcount the subsystems. You can choose a specific audio driver using SDL_AUDIO_DRIVER hint. -The following functions have been renamed: -* SDL_FreeWAV => SDL_free +SDL_FreeWAV has been removed and calls can be replaced with SDL_free. ## SDL_cpuinfo.h -- SDL_Has3DNow() has been removed; there is no replacement. +SDL_Has3DNow() has been removed; there is no replacement. The following headers are no longer automatically included, and will need to be included manually: - immintrin.h diff --git a/include/SDL3/SDL_audio.h b/include/SDL3/SDL_audio.h index 5ec2f2c89..32addc33d 100644 --- a/include/SDL3/SDL_audio.h +++ b/include/SDL3/SDL_audio.h @@ -311,8 +311,6 @@ extern DECLSPEC const char *SDLCALL SDL_GetAudioDriver(int index); * initialized. * * \since This function is available since SDL 3.0.0. - * - * \sa SDL_INIT_AUDIO */ extern DECLSPEC const char *SDLCALL SDL_GetCurrentAudioDriver(void);