Improve documentation.
All checks were successful
continuous-integration/drone/push Build is passing
All checks were successful
continuous-integration/drone/push Build is passing
This commit is contained in:
parent
ed3111eb9e
commit
9874e76de2
|
@ -24,14 +24,17 @@ namespace mastodonpp
|
|||
|
||||
using std::string;
|
||||
|
||||
/*!
|
||||
* @brief Holds the hostname and access token of an instance.
|
||||
*
|
||||
* @since 0.1.0
|
||||
*/
|
||||
class Instance
|
||||
{
|
||||
public:
|
||||
/*!
|
||||
* @brief Construct a new Instance object.
|
||||
*
|
||||
* Holds the hostname and access token of the instance.
|
||||
*
|
||||
* @param instance The hostname of the instance.
|
||||
* @param access_token Your access token.
|
||||
*
|
||||
|
|
|
@ -22,9 +22,21 @@
|
|||
namespace mastodonpp
|
||||
{
|
||||
|
||||
/*!
|
||||
* @brief Used to make a request to the Mastodon API.
|
||||
*
|
||||
* @since 0.1.0
|
||||
*/
|
||||
class Request
|
||||
{
|
||||
public:
|
||||
/*!
|
||||
* @brief Construct a new Request object.
|
||||
*
|
||||
* @param instance An Instance with the access data.
|
||||
*
|
||||
* @since 0.1.0
|
||||
*/
|
||||
explicit Request(Instance &instance);
|
||||
|
||||
private:
|
||||
|
|
|
@ -30,7 +30,7 @@ using std::string;
|
|||
using std::string_view;
|
||||
|
||||
/*!
|
||||
* @brief Return type for API calls.
|
||||
* @brief Return type for Request%s.
|
||||
*
|
||||
* @since 0.1.0
|
||||
*
|
||||
|
@ -67,21 +67,21 @@ struct answer
|
|||
string body;
|
||||
|
||||
/*!
|
||||
* @brief Returns true if answer::error_code is 0, false otherwise.
|
||||
* @brief Returns true if #error_code is 0, false otherwise.
|
||||
*
|
||||
* @since 0.1.0
|
||||
*/
|
||||
explicit operator bool() const;
|
||||
|
||||
/*!
|
||||
* @brief Returns answer::body as std::string_view.
|
||||
* @brief Returns #body as `std::string_view`.
|
||||
*
|
||||
* @since 0.1.0
|
||||
*/
|
||||
explicit operator string_view() const;
|
||||
|
||||
/*!
|
||||
* @brief Returns answer::body as std::ostream.
|
||||
* @brief Returns #body as `std::ostream`.
|
||||
*
|
||||
* @since 0.1.0
|
||||
*/
|
||||
|
|
Loading…
Reference in New Issue
Block a user