mirror of
https://github.com/nlohmann/json.git
synced 2024-08-22 04:52:35 +02:00
Merge pull request #1803 from flopp/spelling
Fix some spelling errors - mostly in comments & documentation.
This commit is contained in:
commit
00cb98a3d1
|
@ -9,7 +9,7 @@ int main()
|
||||||
json::json_pointer ptr("/foo");
|
json::json_pointer ptr("/foo");
|
||||||
std::cout << ptr << '\n';
|
std::cout << ptr << '\n';
|
||||||
|
|
||||||
// apppend a JSON Pointer
|
// append a JSON Pointer
|
||||||
ptr /= json::json_pointer("/bar/baz");
|
ptr /= json::json_pointer("/bar/baz");
|
||||||
std::cout << ptr << '\n';
|
std::cout << ptr << '\n';
|
||||||
|
|
||||||
|
|
|
@ -8,7 +8,7 @@ int main()
|
||||||
// create a JSON pointer
|
// create a JSON pointer
|
||||||
json::json_pointer ptr("/foo");
|
json::json_pointer ptr("/foo");
|
||||||
|
|
||||||
// apppend a JSON Pointer
|
// append a JSON Pointer
|
||||||
std::cout << ptr / json::json_pointer("/bar/baz") << '\n';
|
std::cout << ptr / json::json_pointer("/bar/baz") << '\n';
|
||||||
|
|
||||||
// append a string
|
// append a string
|
||||||
|
|
|
@ -330,7 +330,7 @@ inline cached_power get_cached_power_for_binary_exponent(int e)
|
||||||
// ==> 2^(q - 1 + alpha) <= c * 2^(e + q)
|
// ==> 2^(q - 1 + alpha) <= c * 2^(e + q)
|
||||||
// ==> 2^(alpha - e - 1) <= c
|
// ==> 2^(alpha - e - 1) <= c
|
||||||
//
|
//
|
||||||
// If c were an exakt power of ten, i.e. c = 10^k, one may determine k as
|
// If c were an exact power of ten, i.e. c = 10^k, one may determine k as
|
||||||
//
|
//
|
||||||
// k = ceil( log_10( 2^(alpha - e - 1) ) )
|
// k = ceil( log_10( 2^(alpha - e - 1) ) )
|
||||||
// = ceil( (alpha - e - 1) * log_10(2) )
|
// = ceil( (alpha - e - 1) * log_10(2) )
|
||||||
|
|
|
@ -1929,7 +1929,7 @@ class binary_reader
|
||||||
/*!
|
/*!
|
||||||
@param[in] format the current format
|
@param[in] format the current format
|
||||||
@param[in] detail a detailed error message
|
@param[in] detail a detailed error message
|
||||||
@param[in] context further contect information
|
@param[in] context further context information
|
||||||
@return a message string to use in the parse_error exceptions
|
@return a message string to use in the parse_error exceptions
|
||||||
*/
|
*/
|
||||||
std::string exception_message(const input_format_t format,
|
std::string exception_message(const input_format_t format,
|
||||||
|
|
|
@ -121,8 +121,8 @@ class iter_impl
|
||||||
/*!
|
/*!
|
||||||
@brief const copy constructor
|
@brief const copy constructor
|
||||||
@param[in] other const iterator to copy from
|
@param[in] other const iterator to copy from
|
||||||
@note This copy constuctor had to be defined explicitely to circumvent a bug
|
@note This copy constructor had to be defined explicitly to circumvent a bug
|
||||||
occuring on msvc v19.0 compiler (VS 2015) debug build. For more
|
occurring on msvc v19.0 compiler (VS 2015) debug build. For more
|
||||||
information refer to: https://github.com/nlohmann/json/issues/1608
|
information refer to: https://github.com/nlohmann/json/issues/1608
|
||||||
*/
|
*/
|
||||||
iter_impl(const iter_impl<const BasicJsonType>& other) noexcept
|
iter_impl(const iter_impl<const BasicJsonType>& other) noexcept
|
||||||
|
|
|
@ -126,7 +126,7 @@ class json_pointer
|
||||||
/*!
|
/*!
|
||||||
@brief append an array index at the end of this JSON pointer
|
@brief append an array index at the end of this JSON pointer
|
||||||
|
|
||||||
@param[in] array_index array index ot append
|
@param[in] array_index array index to append
|
||||||
@return JSON pointer with @a array_index appended
|
@return JSON pointer with @a array_index appended
|
||||||
|
|
||||||
@liveexample{The example shows the usage of `operator/=`.,json_pointer__operator_add}
|
@liveexample{The example shows the usage of `operator/=`.,json_pointer__operator_add}
|
||||||
|
|
|
@ -4019,7 +4019,7 @@ class basic_json
|
||||||
/*!
|
/*!
|
||||||
@brief check the existence of an element in a JSON object given a JSON pointer
|
@brief check the existence of an element in a JSON object given a JSON pointer
|
||||||
|
|
||||||
Check wehther the given JSON pointer @a ptr can be resolved in the current
|
Check whether the given JSON pointer @a ptr can be resolved in the current
|
||||||
JSON value.
|
JSON value.
|
||||||
|
|
||||||
@note This method can be executed on any JSON value type.
|
@note This method can be executed on any JSON value type.
|
||||||
|
|
|
@ -7056,7 +7056,7 @@ class binary_reader
|
||||||
/*!
|
/*!
|
||||||
@param[in] format the current format
|
@param[in] format the current format
|
||||||
@param[in] detail a detailed error message
|
@param[in] detail a detailed error message
|
||||||
@param[in] context further contect information
|
@param[in] context further context information
|
||||||
@return a message string to use in the parse_error exceptions
|
@return a message string to use in the parse_error exceptions
|
||||||
*/
|
*/
|
||||||
std::string exception_message(const input_format_t format,
|
std::string exception_message(const input_format_t format,
|
||||||
|
@ -9414,8 +9414,8 @@ class iter_impl
|
||||||
/*!
|
/*!
|
||||||
@brief const copy constructor
|
@brief const copy constructor
|
||||||
@param[in] other const iterator to copy from
|
@param[in] other const iterator to copy from
|
||||||
@note This copy constuctor had to be defined explicitely to circumvent a bug
|
@note This copy constructor had to be defined explicitly to circumvent a bug
|
||||||
occuring on msvc v19.0 compiler (VS 2015) debug build. For more
|
occurring on msvc v19.0 compiler (VS 2015) debug build. For more
|
||||||
information refer to: https://github.com/nlohmann/json/issues/1608
|
information refer to: https://github.com/nlohmann/json/issues/1608
|
||||||
*/
|
*/
|
||||||
iter_impl(const iter_impl<const BasicJsonType>& other) noexcept
|
iter_impl(const iter_impl<const BasicJsonType>& other) noexcept
|
||||||
|
@ -10187,7 +10187,7 @@ class json_pointer
|
||||||
/*!
|
/*!
|
||||||
@brief append an array index at the end of this JSON pointer
|
@brief append an array index at the end of this JSON pointer
|
||||||
|
|
||||||
@param[in] array_index array index ot append
|
@param[in] array_index array index to append
|
||||||
@return JSON pointer with @a array_index appended
|
@return JSON pointer with @a array_index appended
|
||||||
|
|
||||||
@liveexample{The example shows the usage of `operator/=`.,json_pointer__operator_add}
|
@liveexample{The example shows the usage of `operator/=`.,json_pointer__operator_add}
|
||||||
|
@ -12966,7 +12966,7 @@ inline cached_power get_cached_power_for_binary_exponent(int e)
|
||||||
// ==> 2^(q - 1 + alpha) <= c * 2^(e + q)
|
// ==> 2^(q - 1 + alpha) <= c * 2^(e + q)
|
||||||
// ==> 2^(alpha - e - 1) <= c
|
// ==> 2^(alpha - e - 1) <= c
|
||||||
//
|
//
|
||||||
// If c were an exakt power of ten, i.e. c = 10^k, one may determine k as
|
// If c were an exact power of ten, i.e. c = 10^k, one may determine k as
|
||||||
//
|
//
|
||||||
// k = ceil( log_10( 2^(alpha - e - 1) ) )
|
// k = ceil( log_10( 2^(alpha - e - 1) ) )
|
||||||
// = ceil( (alpha - e - 1) * log_10(2) )
|
// = ceil( (alpha - e - 1) * log_10(2) )
|
||||||
|
@ -18549,7 +18549,7 @@ class basic_json
|
||||||
/*!
|
/*!
|
||||||
@brief check the existence of an element in a JSON object given a JSON pointer
|
@brief check the existence of an element in a JSON object given a JSON pointer
|
||||||
|
|
||||||
Check wehther the given JSON pointer @a ptr can be resolved in the current
|
Check whether the given JSON pointer @a ptr can be resolved in the current
|
||||||
JSON value.
|
JSON value.
|
||||||
|
|
||||||
@note This method can be executed on any JSON value type.
|
@note This method can be executed on any JSON value type.
|
||||||
|
|
|
@ -1287,7 +1287,7 @@ TEST_CASE("CBOR")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
SECTION("additonal deserialization")
|
SECTION("additional deserialization")
|
||||||
{
|
{
|
||||||
SECTION("0x7b (string)")
|
SECTION("0x7b (string)")
|
||||||
{
|
{
|
||||||
|
|
|
@ -210,7 +210,7 @@ json parser_helper(const std::string& s)
|
||||||
json j;
|
json j;
|
||||||
json::parser(nlohmann::detail::input_adapter(s)).parse(true, j);
|
json::parser(nlohmann::detail::input_adapter(s)).parse(true, j);
|
||||||
|
|
||||||
// if this line was reached, no exception ocurred
|
// if this line was reached, no exception occurred
|
||||||
// -> check if result is the same without exceptions
|
// -> check if result is the same without exceptions
|
||||||
json j_nothrow;
|
json j_nothrow;
|
||||||
CHECK_NOTHROW(json::parser(nlohmann::detail::input_adapter(s), nullptr, false).parse(true, j_nothrow));
|
CHECK_NOTHROW(json::parser(nlohmann::detail::input_adapter(s), nullptr, false).parse(true, j_nothrow));
|
||||||
|
|
|
@ -1359,7 +1359,7 @@ TEST_CASE("MessagePack roundtrips" * doctest::skip())
|
||||||
{
|
{
|
||||||
SECTION("input from msgpack-python")
|
SECTION("input from msgpack-python")
|
||||||
{
|
{
|
||||||
// most of these are exluded due to differences in key order (not a real problem)
|
// most of these are excluded due to differences in key order (not a real problem)
|
||||||
auto exclude_packed = std::set<std::string>
|
auto exclude_packed = std::set<std::string>
|
||||||
{
|
{
|
||||||
"test/data/json.org/1.json",
|
"test/data/json.org/1.json",
|
||||||
|
|
|
@ -164,7 +164,7 @@ TEST_CASE("regression tests")
|
||||||
{
|
{
|
||||||
SECTION("issue #60 - Double quotation mark is not parsed correctly")
|
SECTION("issue #60 - Double quotation mark is not parsed correctly")
|
||||||
{
|
{
|
||||||
SECTION("escape_dobulequote")
|
SECTION("escape_doublequote")
|
||||||
{
|
{
|
||||||
auto s = "[\"\\\"foo\\\"\"]";
|
auto s = "[\"\\\"foo\\\"\"]";
|
||||||
json j = json::parse(s);
|
json j = json::parse(s);
|
||||||
|
|
|
@ -238,7 +238,7 @@ void from_json(const nlohmann::json& j, contact_book& cb)
|
||||||
TEST_CASE("basic usage" * doctest::test_suite("udt"))
|
TEST_CASE("basic usage" * doctest::test_suite("udt"))
|
||||||
{
|
{
|
||||||
|
|
||||||
// a bit narcissic maybe :) ?
|
// a bit narcissistic maybe :) ?
|
||||||
const udt::age a
|
const udt::age a
|
||||||
{
|
{
|
||||||
23
|
23
|
||||||
|
|
|
@ -1152,7 +1152,7 @@ TEST_CASE("Unicode" * doctest::skip())
|
||||||
json j;
|
json j;
|
||||||
CHECK_NOTHROW(f >> j);
|
CHECK_NOTHROW(f >> j);
|
||||||
|
|
||||||
// the array has 1112064 + 1 elemnts (a terminating "null" value)
|
// the array has 1112064 + 1 elements (a terminating "null" value)
|
||||||
// Note: 1112064 = 0x1FFFFF code points - 2048 invalid values between
|
// Note: 1112064 = 0x1FFFFF code points - 2048 invalid values between
|
||||||
// 0xD800 and 0xDFFF.
|
// 0xD800 and 0xDFFF.
|
||||||
CHECK(j.size() == 1112065);
|
CHECK(j.size() == 1112065);
|
||||||
|
|
Loading…
Reference in a new issue