From f019809133766295ef849b5ee38760ffb99a61dc Mon Sep 17 00:00:00 2001
From: tastytea <tastytea@tastytea.de>
Date: Sat, 26 May 2018 23:02:22 +0200
Subject: [PATCH] enhanced proxy documentation

---
 src/mastodon-cpp.hpp | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/src/mastodon-cpp.hpp b/src/mastodon-cpp.hpp
index 3bae46b..da39e90 100644
--- a/src/mastodon-cpp.hpp
+++ b/src/mastodon-cpp.hpp
@@ -149,10 +149,15 @@ public:
         /*!
          *  @brief  Sets the proxy.
          *
-         *  @param  proxy    See `man 3 CURLOPT_PROXY`
-         *  @param  userpw   See `man 3 CURLOPT_PROXYUSERPWD` (optional)
+         *          Since mastodon-cpp is built on libcurl, it respects the same
+         *          proxy environment variables. See `man curl`.
+         *
+         *  @param  proxy   See `man 3 CURLOPT_PROXY`
+         *  @param  userpw  See `man 3 CURLOPT_PROXYUSERPWD` (optional)
          *
          *  @since  0.15.0
+         *
+         *  @return { description_of_the_return_value }
          */
         const void set_proxy(const string &proxy, const string &userpw = "");