Merge branch 'develop' into main
continuous-integration/drone/push Build is passing Details

This commit is contained in:
tastytea 2020-01-17 17:32:13 +01:00
commit 5d78051161
Signed by: tastytea
GPG Key ID: CFC39497F1B26E07
3 changed files with 11 additions and 12 deletions

View File

@ -20,6 +20,8 @@
#include <string> #include <string>
#include <string_view> #include <string_view>
//! @headerfile helpers.hpp mastodonpp/helpers.hpp
namespace mastodonpp namespace mastodonpp
{ {

View File

@ -25,8 +25,6 @@
#include "types.hpp" #include "types.hpp"
/*! /*!
* @headerfile mastodonpp.hpp mastodonpp/mastodonpp.hpp
*
* @mainpage mastodonpp Reference * @mainpage mastodonpp Reference
* *
* @section using Using the library * @section using Using the library
@ -57,7 +55,7 @@
* *
* int main() * int main()
* { * {
* mastodonpp::Instance instance{"example.com", ""}; * mastodonpp::Instance instance{"example.com", {}};
* std::cout << "Maximum characters per post: " * std::cout << "Maximum characters per post: "
* << instance.get_max_chars() << std::endl; * << instance.get_max_chars() << std::endl;
* *
@ -85,12 +83,10 @@
* *
* @section thread_safety Thread safety * @section thread_safety Thread safety
* *
* The first time you construct an @link mastodonpp::Instance Instance @endlink * The first time you construct an @link mastodonpp::Instance Instance@endlink,
* or @link mastodonpp::Connection Connection @endlink, [curl_global_init(3)] * [curl_global_init(3)](https://curl.haxx.se/libcurl/c/curl_global_init.html)
* (https://curl.haxx.se/libcurl/c/curl_global_init.html) is called. When the * is called. When the last @link mastodonpp::Instance Instance @endlink is
* last @link mastodonpp::Instance Instance @endlink or @link * destroyed, [curl_global_cleanup(3)]
* mastodonpp::Connection Connection @endlink is destroyed,
* [curl_global_cleanup(3)]
* (https://curl.haxx.se/libcurl/c/curl_global_cleanup.html) is called. Both * (https://curl.haxx.se/libcurl/c/curl_global_cleanup.html) is called. Both
* are not thread safe. * are not thread safe.
* *
@ -116,6 +112,8 @@
* @brief C++ wrapper for the Mastodon %API. * @brief C++ wrapper for the Mastodon %API.
* *
* @since 0.1.0 * @since 0.1.0
*
* @headerfile mastodonpp.hpp mastodonpp/mastodonpp.hpp
*/ */
namespace mastodonpp namespace mastodonpp
{} // namespace mastodonpp {} // namespace mastodonpp

View File

@ -75,9 +75,6 @@ using parameterpair =
* @brief Return type for Request%s. * @brief Return type for Request%s.
* *
* @since 0.1.0 * @since 0.1.0
*
* @headerfile answer.hpp mastodonpp/answer.hpp
*
*/ */
struct answer_type struct answer_type
{ {
@ -88,6 +85,8 @@ struct answer_type
* [libcurl-errors(3)](https://curl.haxx.se/libcurl/c/libcurl-errors.html). * [libcurl-errors(3)](https://curl.haxx.se/libcurl/c/libcurl-errors.html).
* *
* @since 0.1.0 * @since 0.1.0
*
* @headerfile types.hpp mastodonpp/types.hpp
*/ */
uint8_t curl_error_code{0}; uint8_t curl_error_code{0};