Incorrect documentation for Mix_FadeOutChannel

libsdl-org / SDL_mixer

An audio mixer that supports various file formats for Simple Directmedia Layer.

zlib License

433 stars 146 forks source link

Closed svanimpe closed 2 years ago

svanimpe commented 2 years ago

The documentation for this function says it returns 0 on success, which isn't the case. This tripped me up for a while.

sezero commented 2 years ago

So, the number of channels touched, 0 if none. would be a proper description?

svanimpe commented 2 years ago

The documentation for Mix_FadeOutMusic phrases this as "scheduled to fade", so perhaps this should be "the number of channels scheduled to fade"?

sezero commented 2 years ago

The documentation for Mix_FadeOutMusic phrases this as "scheduled to fade", so perhaps this should be "the number of channels scheduled to fade"?

Sounds better I guess. @slouken, @icculus?

slouken commented 2 years ago

Sure, sounds good.

sezero commented 2 years ago