diff --git a/README.adoc b/README.adoc index b90c15b..25807bf 100644 --- a/README.adoc +++ b/README.adoc @@ -5,7 +5,7 @@ :uri-branch-main: {uri-base}/src/branch/master *{project}* is a C++ wrapper for the Mastodon API. You submit an API call -and get the raw JSON or easy to use abstractions. +and get the raw JSON that you can then transform into easy to use abstractions. == Usage @@ -77,10 +77,6 @@ Not included in this list are entities. ==== Return types * `Mastodon::return_call`: Contains the response from `Mastodon::API` calls. -* `Mastodon::Easy::return_entity`: Contains the response from high-level - functions that return a single `Mastodon::Easy::Entity`. -* `Mastodon::Easy::return_entities_vector`: Contains the response from - high-level functions that return multiple `Mastodon::Easy::Entity`. ==== Other types diff --git a/src/easy/easy.hpp b/src/easy/easy.hpp index c7c7902..70034f8 100644 --- a/src/easy/easy.hpp +++ b/src/easy/easy.hpp @@ -167,6 +167,7 @@ namespace Easy * * @since 0.100.0 */ + [[deprecated("Will go away in 1.0.0 with no replacement.")]] const return_entity send_post(const Status &status); /*! @@ -174,6 +175,7 @@ namespace Easy * * @since 0.100.0 */ + [[deprecated("Will go away in 1.0.0 with no replacement.")]] const return_entity send_toot(const Status &status); /*! @@ -187,6 +189,7 @@ namespace Easy * * @since 0.100.0 */ + [[deprecated("Will go away in 1.0.0 with no replacement.")]] const return_entity_vector get_notifications( const uint16_t limit = 20, const string since_id = "", const string max_id = ""); diff --git a/src/easy/return_types_easy.hpp b/src/easy/return_types_easy.hpp index 915a89f..5cf8600 100644 --- a/src/easy/return_types_easy.hpp +++ b/src/easy/return_types_easy.hpp @@ -36,8 +36,9 @@ namespace Easy * * @since 0.100.0 */ - template - struct return_entity : return_base + template struct + [[deprecated("Will go away in 1.0.0 with no replacement.")]] + return_entity : return_base { /*! * @brief Mastodon::Easy::Entity @@ -107,8 +108,9 @@ namespace Easy * * @since 0.100.0 */ - template - struct return_entity_vector : return_base + template struct + [[deprecated("Will go away in 1.0.0 with no replacement.")]] + return_entity_vector : return_base { /*! * @brief std::vector of Mastodon::Easy::Entity.