diff options
Diffstat (limited to 'include/mastodonpp.hpp')
| -rw-r--r-- | include/mastodonpp.hpp | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/include/mastodonpp.hpp b/include/mastodonpp.hpp index 606e61a..080d4b2 100644 --- a/include/mastodonpp.hpp +++ b/include/mastodonpp.hpp @@ -20,14 +20,61 @@ #include "return_types.hpp" #include <string> +/*! + * @mainpage mastodonpp Reference + * + * @section using Using the library + * + * Include mastodonpp.hpp, which then includes all other headers. + * + * @code + * #include <mastodonpp/mastodonpp.hpp> + * @endcode + * + * Use it in your CMake project like this: + * + * @code + * find_package(mastodonpp REQUIRED CONFIG) + * target_link_libraries(MyProject mastodonpp::mastodonpp) + * @endcode + * + * Or compile your code with `g++ $(pkg-config --cflags --libs mastodonpp)`. + * + * @section Example + * + * @code + * mastodonpp::API masto("example.com", ""); + * @endcode + */ + namespace mastodonpp { using std::string; +/*! + * @brief C++ wrapper for the Mastodon API. + * + * All text input is expected to be UTF-8. + * + * @since 0.1.0 + * + */ + class API { public: + /*! + * @brief Construct a new API object. + * + * To register your application, leave access_token blank and call + * API::register_app1() and API::register_app2(). + * + * @param instance The hostname of your instance. + * @param access_token Your access token. + * + * @since 0.1.0 + */ explicit API(string instance, string access_token); private: |