Skip to content

Commit 924f530

Browse files
committed
Sync SDL2_mixer wiki -> header
1 parent 7baa66f commit 924f530

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

include/SDL_mixer.h

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -451,7 +451,7 @@ extern DECLSPEC int SDLCALL Mix_OpenAudio(int frequency, Uint16 format, int chan
451451
* by channel count).
452452
* \param device the device name to open, or NULL to choose a reasonable
453453
* default.
454-
* \param allowed_changes Allow change flags (see SDL_AUDIO_ALLOW_* flags)
454+
* \param allowed_changes Allow change flags (see SDL_AUDIO_ALLOW_* flags).
455455
* \returns 0 if successful, -1 on error.
456456
*
457457
* \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);
13571357
* \param chan the channel to register an effect to, or MIX_CHANNEL_POST.
13581358
* \param f effect the callback to run when more of this channel is to be
13591359
* mixed.
1360-
* \param d effect done callback
1361-
* \param arg argument
1360+
* \param d effect done callback.
1361+
* \param arg argument.
13621362
* \returns zero if error (no such channel), nonzero if added. Error messages
13631363
* can be retrieved from Mix_GetError().
13641364
*
@@ -1673,7 +1673,7 @@ extern DECLSPEC int SDLCALL Mix_GroupChannel(int which, int tag);
16731673
* \param from the first channel to set the tag on.
16741674
* \param to the last channel to set the tag on, inclusive.
16751675
* \param tag an arbitrary value to assign a channel.
1676-
* \returns 0 if successful, negative on error
1676+
* \returns 0 if successful, negative on error.
16771677
*
16781678
* \since This function is available since SDL_mixer 2.0.0.
16791679
*/
@@ -1720,7 +1720,7 @@ extern DECLSPEC int SDLCALL Mix_GroupCount(int tag);
17201720
* If no channel with this tag is currently playing, this function returns -1.
17211721
*
17221722
* \param tag an arbitrary value, assigned to channels, to search through.
1723-
* \returns the "oldest" sample playing in a group of channels
1723+
* \returns the "oldest" sample playing in a group of channels.
17241724
*
17251725
* \since This function is available since SDL_mixer 2.0.0.
17261726
*
@@ -1738,7 +1738,7 @@ extern DECLSPEC int SDLCALL Mix_GroupOldest(int tag);
17381738
* If no channel with this tag is currently playing, this function returns -1.
17391739
*
17401740
* \param tag an arbitrary value, assigned to channels, to search through.
1741-
* \returns the "most recent" sample playing in a group of channels
1741+
* \returns the "most recent" sample playing in a group of channels.
17421742
*
17431743
* \since This function is available since SDL_mixer 2.0.0.
17441744
*
@@ -2421,7 +2421,7 @@ extern DECLSPEC int SDLCALL Mix_PausedMusic(void);
24212421
*
24222422
* This only applies to MOD music formats.
24232423
*
2424-
* \param order order
2424+
* \param order order.
24252425
* \returns 0 if successful, or -1 if failed or isn't implemented.
24262426
*
24272427
* \since This function is available since SDL_mixer 2.6.0.
@@ -2504,7 +2504,7 @@ extern DECLSPEC double SDLCALL Mix_MusicDuration(Mix_Music *music);
25042504
*
25052505
* \param music the music object to query.
25062506
* \returns -1.0 if this feature is not used for this music or not supported
2507-
* for some codec
2507+
* for some codec.
25082508
*
25092509
* \since This function is available since SDL_mixer 2.6.0.
25102510
*/
@@ -2519,7 +2519,7 @@ extern DECLSPEC double SDLCALL Mix_GetMusicLoopStartTime(Mix_Music *music);
25192519
*
25202520
* \param music the music object to query.
25212521
* \returns -1.0 if this feature is not used for this music or not supported
2522-
* for some codec
2522+
* for some codec.
25232523
*
25242524
* \since This function is available since SDL_mixer 2.6.0.
25252525
*/
@@ -2534,7 +2534,7 @@ extern DECLSPEC double SDLCALL Mix_GetMusicLoopEndTime(Mix_Music *music);
25342534
*
25352535
* \param music the music object to query.
25362536
* \returns -1.0 if this feature is not used for this music or not supported
2537-
* for some codec
2537+
* for some codec.
25382538
*
25392539
* \since This function is available since SDL_mixer 2.6.0.
25402540
*/
@@ -2554,7 +2554,7 @@ extern DECLSPEC double SDLCALL Mix_GetMusicLoopLengthTime(Mix_Music *music);
25542554
* Paused channels are treated as playing, even though they are not currently
25552555
* making forward progress in mixing.
25562556
*
2557-
* \param channel channel
2557+
* \param channel channel.
25582558
* \returns non-zero if channel is playing, zero otherwise. If `channel` is
25592559
* -1, return the total number of channel playings.
25602560
*
@@ -2593,8 +2593,8 @@ extern DECLSPEC int SDLCALL Mix_PlayingMusic(void);
25932593
* You are strongly encouraged not to use this function without an extremely
25942594
* good reason.
25952595
*
2596-
* \param command command
2597-
* \returns 0 if successful, -1 on error
2596+
* \param command command.
2597+
* \returns 0 if successful, -1 on error.
25982598
*
25992599
* \since This function is available since SDL_mixer 2.0.0.
26002600
*/
@@ -2716,7 +2716,7 @@ extern DECLSPEC int SDLCALL Mix_EachSoundFont(Mix_EachSoundFontCallback function
27162716
* play MIDI files.
27172717
*
27182718
* \param path path to a Timidity config file.
2719-
* \returns 1 if successful, 0 on error
2719+
* \returns 1 if successful, 0 on error.
27202720
*
27212721
* \since This function is available since SDL_mixer 2.6.0.
27222722
*/

0 commit comments

Comments
 (0)