Sync wiki -> header

include/SDL_audio.h

@@ -291,6 +291,8 @@ extern DECLSPEC int SDLCALL SDL_GetNumAudioDrivers(void);
  * \returns the name of the audio driver at the requested index, or NULL if an
  *          invalid index was specified.
  *
+ * \since This function is available since SDL 2.0.0.
+ *
  * \sa SDL_GetNumAudioDrivers
  */
 extern DECLSPEC const char *SDLCALL SDL_GetAudioDriver(int index);
@@ -316,6 +318,8 @@ extern DECLSPEC const char *SDLCALL SDL_GetAudioDriver(int index);
  * \returns 0 on success or a negative error code on failure; call
  *          SDL_GetError() for more information.
  *
+ * \since This function is available since SDL 2.0.0.
+ *
  * \sa SDL_AudioQuit
  */
 extern DECLSPEC int SDLCALL SDL_AudioInit(const char *driver_name);
@@ -328,6 +332,8 @@ extern DECLSPEC int SDLCALL SDL_AudioInit(const char *driver_name);
  * specific need to specify the audio driver you want to use. You should
  * normally use SDL_Quit() or SDL_QuitSubSystem().
  *
+ * \since This function is available since SDL 2.0.0.
+ *
  * \sa SDL_AudioInit
  */
 extern DECLSPEC void SDLCALL SDL_AudioQuit(void);
@@ -391,6 +397,8 @@ extern DECLSPEC const char *SDLCALL SDL_GetCurrentAudioDriver(void);
  *          audio device or failure to set up the audio thread; call
  *          SDL_GetError() for more information.
  *
+ * \since This function is available since SDL 2.0.0.
+ *
  * \sa SDL_CloseAudio
  * \sa SDL_LockAudio
  * \sa SDL_PauseAudio
@@ -476,6 +484,8 @@ extern DECLSPEC int SDLCALL SDL_GetNumAudioDevices(int iscapture);
  * \returns the name of the audio device at the requested index, or NULL on
  *          error.
  *
