From 26e92f519242d9e704b4070800950cbddbe0a810 Mon Sep 17 00:00:00 2001
From: John Kenyon <[EMAIL REDACTED]>
Date: Sun, 8 Oct 2023 01:39:52 -0700
Subject: [PATCH] Fix some \param comments to match real parameter names/list
---
include/SDL3_mixer/SDL_mixer.h | 17 ++++++++---------
1 file changed, 8 insertions(+), 9 deletions(-)
diff --git a/include/SDL3_mixer/SDL_mixer.h b/include/SDL3_mixer/SDL_mixer.h
index 114054ff..c4ea5241 100644
--- a/include/SDL3_mixer/SDL_mixer.h
+++ b/include/SDL3_mixer/SDL_mixer.h
@@ -1229,7 +1229,7 @@ extern DECLSPEC int SDLCALL Mix_RegisterEffect(int chan, Mix_EffectFunc_t f, Mix
* zero if there's an error, not on success. We apologize for the API design
* inconsistency here.
*
- * \param chan the channel to unregister an effect on, or MIX_CHANNEL_POST.
+ * \param channel the channel to unregister an effect on, or MIX_CHANNEL_POST.
* \param f effect the callback stop calling in future mixing iterations.
* \returns zero if error (no such channel or effect), nonzero if removed.
* Error messages can be retrieved from Mix_GetError().
@@ -1255,7 +1255,7 @@ extern DECLSPEC int SDLCALL Mix_UnregisterEffect(int channel, Mix_EffectFunc_t f
* zero if there's an error, not on success. We apologize for the API design
* inconsistency here.
*
- * \param chan the channel to unregister all effects on, or MIX_CHANNEL_POST.
+ * \param channel the channel to unregister all effects on, or MIX_CHANNEL_POST.
* \returns zero if error (no such channel), nonzero if all effects removed.
* Error messages can be retrieved from Mix_GetError().
*
@@ -1613,7 +1613,7 @@ extern DECLSPEC int SDLCALL Mix_GroupNewer(int tag);
*
* \param channel the channel on which to play the new chunk.
* \param chunk the new chunk to play.
- * \param loop the number of times the chunk should loop, -1 to loop (not
+ * \param loops the number of times the chunk should loop, -1 to loop (not
* actually) infinitely.
* \returns which channel was used to play the sound, or -1 if sound could not
* be played.
@@ -1644,7 +1644,7 @@ extern DECLSPEC int SDLCALL Mix_PlayChannel(int channel, Mix_Chunk *chunk, int l
*
* \param channel the channel on which to play the new chunk.
* \param chunk the new chunk to play.
- * \param loop the number of times the chunk should loop, -1 to loop (not
+ * \param loops the number of times the chunk should loop, -1 to loop (not
* actually) infinitely.
* \param ticks the maximum number of milliseconds of this chunk to mix for
* playback.
@@ -1696,7 +1696,7 @@ extern DECLSPEC int SDLCALL Mix_PlayMusic(Mix_Music *music, int loops);
* Mix_VolumeMusic() on fading music).
*
* \param music the new music object to play.
- * \param loop the number of times the chunk should loop, -1 to loop (not
+ * \param loops the number of times the chunk should loop, -1 to loop (not
* actually) infinitely.
* \param ms the number of milliseconds to spend fading in.
* \returns zero on success, -1 on error.
@@ -1733,7 +1733,7 @@ extern DECLSPEC int SDLCALL Mix_FadeInMusic(Mix_Music *music, int loops, int ms)
* To convert from milliseconds, divide by 1000.0.
*
* \param music the new music object to play.
- * \param loop the number of times the chunk should loop, -1 to loop (not
+ * \param loops the number of times the chunk should loop, -1 to loop (not
* actually) infinitely.
* \param ms the number of milliseconds to spend fading in.
* \param position the start position within the music, in seconds, where
@@ -1774,7 +1774,7 @@ extern DECLSPEC int SDLCALL Mix_FadeInMusicPos(Mix_Music *music, int loops, int
* \param channel the channel on which to play the new chunk, or -1 to find
* any available.
* \param chunk the new chunk to play.
- * \param loop the number of times the chunk should loop, -1 to loop (not
+ * \param loops the number of times the chunk should loop, -1 to loop (not
* actually) infinitely.
* \param ms the number of milliseconds to spend fading in.
* \returns which channel was used to play the sound, or -1 if sound could not
@@ -1816,7 +1816,7 @@ extern DECLSPEC int SDLCALL Mix_FadeInChannel(int channel, Mix_Chunk *chunk, int
* \param channel the channel on which to play the new chunk, or -1 to find
* any available.
* \param chunk the new chunk to play.
- * \param loop the number of times the chunk should loop, -1 to loop (not
+ * \param loops the number of times the chunk should loop, -1 to loop (not
* actually) infinitely.
* \param ms the number of milliseconds to spend fading in.
* \param ticks the maximum number of milliseconds of this chunk to mix for
@@ -2104,7 +2104,6 @@ extern DECLSPEC int SDLCALL Mix_FadeOutGroup(int tag, int ms);
* requested; it just schedules the music to fade and notes the time for the
* mixer to manage later, and returns immediately.
*
- * \param which the channel to fade out.
* \param ms number of milliseconds to fade before halting the channel.
* \returns non-zero if music was scheduled to fade, zero otherwise. If no
* music is currently playing, this returns zero.