From 4eb5b4bbe4de7e316bf32038849564dda50d9ebc Mon Sep 17 00:00:00 2001 From: Andrew Kelley Date: Mon, 13 Jun 2016 16:58:27 -0700 Subject: [PATCH] build docs in little endian mode and add note closes #81 --- doc/doxygen.conf.in | 1 + soundio/soundio.h | 4 ++++ 2 files changed, 5 insertions(+) diff --git a/doc/doxygen.conf.in b/doc/doxygen.conf.in index fc754ee..f7a542c 100644 --- a/doc/doxygen.conf.in +++ b/doc/doxygen.conf.in @@ -1668,6 +1668,7 @@ INCLUDE_FILE_PATTERNS = PREDEFINED = SOUNDIO_EXTERN_C= \ SOUNDIO_EXPORT= \ + __LITTLE_ENDIAN__= \ # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The diff --git a/soundio/soundio.h b/soundio/soundio.h index 39691e1..1f1ab10 100644 --- a/soundio/soundio.h +++ b/soundio/soundio.h @@ -275,6 +275,10 @@ enum SoundIoFormat { #elif defined(SOUNDIO_OS_LITTLE_ENDIAN) +/// Note that we build the documentation in Little Endian mode, +/// so all the "NE" macros in the docs point to "LE" and +/// "FE" macros point to "BE". On a Big Endian system it is the +/// other way around. #define SoundIoFormatS16NE SoundIoFormatS16LE #define SoundIoFormatU16NE SoundIoFormatU16LE #define SoundIoFormatS24NE SoundIoFormatS24LE