From f121553082cc4a68784c10b8ad896d34e9412449 Mon Sep 17 00:00:00 2001 From: "Ryan C. Gordon" Date: Wed, 10 Apr 2024 16:07:49 -0400 Subject: [PATCH] include: Fixed up SDL_AudioFormat documentation. (this is not currently bridged to the wiki, but will be soon!) --- include/SDL3/SDL_audio.h | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/include/SDL3/SDL_audio.h b/include/SDL3/SDL_audio.h index de27ba43d..da00483da 100644 --- a/include/SDL3/SDL_audio.h +++ b/include/SDL3/SDL_audio.h @@ -54,24 +54,24 @@ extern "C" { */ /** - * Audio format flags. + * Audio format flags. * - * These are what the 16 bits in SDL_AudioFormat currently mean... - * (Unspecified bits are always zero). + * These are what the 16 bits in SDL_AudioFormat currently mean... + * (Unspecified bits are always zero). * - * \verbatim - ++-----------------------sample is signed if set - || - || ++-----------sample is bigendian if set - || || - || || ++---sample is float if set - || || || - || || || +---sample bit size---+ - || || || | | - 15 14 13 12 11 10 09 08 07 06 05 04 03 02 01 00 - \endverbatim + * ``` + * ++-----------------------sample is signed if set + * || + * || ++-----------sample is bigendian if set + * || || + * || || ++---sample is float if set + * || || || + * || || || +=--sample bit size--++ + * || || || || || + * 15 14 13 12 11 10 09 08 07 06 05 04 03 02 01 00 + * ``` * - * There are macros in SDL 2.0 and later to query these bits. + * There are macros to query these bits. */ typedef Uint16 SDL_AudioFormat;