Improve api docs (#64)

barkeep/barkeep.h

@@ -257,8 +257,10 @@ class AsyncDisplay {
 struct AnimationConfig {
   std::ostream* out = &std::cout; ///< output stream
   std::string message = "";       ///< message to display before the animation
+
   /// style as AnimationStyle or custom animation as a list of strings
   std::variant<AnimationStyle, Strings> style = Ellipsis;
+
   /// interval in which the animation is refreshed
   std::variant<Duration, double> interval = Duration{0.};
   bool no_tty = false; ///< no-tty mode if true (no \r, slower default refresh)
@@ -487,6 +489,7 @@ struct CounterConfig {
   std::optional<double> speed = std::nullopt;
 
   std::string speed_unit = "it/s"; ///< unit of speed text next to speed
+
   /// interval in which the counter is refreshed
   std::variant<Duration, double> interval = Duration{0.};
   bool no_tty = false; ///< no-tty mode if true (no \r, slower default refresh)
@@ -642,8 +645,10 @@ struct ProgressBarConfig {
   std::optional<double> speed = std::nullopt;
 
   std::string speed_unit = "it/s"; ///< unit of speed text next to speed
+
   /// progress bar style, or custom style as BarParts
   std::variant<ProgressBarStyle, BarParts> style = Blocks;
+
   /// interval in which the progress bar is refreshed
   std::variant<Duration, double> interval = Duration{0.};
   bool no_tty = false; ///< no-tty mode if true (no \r, slower default refresh)
@@ -919,6 +924,7 @@ struct IterableBarConfig {
 
   std::string speed_unit = "it/s"; ///< unit of speed text next to speed
   ProgressBarStyle style = Blocks; ///< style of progress bar
+
   /// interval in which the progress bar is refreshed
   std::variant<Duration, double> interval = Duration{0.};
   bool no_tty = false; ///< no-tty mode if true (no \r, slower default refresh)

docs/Doxyfile

@@ -2817,3 +2817,6 @@ MSCGEN_TOOL            =
 # command).
 
 MSCFILE_DIRS           =
+
+
+CLANG_ASSISTED_PARSING = YES

docs/_sidebar.md

@@ -1,6 +1,23 @@
 
-* [Home](README.md)
+* [Home](/)
 
 __API__
-* [Namespaces](api/Namespaces/)
-* [Classes](api/Classes/)
+* [Namespace](api/Namespaces/namespacebarkeep)
+* [Classes](api/Classes/)
+<!-- api -->
+    * [Animation](api/Classes/classbarkeep_1_1_animation.md)
+    * [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)
+    * [Composite](api/Classes/classbarkeep_1_1_composite.md)
+    * [Counter](api/Classes/classbarkeep_1_1_counter.md)
+    * [IterableBar](api/Classes/classbarkeep_1_1_iterable_bar.md)
+    * [IterableBar::Iterator](api/Classes/classbarkeep_1_1_iterable_bar_1_1_iterator.md)
+    * [ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md)
+    * [Speedometer](api/Classes/classbarkeep_1_1_speedometer.md)
+    * [AnimationConfig](api/Classes/structbarkeep_1_1_animation_config.md)
+    * [AtomicTraits](api/Classes/structbarkeep_1_1_atomic_traits.md)
+    * [AtomicTraits< std::atomic< T > >](api/Classes/structbarkeep_1_1_atomic_traits_3_01std_1_1atomic_3_01_t_01_4_01_4.md)
+    * [BarParts](api/Classes/structbarkeep_1_1_bar_parts.md)
+    * [CounterConfig](api/Classes/structbarkeep_1_1_counter_config.md)
+    * [IterableBarConfig](api/Classes/structbarkeep_1_1_iterable_bar_config.md)
+    * [ProgressBarConfig](api/Classes/structbarkeep_1_1_progress_bar_config.md)
+<!-- /api -->