From e1b61b5041f99c9cb49b09788bd7125d6dba34d0 Mon Sep 17 00:00:00 2001 From: tastytea Date: Sun, 13 Oct 2019 23:56:39 +0200 Subject: [PATCH 1/2] Deprecated return_entity(_vector) and some high-level abstractions. send_post(), send_toot() and get_notifications(). I don't have the energy to implement and maintain an useful set of high-level abstractions. --- README.adoc | 4 ---- src/easy/easy.hpp | 3 +++ src/easy/return_types_easy.hpp | 10 ++++++---- 3 files changed, 9 insertions(+), 8 deletions(-) diff --git a/README.adoc b/README.adoc index b90c15b..89e382e 100644 --- a/README.adoc +++ b/README.adoc @@ -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. From c772d7b60ea3d9b93045267ec70a2d196b01dfe4 Mon Sep 17 00:00:00 2001 From: tastytea Date: Mon, 14 Oct 2019 00:00:26 +0200 Subject: [PATCH 2/2] Improved introduction. --- README.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.adoc b/README.adoc index 89e382e..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