From 3b776c08c7ca2af538a218679607bc52b33b4ee6 Mon Sep 17 00:00:00 2001 From: Niels Date: Sun, 7 Feb 2016 10:45:52 +0100 Subject: [PATCH] clarified documentation --- src/json.hpp | 15 ++++++++------- src/json.hpp.re2c | 15 ++++++++------- 2 files changed, 16 insertions(+), 14 deletions(-) diff --git a/src/json.hpp b/src/json.hpp index 753d2ee0..829ba7de 100644 --- a/src/json.hpp +++ b/src/json.hpp @@ -3144,7 +3144,7 @@ class basic_json @return reference to the element at index @a idx @throw std::domain_error if JSON is not an array or null; example: `"cannot - use operator[] with null"` + use operator[] with string"` @complexity Constant if @a idx is in the range of the array. Otherwise linear in `idx - size()`. @@ -3157,16 +3157,17 @@ class basic_json */ reference operator[](size_type idx) { - // implicitly convert null to object + // implicitly convert null value to an empty array if (is_null()) { m_type = value_t::array; m_value.array = create(); } - // [] only works for arrays + // operator[] only works for arrays if (is_array()) { + // fill up array with null values until given idx is reached assert(m_value.array != nullptr); for (size_t i = m_value.array->size(); i <= idx; ++i) { @@ -3202,7 +3203,7 @@ class basic_json */ const_reference operator[](size_type idx) const { - // at only works for arrays + // const operator[] only works for arrays if (is_array()) { assert(m_value.array != nullptr); @@ -3243,14 +3244,14 @@ class basic_json */ reference operator[](const typename object_t::key_type& key) { - // implicitly convert null to object + // implicitly convert null value to an empty object if (is_null()) { m_type = value_t::object; m_value.object = create(); } - // [] only works for objects + // operator[] only works for objects if (is_object()) { assert(m_value.object != nullptr); @@ -3291,7 +3292,7 @@ class basic_json */ const_reference operator[](const typename object_t::key_type& key) const { - // [] only works for objects + // const operator[] only works for objects if (is_object()) { assert(m_value.object != nullptr); diff --git a/src/json.hpp.re2c b/src/json.hpp.re2c index 5ab23bcf..333b4ddf 100644 --- a/src/json.hpp.re2c +++ b/src/json.hpp.re2c @@ -3144,7 +3144,7 @@ class basic_json @return reference to the element at index @a idx @throw std::domain_error if JSON is not an array or null; example: `"cannot - use operator[] with null"` + use operator[] with string"` @complexity Constant if @a idx is in the range of the array. Otherwise linear in `idx - size()`. @@ -3157,16 +3157,17 @@ class basic_json */ reference operator[](size_type idx) { - // implicitly convert null to object + // implicitly convert null value to an empty array if (is_null()) { m_type = value_t::array; m_value.array = create(); } - // [] only works for arrays + // operator[] only works for arrays if (is_array()) { + // fill up array with null values until given idx is reached assert(m_value.array != nullptr); for (size_t i = m_value.array->size(); i <= idx; ++i) { @@ -3202,7 +3203,7 @@ class basic_json */ const_reference operator[](size_type idx) const { - // at only works for arrays + // const operator[] only works for arrays if (is_array()) { assert(m_value.array != nullptr); @@ -3243,14 +3244,14 @@ class basic_json */ reference operator[](const typename object_t::key_type& key) { - // implicitly convert null to object + // implicitly convert null value to an empty object if (is_null()) { m_type = value_t::object; m_value.object = create(); } - // [] only works for objects + // operator[] only works for objects if (is_object()) { assert(m_value.object != nullptr); @@ -3291,7 +3292,7 @@ class basic_json */ const_reference operator[](const typename object_t::key_type& key) const { - // [] only works for objects + // const operator[] only works for objects if (is_object()) { assert(m_value.object != nullptr);