Skip to content

Commit

Permalink
document endianness macros
Browse files Browse the repository at this point in the history
  • Loading branch information
grisumbras committed Jun 12, 2022
1 parent e412d0c commit 43a87fa
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions doc/qbk/01_overview.qbk
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,13 @@ building the library or including the function definitions:
#include <boost/json/src.hpp>
```

[heading Endianness]

Boost.JSON supports both little endian and big endian platforms. It attempts to
deduce the endianness of the target plarform, but when it can't, you still can
choose the proper endianness by defining either `BOOST_JSON_LITTLE_ENDIAN` or
`BOOST_JSON_BIG_ENDIAN`.

[endsect]

[/-----------------------------------------------------------------------------]
Expand Down

0 comments on commit 43a87fa

Please sign in to comment.