tastytea
/
mastodon-cpp
Archived
1
0
Fork 0
Code Issues 2 Pull Requests Releases 26 Wiki Activity

Fixed documentation

This commit is contained in:
tastytea 2018-01-13 16:48:52 +01:00
parent 4f7e4583fd
commit 79bd5740d9
Signed by: tastytea
GPG Key ID: 59346E0EA35C67E5
2 changed files with 7 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/example/example.cpp
View File

@ -18,6 +18,7 @@ int main(int argc, char *argv[])
} }
Mastodon::API masto(argv[1], argv[2]); Mastodon::API masto(argv[1], argv[2]);
masto.set_useragent("mastodon-cpp-example/1.3.3.7");
std::string answer; std::string answer;
std::uint16_t ret; std::uint16_t ret;

22
src/mastodon-cpp.hpp
View File

@ -86,7 +86,7 @@ public:
* @param answer The answer from the server. Usually JSON. On error an * @param answer The answer from the server. Usually JSON. On error an
* empty string. * empty string.
* *
* @return The HTTP error code, or 0xffff if an other error happens. * @return Error code. See README.md for details.
*/ */
const std::uint16_t get(const Mastodon::API::v1 &call, std::string &answer); const std::uint16_t get(const Mastodon::API::v1 &call, std::string &answer);
@ -98,7 +98,7 @@ public:
* @param answer The answer from the server. Usually JSON. On error an * @param answer The answer from the server. Usually JSON. On error an
* empty string. * empty string.
* *
* @return The HTTP error code, or 0xffff if an other error happens. * @return Error code. See README.md for details.
*/ */
const std::uint16_t get(const Mastodon::API::v1 &call, const std::uint16_t get(const Mastodon::API::v1 &call,
const std::string &argument, const std::string &argument,
@ -114,7 +114,7 @@ public:
* @param answer The answer from the server. Usually JSON. On error * @param answer The answer from the server. Usually JSON. On error
* an empty string. * an empty string.
* *
* @return The HTTP error code, or 0xffff if an other error happens. * @return Error code. See README.md for details.
*/ */
const std::uint16_t get(const Mastodon::API::v1 &call, const std::uint16_t get(const Mastodon::API::v1 &call,
const std::vector<std::string> &parameters, const std::vector<std::string> &parameters,
@ -124,16 +124,6 @@ public:
* @brief Make a GET request which requires an argument, pass optional * @brief Make a GET request which requires an argument, pass optional
* parameters. * parameters.
* *
* Example:
*
* Mastodon::API masto(argv[1], argv[2]);
* std::vector<std::string> parameters =
* {
* "limit=2",
* "only_media=1"
* };
* masto.get(Mastodon::API::v1::accounts_id_statuses, "12345", parameters);
*
* @param call A call defined in Mastodon::API::v1 * @param call A call defined in Mastodon::API::v1
* @param argument The non-optional argument * @param argument The non-optional argument
* @param parameters A std::vector containing optional parameters in the * @param parameters A std::vector containing optional parameters in the
@ -141,7 +131,7 @@ public:
* @param answer The answer from the server. Usually JSON. On error * @param answer The answer from the server. Usually JSON. On error
* an empty string. * an empty string.
* *
* @return The HTTP error code, or 0xffff if an other error happens. * @return Error code. See README.md for details.
*/ */
const std::uint16_t get(const Mastodon::API::v1 &call, const std::uint16_t get(const Mastodon::API::v1 &call,
const std::string &argument, const std::string &argument,
@ -155,7 +145,7 @@ public:
* @param answer The answer from the server. Usually JSON. On error an * @param answer The answer from the server. Usually JSON. On error an
* empty string. * empty string.
* *
* @return The HTTP error code, or 0xffff if an other error happens. * @return Error code. See README.md for details.
*/ */
const std::uint16_t get(const std::string &call, const std::uint16_t get(const std::string &call,
std::string &answer); std::string &answer);
@ -206,7 +196,7 @@ private:
* into a std::vector. * into a std::vector.
* @param answer The answer from the server * @param answer The answer from the server
* *
* @return The HTTP error code, or 0xffff if an other error happens. * @return Error code. See README.md for details.
*/ */
const std::uint16_t request_sync(const method &meth, const std::uint16_t request_sync(const method &meth,
const std::string &path, const std::string &path,