Browse Source

include: Fixed up SDL_AudioFormat documentation.

(this is not currently bridged to the wiki, but will be soon!)
Ryan C. Gordon 1 year ago
parent
commit
f121553082
1 changed files with 18 additions and 18 deletions
  1. 18 18
      include/SDL3/SDL_audio.h

+ 18 - 18
include/SDL3/SDL_audio.h

@@ -54,24 +54,24 @@ extern "C" {
  */
 
 /**
- *  Audio format flags.
- *
- *  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
- *
- *  There are macros in SDL 2.0 and later to query these bits.
+ * Audio format flags.
+ *
+ * These are what the 16 bits in SDL_AudioFormat currently mean...
+ * (Unspecified bits are always zero).
+ *
+ * ```
+ * ++-----------------------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 to query these bits.
  */
 typedef Uint16 SDL_AudioFormat;