From f50e08a3d4cdaabfe0e074ee6217b6df55e253f8 Mon Sep 17 00:00:00 2001
From: SDL Wiki Bot <[EMAIL REDACTED]>
Date: Fri, 14 Jun 2024 06:12:06 +0000
Subject: [PATCH] Sync SDL2_mixer wiki -> header
(cherry picked from commit 924f530e42acdccc8478ed1872aaf4f75da82e7c)
---
include/SDL_mixer.h | 28 ++++++++++++++--------------
1 file changed, 14 insertions(+), 14 deletions(-)
diff --git a/include/SDL_mixer.h b/include/SDL_mixer.h
index f6a2d1105..0fa6456b0 100644
--- a/include/SDL_mixer.h
+++ b/include/SDL_mixer.h
@@ -451,7 +451,7 @@ extern DECLSPEC int SDLCALL Mix_OpenAudio(int frequency, Uint16 format, int chan
* by channel count).
* \param device the device name to open, or NULL to choose a reasonable
* default.
- * \param allowed_changes Allow change flags (see SDL_AUDIO_ALLOW_* flags)
+ * \param allowed_changes Allow change flags (see SDL_AUDIO_ALLOW_* flags).
* \returns 0 if successful, -1 on error.
*
* \since This function is available since SDL_mixer 2.0.2.
@@ -1357,8 +1357,8 @@ typedef void (SDLCALL *Mix_EffectDone_t)(int chan, void *udata);
* \param chan the channel to register an effect to, or MIX_CHANNEL_POST.
* \param f effect the callback to run when more of this channel is to be
* mixed.
- * \param d effect done callback
- * \param arg argument
+ * \param d effect done callback.
+ * \param arg argument.
* \returns zero if error (no such channel), nonzero if added. Error messages
* can be retrieved from Mix_GetError().
*
@@ -1673,7 +1673,7 @@ extern DECLSPEC int SDLCALL Mix_GroupChannel(int which, int tag);
* \param from the first channel to set the tag on.
* \param to the last channel to set the tag on, inclusive.
* \param tag an arbitrary value to assign a channel.
- * \returns 0 if successful, negative on error
+ * \returns 0 if successful, negative on error.
*
* \since This function is available since SDL_mixer 2.0.0.
*/
@@ -1720,7 +1720,7 @@ extern DECLSPEC int SDLCALL Mix_GroupCount(int tag);
* If no channel with this tag is currently playing, this function returns -1.
*
* \param tag an arbitrary value, assigned to channels, to search through.
- * \returns the "oldest" sample playing in a group of channels
+ * \returns the "oldest" sample playing in a group of channels.
*
* \since This function is available since SDL_mixer 2.0.0.
*
@@ -1738,7 +1738,7 @@ extern DECLSPEC int SDLCALL Mix_GroupOldest(int tag);
* If no channel with this tag is currently playing, this function returns -1.
*
* \param tag an arbitrary value, assigned to channels, to search through.
- * \returns the "most recent" sample playing in a group of channels
+ * \returns the "most recent" sample playing in a group of channels.
*
* \since This function is available since SDL_mixer 2.0.0.
*
@@ -2421,7 +2421,7 @@ extern DECLSPEC int SDLCALL Mix_PausedMusic(void);
*
* This only applies to MOD music formats.
*
- * \param order order
+ * \param order order.
* \returns 0 if successful, or -1 if failed or isn't implemented.
*
* \since This function is available since SDL_mixer 2.6.0.
@@ -2504,7 +2504,7 @@ extern DECLSPEC double SDLCALL Mix_MusicDuration(Mix_Music *music);
*
* \param music the music object to query.
* \returns -1.0 if this feature is not used for this music or not supported
- * for some codec
+ * for some codec.
*
* \since This function is available since SDL_mixer 2.6.0.
*/
@@ -2519,7 +2519,7 @@ extern DECLSPEC double SDLCALL Mix_GetMusicLoopStartTime(Mix_Music *music);
*
* \param music the music object to query.
* \returns -1.0 if this feature is not used for this music or not supported
- * for some codec
+ * for some codec.
*
* \since This function is available since SDL_mixer 2.6.0.
*/
@@ -2534,7 +2534,7 @@ extern DECLSPEC double SDLCALL Mix_GetMusicLoopEndTime(Mix_Music *music);
*
* \param music the music object to query.
* \returns -1.0 if this feature is not used for this music or not supported
- * for some codec
+ * for some codec.
*
* \since This function is available since SDL_mixer 2.6.0.
*/
@@ -2554,7 +2554,7 @@ extern DECLSPEC double SDLCALL Mix_GetMusicLoopLengthTime(Mix_Music *music);
* Paused channels are treated as playing, even though they are not currently
* making forward progress in mixing.
*
- * \param channel channel
+ * \param channel channel.
* \returns non-zero if channel is playing, zero otherwise. If `channel` is
* -1, return the total number of channel playings.
*
@@ -2593,8 +2593,8 @@ extern DECLSPEC int SDLCALL Mix_PlayingMusic(void);
* You are strongly encouraged not to use this function without an extremely
* good reason.
*
- * \param command command
- * \returns 0 if successful, -1 on error
+ * \param command command.
+ * \returns 0 if successful, -1 on error.
*
* \since This function is available since SDL_mixer 2.0.0.
*/
@@ -2716,7 +2716,7 @@ extern DECLSPEC int SDLCALL Mix_EachSoundFont(Mix_EachSoundFontCallback function
* play MIDI files.
*
* \param path path to a Timidity config file.
- * \returns 1 if successful, 0 on error
+ * \returns 1 if successful, 0 on error.
*
* \since This function is available since SDL_mixer 2.6.0.
*/