Browse Source

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

Ryan C. Gordon 3 years ago
parent
commit
17b4a67aa3
1 changed files with 2 additions and 3 deletions
  1. 2 3
      include/SDL_audio.h

+ 2 - 3
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