Skip to content

Commit d718d86

Browse files
committed
document endianness macros
1 parent d7b696a commit d718d86

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

doc/qbk/overview.qbk

+12-1
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,18 @@ building the library or including the function definitions:
101101
#include <boost/json/src.hpp>
102102
```
103103

104-
[heading Supported Compilers]
104+
[heading Endianness]
105+
106+
Boost.JSON supports both little endian and big endian platforms. It attempts to
107+
deduce the endianness of the target plarform, but when it can't, you still can
108+
choose the proper endianness by defining either `BOOST_JSON_LITTLE_ENDIAN` or
109+
`BOOST_JSON_BIG_ENDIAN`.
110+
111+
[endsect]
112+
113+
[/-----------------------------------------------------------------------------]
114+
115+
[section Supported Compilers]
105116

106117
Boost.JSON has been tested with the following compilers:
107118

0 commit comments

Comments
 (0)