Enhance documentation for Instance and Connection.
continuous-integration/drone/push Build is passing Details

This commit is contained in:
tastytea 2020-01-24 02:18:24 +01:00
parent 9523de8788
commit c9ea49ed91
Signed by: tastytea
GPG Key ID: CFC39497F1B26E07
2 changed files with 7 additions and 0 deletions

View File

@ -68,6 +68,9 @@ struct event_type
/*! /*!
* @brief Represents a connection to an instance. Used for requests. * @brief Represents a connection to an instance. Used for requests.
* *
* Do not make 2 requests with the same Connection at the same time. You can
* create as many Connection%s as you want from one Instance.
*
* @since 0.1.0 * @since 0.1.0
* *
* @headerfile connection.hpp mastodonpp/connection.hpp * @headerfile connection.hpp mastodonpp/connection.hpp

View File

@ -38,6 +38,10 @@ using std::vector;
/*! /*!
* @brief Holds the access data of an instance. * @brief Holds the access data of an instance.
* *
* Instance%s are needed to initialize Connection%s. All properties you set
* here (with set_proxy(), set_useragent() and so on) are copied to every
* Connection you initialize afterwards.
*
* @since 0.1.0 * @since 0.1.0
* *
* @headerfile instance.hpp mastodonpp/instance.hpp * @headerfile instance.hpp mastodonpp/instance.hpp