build docs in little endian mode and add note

closes #81
This commit is contained in:
Andrew Kelley 2016-06-13 16:58:27 -07:00
parent 67746c42ec
commit 4eb5b4bbe4
2 changed files with 5 additions and 0 deletions

View file

@ -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

View file

@ -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