From 17b4a67aa342febf7a7b9fa1f481abddb97c0548 Mon Sep 17 00:00:00 2001 From: "Ryan C. Gordon" Date: Wed, 14 Jul 2021 11:45:06 -0400 Subject: [PATCH] doxygen: We use "\returns" as part of the sentence. --- include/SDL_audio.h | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/include/SDL_audio.h b/include/SDL_audio.h index 7d1bee17f..890fcede2 100644 --- a/include/SDL_audio.h +++ b/include/SDL_audio.h @@ -311,9 +311,8 @@ extern DECLSPEC const char *SDLCALL SDL_GetCurrentAudioDriver(void); * for details on how to prepare this structure. * \param obtained an SDL_AudioSpec structure filled in with the actual * parameters, or NULL. - * \returns This function opens the audio device with the desired parameters, - * and returns 0 if successful, placing the actual hardware - * parameters in the structure pointed to by `obtained`. + * \returns 0 if successful, placing the actual hardware parameters in the + * structure pointed to by `obtained`. * * If `obtained` is NULL, the audio data passed to the callback * function will be guaranteed to be in the requested format, and