summaryrefslogtreecommitdiffstats
path: root/include/instance.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'include/instance.hpp')
-rw-r--r--include/instance.hpp4
1 files changed, 4 insertions, 0 deletions
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