blob: 113ec0bdafe51563512e493f93b5c8dd3b31fa0e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
/* 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 "answer.hpp"
#include "api.hpp"
#include "connection.hpp"
#include "exceptions.hpp"
#include "instance.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
* #include <mastodonpp/mastodonpp.hpp>
* #include <iostream>
*
* int main()
* {
* mastodonpp::Instance instance{"example.com", ""};
* 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;
* }
* }
* @endcode
*
* @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.
*
* @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
#endif // MASTODONPP_HPP
|
