include/SDL_audio.h
changeset 7678 286c42d7c5ed
parent 7677 871d43c6968a
child 8149 681eb46b8ac4
     1.1 --- a/include/SDL_audio.h	Wed Aug 21 09:43:09 2013 -0300
     1.2 +++ b/include/SDL_audio.h	Wed Aug 21 09:47:10 2013 -0300
     1.3 @@ -66,7 +66,7 @@
     1.4  /**
     1.5   *  \name Audio flags
     1.6   */
     1.7 -/*@{ */
     1.8 +/* @{ */
     1.9  
    1.10  #define SDL_AUDIO_MASK_BITSIZE       (0xFF)
    1.11  #define SDL_AUDIO_MASK_DATATYPE      (1<<8)
    1.12 @@ -85,7 +85,7 @@
    1.13   *
    1.14   *  Defaults to LSB byte order.
    1.15   */
    1.16 -/*@{ */
    1.17 +/* @{ */
    1.18  #define AUDIO_U8        0x0008  /**< Unsigned 8-bit samples */
    1.19  #define AUDIO_S8        0x8008  /**< Signed 8-bit samples */
    1.20  #define AUDIO_U16LSB    0x0010  /**< Unsigned 16-bit samples */
    1.21 @@ -94,30 +94,30 @@
    1.22  #define AUDIO_S16MSB    0x9010  /**< As above, but big-endian byte order */
    1.23  #define AUDIO_U16       AUDIO_U16LSB
    1.24  #define AUDIO_S16       AUDIO_S16LSB
    1.25 -/*@} */
    1.26 +/* @} */
    1.27  
    1.28  /**
    1.29   *  \name int32 support
    1.30   */
    1.31 -/*@{ */
    1.32 +/* @{ */
    1.33  #define AUDIO_S32LSB    0x8020  /**< 32-bit integer samples */
    1.34  #define AUDIO_S32MSB    0x9020  /**< As above, but big-endian byte order */
    1.35  #define AUDIO_S32       AUDIO_S32LSB
    1.36 -/*@} */
    1.37 +/* @} */
    1.38  
    1.39  /**
    1.40   *  \name float32 support
    1.41   */
    1.42 -/*@{ */
    1.43 +/* @{ */
    1.44  #define AUDIO_F32LSB    0x8120  /**< 32-bit floating point samples */
    1.45  #define AUDIO_F32MSB    0x9120  /**< As above, but big-endian byte order */
    1.46  #define AUDIO_F32       AUDIO_F32LSB
    1.47 -/*@} */
    1.48 +/* @} */
    1.49  
    1.50  /**
    1.51   *  \name Native audio byte ordering
    1.52   */
    1.53 -/*@{ */
    1.54 +/* @{ */
    1.55  #if SDL_BYTEORDER == SDL_LIL_ENDIAN
    1.56  #define AUDIO_U16SYS    AUDIO_U16LSB
    1.57  #define AUDIO_S16SYS    AUDIO_S16LSB
    1.58 @@ -129,21 +129,21 @@
    1.59  #define AUDIO_S32SYS    AUDIO_S32MSB
    1.60  #define AUDIO_F32SYS    AUDIO_F32MSB
    1.61  #endif
    1.62 -/*@} */
    1.63 +/* @} */
    1.64  
    1.65  /**
    1.66   *  \name Allow change flags
    1.67   *
    1.68   *  Which audio format changes are allowed when opening a device.
    1.69   */
    1.70 -/*@{ */
    1.71 +/* @{ */
    1.72  #define SDL_AUDIO_ALLOW_FREQUENCY_CHANGE    0x00000001
    1.73  #define SDL_AUDIO_ALLOW_FORMAT_CHANGE       0x00000002
    1.74  #define SDL_AUDIO_ALLOW_CHANNELS_CHANGE     0x00000004
    1.75  #define SDL_AUDIO_ALLOW_ANY_CHANGE          (SDL_AUDIO_ALLOW_FREQUENCY_CHANGE|SDL_AUDIO_ALLOW_FORMAT_CHANGE|SDL_AUDIO_ALLOW_CHANNELS_CHANGE)
    1.76 -/*@} */
    1.77 +/* @} */
    1.78  
    1.79 -/*@} *//*Audio flags */
    1.80 +/* @} *//* Audio flags */
    1.81  
    1.82  /**
    1.83   *  This function is called when the audio device needs more data.
    1.84 @@ -218,10 +218,10 @@
    1.85   *  These functions return the list of built in audio drivers, in the
    1.86   *  order that they are normally initialized by default.
    1.87   */
    1.88 -/*@{ */
    1.89 +/* @{ */
    1.90  extern DECLSPEC int SDLCALL SDL_GetNumAudioDrivers(void);
    1.91  extern DECLSPEC const char *SDLCALL SDL_GetAudioDriver(int index);
    1.92 -/*@} */
    1.93 +/* @} */
    1.94  
    1.95  /**
    1.96   *  \name Initialization and cleanup
    1.97 @@ -230,10 +230,10 @@
    1.98   *            you have a specific need to specify the audio driver you want to
    1.99   *            use.  You should normally use SDL_Init() or SDL_InitSubSystem().
   1.100   */
   1.101 -/*@{ */
   1.102 +/* @{ */
   1.103  extern DECLSPEC int SDLCALL SDL_AudioInit(const char *driver_name);
   1.104  extern DECLSPEC void SDLCALL SDL_AudioQuit(void);
   1.105 -/*@} */
   1.106 +/* @} */
   1.107  
   1.108  /**
   1.109   *  This function returns the name of the current audio driver, or NULL
   1.110 @@ -359,7 +359,7 @@
   1.111   *
   1.112   *  Get the current audio state.
   1.113   */
   1.114 -/*@{ */
   1.115 +/* @{ */
   1.116  typedef enum
   1.117  {
   1.118      SDL_AUDIO_STOPPED = 0,
   1.119 @@ -370,7 +370,7 @@
   1.120  
   1.121  extern DECLSPEC SDL_AudioStatus SDLCALL
   1.122  SDL_GetAudioDeviceStatus(SDL_AudioDeviceID dev);
   1.123 -/*@} *//*Audio State */
   1.124 +/* @} *//* Audio State */
   1.125  
   1.126  /**
   1.127   *  \name Pause audio functions
   1.128 @@ -381,11 +381,11 @@
   1.129   *  data for your callback function after opening the audio device.
   1.130   *  Silence will be written to the audio device during the pause.
   1.131   */
   1.132 -/*@{ */
   1.133 +/* @{ */
   1.134  extern DECLSPEC void SDLCALL SDL_PauseAudio(int pause_on);
   1.135  extern DECLSPEC void SDLCALL SDL_PauseAudioDevice(SDL_AudioDeviceID dev,
   1.136                                                    int pause_on);
   1.137 -/*@} *//*Pause audio functions */
   1.138 +/* @} *//* Pause audio functions */
   1.139  
   1.140  /**
   1.141   *  This function loads a WAVE from the data source, automatically freeing
   1.142 @@ -482,12 +482,12 @@
   1.143   *  the callback function is not running.  Do not call these from the callback
   1.144   *  function or you will cause deadlock.
   1.145   */
   1.146 -/*@{ */
   1.147 +/* @{ */
   1.148  extern DECLSPEC void SDLCALL SDL_LockAudio(void);
   1.149  extern DECLSPEC void SDLCALL SDL_LockAudioDevice(SDL_AudioDeviceID dev);
   1.150  extern DECLSPEC void SDLCALL SDL_UnlockAudio(void);
   1.151  extern DECLSPEC void SDLCALL SDL_UnlockAudioDevice(SDL_AudioDeviceID dev);
   1.152 -/*@} *//*Audio lock functions */
   1.153 +/* @} *//* Audio lock functions */
   1.154  
   1.155  /**
   1.156   *  This function shuts down audio processing and closes the audio device.