tastytea
/
mastodon-cpp
Archived
1
0
Fork 0
Code Issues 2 Pull Requests Releases 26 Wiki Activity

enhanced proxy documentation

This commit is contained in:
tastytea 2018-05-26 23:02:22 +02:00
parent 86a614dd61
commit f019809133
Signed by: tastytea
GPG Key ID: 59346E0EA35C67E5
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/mastodon-cpp.hpp
View File

@ -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 = "");