build docs in little endian mode and add note

closes #81
andrewrk · Jun 13, 2016 · 4eb5b4b · 4eb5b4b
1 parent 67746c4
commit 4eb5b4b
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git 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
@@ -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