diff --git a/include/SDL_audio.h b/include/SDL_audio.h index e28dcbd550..8e2143e711 100644 --- a/include/SDL_audio.h +++ b/include/SDL_audio.h @@ -149,18 +149,11 @@ typedef Uint16 SDL_AudioFormat; /* @} *//* Audio flags */ /** - * This function is called when the audio device needs more data. + * This function is called when the audio device needs more data. * - * \param userdata An application-specific parameter saved in - * the SDL_AudioSpec structure - * \param stream A pointer to the audio data buffer. - * \param len The length of that buffer in bytes. - * - * Once the callback returns, the buffer will no longer be valid. - * Stereo samples are stored in a LRLRLR ordering. - * - * You can choose to avoid callbacks and use SDL_QueueAudio() instead, if - * you like. Just open your audio device with a NULL callback. + * \param userdata An application-specific parameter saved in the + * SDL_AudioSpec structure + * \param stream A pointer to the audio data buffer. */ typedef void (SDLCALL * SDL_AudioCallback) (void *userdata, Uint8 * stream, int len); diff --git a/include/SDL_events.h b/include/SDL_events.h index 3989c0148a..aa97bd22f7 100644 --- a/include/SDL_events.h +++ b/include/SDL_events.h @@ -271,12 +271,12 @@ typedef struct SDL_TextEditingExtEvent * Keyboard text input event structure (event.text.*) * * `text` is limited to SDL_TEXTINPUTEVENT_TEXT_SIZE bytes. If the incoming - * string is larger than this, SDL will split it and send it in pieces, - * across multiple events. The string is in UTF-8 format, and if split, SDL - * guarantees that it will not split in the middle of a UTF-8 sequence, so - * any event will only contain complete codepoints. However, if there are - * several codepoints that go together into a single glyph (like an emoji - * "thumbs up" followed by a skin color), they may be split between events. + * string is larger than this, SDL will split it and send it in pieces, across + * multiple events. The string is in UTF-8 format, and if split, SDL + * guarantees that it will not split in the middle of a UTF-8 sequence, so any + * event will only contain complete codepoints. However, if there are several + * codepoints that go together into a single glyph (like an emoji "thumbs up" + * followed by a skin color), they may be split between events. */ typedef struct SDL_TextInputEvent { diff --git a/include/SDL_joystick.h b/include/SDL_joystick.h index f7900458b9..4ce760dbc4 100644 --- a/include/SDL_joystick.h +++ b/include/SDL_joystick.h @@ -798,8 +798,8 @@ extern DECLSPEC void SDLCALL SDL_JoystickUpdate(void); * `SDL_ENABLE`, this function accepts any value, with any non-zero value that * isn't `SDL_QUERY` being treated as `SDL_ENABLE`. * - * If SDL was built with events disabled (extremely uncommon!), this will - * do nothing and always return `SDL_IGNORE`. + * If SDL was built with events disabled (extremely uncommon!), this will do + * nothing and always return `SDL_IGNORE`. * * \param state can be one of `SDL_QUERY`, `SDL_IGNORE`, or `SDL_ENABLE` * \returns If `state` is `SDL_QUERY` then the current state is returned, diff --git a/include/SDL_surface.h b/include/SDL_surface.h index 62fb8e28a4..edf67f8486 100644 --- a/include/SDL_surface.h +++ b/include/SDL_surface.h @@ -97,7 +97,7 @@ typedef struct SDL_Surface } SDL_Surface; /** - * \brief The type of function used for surface blitting functions. + * The type of function used for surface blitting functions. */ typedef int (SDLCALL *SDL_blit) (struct SDL_Surface * src, SDL_Rect * srcrect, struct SDL_Surface * dst, SDL_Rect * dstrect); diff --git a/include/SDL_video.h b/include/SDL_video.h index 8443ac2516..27d8781f31 100644 --- a/include/SDL_video.h +++ b/include/SDL_video.h @@ -770,7 +770,7 @@ extern DECLSPEC Uint32 SDLCALL SDL_GetWindowPixelFormat(SDL_Window * window); * \param w the width of the window, in screen coordinates * \param h the height of the window, in screen coordinates * \param flags 0, or one or more SDL_WindowFlags OR'd together - * \returns the window that was created or NULL on failure; call + * \returns the `SDL_Window` that was created or NULL on failure; call * SDL_GetError() for more information. * * \since This function is available since SDL 2.0.0.