Update apidocs

oir · Mar 29, 2024 · 1a5e042 · 1a5e042
1 parent ee8e31b
commit 1a5e042
Show file tree

Hide file tree

Showing 18 changed files with 72 additions and 18 deletions.
diff --git a/docs/api/Classes/README.md b/docs/api/Classes/README.md
@@ -1540,6 +1540,7 @@ Constructor.
 | std::variant< AnimationStyle, Strings > | **[style](api/Classes/structbarkeep_1_1_animation_config.md#variable-style)**  |
 | std::variant< Duration, [double](api/Classes/classbarkeep_1_1_counter.md) > | **[interval](api/Classes/structbarkeep_1_1_animation_config.md#variable-interval)** <br>interval in which the animation is refreshed  |
 | [bool](api/Classes/classbarkeep_1_1_counter.md) | **[no_tty](api/Classes/structbarkeep_1_1_animation_config.md#variable-no_tty)** <br>no-tty mode if true (no \r, slower default refresh)  |
+| [bool](api/Classes/classbarkeep_1_1_counter.md) | **[show](api/Classes/structbarkeep_1_1_animation_config.md#variable-show)** <br>show the animation immediately after construction  |
 
 
 </span>
@@ -1585,6 +1586,14 @@ bool no_tty = false;
 
 no-tty mode if true (no \r, slower default refresh) 
 
+#### variable show
+
+```cpp
+bool show = true;
+```
+
+show the animation immediately after construction 
+
 -------------------------------
 
 
@@ -1819,6 +1828,7 @@ std::string speed_right_modifier = "";
 | std::string | **[speed_unit](api/Classes/structbarkeep_1_1_counter_config.md#variable-speed_unit)** <br>unit of speed text next to speed interval in which the counter is refreshed  |
 | std::variant< Duration, [double](api/Classes/classbarkeep_1_1_counter.md) > | **[interval](api/Classes/structbarkeep_1_1_counter_config.md#variable-interval)**  |
 | [bool](api/Classes/classbarkeep_1_1_counter.md) | **[no_tty](api/Classes/structbarkeep_1_1_counter_config.md#variable-no_tty)** <br>no-tty mode if true (no \r, slower default refresh)  |
+| [bool](api/Classes/classbarkeep_1_1_counter.md) | **[show](api/Classes/structbarkeep_1_1_counter_config.md#variable-show)** <br>show the counter immediately after construction  |
 
 
 </span>
@@ -1880,6 +1890,14 @@ bool no_tty = false;
 
 no-tty mode if true (no \r, slower default refresh) 
 
+#### variable show
+
+```cpp
+bool show = true;
+```
+
+show the counter immediately after construction 
+
 -------------------------------
 
 
@@ -2003,6 +2021,7 @@ no-tty mode if true (no \r, slower default refresh)
 | std::variant< ProgressBarStyle, [BarParts](api/Classes/structbarkeep_1_1_bar_parts.md) > | **[style](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-style)**  |
 | std::variant< Duration, [double](api/Classes/classbarkeep_1_1_counter.md) > | **[interval](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-interval)** <br>interval in which the progress bar is refreshed  |
 | [bool](api/Classes/classbarkeep_1_1_counter.md) | **[no_tty](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-no_tty)** <br>no-tty mode if true (no \r, slower default refresh)  |
+| [bool](api/Classes/classbarkeep_1_1_counter.md) | **[show](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-show)** <br>show the progress bar immediately after construction  |
 
 
 </span>
@@ -2087,6 +2106,14 @@ bool no_tty = false;
 
 no-tty mode if true (no \r, slower default refresh) 
 
+#### variable show
+
+```cpp
+bool show = true;
+```
+
+show the progress bar immediately after construction 
+
 -------------------------------
 
-Updated on 2024-02-19 at 09:47:42 -0500
+Updated on 2024-03-28 at 21:56:22 -0400
diff --git a/docs/api/Classes/classbarkeep_1_1_animation.md b/docs/api/Classes/classbarkeep_1_1_animation.md
@@ -199,4 +199,4 @@ inline virtual Duration default_interval_() const override
 
 -------------------------------
 
-Updated on 2024-02-19 at 09:47:42 -0500
+Updated on 2024-03-28 at 21:56:21 -0400
diff --git a/docs/api/Classes/classbarkeep_1_1_async_display.md b/docs/api/Classes/classbarkeep_1_1_async_display.md
@@ -289,4 +289,4 @@ friend class Composite(
 
 -------------------------------
 
-Updated on 2024-02-19 at 09:47:42 -0500
+Updated on 2024-03-28 at 21:56:21 -0400
diff --git a/docs/api/Classes/classbarkeep_1_1_composite.md b/docs/api/Classes/classbarkeep_1_1_composite.md
@@ -193,4 +193,4 @@ std::unique_ptr< AsyncDisplay > right_;
 
 -------------------------------
 
-Updated on 2024-02-19 at 09:47:42 -0500
+Updated on 2024-03-28 at 21:56:22 -0400
diff --git a/docs/api/Classes/classbarkeep_1_1_counter.md b/docs/api/Classes/classbarkeep_1_1_counter.md
@@ -256,4 +256,4 @@ std::stringstream ss_;
 
 -------------------------------
 
-Updated on 2024-02-19 at 09:47:42 -0500
+Updated on 2024-03-28 at 21:56:22 -0400
diff --git a/docs/api/Classes/classbarkeep_1_1_iterable_bar.md b/docs/api/Classes/classbarkeep_1_1_iterable_bar.md
@@ -94,4 +94,4 @@ inline auto end()
 
 -------------------------------
 
-Updated on 2024-02-19 at 09:47:42 -0500
+Updated on 2024-03-28 at 21:56:22 -0400
diff --git a/docs/api/Classes/classbarkeep_1_1_iterable_bar_1_1_iterator.md b/docs/api/Classes/classbarkeep_1_1_iterable_bar_1_1_iterator.md
@@ -54,4 +54,4 @@ inline auto & operator*()
 
 -------------------------------
 
-Updated on 2024-02-19 at 09:47:42 -0500
+Updated on 2024-03-28 at 21:56:22 -0400
diff --git a/docs/api/Classes/classbarkeep_1_1_progress_bar.md b/docs/api/Classes/classbarkeep_1_1_progress_bar.md
@@ -331,4 +331,4 @@ static constexprsize_t width_ = 30;
 
 -------------------------------
 
-Updated on 2024-02-19 at 09:47:42 -0500
+Updated on 2024-03-28 at 21:56:22 -0400
diff --git a/docs/api/Classes/classbarkeep_1_1_speedometer.md b/docs/api/Classes/classbarkeep_1_1_speedometer.md
@@ -75,4 +75,4 @@ Constructor.
 
 -------------------------------
 
-Updated on 2024-02-19 at 09:47:42 -0500
+Updated on 2024-03-28 at 21:56:22 -0400
diff --git a/docs/api/Classes/structbarkeep_1_1_animation_config.md b/docs/api/Classes/structbarkeep_1_1_animation_config.md
@@ -17,6 +17,7 @@
 | std::variant< AnimationStyle, Strings > | **[style](api/Classes/structbarkeep_1_1_animation_config.md#variable-style)**  |
 | std::variant< Duration, [double](api/Classes/classbarkeep_1_1_counter.md) > | **[interval](api/Classes/structbarkeep_1_1_animation_config.md#variable-interval)** <br>interval in which the animation is refreshed  |
 | [bool](api/Classes/classbarkeep_1_1_counter.md) | **[no_tty](api/Classes/structbarkeep_1_1_animation_config.md#variable-no_tty)** <br>no-tty mode if true (no \r, slower default refresh)  |
+| [bool](api/Classes/classbarkeep_1_1_counter.md) | **[show](api/Classes/structbarkeep_1_1_animation_config.md#variable-show)** <br>show the animation immediately after construction  |
 
 
 </span>
@@ -62,6 +63,14 @@ bool no_tty = false;
 
 no-tty mode if true (no \r, slower default refresh) 
 
+### variable show
+
+```cpp
+bool show = true;
+```
+
+show the animation immediately after construction 
+
 -------------------------------
 
-Updated on 2024-02-19 at 09:47:42 -0500
+Updated on 2024-03-28 at 21:56:21 -0400
diff --git a/docs/api/Classes/structbarkeep_1_1_atomic_traits.md b/docs/api/Classes/structbarkeep_1_1_atomic_traits.md
@@ -36,4 +36,4 @@ using barkeep::AtomicTraits< T >::value_type =  T;
 
 -------------------------------
 
-Updated on 2024-02-19 at 09:47:42 -0500
+Updated on 2024-03-28 at 21:56:21 -0400
diff --git a/...i/Classes/structbarkeep_1_1_atomic_traits_3_01std_1_1atomic_3_01_t_01_4_01_4.md b/...i/Classes/structbarkeep_1_1_atomic_traits_3_01std_1_1atomic_3_01_t_01_4_01_4.md
@@ -32,4 +32,4 @@ using barkeep::AtomicTraits< std::atomic< T > >::value_type =  T;
 
 -------------------------------
 
-Updated on 2024-02-19 at 09:47:42 -0500
+Updated on 2024-03-28 at 21:56:21 -0400
diff --git a/docs/api/Classes/structbarkeep_1_1_bar_parts.md b/docs/api/Classes/structbarkeep_1_1_bar_parts.md
@@ -129,4 +129,4 @@ std::string speed_right_modifier = "";
 
 -------------------------------
 
-Updated on 2024-02-19 at 09:47:42 -0500
+Updated on 2024-03-28 at 21:56:22 -0400
diff --git a/docs/api/Classes/structbarkeep_1_1_counter_config.md b/docs/api/Classes/structbarkeep_1_1_counter_config.md
@@ -19,6 +19,7 @@
 | std::string | **[speed_unit](api/Classes/structbarkeep_1_1_counter_config.md#variable-speed_unit)** <br>unit of speed text next to speed interval in which the counter is refreshed  |
 | std::variant< Duration, [double](api/Classes/classbarkeep_1_1_counter.md) > | **[interval](api/Classes/structbarkeep_1_1_counter_config.md#variable-interval)**  |
 | [bool](api/Classes/classbarkeep_1_1_counter.md) | **[no_tty](api/Classes/structbarkeep_1_1_counter_config.md#variable-no_tty)** <br>no-tty mode if true (no \r, slower default refresh)  |
+| [bool](api/Classes/classbarkeep_1_1_counter.md) | **[show](api/Classes/structbarkeep_1_1_counter_config.md#variable-show)** <br>show the counter immediately after construction  |
 
 
 </span>
@@ -80,6 +81,14 @@ bool no_tty = false;
 
 no-tty mode if true (no \r, slower default refresh) 
 
+### variable show
+
+```cpp
+bool show = true;
+```
+
+show the counter immediately after construction 
+
 -------------------------------
 
-Updated on 2024-02-19 at 09:47:42 -0500
+Updated on 2024-03-28 at 21:56:22 -0400
diff --git a/docs/api/Classes/structbarkeep_1_1_iterable_bar_config.md b/docs/api/Classes/structbarkeep_1_1_iterable_bar_config.md
@@ -95,4 +95,4 @@ no-tty mode if true (no \r, slower default refresh)
 
 -------------------------------
 
-Updated on 2024-02-19 at 09:47:42 -0500
+Updated on 2024-03-28 at 21:56:22 -0400
diff --git a/docs/api/Classes/structbarkeep_1_1_progress_bar_config.md b/docs/api/Classes/structbarkeep_1_1_progress_bar_config.md
@@ -18,6 +18,7 @@
 | std::variant< ProgressBarStyle, [BarParts](api/Classes/structbarkeep_1_1_bar_parts.md) > | **[style](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-style)**  |
 | std::variant< Duration, [double](api/Classes/classbarkeep_1_1_counter.md) > | **[interval](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-interval)** <br>interval in which the progress bar is refreshed  |
 | [bool](api/Classes/classbarkeep_1_1_counter.md) | **[no_tty](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-no_tty)** <br>no-tty mode if true (no \r, slower default refresh)  |
+| [bool](api/Classes/classbarkeep_1_1_counter.md) | **[show](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-show)** <br>show the progress bar immediately after construction  |
 
 
 </span>
@@ -102,6 +103,14 @@ bool no_tty = false;
 
 no-tty mode if true (no \r, slower default refresh) 
 
+### variable show
+
+```cpp
+bool show = true;
+```
+
+show the progress bar immediately after construction 
+
 -------------------------------
 
-Updated on 2024-02-19 at 09:47:42 -0500
+Updated on 2024-03-28 at 21:56:22 -0400
diff --git a/docs/api/Namespaces/README.md b/docs/api/Namespaces/README.md
@@ -261,4 +261,4 @@ Definitions of various partial bars for [ProgressBar](api/Classes/classbarkeep_1
 
 -------------------------------
 
-Updated on 2024-02-19 at 09:47:42 -0500
+Updated on 2024-03-28 at 21:56:21 -0400
diff --git a/docs/api/Namespaces/namespacebarkeep.md b/docs/api/Namespaces/namespacebarkeep.md
@@ -261,4 +261,4 @@ Definitions of various partial bars for [ProgressBar](api/Classes/classbarkeep_1
 
 -------------------------------
 
-Updated on 2024-02-19 at 09:47:42 -0500
+Updated on 2024-03-28 at 21:56:21 -0400
Original file line number	Diff line number	Diff line change
Expand Up		@@ -199,4 +199,4 @@ inline virtual Duration default_interval_() const override

		-------------------------------

		Updated on 2024-02-19 at 09:47:42 -0500
		Updated on 2024-03-28 at 21:56:21 -0400
Original file line number	Diff line number	Diff line change
Expand Up		@@ -289,4 +289,4 @@ friend class Composite(

		-------------------------------

		Updated on 2024-02-19 at 09:47:42 -0500
		Updated on 2024-03-28 at 21:56:21 -0400
Original file line number	Diff line number	Diff line change
Expand Up		@@ -193,4 +193,4 @@ std::unique_ptr< AsyncDisplay > right_;

		-------------------------------

		Updated on 2024-02-19 at 09:47:42 -0500
		Updated on 2024-03-28 at 21:56:22 -0400
Original file line number	Diff line number	Diff line change
Expand Up		@@ -256,4 +256,4 @@ std::stringstream ss_;

		-------------------------------

		Updated on 2024-02-19 at 09:47:42 -0500
		Updated on 2024-03-28 at 21:56:22 -0400
Original file line number	Diff line number	Diff line change
Expand Up		@@ -94,4 +94,4 @@ inline auto end()

		-------------------------------

		Updated on 2024-02-19 at 09:47:42 -0500
		Updated on 2024-03-28 at 21:56:22 -0400
Original file line number	Diff line number	Diff line change
Expand Up		@@ -54,4 +54,4 @@ inline auto & operator*()

		-------------------------------

		Updated on 2024-02-19 at 09:47:42 -0500
		Updated on 2024-03-28 at 21:56:22 -0400
Original file line number	Diff line number	Diff line change
Expand Up		@@ -331,4 +331,4 @@ static constexprsize_t width_ = 30;

		-------------------------------

		Updated on 2024-02-19 at 09:47:42 -0500
		Updated on 2024-03-28 at 21:56:22 -0400
Original file line number	Diff line number	Diff line change
Expand Up		@@ -75,4 +75,4 @@ Constructor.

		-------------------------------

		Updated on 2024-02-19 at 09:47:42 -0500
		Updated on 2024-03-28 at 21:56:22 -0400
Original file line number	Diff line number	Diff line change
Expand Up		@@ -36,4 +36,4 @@ using barkeep::AtomicTraits< T >::value_type = T;

		-------------------------------

		Updated on 2024-02-19 at 09:47:42 -0500
		Updated on 2024-03-28 at 21:56:21 -0400
Original file line number	Diff line number	Diff line change
Expand Up		@@ -32,4 +32,4 @@ using barkeep::AtomicTraits< std::atomic< T > >::value_type = T;

		-------------------------------

		Updated on 2024-02-19 at 09:47:42 -0500
		Updated on 2024-03-28 at 21:56:21 -0400