Mercurial > code
changeset 651:728bdf008ec3
json_util: wording
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Tue, 23 Oct 2018 21:15:00 +0200 |
| parents | ff73f2dd1c82 |
| children | 6739771fba29 |
| files | cpp/json_util/json_util.hpp |
| diffstat | 1 files changed, 13 insertions(+), 13 deletions(-) [+] |
line wrap: on
line diff
--- a/cpp/json_util/json_util.hpp Tue Oct 23 21:10:00 2018 +0200 +++ b/cpp/json_util/json_util.hpp Tue Oct 23 21:15:00 2018 +0200 @@ -38,7 +38,7 @@ /** * \brief Describe how to convert a JSON value. * - * This class must be specialized for every type you want to convert from JSON + * This traits must be specialized for every type you want to convert from JSON * to its native type. * * You only need to implement the get function with the following signature: @@ -50,7 +50,7 @@ * The implementation should not throw an exception but return a null optional * instead. * - * This class is already specialized for the given types: + * This traits is already specialized for the given types: * * - bool * - double @@ -69,7 +69,7 @@ * Convert the JSON value to bool. * * \param value the value - * \return the bool or none if not a boolean type + * \return the bool or empty if not a boolean type */ static auto get(const nlohmann::json& value) noexcept -> std::optional<bool>; }; @@ -83,7 +83,7 @@ * Convert the JSON value to bool. * * \param value the value - * \return the double or none if not a double type + * \return the double or empty if not a double type */ static auto get(const nlohmann::json& value) noexcept -> std::optional<double>; }; @@ -97,7 +97,7 @@ * Convert the JSON value to std::string. * * \param value the value - * \return the string or none if not a string type + * \return the string or empty if not a string type */ static auto get(const nlohmann::json& value) -> std::optional<std::string>; }; @@ -111,7 +111,7 @@ * Convert the JSON value to std::int8_t. * * \param value the value - * \return the value or none if value does not fit between the range + * \return the value or empty if value does not fit between the range */ static auto get(const nlohmann::json& value) -> std::optional<std::int8_t>; }; @@ -125,7 +125,7 @@ * Convert the JSON value to std::int16_t. * * \param value the value - * \return the value or none if value does not fit between the range + * \return the value or empty if value does not fit between the range */ static auto get(const nlohmann::json& value) -> std::optional<std::int16_t>; }; @@ -139,7 +139,7 @@ * Convert the JSON value to std::int32_t. * * \param value the value - * \return the value or none if value does not fit between the range + * \return the value or empty if value does not fit between the range */ static auto get(const nlohmann::json& value) -> std::optional<std::int32_t>; }; @@ -153,7 +153,7 @@ * Convert the JSON value to std::int64_t. * * \param value the value - * \return the int or none if not a int type + * \return the int or empty if not a int type */ static auto get(const nlohmann::json& value) noexcept -> std::optional<std::int64_t>; }; @@ -167,7 +167,7 @@ * Convert the JSON value to std::uint8_t. * * \param value the value - * \return the value or none if value does not fit between the range + * \return the value or empty if value does not fit between the range */ static auto get(const nlohmann::json& value) -> std::optional<std::uint8_t>; }; @@ -181,7 +181,7 @@ * Convert the JSON value to std::uint16_t. * * \param value the value - * \return the value or none if value does not fit between the range + * \return the value or empty if value does not fit between the range */ static auto get(const nlohmann::json& value) -> std::optional<std::uint16_t>; }; @@ -195,7 +195,7 @@ * Convert the JSON value to std::uint32_t. * * \param value the value - * \return the value or none if value does not fit between the range + * \return the value or empty if value does not fit between the range */ static auto get(const nlohmann::json& value) -> std::optional<std::uint32_t>; }; @@ -209,7 +209,7 @@ * Convert the JSON value to std::uint64_t. * * \param value the value - * \return the int or none if not a int type + * \return the int or empty if not a int type */ static auto get(const nlohmann::json& value) noexcept -> std::optional<std::uint64_t>; };