j3d1/json
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

💡 improved documentation for parsing without exceptions #1405

Browse source 
Closes #1405
This commit is contained in:
Niels Lohmann 2019-01-13 11:46:05 +01:00
parent 06731b14d7
commit ad01736d55
No known key found for this signature in database
GPG key ID: 7F3CEA63AE251B69
2 changed files with 36 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
include/nlohmann/json.hpp
View file

@ -6022,7 +6022,9 @@ class basic_json
@param[in] allow_exceptions whether to throw exceptions in case of a @param[in] allow_exceptions whether to throw exceptions in case of a
parse error (optional, true by default) parse error (optional, true by default)
@return result of the deserialization @return deserialized JSON value; in case of a parse error and
@a allow_exceptions set to `false`, the return value will be
value_t::discarded.
@throw parse_error.101 if a parse error occurs; example: `""unexpected end @throw parse_error.101 if a parse error occurs; example: `""unexpected end
of input; expected string literal""` of input; expected string literal""`
@ -6164,7 +6166,9 @@ class basic_json
@param[in] allow_exceptions whether to throw exceptions in case of a @param[in] allow_exceptions whether to throw exceptions in case of a
parse error (optional, true by default) parse error (optional, true by default)
@return result of the deserialization @return deserialized JSON value; in case of a parse error and
@a allow_exceptions set to `false`, the return value will be
value_t::discarded.
@throw parse_error.101 in case of an unexpected token @throw parse_error.101 in case of an unexpected token
@throw parse_error.102 if to_unicode fails or surrogate error @throw parse_error.102 if to_unicode fails or surrogate error
@ -6795,7 +6799,9 @@ class basic_json
@param[in] allow_exceptions whether to throw exceptions in case of a @param[in] allow_exceptions whether to throw exceptions in case of a
parse error (optional, true by default) parse error (optional, true by default)
@return deserialized JSON value @return deserialized JSON value; in case of a parse error and
@a allow_exceptions set to `false`, the return value will be
value_t::discarded.
@throw parse_error.110 if the given input ends prematurely or the end of @throw parse_error.110 if the given input ends prematurely or the end of
file was not reached when @a strict was set to true file was not reached when @a strict was set to true
@ -6898,7 +6904,9 @@ class basic_json
@param[in] allow_exceptions whether to throw exceptions in case of a @param[in] allow_exceptions whether to throw exceptions in case of a
parse error (optional, true by default) parse error (optional, true by default)
@return deserialized JSON value @return deserialized JSON value; in case of a parse error and
@a allow_exceptions set to `false`, the return value will be
value_t::discarded.
@throw parse_error.110 if the given input ends prematurely or the end of @throw parse_error.110 if the given input ends prematurely or the end of
file was not reached when @a strict was set to true file was not reached when @a strict was set to true
@ -6985,7 +6993,9 @@ class basic_json
@param[in] allow_exceptions whether to throw exceptions in case of a @param[in] allow_exceptions whether to throw exceptions in case of a
parse error (optional, true by default) parse error (optional, true by default)
@return deserialized JSON value @return deserialized JSON value; in case of a parse error and
@a allow_exceptions set to `false`, the return value will be
value_t::discarded.
@throw parse_error.110 if the given input ends prematurely or the end of @throw parse_error.110 if the given input ends prematurely or the end of
file was not reached when @a strict was set to true file was not reached when @a strict was set to true
@ -7074,7 +7084,9 @@ class basic_json
@param[in] allow_exceptions whether to throw exceptions in case of a @param[in] allow_exceptions whether to throw exceptions in case of a
parse error (optional, true by default) parse error (optional, true by default)
@return deserialized JSON value @return deserialized JSON value; in case of a parse error and
@a allow_exceptions set to `false`, the return value will be
value_t::discarded.
@throw parse_error.114 if an unsupported BSON record type is encountered @throw parse_error.114 if an unsupported BSON record type is encountered

24
single_include/nlohmann/json.hpp
View file

@ -18482,7 +18482,9 @@ class basic_json
@param[in] allow_exceptions whether to throw exceptions in case of a @param[in] allow_exceptions whether to throw exceptions in case of a
parse error (optional, true by default) parse error (optional, true by default)
@return result of the deserialization @return deserialized JSON value; in case of a parse error and
@a allow_exceptions set to `false`, the return value will be
value_t::discarded.
@throw parse_error.101 if a parse error occurs; example: `""unexpected end @throw parse_error.101 if a parse error occurs; example: `""unexpected end
of input; expected string literal""` of input; expected string literal""`
@ -18624,7 +18626,9 @@ class basic_json
@param[in] allow_exceptions whether to throw exceptions in case of a @param[in] allow_exceptions whether to throw exceptions in case of a
parse error (optional, true by default) parse error (optional, true by default)
@return result of the deserialization @return deserialized JSON value; in case of a parse error and
@a allow_exceptions set to `false`, the return value will be
value_t::discarded.
@throw parse_error.101 in case of an unexpected token @throw parse_error.101 in case of an unexpected token
@throw parse_error.102 if to_unicode fails or surrogate error @throw parse_error.102 if to_unicode fails or surrogate error
@ -19255,7 +19259,9 @@ class basic_json
@param[in] allow_exceptions whether to throw exceptions in case of a @param[in] allow_exceptions whether to throw exceptions in case of a
parse error (optional, true by default) parse error (optional, true by default)
@return deserialized JSON value @return deserialized JSON value; in case of a parse error and
@a allow_exceptions set to `false`, the return value will be
value_t::discarded.
@throw parse_error.110 if the given input ends prematurely or the end of @throw parse_error.110 if the given input ends prematurely or the end of
file was not reached when @a strict was set to true file was not reached when @a strict was set to true
@ -19358,7 +19364,9 @@ class basic_json
@param[in] allow_exceptions whether to throw exceptions in case of a @param[in] allow_exceptions whether to throw exceptions in case of a
parse error (optional, true by default) parse error (optional, true by default)
@return deserialized JSON value @return deserialized JSON value; in case of a parse error and
@a allow_exceptions set to `false`, the return value will be
value_t::discarded.
@throw parse_error.110 if the given input ends prematurely or the end of @throw parse_error.110 if the given input ends prematurely or the end of
file was not reached when @a strict was set to true file was not reached when @a strict was set to true
@ -19445,7 +19453,9 @@ class basic_json
@param[in] allow_exceptions whether to throw exceptions in case of a @param[in] allow_exceptions whether to throw exceptions in case of a
parse error (optional, true by default) parse error (optional, true by default)
@return deserialized JSON value @return deserialized JSON value; in case of a parse error and
@a allow_exceptions set to `false`, the return value will be
value_t::discarded.
@throw parse_error.110 if the given input ends prematurely or the end of @throw parse_error.110 if the given input ends prematurely or the end of
file was not reached when @a strict was set to true file was not reached when @a strict was set to true
@ -19534,7 +19544,9 @@ class basic_json
@param[in] allow_exceptions whether to throw exceptions in case of a @param[in] allow_exceptions whether to throw exceptions in case of a
parse error (optional, true by default) parse error (optional, true by default)
@return deserialized JSON value @return deserialized JSON value; in case of a parse error and
@a allow_exceptions set to `false`, the return value will be
value_t::discarded.
@throw parse_error.114 if an unsupported BSON record type is encountered @throw parse_error.114 if an unsupported BSON record type is encountered