From c9ea49ed914f908d459941fc8e34580fa9da1877 Mon Sep 17 00:00:00 2001 From: tastytea Date: Fri, 24 Jan 2020 02:18:24 +0100 Subject: Enhance documentation for Instance and Connection. --- include/connection.hpp | 3 +++ include/instance.hpp | 4 ++++ 2 files changed, 7 insertions(+) diff --git a/include/connection.hpp b/include/connection.hpp index 957483a..1d3a273 100644 --- a/include/connection.hpp +++ b/include/connection.hpp @@ -68,6 +68,9 @@ struct event_type /*! * @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 * * @headerfile connection.hpp mastodonpp/connection.hpp diff --git a/include/instance.hpp b/include/instance.hpp index 030ca2a..ca1cfe5 100644 --- a/include/instance.hpp +++ b/include/instance.hpp @@ -38,6 +38,10 @@ using std::vector; /*! * @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 * * @headerfile instance.hpp mastodonpp/instance.hpp -- cgit v1.2.3-54-g00ecf