From a551516be2b8e88aa1cbe86c8878316f63e3f216 Mon Sep 17 00:00:00 2001 From: tastytea Date: Wed, 10 Apr 2019 02:34:21 +0200 Subject: [PATCH] Added short descriptions to the examples. Also added example02 to doxygen-documentation. --- examples/example01_get_public_timeline.cpp | 4 ++-- examples/example02_stream.cpp | 4 ++-- src/mastodon-cpp.hpp | 1 + 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/examples/example01_get_public_timeline.cpp b/examples/example01_get_public_timeline.cpp index 3865568..285762c 100644 --- a/examples/example01_get_public_timeline.cpp +++ b/examples/example01_get_public_timeline.cpp @@ -1,5 +1,5 @@ -/* This file is part of mastodon-cpp. - */ +// This file is part of mastodon-cpp. +// Get the last 4 local posts from the public timeline and display them. // Don't compile this if the Easy-interface is turned off #ifndef WITHOUT_EASY diff --git a/examples/example02_stream.cpp b/examples/example02_stream.cpp index 3ada2d1..7c2353f 100644 --- a/examples/example02_stream.cpp +++ b/examples/example02_stream.cpp @@ -1,5 +1,5 @@ -/* This file is part of mastodon-cpp. - */ +// This file is part of mastodon-cpp. +// Listen to /api/v1/streaming/public and display the events. // Don't compile this if the Easy-interface is turned off #ifndef WITHOUT_EASY diff --git a/src/mastodon-cpp.hpp b/src/mastodon-cpp.hpp index 3f717a7..e559caf 100644 --- a/src/mastodon-cpp.hpp +++ b/src/mastodon-cpp.hpp @@ -42,6 +42,7 @@ using std::uint8_t; /*! * @example example01_get_public_timeline.cpp + * @example example02_stream.cpp */ namespace Mastodon