tastytea
/
mastodonpp
2
1
Fork 0
Code Issues Pull Requests Releases 12 Wiki Activity

Improve documentation.

This commit is contained in:
tastytea 2020-01-08 17:20:44 +01:00
parent deed340f3d
commit 577c252b42
Signed by: tastytea
GPG Key ID: CFC39497F1B26E07
2 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
include/connection.hpp
View File

@ -83,6 +83,7 @@ public:
/*!
* @brief Make a HTTP GET call.
*
* Example:
* @code
* auto answer{connection.get("/api/v1/instance")};

8
include/mastodonpp.hpp
View File

@ -74,17 +74,17 @@
* @section exceptions Exceptions
*
* Any unrecoverable libcurl error will be thrown as a
* mastodonpp::CURLException. Network errors will **not** be thrown, but
* reported via the return value.
* mastodonpp::CURLException. Network errors will not be thrown, but reported
* via the return value.
*
* @section thread_safety Thread safety
*
* The first time you construct an @link mastodonpp::Instance Instance @endlink
* or @link mastodonpp::Connection Connection @endlink, [curl_global_init()]
* or @link mastodonpp::Connection Connection @endlink, [curl_global_init(3)]
* (https://curl.haxx.se/libcurl/c/curl_global_init.html) is called. When the
* last @link mastodonpp::Instance Instance @endlink or @link
* mastodonpp::Connection Connection @endlink is destroyed,
* [curl_global_cleanup()]
* [curl_global_cleanup(3)]
* (https://curl.haxx.se/libcurl/c/curl_global_cleanup.html) is called. Both
* are not thread safe.
*