Merge branch 'develop'
continuous-integration/drone/push Build is passing Details

This commit is contained in:
tastytea 2019-10-14 12:06:43 +02:00
commit c35dab8350
Signed by: tastytea
GPG Key ID: CFC39497F1B26E07
3 changed files with 10 additions and 9 deletions

View File

@ -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

View File

@ -167,6 +167,7 @@ namespace Easy
*
* @since 0.100.0
*/
[[deprecated("Will go away in 1.0.0 with no replacement.")]]
const return_entity<Easy::Status> 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<Easy::Status> 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<Easy::Notification> get_notifications(
const uint16_t limit = 20, const string since_id = "",
const string max_id = "");

View File

@ -36,8 +36,9 @@ namespace Easy
*
* @since 0.100.0
*/
template <typename T>
struct return_entity : return_base
template <typename T> 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 <typename T>
struct return_entity_vector : return_base
template <typename T> struct
[[deprecated("Will go away in 1.0.0 with no replacement.")]]
return_entity_vector : return_base
{
/*!
* @brief std::vector of Mastodon::Easy::Entity.