+ * \since This function is available since SDL 2.0.0.
+ *
  * \sa SDL_GetNumAudioDevices
  */
 extern DECLSPEC const char *SDLCALL SDL_GetAudioDeviceName(int index,
@@ -656,6 +666,8 @@ typedef enum
  *
  * \returns the SDL_AudioStatus of the audio device opened by SDL_OpenAudio().
  *
+ * \since This function is available since SDL 2.0.0.
+ *
  * \sa SDL_GetAudioDeviceStatus
  */
 extern DECLSPEC SDL_AudioStatus SDLCALL SDL_GetAudioStatus(void);
@@ -667,6 +679,8 @@ extern DECLSPEC SDL_AudioStatus SDLCALL SDL_GetAudioStatus(void);
  *            SDL_OpenAudioDevice()
  * \returns the SDL_AudioStatus of the specified audio device.
  *
+ * \since This function is available since SDL 2.0.0.
+ *
  * \sa SDL_PauseAudioDevice
  */
 extern DECLSPEC SDL_AudioStatus SDLCALL SDL_GetAudioDeviceStatus(SDL_AudioDeviceID dev);
@@ -697,6 +711,8 @@ extern DECLSPEC SDL_AudioStatus SDLCALL SDL_GetAudioDeviceStatus(SDL_AudioDevice
  *
  * \param pause_on non-zero to pause, 0 to unpause
  *
+ * \since This function is available since SDL 2.0.0.
+ *
  * \sa SDL_GetAudioStatus
  * \sa SDL_PauseAudioDevice
  */
@@ -726,6 +742,8 @@ extern DECLSPEC void SDLCALL SDL_PauseAudio(int pause_on);
  * \param dev a device opened by SDL_OpenAudioDevice()
  * \param pause_on non-zero to pause, 0 to unpause
  *
+ * \since This function is available since SDL 2.0.0.
+ *
  * \sa SDL_LockAudioDevice
  */
 extern DECLSPEC void SDLCALL SDL_PauseAudioDevice(SDL_AudioDeviceID dev,
@@ -808,6 +826,8 @@ extern DECLSPEC void SDLCALL SDL_PauseAudioDevice(SDL_AudioDeviceID dev,
  *          When the application is done with the data returned in
  *          `audio_buf`, it should call SDL_FreeWAV() to dispose of it.
  *
+ * \since This function is available since SDL 2.0.0.
+ *
  * \sa SDL_FreeWAV
  * \sa SDL_LoadWAV
  */
@@ -834,6 +854,8 @@ extern DECLSPEC SDL_AudioSpec *SDLCALL SDL_LoadWAV_RW(SDL_RWops * src,
  * \param audio_buf a pointer to the buffer created by SDL_LoadWAV() or
  *                  SDL_LoadWAV_RW()
  *
+ * \since This function is available since SDL 2.0.0.
+ *
  * \sa SDL_LoadWAV
  * \sa SDL_LoadWAV_RW
  */
@@ -867,6 +889,8 @@ extern DECLSPEC void SDLCALL SDL_FreeWAV(Uint8 * audio_buf);
  *          or a negative error code on failure; call SDL_GetError() for more
  *          information.
  *
+ * \since This function is available since SDL 2.0.0.
+ *
  * \sa SDL_ConvertAudio
  */
 extern DECLSPEC int SDLCALL SDL_BuildAudioCVT(SDL_AudioCVT * cvt,
@@ -911,6 +935,8 @@ extern DECLSPEC int SDLCALL SDL_BuildAudioCVT(SDL_AudioCVT * cvt,
  * \returns 0 if the conversion was completed successfully or a negative error
  *          code on failure; call SDL_GetError() for more information.
  *
+ * \since This function is available since SDL 2.0.0.
+ *
  * \sa SDL_BuildAudioCVT
  */
 extern DECLSPEC int SDLCALL SDL_ConvertAudio(SDL_AudioCVT * cvt);
@@ -937,6 +963,8 @@ typedef struct _SDL_AudioStream SDL_AudioStream;
  * \param dst_rate The sampling rate of the desired audio output
  * \returns 0 on success, or -1 on error.
  *
+ * \since This function is available since SDL 2.0.7.
+ *
  * \sa SDL_AudioStreamPut
  * \sa SDL_AudioStreamGet
  * \sa SDL_AudioStreamAvailable
@@ -959,6 +987,8 @@ extern DECLSPEC SDL_AudioStream * SDLCALL SDL_NewAudioStream(const SDL_AudioForm
  * \param len The number of bytes to write to the stream
  * \returns 0 on success, or -1 on error.
  *
+ * \since This function is available since SDL 2.0.7.
+ *
  * \sa SDL_NewAudioStream
  * \sa SDL_AudioStreamGet
  * \sa SDL_AudioStreamAvailable
@@ -976,6 +1006,8 @@ extern DECLSPEC int SDLCALL SDL_AudioStreamPut(SDL_AudioStream *stream, const vo
  * \param len The maximum number of bytes to fill
  * \returns the number of bytes read from the stream, or -1 on error
  *
+ * \since This function is available since SDL 2.0.7.
+ *
  * \sa SDL_NewAudioStream
  * \sa SDL_AudioStreamPut
  * \sa SDL_AudioStreamAvailable
@@ -992,6 +1024,8 @@ extern DECLSPEC int SDLCALL SDL_AudioStreamGet(SDL_AudioStream *stream, void *bu
  * resample correctly, so this number might be lower than what you expect, or
  * even be zero. Add more data or flush the stream if you need the data now.
  *
+ * \since This function is available since SDL 2.0.7.
+ *
  * \sa SDL_NewAudioStream
  * \sa SDL_AudioStreamPut
  * \sa SDL_AudioStreamGet
@@ -1009,6 +1043,8 @@ extern DECLSPEC int SDLCALL SDL_AudioStreamAvailable(SDL_AudioStream *stream);
  * audio gaps in the output. Generally this is intended to signal the end of
  * input, so the complete output becomes available.
  *
+ * \since This function is available since SDL 2.0.7.
+ *
  * \sa SDL_NewAudioStream
  * \sa SDL_AudioStreamPut
  * \sa SDL_AudioStreamGet
@@ -1021,6 +1057,8 @@ extern DECLSPEC int SDLCALL SDL_AudioStreamFlush(SDL_AudioStream *stream);
 /**
  * Clear any pending data in the stream without converting it
  *
+ * \since This function is available since SDL 2.0.7.
+ *
  * \sa SDL_NewAudioStream
  * \sa SDL_AudioStreamPut
  * \sa SDL_AudioStreamGet
@@ -1033,6 +1071,8 @@ extern DECLSPEC void SDLCALL SDL_AudioStreamClear(SDL_AudioStream *stream);
 /**
  * Free an audio stream
  *
+ * \since This function is available since SDL 2.0.7.
+ *
  * \sa SDL_NewAudioStream
  * \sa SDL_AudioStreamPut
  * \sa SDL_AudioStreamGet
@@ -1062,6 +1102,8 @@ extern DECLSPEC void SDLCALL SDL_FreeAudioStream(SDL_AudioStream *stream);
  * \param volume ranges from 0 - 128, and should be set to SDL_MIX_MAXVOLUME
  *               for full audio volume
  *
+ * \since This function is available since SDL 2.0.0.
+ *
  * \sa SDL_MixAudioFormat
  */
 extern DECLSPEC void SDLCALL SDL_MixAudio(Uint8 * dst, const Uint8 * src,
@@ -1094,6 +1136,8 @@ extern DECLSPEC void SDLCALL SDL_MixAudio(Uint8 * dst, const Uint8 * src,
  * \param len the length of the audio buffer in bytes
  * \param volume ranges from 0 - 128, and should be set to SDL_MIX_MAXVOLUME
  *               for full audio volume
+ *
+ * \since This function is available since SDL 2.0.0.
  */
 extern DECLSPEC void SDLCALL SDL_MixAudioFormat(Uint8 * dst,
                                                 const Uint8 * src,
@@ -1287,6 +1331,8 @@ extern DECLSPEC void SDLCALL SDL_ClearQueuedAudio(SDL_AudioDeviceID dev);
  *
  * ...and is only useful if you used the legacy SDL_OpenAudio() function.
  *
+ * \since This function is available since SDL 2.0.0.
+ *
  * \sa SDL_LockAudioDevice
  * \sa SDL_UnlockAudio
  * \sa SDL_UnlockAudioDevice
@@ -1326,6 +1372,8 @@ extern DECLSPEC void SDLCALL SDL_LockAudio(void);
  *
  * \param dev the ID of the device to be locked
  *
+ * \since This function is available since SDL 2.0.0.
+ *
  * \sa SDL_UnlockAudioDevice
  */
 extern DECLSPEC void SDLCALL SDL_LockAudioDevice(SDL_AudioDeviceID dev);
@@ -1342,6 +1390,8 @@ extern DECLSPEC void SDLCALL SDL_LockAudioDevice(SDL_AudioDeviceID dev);
  *
  * ...and is only useful if you used the legacy SDL_OpenAudio() function.
  *
+ * \since This function is available since SDL 2.0.0.
+ *
  * \sa SDL_LockAudio
  * \sa SDL_UnlockAudioDevice
  */
@@ -1355,6 +1405,8 @@ extern DECLSPEC void SDLCALL SDL_UnlockAudio(void);
  *
  * \param dev the ID of the device to be unlocked
  *
+ * \since This function is available since SDL 2.0.0.
+ *
  * \sa SDL_LockAudioDevice
  */
 extern DECLSPEC void SDLCALL SDL_UnlockAudioDevice(SDL_AudioDeviceID dev);
@@ -1371,6 +1423,8 @@ extern DECLSPEC void SDLCALL SDL_UnlockAudioDevice(SDL_AudioDeviceID dev);
  *
  * ...and is only useful if you used the legacy SDL_OpenAudio() function.
  *
+ * \since This function is available since SDL 2.0.0.
+ *
  * \sa SDL_OpenAudio
  */
 extern DECLSPEC void SDLCALL SDL_CloseAudio(void);
@@ -1393,6 +1447,8 @@ extern DECLSPEC void SDLCALL SDL_CloseAudio(void);
  *
  * \param dev an audio device previously opened with SDL_OpenAudioDevice()
  *
+ * \since This function is available since SDL 2.0.0.
+ *
  * \sa SDL_OpenAudioDevice
  */
 extern DECLSPEC void SDLCALL SDL_CloseAudioDevice(SDL_AudioDeviceID dev);