Documentation update

This commit is contained in:
tastytea 2018-02-11 17:16:20 +01:00
parent 8222ff6da1
commit 23b09bbb50
Signed by: tastytea
GPG Key ID: 59346E0EA35C67E5
2 changed files with 4 additions and 3 deletions

View File

@ -42,7 +42,9 @@ Install with `make install`.
# Usage
The HTML reference can be generated with `build_doc.sh`, if doxygen is installed. Or just look in `src/mastodon-cpp.hpp`. There are examples in `src/examples/`.
The HTML reference can be generated with `build_doc.sh`, if doxygen is installed.
Or just look in `src/mastodon-cpp.hpp`. It is also available at [tastytea.github.io/mastodon-cpp/](https://tastytea.github.io/mastodon-cpp/docs/classMastodon_1_1API.html).
There are examples in `src/examples/`.
## Most basic example

View File

@ -69,8 +69,7 @@ public:
/*!
* @brief A list of all API calls.
*
* The original `/` are substituted by `_`. Currently only GET
* requests.
* The original `/` are substituted by `_`.
*/
enum class v1
{