Added documentation of the serialize_binary parameter

nlohmann · Apr 13, 2020 · d0dbc84 · d0dbc84
1 parent 38f8e86
commit d0dbc84
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/include/nlohmann/json.hpp b/include/nlohmann/json.hpp
@@ -2200,6 +2200,11 @@ class basic_json
     possible values: `strict` (throws and exception in case a decoding error
     occurs; default), `replace` (replace invalid UTF-8 sequences with U+FFFD),
     and `ignore` (ignore invalid UTF-8 sequences during serialization).
+    @param[in] serialize_binary Whether or not to allow serialization of binary
+    types to JSON.  Because binary types are non-standard, this will produce
+    non-conformant JSON, and is disabled by default.  This flag is primarily
+    useful for debugging.  Will output the binary value as a list of 8-bit
+    numbers prefixed by "b" (e.g. "bindata" = b[3, 0, 42, 255]).
 
     @return string containing the serialization of the JSON value
 

diff --git a/single_include/nlohmann/json.hpp b/single_include/nlohmann/json.hpp
@@ -17733,6 +17733,11 @@ class basic_json
     possible values: `strict` (throws and exception in case a decoding error
     occurs; default), `replace` (replace invalid UTF-8 sequences with U+FFFD),
     and `ignore` (ignore invalid UTF-8 sequences during serialization).
+    @param[in] serialize_binary Whether or not to allow serialization of binary
+    types to JSON.  Because binary types are non-standard, this will produce
+    non-conformant JSON, and is disabled by default.  This flag is primarily
+    useful for debugging.  Will output the binary value as a list of 8-bit
+    numbers prefixed by "b" (e.g. "bindata" = b[3, 0, 42, 255]).
 
     @return string containing the serialization of the JSON value