🔥 consolidate documentation

This commit is contained in:
Niels Lohmann 2021-10-13 21:21:02 +02:00
parent fdef0dc860
commit 13d4e6bcf9
No known key found for this signature in database
GPG Key ID: 7F3CEA63AE251B69
2 changed files with 8 additions and 20 deletions

View File

@ -2032,15 +2032,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return get<ValueType>(); return get<ValueType>();
} }
/*! /// @brief get a binary value
@return reference to the binary value /// @sa https://json.nlohmann.me/api/basic_json/get_binary/
@throw type_error.302 if the value is not binary
@sa see @ref is_binary() to check if the value is binary
@since version 3.8.0
*/
binary_t& get_binary() binary_t& get_binary()
{ {
if (!is_binary()) if (!is_binary())
@ -2051,7 +2044,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return *get_ptr<binary_t*>(); return *get_ptr<binary_t*>();
} }
/// @copydoc get_binary() /// @brief get a binary value
/// @sa https://json.nlohmann.me/api/basic_json/get_binary/
const binary_t& get_binary() const const binary_t& get_binary() const
{ {
if (!is_binary()) if (!is_binary())

View File

@ -19519,15 +19519,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return get<ValueType>(); return get<ValueType>();
} }
/*! /// @brief get a binary value
@return reference to the binary value /// @sa https://json.nlohmann.me/api/basic_json/get_binary/
@throw type_error.302 if the value is not binary
@sa see @ref is_binary() to check if the value is binary
@since version 3.8.0
*/
binary_t& get_binary() binary_t& get_binary()
{ {
if (!is_binary()) if (!is_binary())
@ -19538,7 +19531,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec
return *get_ptr<binary_t*>(); return *get_ptr<binary_t*>();
} }
/// @copydoc get_binary() /// @brief get a binary value
/// @sa https://json.nlohmann.me/api/basic_json/get_binary/
const binary_t& get_binary() const const binary_t& get_binary() const
{ {
if (!is_binary()) if (!is_binary())