From 13d4e6bcf9df5f9979524d5d412aade5749adc58 Mon Sep 17 00:00:00 2001 From: Niels Lohmann Date: Wed, 13 Oct 2021 21:21:02 +0200 Subject: [PATCH] :fire: consolidate documentation --- include/nlohmann/json.hpp | 14 ++++---------- single_include/nlohmann/json.hpp | 14 ++++---------- 2 files changed, 8 insertions(+), 20 deletions(-) diff --git a/include/nlohmann/json.hpp b/include/nlohmann/json.hpp index b3a1e8bfc..780e0ee35 100644 --- a/include/nlohmann/json.hpp +++ b/include/nlohmann/json.hpp @@ -2032,15 +2032,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec return get(); } - /*! - @return reference to the binary value - - @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 - */ + /// @brief get a binary value + /// @sa https://json.nlohmann.me/api/basic_json/get_binary/ binary_t& get_binary() { if (!is_binary()) @@ -2051,7 +2044,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec return *get_ptr(); } - /// @copydoc get_binary() + /// @brief get a binary value + /// @sa https://json.nlohmann.me/api/basic_json/get_binary/ const binary_t& get_binary() const { if (!is_binary()) diff --git a/single_include/nlohmann/json.hpp b/single_include/nlohmann/json.hpp index d863e7957..f0a94b885 100644 --- a/single_include/nlohmann/json.hpp +++ b/single_include/nlohmann/json.hpp @@ -19519,15 +19519,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec return get(); } - /*! - @return reference to the binary value - - @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 - */ + /// @brief get a binary value + /// @sa https://json.nlohmann.me/api/basic_json/get_binary/ binary_t& get_binary() { if (!is_binary()) @@ -19538,7 +19531,8 @@ class basic_json // NOLINT(cppcoreguidelines-special-member-functions,hicpp-spec return *get_ptr(); } - /// @copydoc get_binary() + /// @brief get a binary value + /// @sa https://json.nlohmann.me/api/basic_json/get_binary/ const binary_t& get_binary() const { if (!is_binary())