Skip to content

Commit 43a87fa

Browse files
committed
document endianness macros
1 parent e412d0c commit 43a87fa

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

doc/qbk/01_overview.qbk

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,13 @@ building the library or including the function definitions:
9191
#include <boost/json/src.hpp>
9292
```
9393

94+
[heading Endianness]
95+
96+
Boost.JSON supports both little endian and big endian platforms. It attempts to
97+
deduce the endianness of the target plarform, but when it can't, you still can
98+
choose the proper endianness by defining either `BOOST_JSON_LITTLE_ENDIAN` or
99+
`BOOST_JSON_BIG_ENDIAN`.
100+
94101
[endsect]
95102

96103
[/-----------------------------------------------------------------------------]

0 commit comments

Comments
 (0)