[OMPT-svn-commit] OpenMPT r20521 - trunk/OpenMPT/doc

[<sv...@op...>]

Author: sagamusix
Date: Sun Apr  7 22:01:56 2024
New Revision: 20521
URL: https://source.openmpt.org/browse/openmpt/?op=revision&rev=20521

Log:
[Doc] Update module_formats.md.

Modified:
   trunk/OpenMPT/doc/module_formats.md

Modified: trunk/OpenMPT/doc/module_formats.md
==============================================================================
--- trunk/OpenMPT/doc/module_formats.md	Sun Apr  7 21:29:51 2024	(r20520)
+++ trunk/OpenMPT/doc/module_formats.md	Sun Apr  7 22:01:56 2024	(r20521)
@@ -17,8 +17,8 @@
   a subset of ProTracker MOD).
 * When reading binary structs from the file, use our data types with defined
   endianness, which can be found in `common/Endianness.h`:
-  * Big-Endian: (u)int8/16/32/64be, float32be, float64be
-  * Little-Endian: (u)int8/16/32/64le, float32le, float64le
+  * Big-Endian: (u)int8/16/24/32/64be, float32be, float64be
+  * Little-Endian: (u)int8/16/24/32/64le, float32le, float64le
 
   Entire structs containing integers with defined endianness can be read in one
   go if they are tagged with `MPT_BINARY_STRUCT` (see existing loaders for an
@@ -38,8 +38,8 @@
   thread-safe for libopenmpt.
 * `FileReader` instances may be used to treat a portion of a file as its own
   independent file (through `FileReader::ReadChunk`). This can be useful with
-  "embedded files" such as WAV or Ogg samples. Container formats such as UMX
-  are another good example for this usage.
+  "embedded files" such as WAV or Ogg samples (see MO3 or SymMOD for examples).
+  Container formats such as UMX are another good example for this usage.
 * Samples *either* use middle-C frequency *or* finetune + transpose. For the few
   weird formats that use both, it may make sense to translate everything into
   middle-C frequency.
@@ -66,7 +66,7 @@
   (which may e.g. cause a song title starting with if ..." in various other
   formats to be interpreted as a 669 module), and of course
   Ultimate SoundTracker modules, which have no magic bytes at all.
-* Avoid use of functions tagged with [[deprecated]].
+* Avoid use of functions tagged with `[[deprecated]]`.
 
 Probing
 -------