mastodonpp/include/mastodonpp.hpp

94 lines
2.3 KiB
C++
Raw Normal View History

2020-01-03 08:30:29 +01:00
/* 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
2020-01-03 12:45:55 +01:00
#include "api.hpp"
2020-01-05 11:51:41 +01:00
#include "connection.hpp"
2020-01-04 11:37:08 +01:00
#include "exceptions.hpp"
2020-01-03 12:42:10 +01:00
#include "instance.hpp"
2020-01-03 10:24:31 +01:00
#include "return_types.hpp"
2020-01-03 08:30:29 +01:00
2020-01-03 10:59:04 +01:00
/*!
2020-01-04 12:04:47 +01:00
* @headerfile mastodonpp.hpp mastodonpp/mastodonpp.hpp
*
2020-01-03 10:59:04 +01:00
* @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)`.
*
2020-01-04 11:37:08 +01:00
* @subsection Example
2020-01-03 10:59:04 +01:00
*
* @code
2020-01-05 13:40:21 +01:00
* #include <mastodonpp/mastodonpp.hpp>
* #include <iostream>
*
* int main()
2020-01-04 11:37:08 +01:00
* {
* mastodonpp::Instance instance{"example.com", ""};
2020-01-05 13:40:21 +01:00
* std::cout << "Maximum characters per post: "
* << instance.get_max_chars() << std::endl;
*
* mastodonpp::Connection connection{instance};
*
* auto answer{connection.get(mastodonpp::API::v1::instance)};
* if (answer)
* {
* std::cout << answer << std::endl;
* }
2020-01-04 11:37:08 +01:00
* }
2020-01-03 10:59:04 +01:00
* @endcode
2020-01-04 11:37:08 +01:00
*
* @section exceptions Exceptions
*
* Any unrecoverable libcurl error will be thrown as a
2020-01-06 09:42:51 +01:00
* mastodonpp::CURLException. Network errors will **not** be thrown, but
* reported via the return value.
2020-01-06 10:02:59 +01:00
*
* @example example01_instance_info.cpp
2020-01-03 10:59:04 +01:00
*/
/*!
* @brief C++ wrapper for the Mastodon %API.
2020-01-03 10:59:04 +01:00
*
* All text input is expected to be UTF-8.
*
* @since 0.1.0
*/
2020-01-03 12:42:10 +01:00
namespace mastodonpp
2020-01-03 08:30:29 +01:00
{
2020-01-03 12:42:10 +01:00
2020-01-03 08:30:29 +01:00
} // namespace mastodonpp
#endif // MASTODONPP_HPP