Commit 17b4a67aa342febf7a7b9fa1f481abddb97c0548

Ryan C. Gordon 2021-07-14T11:45:06

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
diff --git a/include/SDL_audio.h b/include/SDL_audio.h
index 7d1bee1..890fced 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