mastodonpp/include/mastodonpp.hpp
tastytea dd1ee45c15
All checks were successful
continuous-integration/drone/push Build is passing
Escape API in documentation where necessary.
2020-01-04 12:22:43 +01:00

85 lines
2.1 KiB
C++

/* This file is part of mastodonpp.
* Copyright © 2020 tastytea <tastytea@tastytea.de>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, version 3.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef MASTODONPP_HPP
#define MASTODONPP_HPP
#include "api.hpp"
#include "exceptions.hpp"
#include "instance.hpp"
#include "request.hpp"
#include "return_types.hpp"
/*!
* @headerfile mastodonpp.hpp mastodonpp/mastodonpp.hpp
*
* @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)`.
*
* @subsection Example
*
* @code
* try
* {
* mastodonpp::Instance instance{"example.com", ""};
* mastodonpp::Request request{instance};
* auto answer{request.get(mastodonpp::API::v1::instance)};
* std::cout << answer << std::endl;
* }
* catch (const mastodonpp::CURLException &e)
* {
* std::cerr << e.what() << std::endl;
* }
* @endcode
*
* @section exceptions Exceptions
*
* Any unrecoverable libcurl error will be thrown as a
* mastodonpp::CURLException.
*/
/*!
* @brief C++ wrapper for the Mastodon %API.
*
* All text input is expected to be UTF-8.
*
* @since 0.1.0
*/
namespace mastodonpp
{
} // namespace mastodonpp
#endif // MASTODONPP_HPP