From 1b7753424ba9592273b546c2fb367f39c621ec9c Mon Sep 17 00:00:00 2001 From: tastytea Date: Sun, 1 Apr 2018 02:20:10 +0200 Subject: [PATCH] documentation enhancement --- src/easy/attachment.hpp | 2 ++ src/easy/easy.hpp | 2 +- src/mastodon-cpp.hpp | 1 + 3 files changed, 4 insertions(+), 1 deletion(-) diff --git a/src/easy/attachment.hpp b/src/easy/attachment.hpp index 6414e51..ae546e4 100644 --- a/src/easy/attachment.hpp +++ b/src/easy/attachment.hpp @@ -80,6 +80,8 @@ namespace Mastodon /*! * @brief Returns the focus point (x, y) + * + * Values are between -1.0 and 1.0. */ const std::array focus() const; diff --git a/src/easy/easy.hpp b/src/easy/easy.hpp index 49b4bb7..21d0290 100644 --- a/src/easy/easy.hpp +++ b/src/easy/easy.hpp @@ -104,7 +104,7 @@ public: explicit Easy(const string &instance, const string &access_token); /*! - * @brief Turns an JSON array into a vector of strings + * @brief Turns a JSON array into a vector of strings * * @param json JSON string holding the array * diff --git a/src/mastodon-cpp.hpp b/src/mastodon-cpp.hpp index 40ac08c..4b1b535 100644 --- a/src/mastodon-cpp.hpp +++ b/src/mastodon-cpp.hpp @@ -37,6 +37,7 @@ * @example example09_streaming_api.cpp * @example example10_simplify.cpp * @example example11_post_media.cpp + * @example example12_easy_laststatus.cpp */ namespace Mastodon {