tastytea/mastodon-cpp
Archived
1
0
Fork 0
Code Issues 2 Pull Requests Releases 26 Wiki Activity

Added documentation to return_entity{,_vector}.
All checks were successful
the build was successful
Details

Browse Source
This commit is contained in:
tastytea 2019-03-30 13:18:42 +01:00
parent c854230f95
commit baf417ce69
Signed by: tastytea
GPG Key ID: CFC39497F1B26E07
1 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
src/easy/return_types_easy.hpp
View File

@ -44,31 +44,64 @@ namespace Easy
template <typename T> template <typename T>
struct return_entity : return_base struct return_entity : return_base
{ {
/*!
* @brief Mastodon::Easy::Entity
*
* @since 0.100.0
*/
T entity; T entity;
return_entity(); return_entity();
return_entity(const uint8_t ec, const string &em, const T &ent); return_entity(const uint8_t ec, const string &em, const T &ent);
/*!
* @brief Same as return_entity::entity.
*
* @since 0.100.0
*/
operator const T() const; operator const T() const;
/*!
* @brief Mastodon::Easy::Entity as string.
*
* @since 0.100.0
*/
operator const string() const; operator const string() const;
// FIXME: Can't get it to work, don't know why. // FIXME: Can't get it to work, don't know why.
/*!
* @brief Mastodon::Easy::Entity as string.
*
* @since 0.100.0
*/
friend std::ostream &operator <<<T>(std::ostream &out, friend std::ostream &operator <<<T>(std::ostream &out,
const return_entity<T> &ret); const return_entity<T> &ret);
}; };
/*! /*!
* @brief Return types for calls that return multiple `Easy::Entity`s. * @brief Return types for calls that return multiple `Easy::Entity`s.
*
* @since 0.100.0
*/ */
template <typename T> template <typename T>
struct return_entity_vector : return_base struct return_entity_vector : return_base
{ {
/*!
* @brief std::vector of Mastodon::Easy::Entity.
*
* @since 0.100.0
*/
vector<T> entities; vector<T> entities;
return_entity_vector(); return_entity_vector();
return_entity_vector(const uint8_t ec, const string &em, return_entity_vector(const uint8_t ec, const string &em,
const vector<T> &vec); const vector<T> &vec);
/*!
* @brief Same es return_entity_vector::entities.
*
* @since 0.100.0
*/
operator const vector<T>() const; operator const vector<T>() const;
}; };
} }