Add sections about thread safety and text input to documentation.

This commit is contained in:
tastytea 2020-01-08 10:54:59 +01:00
parent b1c99e70b8
commit bbd0445821
Signed by: tastytea
GPG Key ID: CFC39497F1B26E07
1 changed files with 17 additions and 8 deletions

View File

@ -45,7 +45,7 @@
*
* Or compile your code with `g++ $(pkg-config --cflags --libs mastodonpp)`.
*
* @subsection Example
* @subsection example Example
*
* @code
* #include <mastodonpp/mastodonpp.hpp>
@ -67,27 +67,36 @@
* }
* @endcode
*
* @subsection input Input
*
* All text input is expected to be UTF-8.
*
* @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.
*
* @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()]
* (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()]
* (https://curl.haxx.se/libcurl/c/curl_global_cleanup.html) is called. Both
* are not thread safe.
*
* @example example01_instance_info.cpp
*/
/*!
* @brief C++ wrapper for the Mastodon %API.
*
* All text input is expected to be UTF-8.
*
* @since 0.1.0
*/
namespace mastodonpp
{
} // namespace mastodonpp
{} // namespace mastodonpp
#endif // MASTODONPP_HPP