diff options
| author | tastytea | 2020-01-08 17:20:44 +0100 |
|---|---|---|
| committer | tastytea | 2020-01-08 17:22:41 +0100 |
| commit | 577c252b4232af466a6c186b5fa5fc79e999747c (patch) | |
| tree | 0497b62bca0034ffd49eefbed3620d6354edaed3 /include | |
| parent | deed340f3d98150f96ef78e7bb4e0ae9f35d4436 (diff) | |
| download | mastodonpp-577c252b4232af466a6c186b5fa5fc79e999747c.tar mastodonpp-577c252b4232af466a6c186b5fa5fc79e999747c.tar.gz mastodonpp-577c252b4232af466a6c186b5fa5fc79e999747c.zip | |
Improve documentation.
Diffstat (limited to 'include')
| -rw-r--r-- | include/connection.hpp | 1 | ||||
| -rw-r--r-- | include/mastodonpp.hpp | 8 |
2 files changed, 5 insertions, 4 deletions
diff --git a/include/connection.hpp b/include/connection.hpp index 2469738..09a3945 100644 --- a/include/connection.hpp +++ b/include/connection.hpp @@ -83,6 +83,7 @@ public: /*! * @brief Make a HTTP GET call. + * * Example: * @code * auto answer{connection.get("/api/v1/instance")}; diff --git a/include/mastodonpp.hpp b/include/mastodonpp.hpp index 85f1214..eecac21 100644 --- a/include/mastodonpp.hpp +++ b/include/mastodonpp.hpp @@ -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. * |