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

📝 fixed two documentation warnings

Browse source
This commit is contained in:
Niels Lohmann 2016-12-11 16:03:23 +01:00
parent bc28942101
commit 6fa4f96ba3
2 changed files with 20 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
src/json.hpp
View file

@ -944,7 +944,7 @@ class basic_json
With a parser callback function, the result of parsing a JSON text can be With a parser callback function, the result of parsing a JSON text can be
influenced. When passed to @ref parse(std::istream&, const influenced. When passed to @ref parse(std::istream&, const
parser_callback_t) or @ref parse(const char*, const parser_callback_t), parser_callback_t) or @ref parse(const CharT, const parser_callback_t),
it is called on certain events (passed as @ref parse_event_t via parameter it is called on certain events (passed as @ref parse_event_t via parameter
@a event) with a set recursion depth @a depth and context JSON value @a event) with a set recursion depth @a depth and context JSON value
@a parsed. The return value of the callback function is a boolean @a parsed. The return value of the callback function is a boolean
@ -987,7 +987,7 @@ class basic_json
skipped completely or replaced by an empty discarded object. skipped completely or replaced by an empty discarded object.
@sa @ref parse(std::istream&, parser_callback_t) or @sa @ref parse(std::istream&, parser_callback_t) or
@ref parse(const char*, parser_callback_t) for examples @ref parse(const CharT, const parser_callback_t) for examples
@since version 1.0.0 @since version 1.0.0
*/ */
@ -6003,11 +6003,11 @@ class basic_json
@since version 1.0.0 (originally for @ref string_t) @since version 1.0.0 (originally for @ref string_t)
*/ */
template<typename CharPT, typename std::enable_if< template<typename CharT, typename std::enable_if<
std::is_pointer<CharPT>::value and std::is_pointer<CharT>::value and
std::is_integral<typename std::remove_pointer<CharPT>::type>::value and std::is_integral<typename std::remove_pointer<CharT>::type>::value and
sizeof(typename std::remove_pointer<CharPT>::type) == 1, int>::type = 0> sizeof(typename std::remove_pointer<CharT>::type) == 1, int>::type = 0>
static basic_json parse(const CharPT s, static basic_json parse(const CharT s,
const parser_callback_t cb = nullptr) const parser_callback_t cb = nullptr)
{ {
return parser(reinterpret_cast<const char*>(s), cb).parse(); return parser(reinterpret_cast<const char*>(s), cb).parse();
@ -6032,7 +6032,7 @@ class basic_json
@liveexample{The example below demonstrates the `parse()` function with @liveexample{The example below demonstrates the `parse()` function with
and without callback function.,parse__istream__parser_callback_t} and without callback function.,parse__istream__parser_callback_t}
@sa @ref parse(const char*, const parser_callback_t) for a version @sa @ref parse(const CharT, const parser_callback_t) for a version
that reads from a string that reads from a string
@since version 1.0.0 @since version 1.0.0
@ -9068,8 +9068,6 @@ basic_json_parser_66:
supplied via the first parameter. Set this to @a supplied via the first parameter. Set this to @a
static_cast<number_float_t*>(nullptr). static_cast<number_float_t*>(nullptr).
@param[in] type the @ref number_float_t in use
@param[in,out] endptr recieves a pointer to the first character after @param[in,out] endptr recieves a pointer to the first character after
the number the number
@ -9088,8 +9086,6 @@ basic_json_parser_66:
supplied via the first parameter. Set this to @a supplied via the first parameter. Set this to @a
static_cast<number_float_t*>(nullptr). static_cast<number_float_t*>(nullptr).
@param[in] type the @ref number_float_t in use
@param[in,out] endptr recieves a pointer to the first character after @param[in,out] endptr recieves a pointer to the first character after
the number the number
@ -9108,8 +9104,6 @@ basic_json_parser_66:
supplied via the first parameter. Set this to @a supplied via the first parameter. Set this to @a
static_cast<number_float_t*>(nullptr). static_cast<number_float_t*>(nullptr).
@param[in] type the @ref number_float_t in use
@param[in,out] endptr recieves a pointer to the first character after @param[in,out] endptr recieves a pointer to the first character after
the number the number
@ -9997,13 +9991,11 @@ basic_json_parser_66:
/*! /*!
@brief replace all occurrences of a substring by another string @brief replace all occurrences of a substring by another string
@param[in,out] s the string to manipulate @param[in,out] s the string to manipulate; changed so that all
occurrences of @a f are replaced with @a t
@param[in] f the substring to replace with @a t @param[in] f the substring to replace with @a t
@param[in] t the string to replace @a f @param[in] t the string to replace @a f
@return The string @a s where all occurrences of @a f are replaced
with @a t.
@pre The search string @a f must not be empty. @pre The search string @a f must not be empty.
@since version 2.0.0 @since version 2.0.0

28
src/json.hpp.re2c
View file

@ -944,7 +944,7 @@ class basic_json
With a parser callback function, the result of parsing a JSON text can be With a parser callback function, the result of parsing a JSON text can be
influenced. When passed to @ref parse(std::istream&, const influenced. When passed to @ref parse(std::istream&, const
parser_callback_t) or @ref parse(const char*, const parser_callback_t), parser_callback_t) or @ref parse(const CharT, const parser_callback_t),
it is called on certain events (passed as @ref parse_event_t via parameter it is called on certain events (passed as @ref parse_event_t via parameter
@a event) with a set recursion depth @a depth and context JSON value @a event) with a set recursion depth @a depth and context JSON value
@a parsed. The return value of the callback function is a boolean @a parsed. The return value of the callback function is a boolean
@ -987,7 +987,7 @@ class basic_json
skipped completely or replaced by an empty discarded object. skipped completely or replaced by an empty discarded object.
@sa @ref parse(std::istream&, parser_callback_t) or @sa @ref parse(std::istream&, parser_callback_t) or
@ref parse(const char*, parser_callback_t) for examples @ref parse(const CharT, const parser_callback_t) for examples
@since version 1.0.0 @since version 1.0.0
*/ */
@ -6003,11 +6003,11 @@ class basic_json
@since version 1.0.0 (originally for @ref string_t) @since version 1.0.0 (originally for @ref string_t)
*/ */
template<typename CharPT, typename std::enable_if< template<typename CharT, typename std::enable_if<
std::is_pointer<CharPT>::value and std::is_pointer<CharT>::value and
std::is_integral<typename std::remove_pointer<CharPT>::type>::value and std::is_integral<typename std::remove_pointer<CharT>::type>::value and
sizeof(typename std::remove_pointer<CharPT>::type) == 1, int>::type = 0> sizeof(typename std::remove_pointer<CharT>::type) == 1, int>::type = 0>
static basic_json parse(const CharPT s, static basic_json parse(const CharT s,
const parser_callback_t cb = nullptr) const parser_callback_t cb = nullptr)
{ {
return parser(reinterpret_cast<const char*>(s), cb).parse(); return parser(reinterpret_cast<const char*>(s), cb).parse();
@ -6032,7 +6032,7 @@ class basic_json
@liveexample{The example below demonstrates the `parse()` function with @liveexample{The example below demonstrates the `parse()` function with
and without callback function.,parse__istream__parser_callback_t} and without callback function.,parse__istream__parser_callback_t}
@sa @ref parse(const char*, const parser_callback_t) for a version @sa @ref parse(const CharT, const parser_callback_t) for a version
that reads from a string that reads from a string
@since version 1.0.0 @since version 1.0.0
@ -8217,8 +8217,6 @@ class basic_json
supplied via the first parameter. Set this to @a supplied via the first parameter. Set this to @a
static_cast<number_float_t*>(nullptr). static_cast<number_float_t*>(nullptr).
@param[in] type the @ref number_float_t in use
@param[in,out] endptr recieves a pointer to the first character after @param[in,out] endptr recieves a pointer to the first character after
the number the number
@ -8237,8 +8235,6 @@ class basic_json
supplied via the first parameter. Set this to @a supplied via the first parameter. Set this to @a
static_cast<number_float_t*>(nullptr). static_cast<number_float_t*>(nullptr).
@param[in] type the @ref number_float_t in use
@param[in,out] endptr recieves a pointer to the first character after @param[in,out] endptr recieves a pointer to the first character after
the number the number
@ -8257,8 +8253,6 @@ class basic_json
supplied via the first parameter. Set this to @a supplied via the first parameter. Set this to @a
static_cast<number_float_t*>(nullptr). static_cast<number_float_t*>(nullptr).
@param[in] type the @ref number_float_t in use
@param[in,out] endptr recieves a pointer to the first character after @param[in,out] endptr recieves a pointer to the first character after
the number the number
@ -9146,13 +9140,11 @@ class basic_json
/*! /*!
@brief replace all occurrences of a substring by another string @brief replace all occurrences of a substring by another string
@param[in,out] s the string to manipulate @param[in,out] s the string to manipulate; changed so that all
occurrences of @a f are replaced with @a t
@param[in] f the substring to replace with @a t @param[in] f the substring to replace with @a t
@param[in] t the string to replace @a f @param[in] t the string to replace @a f
@return The string @a s where all occurrences of @a f are replaced
with @a t.
@pre The search string @a f must not be empty. @pre The search string @a f must not be empty.
@since version 2.0.0 @since version 2.0.0