Skip to content

J
json
Commit 6e129fbf by Niels Lohmann
Options

📝 some small documentation fixes

parent 7107072f
Showing with 21 additions and 12 deletions
doc/Makefile
...@@ -57,6 +57,7 @@ doxygen: create_output create_links ...@@ -57,6 +57,7 @@ doxygen: create_output create_links
$(SED) -i 's@< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberFloatType, AllocatorType >@@g' html/*.html $(SED) -i 's@< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberFloatType, AllocatorType >@@g' html/*.html
$(SED) -i 's@< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType >@@g' html/*.html $(SED) -i 's@< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType >@@g' html/*.html
$(SED) -i 's@< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType >@@g' html/*.html $(SED) -i 's@< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType >@@g' html/*.html
$(SED) -i 's@&lt;&#160;ObjectType,&#160;ArrayType,&#160;StringType,&#160;BooleanType,&#160;NumberIntegerType,&#160;NumberUnsignedType,&#160;NumberFloatType,&#160;AllocatorType&#160;&gt;@@g' html/*.html
upload: clean doxygen check_output upload: clean doxygen check_output
cd html ; ../scripts/git-update-ghpages nlohmann/json cd html ; ../scripts/git-update-ghpages nlohmann/json
......
src/json.hpp
...@@ -3793,7 +3793,7 @@ class basic_json ...@@ -3793,7 +3793,7 @@ class basic_json
container `c`, the expression `c.front()` is equivalent to `*c.begin()`. container `c`, the expression `c.front()` is equivalent to `*c.begin()`.
@return In case of a structured type (array or object), a reference to the @return In case of a structured type (array or object), a reference to the
first element is returned. In cast of number, string, or boolean values, a first element is returned. In case of number, string, or boolean values, a
reference to the value is returned. reference to the value is returned.
@complexity Constant. @complexity Constant.
...@@ -3836,7 +3836,7 @@ class basic_json ...@@ -3836,7 +3836,7 @@ class basic_json
@endcode @endcode
@return In case of a structured type (array or object), a reference to the @return In case of a structured type (array or object), a reference to the
last element is returned. In cast of number, string, or boolean values, a last element is returned. In case of number, string, or boolean values, a
reference to the value is returned. reference to the value is returned.
@complexity Constant. @complexity Constant.
...@@ -4187,10 +4187,14 @@ class basic_json ...@@ -4187,10 +4187,14 @@ class basic_json
element is not found or the JSON value is not an object, end() is element is not found or the JSON value is not an object, end() is
returned. returned.
@note This method always returns @ref end() when executed on a JSON type
that is not an object.
@param[in] key key value of the element to search for @param[in] key key value of the element to search for
@return Iterator to an element with key equivalent to @a key. If no such @return Iterator to an element with key equivalent to @a key. If no such
element is found, past-the-end (see end()) iterator is returned. element is found or the JSON value is not an object, past-the-end (see
@ref end()) iterator is returned.
@complexity Logarithmic in the size of the JSON object. @complexity Logarithmic in the size of the JSON object.
...@@ -4233,6 +4237,9 @@ class basic_json ...@@ -4233,6 +4237,9 @@ class basic_json
default `std::map` type, the return value will always be `0` (@a key was default `std::map` type, the return value will always be `0` (@a key was
not found) or `1` (@a key was found). not found) or `1` (@a key was found).
@note This method always returns `0` when executed on a JSON type that is
not an object.
@param[in] key key value of the element to count @param[in] key key value of the element to count
@return Number of elements with key @a key. If the JSON value is not an @return Number of elements with key @a key. If the JSON value is not an
...@@ -4792,9 +4799,6 @@ class basic_json ...@@ -4792,9 +4799,6 @@ class basic_json
object | `{}` object | `{}`
array | `[]` array | `[]`
@note Floating-point numbers are set to `0.0` which will be serialized to
`0`. The vale type remains @ref number_float_t.
@complexity Linear in the size of the JSON value. @complexity Linear in the size of the JSON value.
@liveexample{The example below shows the effect of `clear()` to different @liveexample{The example below shows the effect of `clear()` to different
......
src/json.hpp.re2c
...@@ -3793,7 +3793,7 @@ class basic_json ...@@ -3793,7 +3793,7 @@ class basic_json
container `c`, the expression `c.front()` is equivalent to `*c.begin()`. container `c`, the expression `c.front()` is equivalent to `*c.begin()`.
@return In case of a structured type (array or object), a reference to the @return In case of a structured type (array or object), a reference to the
first element is returned. In cast of number, string, or boolean values, a first element is returned. In case of number, string, or boolean values, a
reference to the value is returned. reference to the value is returned.
@complexity Constant. @complexity Constant.
...@@ -3836,7 +3836,7 @@ class basic_json ...@@ -3836,7 +3836,7 @@ class basic_json
@endcode @endcode
@return In case of a structured type (array or object), a reference to the @return In case of a structured type (array or object), a reference to the
last element is returned. In cast of number, string, or boolean values, a last element is returned. In case of number, string, or boolean values, a
reference to the value is returned. reference to the value is returned.
@complexity Constant. @complexity Constant.
...@@ -4187,10 +4187,14 @@ class basic_json ...@@ -4187,10 +4187,14 @@ class basic_json
element is not found or the JSON value is not an object, end() is element is not found or the JSON value is not an object, end() is
returned. returned.
@note This method always returns @ref end() when executed on a JSON type
that is not an object.
@param[in] key key value of the element to search for @param[in] key key value of the element to search for
@return Iterator to an element with key equivalent to @a key. If no such @return Iterator to an element with key equivalent to @a key. If no such
element is found, past-the-end (see end()) iterator is returned. element is found or the JSON value is not an object, past-the-end (see
@ref end()) iterator is returned.
@complexity Logarithmic in the size of the JSON object. @complexity Logarithmic in the size of the JSON object.
...@@ -4233,6 +4237,9 @@ class basic_json ...@@ -4233,6 +4237,9 @@ class basic_json
default `std::map` type, the return value will always be `0` (@a key was default `std::map` type, the return value will always be `0` (@a key was
not found) or `1` (@a key was found). not found) or `1` (@a key was found).
@note This method always returns `0` when executed on a JSON type that is
not an object.
@param[in] key key value of the element to count @param[in] key key value of the element to count
@return Number of elements with key @a key. If the JSON value is not an @return Number of elements with key @a key. If the JSON value is not an
...@@ -4792,9 +4799,6 @@ class basic_json ...@@ -4792,9 +4799,6 @@ class basic_json
object | `{}` object | `{}`
array | `[]` array | `[]`
@note Floating-point numbers are set to `0.0` which will be serialized to
`0`. The vale type remains @ref number_float_t.
@complexity Linear in the size of the JSON value. @complexity Linear in the size of the JSON value.
@liveexample{The example below shows the effect of `clear()` to different @liveexample{The example below shows the effect of `clear()` to different
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment