Added short descriptions to the examples.

Also added example02 to doxygen-documentation.
2019-04-10 02:34:21 +02:00 · 2019-04-10 02:34:21 +02:00 · a551516be2
parent bde8d11706
commit a551516be2
3 changed files with 5 additions and 4 deletions
--- 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
--- 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
--- 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