From a96196c95845852656f2e703d473f72c43e6c46a Mon Sep 17 00:00:00 2001 From: "Ryan C. Gordon" Date: Tue, 23 Apr 2024 10:19:26 -0400 Subject: [PATCH] include: Fixed SDL_AudioFormat documentation. --- include/SDL_audio.h | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/include/SDL_audio.h b/include/SDL_audio.h index bd8e7ab6fa..df09c3af4c 100644 --- a/include/SDL_audio.h +++ b/include/SDL_audio.h @@ -44,24 +44,24 @@ extern "C" { #endif /** - * \brief 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 in SDL 2.0 and later to query these bits. */ typedef Uint16 SDL_AudioFormat;