From edc2bba718391aaec685b991b70fd5e574bf4d03 Mon Sep 17 00:00:00 2001 From: tastytea Date: Sat, 4 Jan 2020 19:09:33 +0100 Subject: [PATCH] Improve documentation for CURLWrapper. --- include/curl_wrapper.hpp | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/include/curl_wrapper.hpp b/include/curl_wrapper.hpp index 9da4912..6a088ff 100644 --- a/include/curl_wrapper.hpp +++ b/include/curl_wrapper.hpp @@ -37,6 +37,8 @@ enum class http_method /*! * @brief Handles the details of network connections. * + * You don't need to use this. + * * @since 0.1.0 * * @headerfile curl_wrapper.hpp mastodonpp/curl_wrapper.hpp @@ -78,6 +80,14 @@ public: //! Move assignment operator CURLWrapper& operator=(CURLWrapper &&other) noexcept = default; + /*! + * @brief Make a request. + * + * @param method The HTTP method. + * @param uri The full URI. + * + * @since 0.1.0 + */ [[nodiscard]] string make_request(const http_method &meth, const string_view &uri);