From ad01736d55a7a148c8eaffe55ac5690227732e03 Mon Sep 17 00:00:00 2001
From: Niels Lohmann <mail@nlohmann.me>
Date: Sun, 13 Jan 2019 11:46:05 +0100
Subject: [PATCH] :bulb: improved documentation for parsing without exceptions
#1405
Closes #1405
---
include/nlohmann/json.hpp | 24 ++++++++++++++++++------
single_include/nlohmann/json.hpp | 24 ++++++++++++++++++------
2 files changed, 36 insertions(+), 12 deletions(-)
diff --git a/include/nlohmann/json.hpp b/include/nlohmann/json.hpp
index e6ad210f..3b3da50f 100644
--- a/include/nlohmann/json.hpp
+++ b/include/nlohmann/json.hpp
@@ -6022,7 +6022,9 @@ class basic_json
@param[in] allow_exceptions whether to throw exceptions in case of a
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
of input; expected string literal""`
@@ -6164,7 +6166,9 @@ class basic_json
@param[in] allow_exceptions whether to throw exceptions in case of a
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.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
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
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
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
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
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
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
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
diff --git a/single_include/nlohmann/json.hpp b/single_include/nlohmann/json.hpp
index 3664016e..d85f40f7 100644
--- a/single_include/nlohmann/json.hpp
+++ b/single_include/nlohmann/json.hpp
@@ -18482,7 +18482,9 @@ class basic_json
@param[in] allow_exceptions whether to throw exceptions in case of a
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
of input; expected string literal""`
@@ -18624,7 +18626,9 @@ class basic_json
@param[in] allow_exceptions whether to throw exceptions in case of a
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.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
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
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
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
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
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
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
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