encounter
/
SDL
mirror of https://github.com/encounter/SDL.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doxygen: We use "\returns" as part of the sentence.

This commit is contained in:
Ryan C. Gordon 2021-07-14 11:45:06 -04:00
parent bab0eb71ce
commit 17b4a67aa3
No known key found for this signature in database
GPG Key ID: FA148B892AB48044
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
include/SDL_audio.h
View File

@ -311,9 +311,8 @@ extern DECLSPEC const char *SDLCALL SDL_GetCurrentAudioDriver(void);
* for details on how to prepare this structure. * for details on how to prepare this structure.
* \param obtained an SDL_AudioSpec structure filled in with the actual * \param obtained an SDL_AudioSpec structure filled in with the actual
* parameters, or NULL. * parameters, or NULL.
* \returns This function opens the audio device with the desired parameters, * \returns 0 if successful, placing the actual hardware parameters in the
* and returns 0 if successful, placing the actual hardware * structure pointed to by `obtained`.
* parameters in the structure pointed to by `obtained`.
* *
* If `obtained` is NULL, the audio data passed to the callback * If `obtained` is NULL, the audio data passed to the callback
* function will be guaranteed to be in the requested format, and * function will be guaranteed to be in the requested format, and