From 43a87fa62ceb9af433cffc6a7a07c338bdcf5823 Mon Sep 17 00:00:00 2001 From: Dmitry Arkhipov Date: Sun, 12 Jun 2022 10:00:44 +0300 Subject: [PATCH] document endianness macros --- doc/qbk/01_overview.qbk | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/qbk/01_overview.qbk b/doc/qbk/01_overview.qbk index 37b7aa4fa..f601c84de 100644 --- a/doc/qbk/01_overview.qbk +++ b/doc/qbk/01_overview.qbk @@ -91,6 +91,13 @@ building the library or including the function definitions: #include ``` +[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] [/-----------------------------------------------------------------------------]