diff --git a/barkeep/barkeep.h b/barkeep/barkeep.h index a0a92c4..3bbdbe0 100644 --- a/barkeep/barkeep.h +++ b/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 style = Ellipsis; + /// interval in which the animation is refreshed std::variant 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 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 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 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 style = Blocks; + /// interval in which the progress bar is refreshed std::variant 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 interval = Duration{0.}; bool no_tty = false; ///< no-tty mode if true (no \r, slower default refresh) diff --git a/docs/Doxyfile b/docs/Doxyfile index 1edaf34..697ac9e 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -2817,3 +2817,6 @@ MSCGEN_TOOL = # command). MSCFILE_DIRS = + + +CLANG_ASSISTED_PARSING = YES \ No newline at end of file diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 26119f6..0ef1c2f 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -1,6 +1,23 @@ -* [Home](README.md) +* [Home](/) __API__ -* [Namespaces](api/Namespaces/) -* [Classes](api/Classes/) \ No newline at end of file +* [Namespace](api/Namespaces/namespacebarkeep) +* [Classes](api/Classes/) + + * [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) + diff --git a/docs/api/Classes/README.md b/docs/api/Classes/README.md index 9e9eb12..cda1fd8 100644 --- a/docs/api/Classes/README.md +++ b/docs/api/Classes/README.md @@ -1,2134 +1,24 @@ -## barkeep::Animation +# Classes -Displays a simple animation with a message. +* **namespace [barkeep](api/Namespaces/namespacebarkeep.md)** + * **class [Animation](api/Classes/classbarkeep_1_1_animation.md)**
Displays a simple animation with a message. + * **struct [AnimationConfig](api/Classes/structbarkeep_1_1_animation_config.md)**
[Animation](api/Classes/classbarkeep_1_1_animation.md) parameters. + * **class [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)**
Base class to handle all asynchronous displays. + * **struct [AtomicTraits](api/Classes/structbarkeep_1_1_atomic_traits.md)**
Trait class to extract underlying value type from numerics and std::atomics of numerics. + * **struct [AtomicTraits< std::atomic< T > >](api/Classes/structbarkeep_1_1_atomic_traits_3_01std_1_1atomic_3_01_t_01_4_01_4.md)** + * **struct [BarParts](api/Classes/structbarkeep_1_1_bar_parts.md)** + * **class [Composite](api/Classes/classbarkeep_1_1_composite.md)**
Creates a composite display out of two display that shows them side by side. For instance, you can combine two [Counter](api/Classes/classbarkeep_1_1_counter.md) objects to monitor two variables. + * **class [Counter](api/Classes/classbarkeep_1_1_counter.md)**
Monitors and displays a single numeric variable. + * **struct [CounterConfig](api/Classes/structbarkeep_1_1_counter_config.md)**
[Counter](api/Classes/classbarkeep_1_1_counter.md) parameters. + * **class [IterableBar](api/Classes/classbarkeep_1_1_iterable_bar.md)**
A progress bar that can be used with range-based for loops, that automatically tracks the progress of the loop. + * **class [Iterator](api/Classes/classbarkeep_1_1_iterable_bar_1_1_iterator.md)** + * **struct [IterableBarConfig](api/Classes/structbarkeep_1_1_iterable_bar_config.md)** + * **class [ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md)**
Displays a progress bar, by comparing the progress value being monitored to a given total value. Optionally reports speed. + * **struct [ProgressBarConfig](api/Classes/structbarkeep_1_1_progress_bar_config.md)** + * **class [Speedometer](api/Classes/classbarkeep_1_1_speedometer.md)**
Helper class to measure and display speed of progress. -`#include ` - -Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) - -### Public Types - - - -| | Name | -| -------------- | -------------- | -| using [AnimationStyle](api/Namespaces/namespacebarkeep.md#enum-animationstyle) | **[Style](api/Classes/classbarkeep_1_1_animation.md#using-style)** | - - - - -### Public Functions - - - -| | Name | -| -------------- | -------------- | -| | **[Animation](api/Classes/classbarkeep_1_1_animation.md#function-animation)**(const [AnimationConfig](api/Classes/structbarkeep_1_1_animation_config.md) & cfg ={})
Constructor. | -| | **[Animation](api/Classes/classbarkeep_1_1_animation.md#function-animation)**(const [Animation](api/Classes/classbarkeep_1_1_animation.md) & other) =default | -| | **[Animation](api/Classes/classbarkeep_1_1_animation.md#function-animation)**([Animation](api/Classes/classbarkeep_1_1_animation.md) && ) =default | -| | **[~Animation](api/Classes/classbarkeep_1_1_animation.md#function-~animation)**() | -| virtual std::unique_ptr< [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) > | **[clone](api/Classes/classbarkeep_1_1_animation.md#function-clone)**() const override | - - - - -### Protected Functions - - - -| | Name | -| -------------- | -------------- | -| virtual void | **[render_](api/Classes/classbarkeep_1_1_animation.md#function-render_)**() override
Render a display: animation, progress bar, etc. | -| virtual [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[default_interval_](api/Classes/classbarkeep_1_1_animation.md#function-default_interval_)**() const override | - - - - -### Additional inherited members - - - -**Public Functions inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** - - - -| | Name | -| -------------- | -------------- | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(std::ostream * out =&std::cout, [Duration](api/Namespaces/namespacebarkeep.md#using-duration) interval =[Duration](api/Namespaces/namespacebarkeep.md#using-duration){0.}, std::string message ="", std::string format ="", bool no_tty =false) | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(const [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) & other) | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**([AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) && other) | -| virtual | **[~AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-~asyncdisplay)**() | -| virtual void | **[show](api/Classes/classbarkeep_1_1_async_display.md#function-show)**()
Start the display. This starts writing the display in the output stream, and computing speed if applicable. | -| virtual void | **[done](api/Classes/classbarkeep_1_1_async_display.md#function-done)**()
End the display. | -| bool | **[running](api/Classes/classbarkeep_1_1_async_display.md#function-running)**() const | - - - - -**Protected Functions inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** - - - -| | Name | -| -------------- | -------------- | -| void | **[display_](api/Classes/classbarkeep_1_1_async_display.md#function-display_)**()
Display everything (message, maybe with animation, progress bar, etc). | -| void | **[render_message_](api/Classes/classbarkeep_1_1_async_display.md#function-render_message_)**() const
Display the message to output stream. | -| virtual void | **[start](api/Classes/classbarkeep_1_1_async_display.md#function-start)**()
Start the display but do not show. This typically means start measuring speed if applicable, without displaying anything. | -| virtual void | **[join](api/Classes/classbarkeep_1_1_async_display.md#function-join)**()
Join the display thread. Protected because python bindings need to override to handle GIL. | -| void | **[ensure_not_running](api/Classes/classbarkeep_1_1_async_display.md#function-ensure_not_running)**() const | - - - - -**Protected Attributes inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** - - - -| | Name | -| -------------- | -------------- | -| std::ostream * | **[out_](api/Classes/classbarkeep_1_1_async_display.md#variable-out_)** | -| std::unique_ptr< std::thread > | **[displayer_](api/Classes/classbarkeep_1_1_async_display.md#variable-displayer_)** | -| std::condition_variable | **[completion_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_)** | -| std::mutex | **[completion_m_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_m_)** | -| std::atomic< bool > | **[complete_](api/Classes/classbarkeep_1_1_async_display.md#variable-complete_)** | -| [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[interval_](api/Classes/classbarkeep_1_1_async_display.md#variable-interval_)** | -| std::string | **[message_](api/Classes/classbarkeep_1_1_async_display.md#variable-message_)** | -| std::string | **[format_](api/Classes/classbarkeep_1_1_async_display.md#variable-format_)** | -| bool | **[no_tty_](api/Classes/classbarkeep_1_1_async_display.md#variable-no_tty_)** | - - - - -**Friends inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** - - - -| | Name | -| -------------- | -------------- | -| class | **[Composite](api/Classes/classbarkeep_1_1_async_display.md#friend-composite)** | - - - - - -### Public Types Documentation - -#### using Style - -```cpp -using barkeep::Animation::Style = AnimationStyle; -``` - - -### Public Functions Documentation - -#### function Animation - -```cpp -inline Animation( - const AnimationConfig & cfg ={} -) -``` - -Constructor. - -**Parameters**: - - * **cfg** [Animation](api/Classes/classbarkeep_1_1_animation.md) parameters - - -#### function Animation - -```cpp -Animation( - const Animation & other -) =default -``` - - -#### function Animation - -```cpp -Animation( - Animation && -) =default -``` - - -#### function ~Animation - -```cpp -inline ~Animation() -``` - - -#### function clone - -```cpp -inline virtual std::unique_ptr< AsyncDisplay > clone() const override -``` - - -**Reimplements**: [barkeep::AsyncDisplay::clone](api/Classes/classbarkeep_1_1_async_display.md#function-clone) - - -### Protected Functions Documentation - -#### function render_ - -```cpp -inline virtual void render_() override -``` - -Render a display: animation, progress bar, etc. - -**Reimplements**: [barkeep::AsyncDisplay::render_](api/Classes/classbarkeep_1_1_async_display.md#function-render_) - - -#### function default_interval_ - -```cpp -inline virtual Duration default_interval_() const override -``` - - -**Reimplements**: [barkeep::AsyncDisplay::default_interval_](api/Classes/classbarkeep_1_1_async_display.md#function-default_interval_) - - -------------------------------- - - - -## barkeep::AsyncDisplay - - -Base class to handle all asynchronous displays. - - -`#include ` - -Inherited by [barkeep::Animation](api/Classes/classbarkeep_1_1_animation.md), [barkeep::Composite](api/Classes/classbarkeep_1_1_composite.md), [barkeep::Counter< Progress >](api/Classes/classbarkeep_1_1_counter.md), [barkeep::ProgressBar< Progress >](api/Classes/classbarkeep_1_1_progress_bar.md) - -### Public Functions - - - -| | Name | -| -------------- | -------------- | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(std::ostream * out =&std::cout, [Duration](api/Namespaces/namespacebarkeep.md#using-duration) interval =[Duration](api/Namespaces/namespacebarkeep.md#using-duration){0.}, std::string message ="", std::string format ="", bool no_tty =false) | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(const [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) & other) | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**([AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) && other) | -| virtual | **[~AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-~asyncdisplay)**() | -| virtual void | **[show](api/Classes/classbarkeep_1_1_async_display.md#function-show)**()
Start the display. This starts writing the display in the output stream, and computing speed if applicable. | -| virtual void | **[done](api/Classes/classbarkeep_1_1_async_display.md#function-done)**()
End the display. | -| bool | **[running](api/Classes/classbarkeep_1_1_async_display.md#function-running)**() const | -| virtual std::unique_ptr< [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) > | **[clone](api/Classes/classbarkeep_1_1_async_display.md#function-clone)**() const =0 | - - - - -### Protected Functions - - - -| | Name | -| -------------- | -------------- | -| virtual void | **[render_](api/Classes/classbarkeep_1_1_async_display.md#function-render_)**() =0
Render a display: animation, progress bar, etc. | -| virtual [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[default_interval_](api/Classes/classbarkeep_1_1_async_display.md#function-default_interval_)**() const =0 | -| void | **[display_](api/Classes/classbarkeep_1_1_async_display.md#function-display_)**()
Display everything (message, maybe with animation, progress bar, etc). | -| void | **[render_message_](api/Classes/classbarkeep_1_1_async_display.md#function-render_message_)**() const
Display the message to output stream. | -| virtual void | **[start](api/Classes/classbarkeep_1_1_async_display.md#function-start)**()
Start the display but do not show. This typically means start measuring speed if applicable, without displaying anything. | -| virtual void | **[join](api/Classes/classbarkeep_1_1_async_display.md#function-join)**()
Join the display thread. Protected because python bindings need to override to handle GIL. | -| void | **[ensure_not_running](api/Classes/classbarkeep_1_1_async_display.md#function-ensure_not_running)**() const | - - - - -### Protected Attributes - - - -| | Name | -| -------------- | -------------- | -| std::ostream * | **[out_](api/Classes/classbarkeep_1_1_async_display.md#variable-out_)** | -| std::unique_ptr< std::thread > | **[displayer_](api/Classes/classbarkeep_1_1_async_display.md#variable-displayer_)** | -| std::condition_variable | **[completion_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_)** | -| std::mutex | **[completion_m_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_m_)** | -| std::atomic< bool > | **[complete_](api/Classes/classbarkeep_1_1_async_display.md#variable-complete_)** | -| [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[interval_](api/Classes/classbarkeep_1_1_async_display.md#variable-interval_)** | -| std::string | **[message_](api/Classes/classbarkeep_1_1_async_display.md#variable-message_)** | -| std::string | **[format_](api/Classes/classbarkeep_1_1_async_display.md#variable-format_)** | -| bool | **[no_tty_](api/Classes/classbarkeep_1_1_async_display.md#variable-no_tty_)** | - - - - -### Friends - - - -| | Name | -| -------------- | -------------- | -| class | **[Composite](api/Classes/classbarkeep_1_1_async_display.md#friend-composite)** | - - - - -### Public Functions Documentation - -#### function AsyncDisplay - -```cpp -inline AsyncDisplay( - std::ostream * out =&std::cout, - Duration interval =Duration{0.}, - std::string message ="", - std::string format ="", - bool no_tty =false -) -``` - - -#### function AsyncDisplay - -```cpp -inline AsyncDisplay( - const AsyncDisplay & other -) -``` - - -#### function AsyncDisplay - -```cpp -inline AsyncDisplay( - AsyncDisplay && other -) -``` - - -#### function ~AsyncDisplay - -```cpp -inline virtual ~AsyncDisplay() -``` - - -#### function show - -```cpp -inline virtual void show() -``` - -Start the display. This starts writing the display in the output stream, and computing speed if applicable. - -#### function done - -```cpp -inline virtual void done() -``` - -End the display. - -#### function running - -```cpp -inline bool running() const -``` - - -#### function clone - -```cpp -virtual std::unique_ptr< AsyncDisplay > clone() const =0 -``` - - -**Reimplemented by**: [barkeep::Animation::clone](api/Classes/classbarkeep_1_1_animation.md#function-clone), [barkeep::Composite::clone](api/Classes/classbarkeep_1_1_composite.md#function-clone), [barkeep::Counter::clone](api/Classes/classbarkeep_1_1_counter.md#function-clone), [barkeep::ProgressBar::clone](api/Classes/classbarkeep_1_1_progress_bar.md#function-clone) - - -### Protected Functions Documentation - -#### function render_ - -```cpp -virtual void render_() =0 -``` - -Render a display: animation, progress bar, etc. - -**Reimplemented by**: [barkeep::Animation::render_](api/Classes/classbarkeep_1_1_animation.md#function-render_), [barkeep::Composite::render_](api/Classes/classbarkeep_1_1_composite.md#function-render_), [barkeep::Counter::render_](api/Classes/classbarkeep_1_1_counter.md#function-render_), [barkeep::ProgressBar::render_](api/Classes/classbarkeep_1_1_progress_bar.md#function-render_) - - -#### function default_interval_ - -```cpp -virtual Duration default_interval_() const =0 -``` - - -**Reimplemented by**: [barkeep::Animation::default_interval_](api/Classes/classbarkeep_1_1_animation.md#function-default_interval_), [barkeep::Composite::default_interval_](api/Classes/classbarkeep_1_1_composite.md#function-default_interval_), [barkeep::Counter::default_interval_](api/Classes/classbarkeep_1_1_counter.md#function-default_interval_), [barkeep::ProgressBar::default_interval_](api/Classes/classbarkeep_1_1_progress_bar.md#function-default_interval_) - - -#### function display_ - -```cpp -inline void display_() -``` - -Display everything (message, maybe with animation, progress bar, etc). - -#### function render_message_ - -```cpp -inline void render_message_() const -``` - -Display the message to output stream. - -#### function start - -```cpp -inline virtual void start() -``` - -Start the display but do not show. This typically means start measuring speed if applicable, without displaying anything. - -**Reimplemented by**: [barkeep::Composite::start](api/Classes/classbarkeep_1_1_composite.md#function-start), [barkeep::Counter::start](api/Classes/classbarkeep_1_1_counter.md#function-start), [barkeep::ProgressBar::start](api/Classes/classbarkeep_1_1_progress_bar.md#function-start) - - -#### function join - -```cpp -inline virtual void join() -``` - -Join the display thread. Protected because python bindings need to override to handle GIL. - -#### function ensure_not_running - -```cpp -inline void ensure_not_running() const -``` - - -### Protected Attributes Documentation - -#### variable out_ - -```cpp -std::ostream * out_; -``` - - -#### variable displayer_ - -```cpp -std::unique_ptr< std::thread > displayer_; -``` - - -#### variable completion_ - -```cpp -std::condition_variable completion_; -``` - - -#### variable completion_m_ - -```cpp -std::mutex completion_m_; -``` - - -#### variable complete_ - -```cpp -std::atomic< bool > complete_ = false; -``` - - -#### variable interval_ - -```cpp -Duration interval_ {0.0}; -``` - - -#### variable message_ - -```cpp -std::string message_; -``` - - -#### variable format_ - -```cpp -std::string format_; -``` - - -#### variable no_tty_ - -```cpp -bool no_tty_ = false; -``` - - -### Friends - -#### friend Composite - -```cpp -friend class Composite( - Composite -); -``` - - -------------------------------- - - - -## barkeep::Composite - - -Creates a composite display out of two display that shows them side by side. For instance, you can combine two [Counter](api/Classes/classbarkeep_1_1_counter.md) objects to monitor two variables. - - -`#include ` - -Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) - -### Public Functions - - - -| | Name | -| -------------- | -------------- | -| | **[Composite](api/Classes/classbarkeep_1_1_composite.md#function-composite)**(std::unique_ptr< [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) > left, std::unique_ptr< [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) > right) | -| | **[Composite](api/Classes/classbarkeep_1_1_composite.md#function-composite)**(const [Composite](api/Classes/classbarkeep_1_1_composite.md) & other)
Copy constructor clones child displays. | -| | **[~Composite](api/Classes/classbarkeep_1_1_composite.md#function-~composite)**() | -| virtual std::unique_ptr< [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) > | **[clone](api/Classes/classbarkeep_1_1_composite.md#function-clone)**() const override | - - - - -### Protected Functions - - - -| | Name | -| -------------- | -------------- | -| virtual void | **[render_](api/Classes/classbarkeep_1_1_composite.md#function-render_)**() override
Render a display: animation, progress bar, etc. | -| virtual [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[default_interval_](api/Classes/classbarkeep_1_1_composite.md#function-default_interval_)**() const override | -| virtual void | **[start](api/Classes/classbarkeep_1_1_composite.md#function-start)**() override
Start the display but do not show. This typically means start measuring speed if applicable, without displaying anything. | - - - - -### Protected Attributes - - - -| | Name | -| -------------- | -------------- | -| std::unique_ptr< [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) > | **[left_](api/Classes/classbarkeep_1_1_composite.md#variable-left_)** | -| std::unique_ptr< [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) > | **[right_](api/Classes/classbarkeep_1_1_composite.md#variable-right_)** | - - - - -### Additional inherited members - - - -**Public Functions inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** - - - -| | Name | -| -------------- | -------------- | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(std::ostream * out =&std::cout, [Duration](api/Namespaces/namespacebarkeep.md#using-duration) interval =[Duration](api/Namespaces/namespacebarkeep.md#using-duration){0.}, std::string message ="", std::string format ="", bool no_tty =false) | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(const [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) & other) | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**([AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) && other) | -| virtual | **[~AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-~asyncdisplay)**() | -| virtual void | **[show](api/Classes/classbarkeep_1_1_async_display.md#function-show)**()
Start the display. This starts writing the display in the output stream, and computing speed if applicable. | -| virtual void | **[done](api/Classes/classbarkeep_1_1_async_display.md#function-done)**()
End the display. | -| bool | **[running](api/Classes/classbarkeep_1_1_async_display.md#function-running)**() const | - - - - -**Protected Functions inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** - - - -| | Name | -| -------------- | -------------- | -| void | **[display_](api/Classes/classbarkeep_1_1_async_display.md#function-display_)**()
Display everything (message, maybe with animation, progress bar, etc). | -| void | **[render_message_](api/Classes/classbarkeep_1_1_async_display.md#function-render_message_)**() const
Display the message to output stream. | -| virtual void | **[join](api/Classes/classbarkeep_1_1_async_display.md#function-join)**()
Join the display thread. Protected because python bindings need to override to handle GIL. | -| void | **[ensure_not_running](api/Classes/classbarkeep_1_1_async_display.md#function-ensure_not_running)**() const | - - - - -**Protected Attributes inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** - - - -| | Name | -| -------------- | -------------- | -| std::ostream * | **[out_](api/Classes/classbarkeep_1_1_async_display.md#variable-out_)** | -| std::unique_ptr< std::thread > | **[displayer_](api/Classes/classbarkeep_1_1_async_display.md#variable-displayer_)** | -| std::condition_variable | **[completion_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_)** | -| std::mutex | **[completion_m_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_m_)** | -| std::atomic< bool > | **[complete_](api/Classes/classbarkeep_1_1_async_display.md#variable-complete_)** | -| [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[interval_](api/Classes/classbarkeep_1_1_async_display.md#variable-interval_)** | -| std::string | **[message_](api/Classes/classbarkeep_1_1_async_display.md#variable-message_)** | -| std::string | **[format_](api/Classes/classbarkeep_1_1_async_display.md#variable-format_)** | -| bool | **[no_tty_](api/Classes/classbarkeep_1_1_async_display.md#variable-no_tty_)** | - - - - - -### Public Functions Documentation - -#### function Composite - -```cpp -inline Composite( - std::unique_ptr< AsyncDisplay > left, - std::unique_ptr< AsyncDisplay > right -) -``` - - -#### function Composite - -```cpp -inline Composite( - const Composite & other -) -``` - -Copy constructor clones child displays. - -#### function ~Composite - -```cpp -inline ~Composite() -``` - - -#### function clone - -```cpp -inline virtual std::unique_ptr< AsyncDisplay > clone() const override -``` - - -**Reimplements**: [barkeep::AsyncDisplay::clone](api/Classes/classbarkeep_1_1_async_display.md#function-clone) - - -### Protected Functions Documentation - -#### function render_ - -```cpp -inline virtual void render_() override -``` - -Render a display: animation, progress bar, etc. - -**Reimplements**: [barkeep::AsyncDisplay::render_](api/Classes/classbarkeep_1_1_async_display.md#function-render_) - - -#### function default_interval_ - -```cpp -inline virtual Duration default_interval_() const override -``` - - -**Reimplements**: [barkeep::AsyncDisplay::default_interval_](api/Classes/classbarkeep_1_1_async_display.md#function-default_interval_) - - -#### function start - -```cpp -inline virtual void start() override -``` - -Start the display but do not show. This typically means start measuring speed if applicable, without displaying anything. - -**Reimplements**: [barkeep::AsyncDisplay::start](api/Classes/classbarkeep_1_1_async_display.md#function-start) - - -### Protected Attributes Documentation - -#### variable left_ - -```cpp -std::unique_ptr< AsyncDisplay > left_; -``` - - -#### variable right_ - -```cpp -std::unique_ptr< AsyncDisplay > right_; -``` - - -------------------------------- - - - -## barkeep::Counter - - -Monitors and displays a single numeric variable. [More...](#detailed-description) - - -`#include ` - -Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) - -### Public Functions - - - -| | Name | -| -------------- | -------------- | -| | **[Counter](api/Classes/classbarkeep_1_1_counter.md#function-counter)**(Progress * progress, const [CounterConfig](api/Classes/structbarkeep_1_1_counter_config.md) & cfg ={})
Constructor. | -| | **[Counter](api/Classes/classbarkeep_1_1_counter.md#function-counter)**(const [Counter](api/Classes/classbarkeep_1_1_counter.md)< Progress > & other) | -| | **[Counter](api/Classes/classbarkeep_1_1_counter.md#function-counter)**([Counter](api/Classes/classbarkeep_1_1_counter.md)< Progress > && other) | -| | **[~Counter](api/Classes/classbarkeep_1_1_counter.md#function-~counter)**() | -| virtual std::unique_ptr< [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) > | **[clone](api/Classes/classbarkeep_1_1_counter.md#function-clone)**() const override | - - - - -### Protected Functions - - - -| | Name | -| -------------- | -------------- | -| void | **[render_counts_](api/Classes/classbarkeep_1_1_counter.md#function-render_counts_)**()
Write the value of progress to the output stream. | -| virtual void | **[render_](api/Classes/classbarkeep_1_1_counter.md#function-render_)**() override
Write the value of progress with the message to the output stream. | -| virtual [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[default_interval_](api/Classes/classbarkeep_1_1_counter.md#function-default_interval_)**() const override
Default interval in which the display is refreshed, if interval() is not invoked. | -| virtual void | **[start](api/Classes/classbarkeep_1_1_counter.md#function-start)**() override
Start the display but do not show. This typically means start measuring speed if applicable, without displaying anything. | - - - - -### Protected Attributes - - - -| | Name | -| -------------- | -------------- | -| Progress * | **[progress_](api/Classes/classbarkeep_1_1_counter.md#variable-progress_)** | -| std::unique_ptr< [Speedometer](api/Classes/classbarkeep_1_1_speedometer.md)< Progress > > | **[speedom_](api/Classes/classbarkeep_1_1_counter.md#variable-speedom_)** | -| std::string | **[speed_unit_](api/Classes/classbarkeep_1_1_counter.md#variable-speed_unit_)** | -| std::stringstream | **[ss_](api/Classes/classbarkeep_1_1_counter.md#variable-ss_)** | - - - - -### Additional inherited members - - - -**Public Functions inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** - - - -| | Name | -| -------------- | -------------- | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(std::ostream * out =&std::cout, [Duration](api/Namespaces/namespacebarkeep.md#using-duration) interval =[Duration](api/Namespaces/namespacebarkeep.md#using-duration){0.}, std::string message ="", std::string format ="", bool no_tty =false) | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(const [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) & other) | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**([AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) && other) | -| virtual | **[~AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-~asyncdisplay)**() | -| virtual void | **[show](api/Classes/classbarkeep_1_1_async_display.md#function-show)**()
Start the display. This starts writing the display in the output stream, and computing speed if applicable. | -| virtual void | **[done](api/Classes/classbarkeep_1_1_async_display.md#function-done)**()
End the display. | -| bool | **[running](api/Classes/classbarkeep_1_1_async_display.md#function-running)**() const | - - - - -**Protected Functions inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** - - - -| | Name | -| -------------- | -------------- | -| void | **[display_](api/Classes/classbarkeep_1_1_async_display.md#function-display_)**()
Display everything (message, maybe with animation, progress bar, etc). | -| void | **[render_message_](api/Classes/classbarkeep_1_1_async_display.md#function-render_message_)**() const
Display the message to output stream. | -| virtual void | **[join](api/Classes/classbarkeep_1_1_async_display.md#function-join)**()
Join the display thread. Protected because python bindings need to override to handle GIL. | -| void | **[ensure_not_running](api/Classes/classbarkeep_1_1_async_display.md#function-ensure_not_running)**() const | - - - - -**Protected Attributes inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** - - - -| | Name | -| -------------- | -------------- | -| std::ostream * | **[out_](api/Classes/classbarkeep_1_1_async_display.md#variable-out_)** | -| std::unique_ptr< std::thread > | **[displayer_](api/Classes/classbarkeep_1_1_async_display.md#variable-displayer_)** | -| std::condition_variable | **[completion_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_)** | -| std::mutex | **[completion_m_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_m_)** | -| std::atomic< bool > | **[complete_](api/Classes/classbarkeep_1_1_async_display.md#variable-complete_)** | -| [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[interval_](api/Classes/classbarkeep_1_1_async_display.md#variable-interval_)** | -| std::string | **[message_](api/Classes/classbarkeep_1_1_async_display.md#variable-message_)** | -| std::string | **[format_](api/Classes/classbarkeep_1_1_async_display.md#variable-format_)** | -| bool | **[no_tty_](api/Classes/classbarkeep_1_1_async_display.md#variable-no_tty_)** | - - - - -**Friends inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** - - - -| | Name | -| -------------- | -------------- | -| class | **[Composite](api/Classes/classbarkeep_1_1_async_display.md#friend-composite)** | - - - - - -### Detailed Description - -```cpp -template -class barkeep::Counter; -``` - -Monitors and displays a single numeric variable. -### Public Functions Documentation - -#### function Counter - -```cpp -inline Counter( - Progress * progress, - const CounterConfig & cfg ={} -) -``` - -Constructor. - -**Parameters**: - - * **progress** Variable to be monitored and displayed - * **cfg** [Counter](api/Classes/classbarkeep_1_1_counter.md) parameters - - -#### function Counter - -```cpp -inline Counter( - const Counter< Progress > & other -) -``` - - -#### function Counter - -```cpp -inline Counter( - Counter< Progress > && other -) -``` - - -#### function ~Counter - -```cpp -inline ~Counter() -``` - - -#### function clone - -```cpp -inline virtual std::unique_ptr< AsyncDisplay > clone() const override -``` - - -**Reimplements**: [barkeep::AsyncDisplay::clone](api/Classes/classbarkeep_1_1_async_display.md#function-clone) - - -### Protected Functions Documentation - -#### function render_counts_ - -```cpp -inline void render_counts_() -``` - -Write the value of progress to the output stream. - -#### function render_ - -```cpp -inline virtual void render_() override -``` - -Write the value of progress with the message to the output stream. - -**Reimplements**: [barkeep::AsyncDisplay::render_](api/Classes/classbarkeep_1_1_async_display.md#function-render_) - - -#### function default_interval_ - -```cpp -inline virtual Duration default_interval_() const override -``` - -Default interval in which the display is refreshed, if interval() is not invoked. - -**Return**: default interval - -**Reimplements**: [barkeep::AsyncDisplay::default_interval_](api/Classes/classbarkeep_1_1_async_display.md#function-default_interval_) - - -#### function start - -```cpp -inline virtual void start() override -``` - -Start the display but do not show. This typically means start measuring speed if applicable, without displaying anything. - -**Reimplements**: [barkeep::AsyncDisplay::start](api/Classes/classbarkeep_1_1_async_display.md#function-start) - - -### Protected Attributes Documentation - -#### variable progress_ - -```cpp -Progress * progress_ = nullptr; -``` - - -#### variable speedom_ - -```cpp -std::unique_ptr< Speedometer< Progress > > speedom_; -``` - - -#### variable speed_unit_ - -```cpp -std::string speed_unit_ = "it/s"; -``` - - -#### variable ss_ - -```cpp -std::stringstream ss_; -``` - - -------------------------------- - - - -## barkeep::IterableBar - - -A progress bar that can be used with range-based for loops, that automatically tracks the progress of the loop. [More...](#detailed-description) - - -`#include ` - -### Public Classes - - - -| | Name | -| -------------- | -------------- | -| class | **[Iterator](api/Classes/classbarkeep_1_1_iterable_bar_1_1_iterator.md)** | - - - - -### Public Types - - - -| | Name | -| -------------- | -------------- | -| using std::atomic< size_t > | **[ProgressType](api/Classes/classbarkeep_1_1_iterable_bar.md#using-progresstype)** | -| using [value_t](api/Namespaces/namespacebarkeep.md#using-value_t)< [ProgressType](api/Classes/classbarkeep_1_1_iterable_bar.md#using-progresstype) > | **[ValueType](api/Classes/classbarkeep_1_1_iterable_bar.md#using-valuetype)** | - - - - -### Public Functions - - - -| | Name | -| -------------- | -------------- | -| | **[IterableBar](api/Classes/classbarkeep_1_1_iterable_bar.md#function-iterablebar)**(Container & container, const [IterableBarConfig](api/Classes/structbarkeep_1_1_iterable_bar_config.md)< [ValueType](api/Classes/classbarkeep_1_1_iterable_bar.md#using-valuetype) > & cfg ={}) | -| auto | **[begin](api/Classes/classbarkeep_1_1_iterable_bar.md#function-begin)**() | -| auto | **[end](api/Classes/classbarkeep_1_1_iterable_bar.md#function-end)**() | - - - - -### Detailed Description - -```cpp -template -class barkeep::IterableBar; -``` - -A progress bar that can be used with range-based for loops, that automatically tracks the progress of the loop. -### Public Types Documentation - -#### using ProgressType - -```cpp -using barkeep::IterableBar< Container >::ProgressType = std::atomic; -``` - - -#### using ValueType - -```cpp -using barkeep::IterableBar< Container >::ValueType = value_t; -``` - - -### Public Functions Documentation - -#### function IterableBar - -```cpp -inline IterableBar( - Container & container, - const IterableBarConfig< ValueType > & cfg ={} -) -``` - - -#### function begin - -```cpp -inline auto begin() -``` - - -#### function end - -```cpp -inline auto end() -``` - - -------------------------------- - - - -## barkeep::IterableBar::Iterator - - - - - -`#include ` - -### Public Functions - - - -| | Name | -| -------------- | -------------- | -| | **[Iterator](api/Classes/classbarkeep_1_1_iterable_bar_1_1_iterator.md#function-iterator)**(typename Container::iterator it, [ProgressType](api/Classes/classbarkeep_1_1_iterable_bar.md#using-progresstype) & idx) | -| [Iterator](api/Classes/classbarkeep_1_1_iterable_bar_1_1_iterator.md) & | **[operator++](api/Classes/classbarkeep_1_1_iterable_bar_1_1_iterator.md#function-operator++)**() | -| bool | **[operator!=](api/Classes/classbarkeep_1_1_iterable_bar_1_1_iterator.md#function-operator!=)**(const [Iterator](api/Classes/classbarkeep_1_1_iterable_bar_1_1_iterator.md) & other) const | -| auto & | **[operator*](api/Classes/classbarkeep_1_1_iterable_bar_1_1_iterator.md#function-operator*)**() | - - - - -### Public Functions Documentation - -#### function Iterator - -```cpp -inline Iterator( - typename Container::iterator it, - ProgressType & idx -) -``` - - -#### function operator++ - -```cpp -inline Iterator & operator++() -``` - - -#### function operator!= - -```cpp -inline bool operator!=( - const Iterator & other -) const -``` - - -#### function operator* - -```cpp -inline auto & operator*() -``` - - -------------------------------- - - - -## barkeep::ProgressBar - - -Displays a progress bar, by comparing the progress value being monitored to a given total value. Optionally reports speed. [More...](#detailed-description) - - -`#include ` - -Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) - -### Public Types - - - -| | Name | -| -------------- | -------------- | -| using [ProgressBarStyle](api/Namespaces/namespacebarkeep.md#enum-progressbarstyle) | **[Style](api/Classes/classbarkeep_1_1_progress_bar.md#using-style)** | - - - - -### Protected Types - - - -| | Name | -| -------------- | -------------- | -| using [value_t](api/Namespaces/namespacebarkeep.md#using-value_t)< Progress > | **[ValueType](api/Classes/classbarkeep_1_1_progress_bar.md#using-valuetype)** | - - - - -### Public Functions - - - -| | Name | -| -------------- | -------------- | -| | **[ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md#function-progressbar)**(Progress * progress, const [ProgressBarConfig](api/Classes/structbarkeep_1_1_progress_bar_config.md)< [ValueType](api/Classes/classbarkeep_1_1_progress_bar.md#using-valuetype) > & cfg ={})
Constructor. | -| | **[ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md#function-progressbar)**([ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md)< Progress > && other)
move constructor | -| | **[ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md#function-progressbar)**(const [ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md)< Progress > & other)
copy constructor | -| | **[~ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md#function-~progressbar)**() | -| virtual std::unique_ptr< [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) > | **[clone](api/Classes/classbarkeep_1_1_progress_bar.md#function-clone)**() const override | - - - - -### Protected Functions - - - -| | Name | -| -------------- | -------------- | -| void | **[render_progress_bar_](api/Classes/classbarkeep_1_1_progress_bar.md#function-render_progress_bar_)**(std::ostream * out =nullptr)
Compute the shape of the progress bar based on progress and write to output stream. | -| void | **[render_counts_](api/Classes/classbarkeep_1_1_progress_bar.md#function-render_counts_)**()
Write progress value with the total, e.g. 50/100, to output stream. Progress width is expanded (and right justified) to match width of total. | -| void | **[render_percentage_](api/Classes/classbarkeep_1_1_progress_bar.md#function-render_percentage_)**()
Write the percent completed to output stream. | -| virtual void | **[render_](api/Classes/classbarkeep_1_1_progress_bar.md#function-render_)**() override
Run all of the individual render methods to write everything to stream. | -| virtual [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[default_interval_](api/Classes/classbarkeep_1_1_progress_bar.md#function-default_interval_)**() const override | -| virtual void | **[start](api/Classes/classbarkeep_1_1_progress_bar.md#function-start)**() override
Start the display but do not show. This typically means start measuring speed if applicable, without displaying anything. | - - - - -### Protected Attributes - - - -| | Name | -| -------------- | -------------- | -| Progress * | **[progress_](api/Classes/classbarkeep_1_1_progress_bar.md#variable-progress_)** | -| std::unique_ptr< [Speedometer](api/Classes/classbarkeep_1_1_speedometer.md)< Progress > > | **[speedom_](api/Classes/classbarkeep_1_1_progress_bar.md#variable-speedom_)** | -| std::string | **[speed_unit_](api/Classes/classbarkeep_1_1_progress_bar.md#variable-speed_unit_)** | -| [ValueType](api/Classes/classbarkeep_1_1_progress_bar.md#using-valuetype) | **[total_](api/Classes/classbarkeep_1_1_progress_bar.md#variable-total_)** | -| [BarParts](api/Classes/structbarkeep_1_1_bar_parts.md) | **[bar_parts_](api/Classes/classbarkeep_1_1_progress_bar.md#variable-bar_parts_)** | -| constexpr size_t | **[width_](api/Classes/classbarkeep_1_1_progress_bar.md#variable-width_)** | - - - - -### Additional inherited members - - - -**Public Functions inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** - - - -| | Name | -| -------------- | -------------- | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(std::ostream * out =&std::cout, [Duration](api/Namespaces/namespacebarkeep.md#using-duration) interval =[Duration](api/Namespaces/namespacebarkeep.md#using-duration){0.}, std::string message ="", std::string format ="", bool no_tty =false) | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(const [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) & other) | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**([AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) && other) | -| virtual | **[~AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-~asyncdisplay)**() | -| virtual void | **[show](api/Classes/classbarkeep_1_1_async_display.md#function-show)**()
Start the display. This starts writing the display in the output stream, and computing speed if applicable. | -| virtual void | **[done](api/Classes/classbarkeep_1_1_async_display.md#function-done)**()
End the display. | -| bool | **[running](api/Classes/classbarkeep_1_1_async_display.md#function-running)**() const | - - - - -**Protected Functions inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** - - - -| | Name | -| -------------- | -------------- | -| void | **[display_](api/Classes/classbarkeep_1_1_async_display.md#function-display_)**()
Display everything (message, maybe with animation, progress bar, etc). | -| void | **[render_message_](api/Classes/classbarkeep_1_1_async_display.md#function-render_message_)**() const
Display the message to output stream. | -| virtual void | **[join](api/Classes/classbarkeep_1_1_async_display.md#function-join)**()
Join the display thread. Protected because python bindings need to override to handle GIL. | -| void | **[ensure_not_running](api/Classes/classbarkeep_1_1_async_display.md#function-ensure_not_running)**() const | - - - - -**Protected Attributes inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** - - - -| | Name | -| -------------- | -------------- | -| std::ostream * | **[out_](api/Classes/classbarkeep_1_1_async_display.md#variable-out_)** | -| std::unique_ptr< std::thread > | **[displayer_](api/Classes/classbarkeep_1_1_async_display.md#variable-displayer_)** | -| std::condition_variable | **[completion_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_)** | -| std::mutex | **[completion_m_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_m_)** | -| std::atomic< bool > | **[complete_](api/Classes/classbarkeep_1_1_async_display.md#variable-complete_)** | -| [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[interval_](api/Classes/classbarkeep_1_1_async_display.md#variable-interval_)** | -| std::string | **[message_](api/Classes/classbarkeep_1_1_async_display.md#variable-message_)** | -| std::string | **[format_](api/Classes/classbarkeep_1_1_async_display.md#variable-format_)** | -| bool | **[no_tty_](api/Classes/classbarkeep_1_1_async_display.md#variable-no_tty_)** | - - - - -**Friends inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** - - - -| | Name | -| -------------- | -------------- | -| class | **[Composite](api/Classes/classbarkeep_1_1_async_display.md#friend-composite)** | - - - - - -### Detailed Description - -```cpp -template -class barkeep::ProgressBar; -``` - -Displays a progress bar, by comparing the progress value being monitored to a given total value. Optionally reports speed. -### Public Types Documentation - -#### using Style - -```cpp -using barkeep::ProgressBar< Progress >::Style = ProgressBarStyle; -``` - - -### Protected Types Documentation - -#### using ValueType - -```cpp -using barkeep::ProgressBar< Progress >::ValueType = value_t; -``` - - -### Public Functions Documentation - -#### function ProgressBar - -```cpp -inline ProgressBar( - Progress * progress, - const ProgressBarConfig< ValueType > & cfg ={} -) -``` - -Constructor. - -**Parameters**: - - * **progress** Variable to be monitored to measure completion - * **cfg** [ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md) parameters - - -#### function ProgressBar - -```cpp -inline ProgressBar( - ProgressBar< Progress > && other -) -``` - -move constructor - -#### function ProgressBar - -```cpp -inline ProgressBar( - const ProgressBar< Progress > & other -) -``` - -copy constructor - -#### function ~ProgressBar - -```cpp -inline ~ProgressBar() -``` - - -#### function clone - -```cpp -inline virtual std::unique_ptr< AsyncDisplay > clone() const override -``` - - -**Reimplements**: [barkeep::AsyncDisplay::clone](api/Classes/classbarkeep_1_1_async_display.md#function-clone) - - -### Protected Functions Documentation - -#### function render_progress_bar_ - -```cpp -inline void render_progress_bar_( - std::ostream * out =nullptr -) -``` - -Compute the shape of the progress bar based on progress and write to output stream. - -#### function render_counts_ - -```cpp -inline void render_counts_() -``` - -Write progress value with the total, e.g. 50/100, to output stream. Progress width is expanded (and right justified) to match width of total. - -#### function render_percentage_ - -```cpp -inline void render_percentage_() -``` - -Write the percent completed to output stream. - -#### function render_ - -```cpp -inline virtual void render_() override -``` - -Run all of the individual render methods to write everything to stream. - -**Reimplements**: [barkeep::AsyncDisplay::render_](api/Classes/classbarkeep_1_1_async_display.md#function-render_) - - -#### function default_interval_ - -```cpp -inline virtual Duration default_interval_() const override -``` - - -**Reimplements**: [barkeep::AsyncDisplay::default_interval_](api/Classes/classbarkeep_1_1_async_display.md#function-default_interval_) - - -#### function start - -```cpp -inline virtual void start() override -``` - -Start the display but do not show. This typically means start measuring speed if applicable, without displaying anything. - -**Reimplements**: [barkeep::AsyncDisplay::start](api/Classes/classbarkeep_1_1_async_display.md#function-start) - - -### Protected Attributes Documentation - -#### variable progress_ - -```cpp -Progress * progress_; -``` - - -#### variable speedom_ - -```cpp -std::unique_ptr< Speedometer< Progress > > speedom_; -``` - - -#### variable speed_unit_ - -```cpp -std::string speed_unit_ = "it/s"; -``` - - -#### variable total_ - -```cpp -ValueType total_ {100}; -``` - - -#### variable bar_parts_ - -```cpp -BarParts bar_parts_; -``` - - -#### variable width_ - -```cpp -static constexpr size_t width_ = 30; -``` - - -------------------------------- - - - -## barkeep::Speedometer - - -Helper class to measure and display speed of progress. [More...](#detailed-description) - - -`#include ` - -### Public Functions - - - -| | Name | -| -------------- | -------------- | -| double | **[speed](api/Classes/classbarkeep_1_1_speedometer.md#function-speed)**() | -| void | **[render_speed](api/Classes/classbarkeep_1_1_speedometer.md#function-render_speed)**(std::ostream * out, const std::string & speed_unit)
Write speed to given output stream. Speed is a double (written with precision 2), possibly followed by a unit of speed. | -| void | **[start](api/Classes/classbarkeep_1_1_speedometer.md#function-start)**()
Start computing the speed based on the amount of change in progress. | -| | **[Speedometer](api/Classes/classbarkeep_1_1_speedometer.md#function-speedometer)**(Progress & progress, double discount)
Constructor. | - - - - -### Detailed Description - -```cpp -template -class barkeep::Speedometer; -``` - -Helper class to measure and display speed of progress. -### Public Functions Documentation - -#### function speed - -```cpp -inline double speed() -``` - - -#### function render_speed - -```cpp -inline void render_speed( - std::ostream * out, - const std::string & speed_unit -) -``` - -Write speed to given output stream. Speed is a double (written with precision 2), possibly followed by a unit of speed. - -#### function start - -```cpp -inline void start() -``` - -Start computing the speed based on the amount of change in progress. - -#### function Speedometer - -```cpp -inline Speedometer( - Progress & progress, - double discount -) -``` - -Constructor. - -**Parameters**: - - * **progress** Reference to numeric to measure the change of. - * **discount** Discount factor in [0, 1] to use in computing the speed. Previous increments are weighted by (1-discount). If discount is 0, all increments are weighted equally. If discount is 1, only the most recent increment is considered. - - -------------------------------- - - - -## barkeep::AnimationConfig - - -[Animation](api/Classes/classbarkeep_1_1_animation.md) parameters. - - -`#include ` - -### Public Attributes - - - -| | Name | -| -------------- | -------------- | -| std::ostream * | **[out](api/Classes/structbarkeep_1_1_animation_config.md#variable-out)**
output stream | -| std::string | **[message](api/Classes/structbarkeep_1_1_animation_config.md#variable-message)**
message to display before the animation style as AnimationStyle or custom animation as a list of strings | -| std::variant< [AnimationStyle](api/Namespaces/namespacebarkeep.md#enum-animationstyle), [Strings](api/Namespaces/namespacebarkeep.md#using-strings) > | **[style](api/Classes/structbarkeep_1_1_animation_config.md#variable-style)** | -| std::variant< [Duration](api/Namespaces/namespacebarkeep.md#using-duration), double > | **[interval](api/Classes/structbarkeep_1_1_animation_config.md#variable-interval)**
interval in which the animation is refreshed | -| bool | **[no_tty](api/Classes/structbarkeep_1_1_animation_config.md#variable-no_tty)**
no-tty mode if true (no \r, slower default refresh) | -| bool | **[show](api/Classes/structbarkeep_1_1_animation_config.md#variable-show)**
show the animation immediately after construction | - - - - -### Public Attributes Documentation - -#### variable out - -```cpp -std::ostream * out = &std::cout; -``` - -output stream - -#### variable message - -```cpp -std::string message = ""; -``` - -message to display before the animation style as AnimationStyle or custom animation as a list of strings - -#### variable style - -```cpp -std::variant< AnimationStyle, Strings > style = Ellipsis; -``` - - -#### variable interval - -```cpp -std::variant< Duration, double > interval = Duration{0.}; -``` - -interval in which the animation is refreshed - -#### variable no_tty - -```cpp -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 - -------------------------------- - - - -## barkeep::AtomicTraits - - -Trait class to extract underlying value type from numerics and std::atomics of numerics. [More...](#detailed-description) - - -`#include ` - -### Public Types - - - -| | Name | -| -------------- | -------------- | -| using T | **[value_type](api/Classes/structbarkeep_1_1_atomic_traits.md#using-value_type)** | - - - - -### Detailed Description - -```cpp -template -struct barkeep::AtomicTraits; -``` - -Trait class to extract underlying value type from numerics and std::atomics of numerics. -### Public Types Documentation - -#### using value_type - -```cpp -using barkeep::AtomicTraits< T >::value_type = T; -``` - - -------------------------------- - - - -## barkeep::AtomicTraits< std::atomic< T > > - - - [More...](#detailed-description) - - -`#include ` - -### Public Types - - - -| | Name | -| -------------- | -------------- | -| using T | **[value_type](api/Classes/structbarkeep_1_1_atomic_traits_3_01std_1_1atomic_3_01_t_01_4_01_4.md#using-value_type)** | - - - - -### Detailed Description - -```cpp -template -struct barkeep::AtomicTraits< std::atomic< T > >; -``` - -### Public Types Documentation - -#### using value_type - -```cpp -using barkeep::AtomicTraits< std::atomic< T > >::value_type = T; -``` - - -------------------------------- - - - -## barkeep::BarParts - - - - - -`#include ` - -### Public Attributes - - - -| | Name | -| -------------- | -------------- | -| std::string | **[left](api/Classes/structbarkeep_1_1_bar_parts.md#variable-left)** | -| std::string | **[right](api/Classes/structbarkeep_1_1_bar_parts.md#variable-right)** | -| [Strings](api/Namespaces/namespacebarkeep.md#using-strings) | **[fill](api/Classes/structbarkeep_1_1_bar_parts.md#variable-fill)** | -| [Strings](api/Namespaces/namespacebarkeep.md#using-strings) | **[empty](api/Classes/structbarkeep_1_1_bar_parts.md#variable-empty)** | -| std::string | **[incomplete_left_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-incomplete_left_modifier)** | -| std::string | **[complete_left_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-complete_left_modifier)** | -| std::string | **[middle_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-middle_modifier)** | -| std::string | **[right_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-right_modifier)** | -| std::string | **[percent_left_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-percent_left_modifier)** | -| std::string | **[percent_right_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-percent_right_modifier)** | -| std::string | **[value_left_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-value_left_modifier)** | -| std::string | **[value_right_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-value_right_modifier)** | -| std::string | **[speed_left_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-speed_left_modifier)** | -| std::string | **[speed_right_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-speed_right_modifier)** | - - - - -### Public Attributes Documentation - -#### variable left - -```cpp -std::string left; -``` - - -#### variable right - -```cpp -std::string right; -``` - - -#### variable fill - -```cpp -Strings fill; -``` - - -#### variable empty - -```cpp -Strings empty; -``` - - -#### variable incomplete_left_modifier - -```cpp -std::string incomplete_left_modifier = ""; -``` - - -#### variable complete_left_modifier - -```cpp -std::string complete_left_modifier = ""; -``` - - -#### variable middle_modifier - -```cpp -std::string middle_modifier = ""; -``` - - -#### variable right_modifier - -```cpp -std::string right_modifier = ""; -``` - - -#### variable percent_left_modifier - -```cpp -std::string percent_left_modifier = ""; -``` - - -#### variable percent_right_modifier - -```cpp -std::string percent_right_modifier = ""; -``` - - -#### variable value_left_modifier - -```cpp -std::string value_left_modifier = ""; -``` - - -#### variable value_right_modifier - -```cpp -std::string value_right_modifier = ""; -``` - - -#### variable speed_left_modifier - -```cpp -std::string speed_left_modifier = ""; -``` - - -#### variable speed_right_modifier - -```cpp -std::string speed_right_modifier = ""; -``` ------------------------------- - - - -## barkeep::CounterConfig - - -[Counter](api/Classes/classbarkeep_1_1_counter.md) parameters. - - -`#include ` - -### Public Attributes - - - -| | Name | -| -------------- | -------------- | -| std::ostream * | **[out](api/Classes/structbarkeep_1_1_counter_config.md#variable-out)**
output stream | -| std::string | **[format](api/Classes/structbarkeep_1_1_counter_config.md#variable-format)**
format string to format entire counter | -| std::string | **[message](api/Classes/structbarkeep_1_1_counter_config.md#variable-message)**
message to display with the counter | -| std::optional< double > | **[speed](api/Classes/structbarkeep_1_1_counter_config.md#variable-speed)**
Speed discount factor in [0, 1] to use in computing the speed. Previous increments are weighted by (1-speed). If speed is 0, all increments are weighed equally. If speed is 1, only the most recent increment is considered. If speed is `std::nullopt`, speed is not computed. | -| std::string | **[speed_unit](api/Classes/structbarkeep_1_1_counter_config.md#variable-speed_unit)**
unit of speed text next to speed interval in which the counter is refreshed | -| std::variant< [Duration](api/Namespaces/namespacebarkeep.md#using-duration), double > | **[interval](api/Classes/structbarkeep_1_1_counter_config.md#variable-interval)** | -| bool | **[no_tty](api/Classes/structbarkeep_1_1_counter_config.md#variable-no_tty)**
no-tty mode if true (no \r, slower default refresh) | -| bool | **[show](api/Classes/structbarkeep_1_1_counter_config.md#variable-show)**
show the counter immediately after construction | - - - - -### Public Attributes Documentation - -#### variable out - -```cpp -std::ostream * out = &std::cout; -``` - -output stream - -#### variable format - -```cpp -std::string format = ""; -``` - -format string to format entire counter - -#### variable message - -```cpp -std::string message = ""; -``` - -message to display with the counter - -#### variable speed - -```cpp -std::optional< double > speed = std::nullopt; -``` - -Speed discount factor in [0, 1] to use in computing the speed. Previous increments are weighted by (1-speed). If speed is 0, all increments are weighed equally. If speed is 1, only the most recent increment is considered. If speed is `std::nullopt`, speed is not computed. - -#### variable speed_unit - -```cpp -std::string speed_unit = "it/s"; -``` - -unit of speed text next to speed interval in which the counter is refreshed - -#### variable interval - -```cpp -std::variant< Duration, double > interval = Duration{0.}; -``` - - -#### variable no_tty - -```cpp -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 - -------------------------------- - - - -## barkeep::IterableBarConfig - - - [More...](#detailed-description) - - -`#include ` - -### Public Attributes - - - -| | Name | -| -------------- | -------------- | -| std::ostream * | **[out](api/Classes/structbarkeep_1_1_iterable_bar_config.md#variable-out)**
output stream | -| std::string | **[format](api/Classes/structbarkeep_1_1_iterable_bar_config.md#variable-format)**
format string for the entire progress bar | -| std::string | **[message](api/Classes/structbarkeep_1_1_iterable_bar_config.md#variable-message)**
message to display with the bar | -| std::optional< double > | **[speed](api/Classes/structbarkeep_1_1_iterable_bar_config.md#variable-speed)**
Speed discount factor in [0, 1] to use in computing the speed. Previous increments are weighted by (1-speed). If speed is 0, all increments are weighed equally. If speed is 1, only the most recent increment is considered. If speed is `std::nullopt`, speed is not computed. | -| std::string | **[speed_unit](api/Classes/structbarkeep_1_1_iterable_bar_config.md#variable-speed_unit)**
unit of speed text next to speed | -| [ProgressBarStyle](api/Namespaces/namespacebarkeep.md#enum-progressbarstyle) | **[style](api/Classes/structbarkeep_1_1_iterable_bar_config.md#variable-style)**
style of progress bar interval in which the progress bar is refreshed | -| std::variant< [Duration](api/Namespaces/namespacebarkeep.md#using-duration), double > | **[interval](api/Classes/structbarkeep_1_1_iterable_bar_config.md#variable-interval)** | -| bool | **[no_tty](api/Classes/structbarkeep_1_1_iterable_bar_config.md#variable-no_tty)**
no-tty mode if true (no \r, slower default refresh) | - - - - -### Detailed Description - -```cpp -template -struct barkeep::IterableBarConfig; -``` - -### Public Attributes Documentation - -#### variable out - -```cpp -std::ostream * out = &std::cout; -``` - -output stream - -#### variable format - -```cpp -std::string format = ""; -``` - -format string for the entire progress bar - -#### variable message - -```cpp -std::string message = ""; -``` - -message to display with the bar - -#### variable speed - -```cpp -std::optional< double > speed = std::nullopt; -``` - -Speed discount factor in [0, 1] to use in computing the speed. Previous increments are weighted by (1-speed). If speed is 0, all increments are weighed equally. If speed is 1, only the most recent increment is considered. If speed is `std::nullopt`, speed is not computed. - -#### variable speed_unit - -```cpp -std::string speed_unit = "it/s"; -``` - -unit of speed text next to speed - -#### variable style - -```cpp -ProgressBarStyle style = Blocks; -``` - -style of progress bar interval in which the progress bar is refreshed - -#### variable interval - -```cpp -std::variant< Duration, double > interval = Duration{0.}; -``` - - -#### variable no_tty - -```cpp -bool no_tty = false; -``` - -no-tty mode if true (no \r, slower default refresh) - -------------------------------- - - - -## barkeep::ProgressBarConfig - - - [More...](#detailed-description) - - -`#include ` - -### Public Attributes - - - -| | Name | -| -------------- | -------------- | -| std::ostream * | **[out](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-out)**
output stream | -| ValueType | **[total](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-total)**
total amount of work for a full bar | -| std::string | **[format](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-format)**
format string for the entire progress bar | -| std::string | **[message](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-message)**
message to display with the bar | -| std::optional< double > | **[speed](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-speed)**
Speed discount factor in [0, 1] to use in computing the speed. Previous increments are weighted by (1-speed). If speed is 0, all increments are weighed equally. If speed is 1, only the most recent increment is considered. If speed is `std::nullopt`, speed is not computed. | -| std::string | **[speed_unit](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-speed_unit)**
unit of speed text next to speed progress bar style, or custom style as [BarParts](api/Classes/structbarkeep_1_1_bar_parts.md) | -| std::variant< [ProgressBarStyle](api/Namespaces/namespacebarkeep.md#enum-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](api/Namespaces/namespacebarkeep.md#using-duration), double > | **[interval](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-interval)**
interval in which the progress bar is refreshed | -| bool | **[no_tty](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-no_tty)**
no-tty mode if true (no \r, slower default refresh) | -| bool | **[show](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-show)**
show the progress bar immediately after construction | - - - - -### Detailed Description - -```cpp -template -struct barkeep::ProgressBarConfig; -``` - -### Public Attributes Documentation - -#### variable out - -```cpp -std::ostream * out = &std::cout; -``` - -output stream - -#### variable total - -```cpp -ValueType total = 100; -``` - -total amount of work for a full bar - -#### variable format - -```cpp -std::string format = ""; -``` - -format string for the entire progress bar - -#### variable message - -```cpp -std::string message = ""; -``` - -message to display with the bar - -#### variable speed - -```cpp -std::optional< double > speed = std::nullopt; -``` - -Speed discount factor in [0, 1] to use in computing the speed. Previous increments are weighted by (1-speed). If speed is 0, all increments are weighed equally. If speed is 1, only the most recent increment is considered. If speed is `std::nullopt`, speed is not computed. - -#### variable speed_unit - -```cpp -std::string speed_unit = "it/s"; -``` - -unit of speed text next to speed progress bar style, or custom style as [BarParts](api/Classes/structbarkeep_1_1_bar_parts.md) - -#### variable style - -```cpp -std::variant< ProgressBarStyle, BarParts > style = Blocks; -``` - - -#### variable interval - -```cpp -std::variant< Duration, double > interval = Duration{0.}; -``` - -interval in which the progress bar is refreshed - -#### variable no_tty - -```cpp -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-03-28 at 22:58:08 -0400 \ No newline at end of file diff --git a/docs/api/Classes/classbarkeep_1_1_animation.md b/docs/api/Classes/classbarkeep_1_1_animation.md index f415621..def4e84 100644 --- a/docs/api/Classes/classbarkeep_1_1_animation.md +++ b/docs/api/Classes/classbarkeep_1_1_animation.md @@ -6,7 +6,7 @@ Displays a simple animation with a message. `#include ` -Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) +Inherits from [`barkeep::AsyncDisplay`](api/Classes/classbarkeep_1_1_async_display.md) ## Public Types @@ -14,7 +14,7 @@ Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display | | Name | | -------------- | -------------- | -| using [AnimationStyle](api/Namespaces/namespacebarkeep.md#enum-animationstyle) | **[Style](api/Classes/classbarkeep_1_1_animation.md#using-style)** | +| using [AnimationStyle](api/Namespaces/namespacebarkeep.md#enum-animationstyle) | **[Style](api/Classes/classbarkeep_1_1_animation.md#using-style)** | @@ -25,11 +25,11 @@ Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display | | Name | | -------------- | -------------- | -| | **[Animation](api/Classes/classbarkeep_1_1_animation.md#function-animation)**(const [AnimationConfig](api/Classes/structbarkeep_1_1_animation_config.md) & cfg ={})
Constructor. | -| | **[Animation](api/Classes/classbarkeep_1_1_animation.md#function-animation)**(const [Animation](api/Classes/classbarkeep_1_1_animation.md) & other) =default | -| | **[Animation](api/Classes/classbarkeep_1_1_animation.md#function-animation)**([Animation](api/Classes/classbarkeep_1_1_animation.md) && ) =default | -| | **[~Animation](api/Classes/classbarkeep_1_1_animation.md#function-~animation)**() | -| virtual std::unique_ptr< [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) > | **[clone](api/Classes/classbarkeep_1_1_animation.md#function-clone)**() const override | +| | **[Animation](api/Classes/classbarkeep_1_1_animation.md#function-animation)**(const [AnimationConfig](api/Classes/structbarkeep_1_1_animation_config.md) & cfg = {})
Constructor. | +| | **[Animation](api/Classes/classbarkeep_1_1_animation.md#function-animation)**(const [Animation](api/Classes/classbarkeep_1_1_animation.md) & other) = default | +| | **[Animation](api/Classes/classbarkeep_1_1_animation.md#function-animation)**([Animation](api/Classes/classbarkeep_1_1_animation.md) && ) = default | +| | **[~Animation](api/Classes/classbarkeep_1_1_animation.md#function-~animation)**() | +| virtual std::unique_ptr< [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) > | **[clone](api/Classes/classbarkeep_1_1_animation.md#function-clone)**() const override | @@ -40,8 +40,8 @@ Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display | | Name | | -------------- | -------------- | -| virtual void | **[render_](api/Classes/classbarkeep_1_1_animation.md#function-render_)**() override
Render a display: animation, progress bar, etc. | -| virtual [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[default_interval_](api/Classes/classbarkeep_1_1_animation.md#function-default_interval_)**() const override | +| virtual void | **[render_](api/Classes/classbarkeep_1_1_animation.md#function-render_)**() override
Render a display: animation, progress bar, etc. | +| virtual [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[default_interval_](api/Classes/classbarkeep_1_1_animation.md#function-default_interval_)**() const override | @@ -50,64 +50,64 @@ Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display -**Public Functions inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** +**Public Functions inherited from [`barkeep::AsyncDisplay`](api/Classes/classbarkeep_1_1_async_display.md)** | | Name | | -------------- | -------------- | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(std::ostream * out =&std::cout, [Duration](api/Namespaces/namespacebarkeep.md#using-duration) interval =[Duration](api/Namespaces/namespacebarkeep.md#using-duration){0.}, std::string message ="", std::string format ="", bool no_tty =false) | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(const [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) & other) | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**([AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) && other) | -| virtual | **[~AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-~asyncdisplay)**() | -| virtual void | **[show](api/Classes/classbarkeep_1_1_async_display.md#function-show)**()
Start the display. This starts writing the display in the output stream, and computing speed if applicable. | -| virtual void | **[done](api/Classes/classbarkeep_1_1_async_display.md#function-done)**()
End the display. | -| bool | **[running](api/Classes/classbarkeep_1_1_async_display.md#function-running)**() const | +| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(std::ostream * out = &std::cout, [Duration](api/Namespaces/namespacebarkeep.md#using-duration) interval = [Duration](api/Namespaces/namespacebarkeep.md#using-duration){0.}, std::string message = "", std::string format = "", bool no_tty = false) | +| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(const [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) & other) | +| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**([AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) && other) | +| virtual | **[~AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-~asyncdisplay)**() | +| virtual void | **[show](api/Classes/classbarkeep_1_1_async_display.md#function-show)**()
Start the display. This starts writing the display in the output stream, and computing speed if applicable. | +| virtual void | **[done](api/Classes/classbarkeep_1_1_async_display.md#function-done)**()
End the display. | +| bool | **[running](api/Classes/classbarkeep_1_1_async_display.md#function-running)**() const | -**Protected Functions inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** +**Protected Functions inherited from [`barkeep::AsyncDisplay`](api/Classes/classbarkeep_1_1_async_display.md)** | | Name | | -------------- | -------------- | -| void | **[display_](api/Classes/classbarkeep_1_1_async_display.md#function-display_)**()
Display everything (message, maybe with animation, progress bar, etc). | -| void | **[render_message_](api/Classes/classbarkeep_1_1_async_display.md#function-render_message_)**() const
Display the message to output stream. | -| virtual void | **[start](api/Classes/classbarkeep_1_1_async_display.md#function-start)**()
Start the display but do not show. This typically means start measuring speed if applicable, without displaying anything. | -| virtual void | **[join](api/Classes/classbarkeep_1_1_async_display.md#function-join)**()
Join the display thread. Protected because python bindings need to override to handle GIL. | -| void | **[ensure_not_running](api/Classes/classbarkeep_1_1_async_display.md#function-ensure_not_running)**() const | +| void | **[display_](api/Classes/classbarkeep_1_1_async_display.md#function-display_)**()
Display everything (message, maybe with animation, progress bar, etc). | +| void | **[render_message_](api/Classes/classbarkeep_1_1_async_display.md#function-render_message_)**() const
Display the message to output stream. | +| virtual void | **[start](api/Classes/classbarkeep_1_1_async_display.md#function-start)**()
Start the display but do not show. This typically means start measuring speed if applicable, without displaying anything. | +| virtual void | **[join](api/Classes/classbarkeep_1_1_async_display.md#function-join)**()
Join the display thread. Protected because python bindings need to override to handle GIL. | +| void | **[ensure_not_running](api/Classes/classbarkeep_1_1_async_display.md#function-ensure_not_running)**() const | -**Protected Attributes inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** +**Protected Attributes inherited from [`barkeep::AsyncDisplay`](api/Classes/classbarkeep_1_1_async_display.md)** | | Name | | -------------- | -------------- | -| std::ostream * | **[out_](api/Classes/classbarkeep_1_1_async_display.md#variable-out_)** | -| std::unique_ptr< std::thread > | **[displayer_](api/Classes/classbarkeep_1_1_async_display.md#variable-displayer_)** | -| std::condition_variable | **[completion_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_)** | -| std::mutex | **[completion_m_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_m_)** | -| std::atomic< bool > | **[complete_](api/Classes/classbarkeep_1_1_async_display.md#variable-complete_)** | -| [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[interval_](api/Classes/classbarkeep_1_1_async_display.md#variable-interval_)** | -| std::string | **[message_](api/Classes/classbarkeep_1_1_async_display.md#variable-message_)** | -| std::string | **[format_](api/Classes/classbarkeep_1_1_async_display.md#variable-format_)** | -| bool | **[no_tty_](api/Classes/classbarkeep_1_1_async_display.md#variable-no_tty_)** | +| std::ostream * | **[out_](api/Classes/classbarkeep_1_1_async_display.md#variable-out_)** | +| std::unique_ptr< std::thread > | **[displayer_](api/Classes/classbarkeep_1_1_async_display.md#variable-displayer_)** | +| std::condition_variable | **[completion_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_)** | +| std::mutex | **[completion_m_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_m_)** | +| std::atomic< bool > | **[complete_](api/Classes/classbarkeep_1_1_async_display.md#variable-complete_)** | +| [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[interval_](api/Classes/classbarkeep_1_1_async_display.md#variable-interval_)** | +| std::string | **[message_](api/Classes/classbarkeep_1_1_async_display.md#variable-message_)** | +| std::string | **[format_](api/Classes/classbarkeep_1_1_async_display.md#variable-format_)** | +| bool | **[no_tty_](api/Classes/classbarkeep_1_1_async_display.md#variable-no_tty_)** | -**Friends inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** +**Friends inherited from [`barkeep::AsyncDisplay`](api/Classes/classbarkeep_1_1_async_display.md)** | | Name | | -------------- | -------------- | -| class | **[Composite](api/Classes/classbarkeep_1_1_async_display.md#friend-composite)** | +| class | **[Composite](api/Classes/classbarkeep_1_1_async_display.md#friend-composite)** | @@ -115,7 +115,7 @@ Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display ## Public Types Documentation -### using Style +### using `Style` ```cpp using barkeep::Animation::Style = AnimationStyle; @@ -124,11 +124,11 @@ using barkeep::Animation::Style = AnimationStyle; ## Public Functions Documentation -### function Animation +### function `Animation` ```cpp inline Animation( - const AnimationConfig & cfg ={} + const AnimationConfig & cfg = {} ) ``` @@ -139,44 +139,44 @@ Constructor. * **cfg** [Animation](api/Classes/classbarkeep_1_1_animation.md) parameters -### function Animation +### function `Animation` ```cpp Animation( const Animation & other -) =default +) = default ``` -### function Animation +### function `Animation` ```cpp Animation( Animation && -) =default +) = default ``` -### function ~Animation +### function `~Animation` ```cpp inline ~Animation() ``` -### function clone +### function `clone` ```cpp inline virtual std::unique_ptr< AsyncDisplay > clone() const override ``` -**Reimplements**: [barkeep::AsyncDisplay::clone](api/Classes/classbarkeep_1_1_async_display.md#function-clone) +**Reimplements**: [`barkeep::AsyncDisplay::clone`](api/Classes/classbarkeep_1_1_async_display.md#function-clone) ## Protected Functions Documentation -### function render_ +### function `render_` ```cpp inline virtual void render_() override @@ -184,19 +184,17 @@ inline virtual void render_() override Render a display: animation, progress bar, etc. -**Reimplements**: [barkeep::AsyncDisplay::render_](api/Classes/classbarkeep_1_1_async_display.md#function-render_) +**Reimplements**: [`barkeep::AsyncDisplay::render_`](api/Classes/classbarkeep_1_1_async_display.md#function-render_) -### function default_interval_ +### function `default_interval_` ```cpp inline virtual Duration default_interval_() const override ``` -**Reimplements**: [barkeep::AsyncDisplay::default_interval_](api/Classes/classbarkeep_1_1_async_display.md#function-default_interval_) +**Reimplements**: [`barkeep::AsyncDisplay::default_interval_`](api/Classes/classbarkeep_1_1_async_display.md#function-default_interval_) -------------------------------- - -Updated on 2024-03-28 at 22:58:08 -0400 \ No newline at end of file +------------------------------- \ No newline at end of file diff --git a/docs/api/Classes/classbarkeep_1_1_async_display.md b/docs/api/Classes/classbarkeep_1_1_async_display.md index 6f2eb77..c6cc2b8 100644 --- a/docs/api/Classes/classbarkeep_1_1_async_display.md +++ b/docs/api/Classes/classbarkeep_1_1_async_display.md @@ -6,7 +6,7 @@ Base class to handle all asynchronous displays. `#include ` -Inherited by [barkeep::Animation](api/Classes/classbarkeep_1_1_animation.md), [barkeep::Composite](api/Classes/classbarkeep_1_1_composite.md), [barkeep::Counter< Progress >](api/Classes/classbarkeep_1_1_counter.md), [barkeep::ProgressBar< Progress >](api/Classes/classbarkeep_1_1_progress_bar.md) +Inherited by [`barkeep::Animation`](api/Classes/classbarkeep_1_1_animation.md), [`barkeep::Composite`](api/Classes/classbarkeep_1_1_composite.md), [`barkeep::Counter< Progress >`](api/Classes/classbarkeep_1_1_counter.md), [`barkeep::ProgressBar< Progress >`](api/Classes/classbarkeep_1_1_progress_bar.md) ## Public Functions @@ -14,14 +14,14 @@ Inherited by [barkeep::Animation](api/Classes/classbarkeep_1_1_animation.md), [b | | Name | | -------------- | -------------- | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(std::ostream * out =&std::cout, [Duration](api/Namespaces/namespacebarkeep.md#using-duration) interval =[Duration](api/Namespaces/namespacebarkeep.md#using-duration){0.}, std::string message ="", std::string format ="", bool no_tty =false) | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(const [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) & other) | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**([AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) && other) | -| virtual | **[~AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-~asyncdisplay)**() | -| virtual void | **[show](api/Classes/classbarkeep_1_1_async_display.md#function-show)**()
Start the display. This starts writing the display in the output stream, and computing speed if applicable. | -| virtual void | **[done](api/Classes/classbarkeep_1_1_async_display.md#function-done)**()
End the display. | -| bool | **[running](api/Classes/classbarkeep_1_1_async_display.md#function-running)**() const | -| virtual std::unique_ptr< [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) > | **[clone](api/Classes/classbarkeep_1_1_async_display.md#function-clone)**() const =0 | +| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(std::ostream * out = &std::cout, [Duration](api/Namespaces/namespacebarkeep.md#using-duration) interval = [Duration](api/Namespaces/namespacebarkeep.md#using-duration){0.}, std::string message = "", std::string format = "", bool no_tty = false) | +| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(const [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) & other) | +| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**([AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) && other) | +| virtual | **[~AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-~asyncdisplay)**() | +| virtual void | **[show](api/Classes/classbarkeep_1_1_async_display.md#function-show)**()
Start the display. This starts writing the display in the output stream, and computing speed if applicable. | +| virtual void | **[done](api/Classes/classbarkeep_1_1_async_display.md#function-done)**()
End the display. | +| bool | **[running](api/Classes/classbarkeep_1_1_async_display.md#function-running)**() const | +| virtual std::unique_ptr< [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) > | **[clone](api/Classes/classbarkeep_1_1_async_display.md#function-clone)**() const = 0 | @@ -32,13 +32,13 @@ Inherited by [barkeep::Animation](api/Classes/classbarkeep_1_1_animation.md), [b | | Name | | -------------- | -------------- | -| virtual void | **[render_](api/Classes/classbarkeep_1_1_async_display.md#function-render_)**() =0
Render a display: animation, progress bar, etc. | -| virtual [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[default_interval_](api/Classes/classbarkeep_1_1_async_display.md#function-default_interval_)**() const =0 | -| void | **[display_](api/Classes/classbarkeep_1_1_async_display.md#function-display_)**()
Display everything (message, maybe with animation, progress bar, etc). | -| void | **[render_message_](api/Classes/classbarkeep_1_1_async_display.md#function-render_message_)**() const
Display the message to output stream. | -| virtual void | **[start](api/Classes/classbarkeep_1_1_async_display.md#function-start)**()
Start the display but do not show. This typically means start measuring speed if applicable, without displaying anything. | -| virtual void | **[join](api/Classes/classbarkeep_1_1_async_display.md#function-join)**()
Join the display thread. Protected because python bindings need to override to handle GIL. | -| void | **[ensure_not_running](api/Classes/classbarkeep_1_1_async_display.md#function-ensure_not_running)**() const | +| virtual void | **[render_](api/Classes/classbarkeep_1_1_async_display.md#function-render_)**() = 0
Render a display: animation, progress bar, etc. | +| virtual [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[default_interval_](api/Classes/classbarkeep_1_1_async_display.md#function-default_interval_)**() const = 0 | +| void | **[display_](api/Classes/classbarkeep_1_1_async_display.md#function-display_)**()
Display everything (message, maybe with animation, progress bar, etc). | +| void | **[render_message_](api/Classes/classbarkeep_1_1_async_display.md#function-render_message_)**() const
Display the message to output stream. | +| virtual void | **[start](api/Classes/classbarkeep_1_1_async_display.md#function-start)**()
Start the display but do not show. This typically means start measuring speed if applicable, without displaying anything. | +| virtual void | **[join](api/Classes/classbarkeep_1_1_async_display.md#function-join)**()
Join the display thread. Protected because python bindings need to override to handle GIL. | +| void | **[ensure_not_running](api/Classes/classbarkeep_1_1_async_display.md#function-ensure_not_running)**() const | @@ -49,15 +49,15 @@ Inherited by [barkeep::Animation](api/Classes/classbarkeep_1_1_animation.md), [b | | Name | | -------------- | -------------- | -| std::ostream * | **[out_](api/Classes/classbarkeep_1_1_async_display.md#variable-out_)** | -| std::unique_ptr< std::thread > | **[displayer_](api/Classes/classbarkeep_1_1_async_display.md#variable-displayer_)** | -| std::condition_variable | **[completion_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_)** | -| std::mutex | **[completion_m_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_m_)** | -| std::atomic< bool > | **[complete_](api/Classes/classbarkeep_1_1_async_display.md#variable-complete_)** | -| [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[interval_](api/Classes/classbarkeep_1_1_async_display.md#variable-interval_)** | -| std::string | **[message_](api/Classes/classbarkeep_1_1_async_display.md#variable-message_)** | -| std::string | **[format_](api/Classes/classbarkeep_1_1_async_display.md#variable-format_)** | -| bool | **[no_tty_](api/Classes/classbarkeep_1_1_async_display.md#variable-no_tty_)** | +| std::ostream * | **[out_](api/Classes/classbarkeep_1_1_async_display.md#variable-out_)** | +| std::unique_ptr< std::thread > | **[displayer_](api/Classes/classbarkeep_1_1_async_display.md#variable-displayer_)** | +| std::condition_variable | **[completion_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_)** | +| std::mutex | **[completion_m_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_m_)** | +| std::atomic< bool > | **[complete_](api/Classes/classbarkeep_1_1_async_display.md#variable-complete_)** | +| [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[interval_](api/Classes/classbarkeep_1_1_async_display.md#variable-interval_)** | +| std::string | **[message_](api/Classes/classbarkeep_1_1_async_display.md#variable-message_)** | +| std::string | **[format_](api/Classes/classbarkeep_1_1_async_display.md#variable-format_)** | +| bool | **[no_tty_](api/Classes/classbarkeep_1_1_async_display.md#variable-no_tty_)** | @@ -68,27 +68,27 @@ Inherited by [barkeep::Animation](api/Classes/classbarkeep_1_1_animation.md), [b | | Name | | -------------- | -------------- | -| class | **[Composite](api/Classes/classbarkeep_1_1_async_display.md#friend-composite)** | +| class | **[Composite](api/Classes/classbarkeep_1_1_async_display.md#friend-composite)** | ## Public Functions Documentation -### function AsyncDisplay +### function `AsyncDisplay` ```cpp inline AsyncDisplay( - std::ostream * out =&std::cout, - Duration interval =Duration{0.}, - std::string message ="", - std::string format ="", - bool no_tty =false + std::ostream * out = &std::cout, + Duration interval = Duration{0.}, + std::string message = "", + std::string format = "", + bool no_tty = false ) ``` -### function AsyncDisplay +### function `AsyncDisplay` ```cpp inline AsyncDisplay( @@ -97,7 +97,7 @@ inline AsyncDisplay( ``` -### function AsyncDisplay +### function `AsyncDisplay` ```cpp inline AsyncDisplay( @@ -106,14 +106,14 @@ inline AsyncDisplay( ``` -### function ~AsyncDisplay +### function `~AsyncDisplay` ```cpp inline virtual ~AsyncDisplay() ``` -### function show +### function `show` ```cpp inline virtual void show() @@ -121,7 +121,7 @@ inline virtual void show() Start the display. This starts writing the display in the output stream, and computing speed if applicable. -### function done +### function `done` ```cpp inline virtual void done() @@ -129,47 +129,47 @@ inline virtual void done() End the display. -### function running +### function `running` ```cpp inline bool running() const ``` -### function clone +### function `clone` ```cpp -virtual std::unique_ptr< AsyncDisplay > clone() const =0 +virtual std::unique_ptr< AsyncDisplay > clone() const = 0 ``` -**Reimplemented by**: [barkeep::Animation::clone](api/Classes/classbarkeep_1_1_animation.md#function-clone), [barkeep::Composite::clone](api/Classes/classbarkeep_1_1_composite.md#function-clone), [barkeep::Counter::clone](api/Classes/classbarkeep_1_1_counter.md#function-clone), [barkeep::ProgressBar::clone](api/Classes/classbarkeep_1_1_progress_bar.md#function-clone) +**Reimplemented by**: [`barkeep::Animation::clone`](api/Classes/classbarkeep_1_1_animation.md#function-clone), [`barkeep::Composite::clone`](api/Classes/classbarkeep_1_1_composite.md#function-clone), [`barkeep::Counter::clone`](api/Classes/classbarkeep_1_1_counter.md#function-clone), [`barkeep::ProgressBar::clone`](api/Classes/classbarkeep_1_1_progress_bar.md#function-clone) ## Protected Functions Documentation -### function render_ +### function `render_` ```cpp -virtual void render_() =0 +virtual void render_() = 0 ``` Render a display: animation, progress bar, etc. -**Reimplemented by**: [barkeep::Animation::render_](api/Classes/classbarkeep_1_1_animation.md#function-render_), [barkeep::Composite::render_](api/Classes/classbarkeep_1_1_composite.md#function-render_), [barkeep::Counter::render_](api/Classes/classbarkeep_1_1_counter.md#function-render_), [barkeep::ProgressBar::render_](api/Classes/classbarkeep_1_1_progress_bar.md#function-render_) +**Reimplemented by**: [`barkeep::Animation::render_`](api/Classes/classbarkeep_1_1_animation.md#function-render_), [`barkeep::Composite::render_`](api/Classes/classbarkeep_1_1_composite.md#function-render_), [`barkeep::Counter::render_`](api/Classes/classbarkeep_1_1_counter.md#function-render_), [`barkeep::ProgressBar::render_`](api/Classes/classbarkeep_1_1_progress_bar.md#function-render_) -### function default_interval_ +### function `default_interval_` ```cpp -virtual Duration default_interval_() const =0 +virtual Duration default_interval_() const = 0 ``` -**Reimplemented by**: [barkeep::Animation::default_interval_](api/Classes/classbarkeep_1_1_animation.md#function-default_interval_), [barkeep::Composite::default_interval_](api/Classes/classbarkeep_1_1_composite.md#function-default_interval_), [barkeep::Counter::default_interval_](api/Classes/classbarkeep_1_1_counter.md#function-default_interval_), [barkeep::ProgressBar::default_interval_](api/Classes/classbarkeep_1_1_progress_bar.md#function-default_interval_) +**Reimplemented by**: [`barkeep::Animation::default_interval_`](api/Classes/classbarkeep_1_1_animation.md#function-default_interval_), [`barkeep::Composite::default_interval_`](api/Classes/classbarkeep_1_1_composite.md#function-default_interval_), [`barkeep::Counter::default_interval_`](api/Classes/classbarkeep_1_1_counter.md#function-default_interval_), [`barkeep::ProgressBar::default_interval_`](api/Classes/classbarkeep_1_1_progress_bar.md#function-default_interval_) -### function display_ +### function `display_` ```cpp inline void display_() @@ -177,7 +177,7 @@ inline void display_() Display everything (message, maybe with animation, progress bar, etc). -### function render_message_ +### function `render_message_` ```cpp inline void render_message_() const @@ -185,7 +185,7 @@ inline void render_message_() const Display the message to output stream. -### function start +### function `start` ```cpp inline virtual void start() @@ -193,10 +193,10 @@ inline virtual void start() Start the display but do not show. This typically means start measuring speed if applicable, without displaying anything. -**Reimplemented by**: [barkeep::Composite::start](api/Classes/classbarkeep_1_1_composite.md#function-start), [barkeep::Counter::start](api/Classes/classbarkeep_1_1_counter.md#function-start), [barkeep::ProgressBar::start](api/Classes/classbarkeep_1_1_progress_bar.md#function-start) +**Reimplemented by**: [`barkeep::Composite::start`](api/Classes/classbarkeep_1_1_composite.md#function-start), [`barkeep::Counter::start`](api/Classes/classbarkeep_1_1_counter.md#function-start), [`barkeep::ProgressBar::start`](api/Classes/classbarkeep_1_1_progress_bar.md#function-start) -### function join +### function `join` ```cpp inline virtual void join() @@ -204,7 +204,7 @@ inline virtual void join() Join the display thread. Protected because python bindings need to override to handle GIL. -### function ensure_not_running +### function `ensure_not_running` ```cpp inline void ensure_not_running() const @@ -213,63 +213,63 @@ inline void ensure_not_running() const ## Protected Attributes Documentation -### variable out_ +### variable `out_` ```cpp std::ostream * out_; ``` -### variable displayer_ +### variable `displayer_` ```cpp std::unique_ptr< std::thread > displayer_; ``` -### variable completion_ +### variable `completion_` ```cpp std::condition_variable completion_; ``` -### variable completion_m_ +### variable `completion_m_` ```cpp std::mutex completion_m_; ``` -### variable complete_ +### variable `complete_` ```cpp std::atomic< bool > complete_ = false; ``` -### variable interval_ +### variable `interval_` ```cpp Duration interval_ {0.0}; ``` -### variable message_ +### variable `message_` ```cpp std::string message_; ``` -### variable format_ +### variable `format_` ```cpp std::string format_; ``` -### variable no_tty_ +### variable `no_tty_` ```cpp bool no_tty_ = false; @@ -278,7 +278,7 @@ bool no_tty_ = false; ## Friends -### friend Composite +### friend `Composite` ```cpp friend class Composite( @@ -287,6 +287,4 @@ friend class Composite( ``` -------------------------------- - -Updated on 2024-03-28 at 22:58:08 -0400 \ No newline at end of file +------------------------------- \ No newline at end of file diff --git a/docs/api/Classes/classbarkeep_1_1_composite.md b/docs/api/Classes/classbarkeep_1_1_composite.md index c9ebdb9..3ee1f42 100644 --- a/docs/api/Classes/classbarkeep_1_1_composite.md +++ b/docs/api/Classes/classbarkeep_1_1_composite.md @@ -6,7 +6,7 @@ Creates a composite display out of two display that shows them side by side. For `#include ` -Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) +Inherits from [`barkeep::AsyncDisplay`](api/Classes/classbarkeep_1_1_async_display.md) ## Public Functions @@ -14,10 +14,10 @@ Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display | | Name | | -------------- | -------------- | -| | **[Composite](api/Classes/classbarkeep_1_1_composite.md#function-composite)**(std::unique_ptr< [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) > left, std::unique_ptr< [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) > right) | -| | **[Composite](api/Classes/classbarkeep_1_1_composite.md#function-composite)**(const [Composite](api/Classes/classbarkeep_1_1_composite.md) & other)
Copy constructor clones child displays. | -| | **[~Composite](api/Classes/classbarkeep_1_1_composite.md#function-~composite)**() | -| virtual std::unique_ptr< [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) > | **[clone](api/Classes/classbarkeep_1_1_composite.md#function-clone)**() const override | +| | **[Composite](api/Classes/classbarkeep_1_1_composite.md#function-composite)**(std::unique_ptr< [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) > left, std::unique_ptr< [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) > right) | +| | **[Composite](api/Classes/classbarkeep_1_1_composite.md#function-composite)**(const [Composite](api/Classes/classbarkeep_1_1_composite.md) & other)
Copy constructor clones child displays. | +| | **[~Composite](api/Classes/classbarkeep_1_1_composite.md#function-~composite)**() | +| virtual std::unique_ptr< [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) > | **[clone](api/Classes/classbarkeep_1_1_composite.md#function-clone)**() const override | @@ -28,9 +28,9 @@ Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display | | Name | | -------------- | -------------- | -| virtual void | **[render_](api/Classes/classbarkeep_1_1_composite.md#function-render_)**() override
Render a display: animation, progress bar, etc. | -| virtual [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[default_interval_](api/Classes/classbarkeep_1_1_composite.md#function-default_interval_)**() const override | -| virtual void | **[start](api/Classes/classbarkeep_1_1_composite.md#function-start)**() override
Start the display but do not show. This typically means start measuring speed if applicable, without displaying anything. | +| virtual void | **[render_](api/Classes/classbarkeep_1_1_composite.md#function-render_)**() override
Render a display: animation, progress bar, etc. | +| virtual [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[default_interval_](api/Classes/classbarkeep_1_1_composite.md#function-default_interval_)**() const override | +| virtual void | **[start](api/Classes/classbarkeep_1_1_composite.md#function-start)**() override
Start the display but do not show. This typically means start measuring speed if applicable, without displaying anything. | @@ -41,8 +41,8 @@ Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display | | Name | | -------------- | -------------- | -| std::unique_ptr< [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) > | **[left_](api/Classes/classbarkeep_1_1_composite.md#variable-left_)** | -| std::unique_ptr< [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) > | **[right_](api/Classes/classbarkeep_1_1_composite.md#variable-right_)** | +| std::unique_ptr< [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) > | **[left_](api/Classes/classbarkeep_1_1_composite.md#variable-left_)** | +| std::unique_ptr< [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) > | **[right_](api/Classes/classbarkeep_1_1_composite.md#variable-right_)** | @@ -51,52 +51,52 @@ Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display -**Public Functions inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** +**Public Functions inherited from [`barkeep::AsyncDisplay`](api/Classes/classbarkeep_1_1_async_display.md)** | | Name | | -------------- | -------------- | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(std::ostream * out =&std::cout, [Duration](api/Namespaces/namespacebarkeep.md#using-duration) interval =[Duration](api/Namespaces/namespacebarkeep.md#using-duration){0.}, std::string message ="", std::string format ="", bool no_tty =false) | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(const [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) & other) | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**([AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) && other) | -| virtual | **[~AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-~asyncdisplay)**() | -| virtual void | **[show](api/Classes/classbarkeep_1_1_async_display.md#function-show)**()
Start the display. This starts writing the display in the output stream, and computing speed if applicable. | -| virtual void | **[done](api/Classes/classbarkeep_1_1_async_display.md#function-done)**()
End the display. | -| bool | **[running](api/Classes/classbarkeep_1_1_async_display.md#function-running)**() const | +| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(std::ostream * out = &std::cout, [Duration](api/Namespaces/namespacebarkeep.md#using-duration) interval = [Duration](api/Namespaces/namespacebarkeep.md#using-duration){0.}, std::string message = "", std::string format = "", bool no_tty = false) | +| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(const [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) & other) | +| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**([AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) && other) | +| virtual | **[~AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-~asyncdisplay)**() | +| virtual void | **[show](api/Classes/classbarkeep_1_1_async_display.md#function-show)**()
Start the display. This starts writing the display in the output stream, and computing speed if applicable. | +| virtual void | **[done](api/Classes/classbarkeep_1_1_async_display.md#function-done)**()
End the display. | +| bool | **[running](api/Classes/classbarkeep_1_1_async_display.md#function-running)**() const | -**Protected Functions inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** +**Protected Functions inherited from [`barkeep::AsyncDisplay`](api/Classes/classbarkeep_1_1_async_display.md)** | | Name | | -------------- | -------------- | -| void | **[display_](api/Classes/classbarkeep_1_1_async_display.md#function-display_)**()
Display everything (message, maybe with animation, progress bar, etc). | -| void | **[render_message_](api/Classes/classbarkeep_1_1_async_display.md#function-render_message_)**() const
Display the message to output stream. | -| virtual void | **[join](api/Classes/classbarkeep_1_1_async_display.md#function-join)**()
Join the display thread. Protected because python bindings need to override to handle GIL. | -| void | **[ensure_not_running](api/Classes/classbarkeep_1_1_async_display.md#function-ensure_not_running)**() const | +| void | **[display_](api/Classes/classbarkeep_1_1_async_display.md#function-display_)**()
Display everything (message, maybe with animation, progress bar, etc). | +| void | **[render_message_](api/Classes/classbarkeep_1_1_async_display.md#function-render_message_)**() const
Display the message to output stream. | +| virtual void | **[join](api/Classes/classbarkeep_1_1_async_display.md#function-join)**()
Join the display thread. Protected because python bindings need to override to handle GIL. | +| void | **[ensure_not_running](api/Classes/classbarkeep_1_1_async_display.md#function-ensure_not_running)**() const | -**Protected Attributes inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** +**Protected Attributes inherited from [`barkeep::AsyncDisplay`](api/Classes/classbarkeep_1_1_async_display.md)** | | Name | | -------------- | -------------- | -| std::ostream * | **[out_](api/Classes/classbarkeep_1_1_async_display.md#variable-out_)** | -| std::unique_ptr< std::thread > | **[displayer_](api/Classes/classbarkeep_1_1_async_display.md#variable-displayer_)** | -| std::condition_variable | **[completion_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_)** | -| std::mutex | **[completion_m_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_m_)** | -| std::atomic< bool > | **[complete_](api/Classes/classbarkeep_1_1_async_display.md#variable-complete_)** | -| [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[interval_](api/Classes/classbarkeep_1_1_async_display.md#variable-interval_)** | -| std::string | **[message_](api/Classes/classbarkeep_1_1_async_display.md#variable-message_)** | -| std::string | **[format_](api/Classes/classbarkeep_1_1_async_display.md#variable-format_)** | -| bool | **[no_tty_](api/Classes/classbarkeep_1_1_async_display.md#variable-no_tty_)** | +| std::ostream * | **[out_](api/Classes/classbarkeep_1_1_async_display.md#variable-out_)** | +| std::unique_ptr< std::thread > | **[displayer_](api/Classes/classbarkeep_1_1_async_display.md#variable-displayer_)** | +| std::condition_variable | **[completion_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_)** | +| std::mutex | **[completion_m_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_m_)** | +| std::atomic< bool > | **[complete_](api/Classes/classbarkeep_1_1_async_display.md#variable-complete_)** | +| [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[interval_](api/Classes/classbarkeep_1_1_async_display.md#variable-interval_)** | +| std::string | **[message_](api/Classes/classbarkeep_1_1_async_display.md#variable-message_)** | +| std::string | **[format_](api/Classes/classbarkeep_1_1_async_display.md#variable-format_)** | +| bool | **[no_tty_](api/Classes/classbarkeep_1_1_async_display.md#variable-no_tty_)** | @@ -104,7 +104,7 @@ Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display ## Public Functions Documentation -### function Composite +### function `Composite` ```cpp inline Composite( @@ -114,7 +114,7 @@ inline Composite( ``` -### function Composite +### function `Composite` ```cpp inline Composite( @@ -124,26 +124,26 @@ inline Composite( Copy constructor clones child displays. -### function ~Composite +### function `~Composite` ```cpp inline ~Composite() ``` -### function clone +### function `clone` ```cpp inline virtual std::unique_ptr< AsyncDisplay > clone() const override ``` -**Reimplements**: [barkeep::AsyncDisplay::clone](api/Classes/classbarkeep_1_1_async_display.md#function-clone) +**Reimplements**: [`barkeep::AsyncDisplay::clone`](api/Classes/classbarkeep_1_1_async_display.md#function-clone) ## Protected Functions Documentation -### function render_ +### function `render_` ```cpp inline virtual void render_() override @@ -151,20 +151,20 @@ inline virtual void render_() override Render a display: animation, progress bar, etc. -**Reimplements**: [barkeep::AsyncDisplay::render_](api/Classes/classbarkeep_1_1_async_display.md#function-render_) +**Reimplements**: [`barkeep::AsyncDisplay::render_`](api/Classes/classbarkeep_1_1_async_display.md#function-render_) -### function default_interval_ +### function `default_interval_` ```cpp inline virtual Duration default_interval_() const override ``` -**Reimplements**: [barkeep::AsyncDisplay::default_interval_](api/Classes/classbarkeep_1_1_async_display.md#function-default_interval_) +**Reimplements**: [`barkeep::AsyncDisplay::default_interval_`](api/Classes/classbarkeep_1_1_async_display.md#function-default_interval_) -### function start +### function `start` ```cpp inline virtual void start() override @@ -172,25 +172,23 @@ inline virtual void start() override Start the display but do not show. This typically means start measuring speed if applicable, without displaying anything. -**Reimplements**: [barkeep::AsyncDisplay::start](api/Classes/classbarkeep_1_1_async_display.md#function-start) +**Reimplements**: [`barkeep::AsyncDisplay::start`](api/Classes/classbarkeep_1_1_async_display.md#function-start) ## Protected Attributes Documentation -### variable left_ +### variable `left_` ```cpp std::unique_ptr< AsyncDisplay > left_; ``` -### variable right_ +### variable `right_` ```cpp std::unique_ptr< AsyncDisplay > right_; ``` -------------------------------- - -Updated on 2024-03-28 at 22:58:08 -0400 \ No newline at end of file +------------------------------- \ No newline at end of file diff --git a/docs/api/Classes/classbarkeep_1_1_counter.md b/docs/api/Classes/classbarkeep_1_1_counter.md index dd90e57..4c64bcb 100644 --- a/docs/api/Classes/classbarkeep_1_1_counter.md +++ b/docs/api/Classes/classbarkeep_1_1_counter.md @@ -6,7 +6,7 @@ Monitors and displays a single numeric variable. [More...](#detailed-descriptio `#include ` -Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) +Inherits from [`barkeep::AsyncDisplay`](api/Classes/classbarkeep_1_1_async_display.md) ## Public Functions @@ -14,11 +14,11 @@ Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display | | Name | | -------------- | -------------- | -| | **[Counter](api/Classes/classbarkeep_1_1_counter.md#function-counter)**(Progress * progress, const [CounterConfig](api/Classes/structbarkeep_1_1_counter_config.md) & cfg ={})
Constructor. | -| | **[Counter](api/Classes/classbarkeep_1_1_counter.md#function-counter)**(const [Counter](api/Classes/classbarkeep_1_1_counter.md)< Progress > & other) | -| | **[Counter](api/Classes/classbarkeep_1_1_counter.md#function-counter)**([Counter](api/Classes/classbarkeep_1_1_counter.md)< Progress > && other) | -| | **[~Counter](api/Classes/classbarkeep_1_1_counter.md#function-~counter)**() | -| virtual std::unique_ptr< [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) > | **[clone](api/Classes/classbarkeep_1_1_counter.md#function-clone)**() const override | +| | **[Counter](api/Classes/classbarkeep_1_1_counter.md#function-counter)**(Progress * progress, const [CounterConfig](api/Classes/structbarkeep_1_1_counter_config.md) & cfg = {})
Constructor. | +| | **[Counter](api/Classes/classbarkeep_1_1_counter.md#function-counter)**(const [Counter](api/Classes/classbarkeep_1_1_counter.md)< Progress > & other) | +| | **[Counter](api/Classes/classbarkeep_1_1_counter.md#function-counter)**([Counter](api/Classes/classbarkeep_1_1_counter.md)< Progress > && other) | +| | **[~Counter](api/Classes/classbarkeep_1_1_counter.md#function-~counter)**() | +| virtual std::unique_ptr< [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) > | **[clone](api/Classes/classbarkeep_1_1_counter.md#function-clone)**() const override | @@ -29,10 +29,10 @@ Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display | | Name | | -------------- | -------------- | -| void | **[render_counts_](api/Classes/classbarkeep_1_1_counter.md#function-render_counts_)**()
Write the value of progress to the output stream. | -| virtual void | **[render_](api/Classes/classbarkeep_1_1_counter.md#function-render_)**() override
Write the value of progress with the message to the output stream. | -| virtual [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[default_interval_](api/Classes/classbarkeep_1_1_counter.md#function-default_interval_)**() const override
Default interval in which the display is refreshed, if interval() is not invoked. | -| virtual void | **[start](api/Classes/classbarkeep_1_1_counter.md#function-start)**() override
Start the display but do not show. This typically means start measuring speed if applicable, without displaying anything. | +| void | **[render_counts_](api/Classes/classbarkeep_1_1_counter.md#function-render_counts_)**()
Write the value of progress to the output stream. | +| virtual void | **[render_](api/Classes/classbarkeep_1_1_counter.md#function-render_)**() override
Write the value of progress with the message to the output stream. | +| virtual [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[default_interval_](api/Classes/classbarkeep_1_1_counter.md#function-default_interval_)**() const override
Default interval in which the display is refreshed, if interval() is not invoked. | +| virtual void | **[start](api/Classes/classbarkeep_1_1_counter.md#function-start)**() override
Start the display but do not show. This typically means start measuring speed if applicable, without displaying anything. | @@ -43,10 +43,10 @@ Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display | | Name | | -------------- | -------------- | -| Progress * | **[progress_](api/Classes/classbarkeep_1_1_counter.md#variable-progress_)** | -| std::unique_ptr< [Speedometer](api/Classes/classbarkeep_1_1_speedometer.md)< Progress > > | **[speedom_](api/Classes/classbarkeep_1_1_counter.md#variable-speedom_)** | -| std::string | **[speed_unit_](api/Classes/classbarkeep_1_1_counter.md#variable-speed_unit_)** | -| std::stringstream | **[ss_](api/Classes/classbarkeep_1_1_counter.md#variable-ss_)** | +| Progress * | **[progress_](api/Classes/classbarkeep_1_1_counter.md#variable-progress_)** | +| std::unique_ptr< [Speedometer](api/Classes/classbarkeep_1_1_speedometer.md)< Progress > > | **[speedom_](api/Classes/classbarkeep_1_1_counter.md#variable-speedom_)** | +| std::string | **[speed_unit_](api/Classes/classbarkeep_1_1_counter.md#variable-speed_unit_)** | +| std::stringstream | **[ss_](api/Classes/classbarkeep_1_1_counter.md#variable-ss_)** | @@ -55,63 +55,63 @@ Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display -**Public Functions inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** +**Public Functions inherited from [`barkeep::AsyncDisplay`](api/Classes/classbarkeep_1_1_async_display.md)** | | Name | | -------------- | -------------- | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(std::ostream * out =&std::cout, [Duration](api/Namespaces/namespacebarkeep.md#using-duration) interval =[Duration](api/Namespaces/namespacebarkeep.md#using-duration){0.}, std::string message ="", std::string format ="", bool no_tty =false) | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(const [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) & other) | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**([AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) && other) | -| virtual | **[~AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-~asyncdisplay)**() | -| virtual void | **[show](api/Classes/classbarkeep_1_1_async_display.md#function-show)**()
Start the display. This starts writing the display in the output stream, and computing speed if applicable. | -| virtual void | **[done](api/Classes/classbarkeep_1_1_async_display.md#function-done)**()
End the display. | -| bool | **[running](api/Classes/classbarkeep_1_1_async_display.md#function-running)**() const | +| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(std::ostream * out = &std::cout, [Duration](api/Namespaces/namespacebarkeep.md#using-duration) interval = [Duration](api/Namespaces/namespacebarkeep.md#using-duration){0.}, std::string message = "", std::string format = "", bool no_tty = false) | +| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(const [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) & other) | +| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**([AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) && other) | +| virtual | **[~AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-~asyncdisplay)**() | +| virtual void | **[show](api/Classes/classbarkeep_1_1_async_display.md#function-show)**()
Start the display. This starts writing the display in the output stream, and computing speed if applicable. | +| virtual void | **[done](api/Classes/classbarkeep_1_1_async_display.md#function-done)**()
End the display. | +| bool | **[running](api/Classes/classbarkeep_1_1_async_display.md#function-running)**() const | -**Protected Functions inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** +**Protected Functions inherited from [`barkeep::AsyncDisplay`](api/Classes/classbarkeep_1_1_async_display.md)** | | Name | | -------------- | -------------- | -| void | **[display_](api/Classes/classbarkeep_1_1_async_display.md#function-display_)**()
Display everything (message, maybe with animation, progress bar, etc). | -| void | **[render_message_](api/Classes/classbarkeep_1_1_async_display.md#function-render_message_)**() const
Display the message to output stream. | -| virtual void | **[join](api/Classes/classbarkeep_1_1_async_display.md#function-join)**()
Join the display thread. Protected because python bindings need to override to handle GIL. | -| void | **[ensure_not_running](api/Classes/classbarkeep_1_1_async_display.md#function-ensure_not_running)**() const | +| void | **[display_](api/Classes/classbarkeep_1_1_async_display.md#function-display_)**()
Display everything (message, maybe with animation, progress bar, etc). | +| void | **[render_message_](api/Classes/classbarkeep_1_1_async_display.md#function-render_message_)**() const
Display the message to output stream. | +| virtual void | **[join](api/Classes/classbarkeep_1_1_async_display.md#function-join)**()
Join the display thread. Protected because python bindings need to override to handle GIL. | +| void | **[ensure_not_running](api/Classes/classbarkeep_1_1_async_display.md#function-ensure_not_running)**() const | -**Protected Attributes inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** +**Protected Attributes inherited from [`barkeep::AsyncDisplay`](api/Classes/classbarkeep_1_1_async_display.md)** | | Name | | -------------- | -------------- | -| std::ostream * | **[out_](api/Classes/classbarkeep_1_1_async_display.md#variable-out_)** | -| std::unique_ptr< std::thread > | **[displayer_](api/Classes/classbarkeep_1_1_async_display.md#variable-displayer_)** | -| std::condition_variable | **[completion_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_)** | -| std::mutex | **[completion_m_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_m_)** | -| std::atomic< bool > | **[complete_](api/Classes/classbarkeep_1_1_async_display.md#variable-complete_)** | -| [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[interval_](api/Classes/classbarkeep_1_1_async_display.md#variable-interval_)** | -| std::string | **[message_](api/Classes/classbarkeep_1_1_async_display.md#variable-message_)** | -| std::string | **[format_](api/Classes/classbarkeep_1_1_async_display.md#variable-format_)** | -| bool | **[no_tty_](api/Classes/classbarkeep_1_1_async_display.md#variable-no_tty_)** | +| std::ostream * | **[out_](api/Classes/classbarkeep_1_1_async_display.md#variable-out_)** | +| std::unique_ptr< std::thread > | **[displayer_](api/Classes/classbarkeep_1_1_async_display.md#variable-displayer_)** | +| std::condition_variable | **[completion_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_)** | +| std::mutex | **[completion_m_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_m_)** | +| std::atomic< bool > | **[complete_](api/Classes/classbarkeep_1_1_async_display.md#variable-complete_)** | +| [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[interval_](api/Classes/classbarkeep_1_1_async_display.md#variable-interval_)** | +| std::string | **[message_](api/Classes/classbarkeep_1_1_async_display.md#variable-message_)** | +| std::string | **[format_](api/Classes/classbarkeep_1_1_async_display.md#variable-format_)** | +| bool | **[no_tty_](api/Classes/classbarkeep_1_1_async_display.md#variable-no_tty_)** | -**Friends inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** +**Friends inherited from [`barkeep::AsyncDisplay`](api/Classes/classbarkeep_1_1_async_display.md)** | | Name | | -------------- | -------------- | -| class | **[Composite](api/Classes/classbarkeep_1_1_async_display.md#friend-composite)** | +| class | **[Composite](api/Classes/classbarkeep_1_1_async_display.md#friend-composite)** | @@ -127,12 +127,12 @@ class barkeep::Counter; Monitors and displays a single numeric variable. ## Public Functions Documentation -### function Counter +### function `Counter` ```cpp inline Counter( Progress * progress, - const CounterConfig & cfg ={} + const CounterConfig & cfg = {} ) ``` @@ -144,7 +144,7 @@ Constructor. * **cfg** [Counter](api/Classes/classbarkeep_1_1_counter.md) parameters -### function Counter +### function `Counter` ```cpp inline Counter( @@ -153,7 +153,7 @@ inline Counter( ``` -### function Counter +### function `Counter` ```cpp inline Counter( @@ -162,26 +162,26 @@ inline Counter( ``` -### function ~Counter +### function `~Counter` ```cpp inline ~Counter() ``` -### function clone +### function `clone` ```cpp inline virtual std::unique_ptr< AsyncDisplay > clone() const override ``` -**Reimplements**: [barkeep::AsyncDisplay::clone](api/Classes/classbarkeep_1_1_async_display.md#function-clone) +**Reimplements**: [`barkeep::AsyncDisplay::clone`](api/Classes/classbarkeep_1_1_async_display.md#function-clone) ## Protected Functions Documentation -### function render_counts_ +### function `render_counts_` ```cpp inline void render_counts_() @@ -189,7 +189,7 @@ inline void render_counts_() Write the value of progress to the output stream. -### function render_ +### function `render_` ```cpp inline virtual void render_() override @@ -197,10 +197,10 @@ inline virtual void render_() override Write the value of progress with the message to the output stream. -**Reimplements**: [barkeep::AsyncDisplay::render_](api/Classes/classbarkeep_1_1_async_display.md#function-render_) +**Reimplements**: [`barkeep::AsyncDisplay::render_`](api/Classes/classbarkeep_1_1_async_display.md#function-render_) -### function default_interval_ +### function `default_interval_` ```cpp inline virtual Duration default_interval_() const override @@ -210,10 +210,10 @@ Default interval in which the display is refreshed, if interval() is not invoked **Return**: default interval -**Reimplements**: [barkeep::AsyncDisplay::default_interval_](api/Classes/classbarkeep_1_1_async_display.md#function-default_interval_) +**Reimplements**: [`barkeep::AsyncDisplay::default_interval_`](api/Classes/classbarkeep_1_1_async_display.md#function-default_interval_) -### function start +### function `start` ```cpp inline virtual void start() override @@ -221,39 +221,37 @@ inline virtual void start() override Start the display but do not show. This typically means start measuring speed if applicable, without displaying anything. -**Reimplements**: [barkeep::AsyncDisplay::start](api/Classes/classbarkeep_1_1_async_display.md#function-start) +**Reimplements**: [`barkeep::AsyncDisplay::start`](api/Classes/classbarkeep_1_1_async_display.md#function-start) ## Protected Attributes Documentation -### variable progress_ +### variable `progress_` ```cpp Progress * progress_ = nullptr; ``` -### variable speedom_ +### variable `speedom_` ```cpp std::unique_ptr< Speedometer< Progress > > speedom_; ``` -### variable speed_unit_ +### variable `speed_unit_` ```cpp std::string speed_unit_ = "it/s"; ``` -### variable ss_ +### variable `ss_` ```cpp std::stringstream ss_; ``` -------------------------------- - -Updated on 2024-03-28 at 22:58:08 -0400 \ No newline at end of file +------------------------------- \ No newline at end of file diff --git a/docs/api/Classes/classbarkeep_1_1_iterable_bar.md b/docs/api/Classes/classbarkeep_1_1_iterable_bar.md index 49821c0..2bc884b 100644 --- a/docs/api/Classes/classbarkeep_1_1_iterable_bar.md +++ b/docs/api/Classes/classbarkeep_1_1_iterable_bar.md @@ -23,8 +23,8 @@ A progress bar that can be used with range-based for loops, that automatically t | | Name | | -------------- | -------------- | -| using std::atomic< size_t > | **[ProgressType](api/Classes/classbarkeep_1_1_iterable_bar.md#using-progresstype)** | -| using [value_t](api/Namespaces/namespacebarkeep.md#using-value_t)< [ProgressType](api/Classes/classbarkeep_1_1_iterable_bar.md#using-progresstype) > | **[ValueType](api/Classes/classbarkeep_1_1_iterable_bar.md#using-valuetype)** | +| using std::atomic< size_t > | **[ProgressType](api/Classes/classbarkeep_1_1_iterable_bar.md#using-progresstype)** | +| using [value_t](api/Namespaces/namespacebarkeep.md#using-value_t)< [ProgressType](api/Classes/classbarkeep_1_1_iterable_bar.md#using-progresstype) > | **[ValueType](api/Classes/classbarkeep_1_1_iterable_bar.md#using-valuetype)** | @@ -35,9 +35,9 @@ A progress bar that can be used with range-based for loops, that automatically t | | Name | | -------------- | -------------- | -| | **[IterableBar](api/Classes/classbarkeep_1_1_iterable_bar.md#function-iterablebar)**(Container & container, const [IterableBarConfig](api/Classes/structbarkeep_1_1_iterable_bar_config.md)< [ValueType](api/Classes/classbarkeep_1_1_iterable_bar.md#using-valuetype) > & cfg ={}) | -| auto | **[begin](api/Classes/classbarkeep_1_1_iterable_bar.md#function-begin)**() | -| auto | **[end](api/Classes/classbarkeep_1_1_iterable_bar.md#function-end)**() | +| | **[IterableBar](api/Classes/classbarkeep_1_1_iterable_bar.md#function-iterablebar)**(Container & container, const [IterableBarConfig](api/Classes/structbarkeep_1_1_iterable_bar_config.md)< [ValueType](api/Classes/classbarkeep_1_1_iterable_bar.md#using-valuetype) > & cfg = {}) | +| auto | **[begin](api/Classes/classbarkeep_1_1_iterable_bar.md#function-begin)**() | +| auto | **[end](api/Classes/classbarkeep_1_1_iterable_bar.md#function-end)**() | @@ -52,14 +52,14 @@ class barkeep::IterableBar; A progress bar that can be used with range-based for loops, that automatically tracks the progress of the loop. ## Public Types Documentation -### using ProgressType +### using `ProgressType` ```cpp using barkeep::IterableBar< Container >::ProgressType = std::atomic; ``` -### using ValueType +### using `ValueType` ```cpp using barkeep::IterableBar< Container >::ValueType = value_t; @@ -68,30 +68,28 @@ using barkeep::IterableBar< Container >::ValueType = value_t; ## Public Functions Documentation -### function IterableBar +### function `IterableBar` ```cpp inline IterableBar( Container & container, - const IterableBarConfig< ValueType > & cfg ={} + const IterableBarConfig< ValueType > & cfg = {} ) ``` -### function begin +### function `begin` ```cpp inline auto begin() ``` -### function end +### function `end` ```cpp inline auto end() ``` -------------------------------- - -Updated on 2024-03-28 at 22:58:08 -0400 \ No newline at end of file +------------------------------- \ No newline at end of file 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 index 891d21e..6c051dd 100644 --- 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 @@ -12,17 +12,17 @@ | | Name | | -------------- | -------------- | -| | **[Iterator](api/Classes/classbarkeep_1_1_iterable_bar_1_1_iterator.md#function-iterator)**(typename Container::iterator it, [ProgressType](api/Classes/classbarkeep_1_1_iterable_bar.md#using-progresstype) & idx) | -| [Iterator](api/Classes/classbarkeep_1_1_iterable_bar_1_1_iterator.md) & | **[operator++](api/Classes/classbarkeep_1_1_iterable_bar_1_1_iterator.md#function-operator++)**() | -| bool | **[operator!=](api/Classes/classbarkeep_1_1_iterable_bar_1_1_iterator.md#function-operator!=)**(const [Iterator](api/Classes/classbarkeep_1_1_iterable_bar_1_1_iterator.md) & other) const | -| auto & | **[operator*](api/Classes/classbarkeep_1_1_iterable_bar_1_1_iterator.md#function-operator*)**() | +| | **[Iterator](api/Classes/classbarkeep_1_1_iterable_bar_1_1_iterator.md#function-iterator)**(typename Container::iterator it, [ProgressType](api/Classes/classbarkeep_1_1_iterable_bar.md#using-progresstype) & idx) | +| [Iterator](api/Classes/classbarkeep_1_1_iterable_bar_1_1_iterator.md) & | **[operator++](api/Classes/classbarkeep_1_1_iterable_bar_1_1_iterator.md#function-operator++)**() | +| bool | **[operator!=](api/Classes/classbarkeep_1_1_iterable_bar_1_1_iterator.md#function-operator!=)**(const [Iterator](api/Classes/classbarkeep_1_1_iterable_bar_1_1_iterator.md) & other) const | +| auto & | **[operator*](api/Classes/classbarkeep_1_1_iterable_bar_1_1_iterator.md#function-operator*)**() | ## Public Functions Documentation -### function Iterator +### function `Iterator` ```cpp inline Iterator( @@ -32,14 +32,14 @@ inline Iterator( ``` -### function operator++ +### function `operator++` ```cpp inline Iterator & operator++() ``` -### function operator!= +### function `operator!=` ```cpp inline bool operator!=( @@ -48,13 +48,11 @@ inline bool operator!=( ``` -### function operator* +### function `operator*` ```cpp inline auto & operator*() ``` -------------------------------- - -Updated on 2024-03-28 at 22:58:08 -0400 \ No newline at end of file +------------------------------- \ No newline at end of file diff --git a/docs/api/Classes/classbarkeep_1_1_progress_bar.md b/docs/api/Classes/classbarkeep_1_1_progress_bar.md index e896c60..9ab5da8 100644 --- a/docs/api/Classes/classbarkeep_1_1_progress_bar.md +++ b/docs/api/Classes/classbarkeep_1_1_progress_bar.md @@ -6,7 +6,7 @@ Displays a progress bar, by comparing the progress value being monitored to a gi `#include ` -Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) +Inherits from [`barkeep::AsyncDisplay`](api/Classes/classbarkeep_1_1_async_display.md) ## Public Types @@ -14,7 +14,7 @@ Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display | | Name | | -------------- | -------------- | -| using [ProgressBarStyle](api/Namespaces/namespacebarkeep.md#enum-progressbarstyle) | **[Style](api/Classes/classbarkeep_1_1_progress_bar.md#using-style)** | +| using [ProgressBarStyle](api/Namespaces/namespacebarkeep.md#enum-progressbarstyle) | **[Style](api/Classes/classbarkeep_1_1_progress_bar.md#using-style)** | @@ -25,7 +25,7 @@ Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display | | Name | | -------------- | -------------- | -| using [value_t](api/Namespaces/namespacebarkeep.md#using-value_t)< Progress > | **[ValueType](api/Classes/classbarkeep_1_1_progress_bar.md#using-valuetype)** | +| using [value_t](api/Namespaces/namespacebarkeep.md#using-value_t)< Progress > | **[ValueType](api/Classes/classbarkeep_1_1_progress_bar.md#using-valuetype)** | @@ -36,11 +36,11 @@ Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display | | Name | | -------------- | -------------- | -| | **[ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md#function-progressbar)**(Progress * progress, const [ProgressBarConfig](api/Classes/structbarkeep_1_1_progress_bar_config.md)< [ValueType](api/Classes/classbarkeep_1_1_progress_bar.md#using-valuetype) > & cfg ={})
Constructor. | -| | **[ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md#function-progressbar)**([ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md)< Progress > && other)
move constructor | -| | **[ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md#function-progressbar)**(const [ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md)< Progress > & other)
copy constructor | -| | **[~ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md#function-~progressbar)**() | -| virtual std::unique_ptr< [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) > | **[clone](api/Classes/classbarkeep_1_1_progress_bar.md#function-clone)**() const override | +| | **[ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md#function-progressbar)**(Progress * progress, const [ProgressBarConfig](api/Classes/structbarkeep_1_1_progress_bar_config.md)< [ValueType](api/Classes/classbarkeep_1_1_progress_bar.md#using-valuetype) > & cfg = {})
Constructor. | +| | **[ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md#function-progressbar)**([ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md)< Progress > && other)
move constructor | +| | **[ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md#function-progressbar)**(const [ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md)< Progress > & other)
copy constructor | +| | **[~ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md#function-~progressbar)**() | +| virtual std::unique_ptr< [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) > | **[clone](api/Classes/classbarkeep_1_1_progress_bar.md#function-clone)**() const override | @@ -51,12 +51,12 @@ Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display | | Name | | -------------- | -------------- | -| void | **[render_progress_bar_](api/Classes/classbarkeep_1_1_progress_bar.md#function-render_progress_bar_)**(std::ostream * out =nullptr)
Compute the shape of the progress bar based on progress and write to output stream. | -| void | **[render_counts_](api/Classes/classbarkeep_1_1_progress_bar.md#function-render_counts_)**()
Write progress value with the total, e.g. 50/100, to output stream. Progress width is expanded (and right justified) to match width of total. | -| void | **[render_percentage_](api/Classes/classbarkeep_1_1_progress_bar.md#function-render_percentage_)**()
Write the percent completed to output stream. | -| virtual void | **[render_](api/Classes/classbarkeep_1_1_progress_bar.md#function-render_)**() override
Run all of the individual render methods to write everything to stream. | -| virtual [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[default_interval_](api/Classes/classbarkeep_1_1_progress_bar.md#function-default_interval_)**() const override | -| virtual void | **[start](api/Classes/classbarkeep_1_1_progress_bar.md#function-start)**() override
Start the display but do not show. This typically means start measuring speed if applicable, without displaying anything. | +| void | **[render_progress_bar_](api/Classes/classbarkeep_1_1_progress_bar.md#function-render_progress_bar_)**(std::ostream * out = nullptr)
Compute the shape of the progress bar based on progress and write to output stream. | +| void | **[render_counts_](api/Classes/classbarkeep_1_1_progress_bar.md#function-render_counts_)**()
Write progress value with the total, e.g. 50/100, to output stream. Progress width is expanded (and right justified) to match width of total. | +| void | **[render_percentage_](api/Classes/classbarkeep_1_1_progress_bar.md#function-render_percentage_)**()
Write the percent completed to output stream. | +| virtual void | **[render_](api/Classes/classbarkeep_1_1_progress_bar.md#function-render_)**() override
Run all of the individual render methods to write everything to stream. | +| virtual [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[default_interval_](api/Classes/classbarkeep_1_1_progress_bar.md#function-default_interval_)**() const override | +| virtual void | **[start](api/Classes/classbarkeep_1_1_progress_bar.md#function-start)**() override
Start the display but do not show. This typically means start measuring speed if applicable, without displaying anything. | @@ -67,12 +67,12 @@ Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display | | Name | | -------------- | -------------- | -| Progress * | **[progress_](api/Classes/classbarkeep_1_1_progress_bar.md#variable-progress_)** | -| std::unique_ptr< [Speedometer](api/Classes/classbarkeep_1_1_speedometer.md)< Progress > > | **[speedom_](api/Classes/classbarkeep_1_1_progress_bar.md#variable-speedom_)** | -| std::string | **[speed_unit_](api/Classes/classbarkeep_1_1_progress_bar.md#variable-speed_unit_)** | -| [ValueType](api/Classes/classbarkeep_1_1_progress_bar.md#using-valuetype) | **[total_](api/Classes/classbarkeep_1_1_progress_bar.md#variable-total_)** | -| [BarParts](api/Classes/structbarkeep_1_1_bar_parts.md) | **[bar_parts_](api/Classes/classbarkeep_1_1_progress_bar.md#variable-bar_parts_)** | -| constexpr size_t | **[width_](api/Classes/classbarkeep_1_1_progress_bar.md#variable-width_)** | +| Progress * | **[progress_](api/Classes/classbarkeep_1_1_progress_bar.md#variable-progress_)** | +| std::unique_ptr< [Speedometer](api/Classes/classbarkeep_1_1_speedometer.md)< Progress > > | **[speedom_](api/Classes/classbarkeep_1_1_progress_bar.md#variable-speedom_)** | +| std::string | **[speed_unit_](api/Classes/classbarkeep_1_1_progress_bar.md#variable-speed_unit_)** | +| [ValueType](api/Classes/classbarkeep_1_1_progress_bar.md#using-valuetype) | **[total_](api/Classes/classbarkeep_1_1_progress_bar.md#variable-total_)** | +| [BarParts](api/Classes/structbarkeep_1_1_bar_parts.md) | **[bar_parts_](api/Classes/classbarkeep_1_1_progress_bar.md#variable-bar_parts_)** | +| constexpr size_t | **[width_](api/Classes/classbarkeep_1_1_progress_bar.md#variable-width_)** | @@ -81,63 +81,63 @@ Inherits from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display -**Public Functions inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** +**Public Functions inherited from [`barkeep::AsyncDisplay`](api/Classes/classbarkeep_1_1_async_display.md)** | | Name | | -------------- | -------------- | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(std::ostream * out =&std::cout, [Duration](api/Namespaces/namespacebarkeep.md#using-duration) interval =[Duration](api/Namespaces/namespacebarkeep.md#using-duration){0.}, std::string message ="", std::string format ="", bool no_tty =false) | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(const [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) & other) | -| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**([AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) && other) | -| virtual | **[~AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-~asyncdisplay)**() | -| virtual void | **[show](api/Classes/classbarkeep_1_1_async_display.md#function-show)**()
Start the display. This starts writing the display in the output stream, and computing speed if applicable. | -| virtual void | **[done](api/Classes/classbarkeep_1_1_async_display.md#function-done)**()
End the display. | -| bool | **[running](api/Classes/classbarkeep_1_1_async_display.md#function-running)**() const | +| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(std::ostream * out = &std::cout, [Duration](api/Namespaces/namespacebarkeep.md#using-duration) interval = [Duration](api/Namespaces/namespacebarkeep.md#using-duration){0.}, std::string message = "", std::string format = "", bool no_tty = false) | +| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**(const [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) & other) | +| | **[AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-asyncdisplay)**([AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) && other) | +| virtual | **[~AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md#function-~asyncdisplay)**() | +| virtual void | **[show](api/Classes/classbarkeep_1_1_async_display.md#function-show)**()
Start the display. This starts writing the display in the output stream, and computing speed if applicable. | +| virtual void | **[done](api/Classes/classbarkeep_1_1_async_display.md#function-done)**()
End the display. | +| bool | **[running](api/Classes/classbarkeep_1_1_async_display.md#function-running)**() const | -**Protected Functions inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** +**Protected Functions inherited from [`barkeep::AsyncDisplay`](api/Classes/classbarkeep_1_1_async_display.md)** | | Name | | -------------- | -------------- | -| void | **[display_](api/Classes/classbarkeep_1_1_async_display.md#function-display_)**()
Display everything (message, maybe with animation, progress bar, etc). | -| void | **[render_message_](api/Classes/classbarkeep_1_1_async_display.md#function-render_message_)**() const
Display the message to output stream. | -| virtual void | **[join](api/Classes/classbarkeep_1_1_async_display.md#function-join)**()
Join the display thread. Protected because python bindings need to override to handle GIL. | -| void | **[ensure_not_running](api/Classes/classbarkeep_1_1_async_display.md#function-ensure_not_running)**() const | +| void | **[display_](api/Classes/classbarkeep_1_1_async_display.md#function-display_)**()
Display everything (message, maybe with animation, progress bar, etc). | +| void | **[render_message_](api/Classes/classbarkeep_1_1_async_display.md#function-render_message_)**() const
Display the message to output stream. | +| virtual void | **[join](api/Classes/classbarkeep_1_1_async_display.md#function-join)**()
Join the display thread. Protected because python bindings need to override to handle GIL. | +| void | **[ensure_not_running](api/Classes/classbarkeep_1_1_async_display.md#function-ensure_not_running)**() const | -**Protected Attributes inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** +**Protected Attributes inherited from [`barkeep::AsyncDisplay`](api/Classes/classbarkeep_1_1_async_display.md)** | | Name | | -------------- | -------------- | -| std::ostream * | **[out_](api/Classes/classbarkeep_1_1_async_display.md#variable-out_)** | -| std::unique_ptr< std::thread > | **[displayer_](api/Classes/classbarkeep_1_1_async_display.md#variable-displayer_)** | -| std::condition_variable | **[completion_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_)** | -| std::mutex | **[completion_m_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_m_)** | -| std::atomic< bool > | **[complete_](api/Classes/classbarkeep_1_1_async_display.md#variable-complete_)** | -| [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[interval_](api/Classes/classbarkeep_1_1_async_display.md#variable-interval_)** | -| std::string | **[message_](api/Classes/classbarkeep_1_1_async_display.md#variable-message_)** | -| std::string | **[format_](api/Classes/classbarkeep_1_1_async_display.md#variable-format_)** | -| bool | **[no_tty_](api/Classes/classbarkeep_1_1_async_display.md#variable-no_tty_)** | +| std::ostream * | **[out_](api/Classes/classbarkeep_1_1_async_display.md#variable-out_)** | +| std::unique_ptr< std::thread > | **[displayer_](api/Classes/classbarkeep_1_1_async_display.md#variable-displayer_)** | +| std::condition_variable | **[completion_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_)** | +| std::mutex | **[completion_m_](api/Classes/classbarkeep_1_1_async_display.md#variable-completion_m_)** | +| std::atomic< bool > | **[complete_](api/Classes/classbarkeep_1_1_async_display.md#variable-complete_)** | +| [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[interval_](api/Classes/classbarkeep_1_1_async_display.md#variable-interval_)** | +| std::string | **[message_](api/Classes/classbarkeep_1_1_async_display.md#variable-message_)** | +| std::string | **[format_](api/Classes/classbarkeep_1_1_async_display.md#variable-format_)** | +| bool | **[no_tty_](api/Classes/classbarkeep_1_1_async_display.md#variable-no_tty_)** | -**Friends inherited from [barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)** +**Friends inherited from [`barkeep::AsyncDisplay`](api/Classes/classbarkeep_1_1_async_display.md)** | | Name | | -------------- | -------------- | -| class | **[Composite](api/Classes/classbarkeep_1_1_async_display.md#friend-composite)** | +| class | **[Composite](api/Classes/classbarkeep_1_1_async_display.md#friend-composite)** | @@ -153,7 +153,7 @@ class barkeep::ProgressBar; Displays a progress bar, by comparing the progress value being monitored to a given total value. Optionally reports speed. ## Public Types Documentation -### using Style +### using `Style` ```cpp using barkeep::ProgressBar< Progress >::Style = ProgressBarStyle; @@ -162,7 +162,7 @@ using barkeep::ProgressBar< Progress >::Style = ProgressBarStyle; ## Protected Types Documentation -### using ValueType +### using `ValueType` ```cpp using barkeep::ProgressBar< Progress >::ValueType = value_t; @@ -171,12 +171,12 @@ using barkeep::ProgressBar< Progress >::ValueType = value_t; ## Public Functions Documentation -### function ProgressBar +### function `ProgressBar` ```cpp inline ProgressBar( Progress * progress, - const ProgressBarConfig< ValueType > & cfg ={} + const ProgressBarConfig< ValueType > & cfg = {} ) ``` @@ -188,7 +188,7 @@ Constructor. * **cfg** [ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md) parameters -### function ProgressBar +### function `ProgressBar` ```cpp inline ProgressBar( @@ -198,7 +198,7 @@ inline ProgressBar( move constructor -### function ProgressBar +### function `ProgressBar` ```cpp inline ProgressBar( @@ -208,36 +208,36 @@ inline ProgressBar( copy constructor -### function ~ProgressBar +### function `~ProgressBar` ```cpp inline ~ProgressBar() ``` -### function clone +### function `clone` ```cpp inline virtual std::unique_ptr< AsyncDisplay > clone() const override ``` -**Reimplements**: [barkeep::AsyncDisplay::clone](api/Classes/classbarkeep_1_1_async_display.md#function-clone) +**Reimplements**: [`barkeep::AsyncDisplay::clone`](api/Classes/classbarkeep_1_1_async_display.md#function-clone) ## Protected Functions Documentation -### function render_progress_bar_ +### function `render_progress_bar_` ```cpp inline void render_progress_bar_( - std::ostream * out =nullptr + std::ostream * out = nullptr ) ``` Compute the shape of the progress bar based on progress and write to output stream. -### function render_counts_ +### function `render_counts_` ```cpp inline void render_counts_() @@ -245,7 +245,7 @@ inline void render_counts_() Write progress value with the total, e.g. 50/100, to output stream. Progress width is expanded (and right justified) to match width of total. -### function render_percentage_ +### function `render_percentage_` ```cpp inline void render_percentage_() @@ -253,7 +253,7 @@ inline void render_percentage_() Write the percent completed to output stream. -### function render_ +### function `render_` ```cpp inline virtual void render_() override @@ -261,20 +261,20 @@ inline virtual void render_() override Run all of the individual render methods to write everything to stream. -**Reimplements**: [barkeep::AsyncDisplay::render_](api/Classes/classbarkeep_1_1_async_display.md#function-render_) +**Reimplements**: [`barkeep::AsyncDisplay::render_`](api/Classes/classbarkeep_1_1_async_display.md#function-render_) -### function default_interval_ +### function `default_interval_` ```cpp inline virtual Duration default_interval_() const override ``` -**Reimplements**: [barkeep::AsyncDisplay::default_interval_](api/Classes/classbarkeep_1_1_async_display.md#function-default_interval_) +**Reimplements**: [`barkeep::AsyncDisplay::default_interval_`](api/Classes/classbarkeep_1_1_async_display.md#function-default_interval_) -### function start +### function `start` ```cpp inline virtual void start() override @@ -282,53 +282,51 @@ inline virtual void start() override Start the display but do not show. This typically means start measuring speed if applicable, without displaying anything. -**Reimplements**: [barkeep::AsyncDisplay::start](api/Classes/classbarkeep_1_1_async_display.md#function-start) +**Reimplements**: [`barkeep::AsyncDisplay::start`](api/Classes/classbarkeep_1_1_async_display.md#function-start) ## Protected Attributes Documentation -### variable progress_ +### variable `progress_` ```cpp Progress * progress_; ``` -### variable speedom_ +### variable `speedom_` ```cpp std::unique_ptr< Speedometer< Progress > > speedom_; ``` -### variable speed_unit_ +### variable `speed_unit_` ```cpp std::string speed_unit_ = "it/s"; ``` -### variable total_ +### variable `total_` ```cpp ValueType total_ {100}; ``` -### variable bar_parts_ +### variable `bar_parts_` ```cpp BarParts bar_parts_; ``` -### variable width_ +### variable `width_` ```cpp static constexpr size_t width_ = 30; ``` -------------------------------- - -Updated on 2024-03-28 at 22:58:08 -0400 \ No newline at end of file +------------------------------- \ No newline at end of file diff --git a/docs/api/Classes/classbarkeep_1_1_speedometer.md b/docs/api/Classes/classbarkeep_1_1_speedometer.md index fbef135..150f497 100644 --- a/docs/api/Classes/classbarkeep_1_1_speedometer.md +++ b/docs/api/Classes/classbarkeep_1_1_speedometer.md @@ -12,10 +12,10 @@ Helper class to measure and display speed of progress. [More...](#detailed-desc | | Name | | -------------- | -------------- | -| double | **[speed](api/Classes/classbarkeep_1_1_speedometer.md#function-speed)**() | -| void | **[render_speed](api/Classes/classbarkeep_1_1_speedometer.md#function-render_speed)**(std::ostream * out, const std::string & speed_unit)
Write speed to given output stream. Speed is a double (written with precision 2), possibly followed by a unit of speed. | -| void | **[start](api/Classes/classbarkeep_1_1_speedometer.md#function-start)**()
Start computing the speed based on the amount of change in progress. | -| | **[Speedometer](api/Classes/classbarkeep_1_1_speedometer.md#function-speedometer)**(Progress & progress, double discount)
Constructor. | +| double | **[speed](api/Classes/classbarkeep_1_1_speedometer.md#function-speed)**() | +| void | **[render_speed](api/Classes/classbarkeep_1_1_speedometer.md#function-render_speed)**(std::ostream * out, const std::string & speed_unit)
Write speed to given output stream. Speed is a double (written with precision 2), possibly followed by a unit of speed. | +| void | **[start](api/Classes/classbarkeep_1_1_speedometer.md#function-start)**()
Start computing the speed based on the amount of change in progress. | +| | **[Speedometer](api/Classes/classbarkeep_1_1_speedometer.md#function-speedometer)**(Progress & progress, double discount)
Constructor. | @@ -30,14 +30,14 @@ class barkeep::Speedometer; Helper class to measure and display speed of progress. ## Public Functions Documentation -### function speed +### function `speed` ```cpp inline double speed() ``` -### function render_speed +### function `render_speed` ```cpp inline void render_speed( @@ -48,7 +48,7 @@ inline void render_speed( Write speed to given output stream. Speed is a double (written with precision 2), possibly followed by a unit of speed. -### function start +### function `start` ```cpp inline void start() @@ -56,7 +56,7 @@ inline void start() Start computing the speed based on the amount of change in progress. -### function Speedometer +### function `Speedometer` ```cpp inline Speedometer( @@ -73,6 +73,4 @@ Constructor. * **discount** Discount factor in [0, 1] to use in computing the speed. Previous increments are weighted by (1-discount). If discount is 0, all increments are weighted equally. If discount is 1, only the most recent increment is considered. -------------------------------- - -Updated on 2024-03-28 at 22:58:08 -0400 \ No newline at end of file +------------------------------- \ No newline at end of file diff --git a/docs/api/Classes/structbarkeep_1_1_animation_config.md b/docs/api/Classes/structbarkeep_1_1_animation_config.md index b2ab864..2517280 100644 --- a/docs/api/Classes/structbarkeep_1_1_animation_config.md +++ b/docs/api/Classes/structbarkeep_1_1_animation_config.md @@ -12,19 +12,19 @@ | | Name | | -------------- | -------------- | -| std::ostream * | **[out](api/Classes/structbarkeep_1_1_animation_config.md#variable-out)**
output stream | -| std::string | **[message](api/Classes/structbarkeep_1_1_animation_config.md#variable-message)**
message to display before the animation style as AnimationStyle or custom animation as a list of strings | -| std::variant< [AnimationStyle](api/Namespaces/namespacebarkeep.md#enum-animationstyle), [Strings](api/Namespaces/namespacebarkeep.md#using-strings) > | **[style](api/Classes/structbarkeep_1_1_animation_config.md#variable-style)** | -| std::variant< [Duration](api/Namespaces/namespacebarkeep.md#using-duration), double > | **[interval](api/Classes/structbarkeep_1_1_animation_config.md#variable-interval)**
interval in which the animation is refreshed | -| bool | **[no_tty](api/Classes/structbarkeep_1_1_animation_config.md#variable-no_tty)**
no-tty mode if true (no \r, slower default refresh) | -| bool | **[show](api/Classes/structbarkeep_1_1_animation_config.md#variable-show)**
show the animation immediately after construction | +| std::ostream * | **[out](api/Classes/structbarkeep_1_1_animation_config.md#variable-out)**
output stream | +| std::string | **[message](api/Classes/structbarkeep_1_1_animation_config.md#variable-message)**
message to display before the animation | +| std::variant< [AnimationStyle](api/Namespaces/namespacebarkeep.md#enum-animationstyle), [Strings](api/Namespaces/namespacebarkeep.md#using-strings) > | **[style](api/Classes/structbarkeep_1_1_animation_config.md#variable-style)**
style as AnimationStyle or custom animation as a list of strings | +| std::variant< [Duration](api/Namespaces/namespacebarkeep.md#using-duration), double > | **[interval](api/Classes/structbarkeep_1_1_animation_config.md#variable-interval)**
interval in which the animation is refreshed | +| bool | **[no_tty](api/Classes/structbarkeep_1_1_animation_config.md#variable-no_tty)**
no-tty mode if true (no \r, slower default refresh) | +| bool | **[show](api/Classes/structbarkeep_1_1_animation_config.md#variable-show)**
show the animation immediately after construction | ## Public Attributes Documentation -### variable out +### variable `out` ```cpp std::ostream * out = &std::cout; @@ -32,22 +32,23 @@ std::ostream * out = &std::cout; output stream -### variable message +### variable `message` ```cpp std::string message = ""; ``` -message to display before the animation style as AnimationStyle or custom animation as a list of strings +message to display before the animation -### variable style +### variable `style` ```cpp std::variant< AnimationStyle, Strings > style = Ellipsis; ``` +style as AnimationStyle or custom animation as a list of strings -### variable interval +### variable `interval` ```cpp std::variant< Duration, double > interval = Duration{0.}; @@ -55,7 +56,7 @@ std::variant< Duration, double > interval = Duration{0.}; interval in which the animation is refreshed -### variable no_tty +### variable `no_tty` ```cpp bool no_tty = false; @@ -63,7 +64,7 @@ bool no_tty = false; no-tty mode if true (no \r, slower default refresh) -### variable show +### variable `show` ```cpp bool show = true; @@ -71,6 +72,4 @@ bool show = true; show the animation immediately after construction -------------------------------- - -Updated on 2024-03-28 at 22:58:08 -0400 \ No newline at end of file +------------------------------- \ No newline at end of file diff --git a/docs/api/Classes/structbarkeep_1_1_atomic_traits.md b/docs/api/Classes/structbarkeep_1_1_atomic_traits.md index 0ba64e2..5c8f8b5 100644 --- a/docs/api/Classes/structbarkeep_1_1_atomic_traits.md +++ b/docs/api/Classes/structbarkeep_1_1_atomic_traits.md @@ -12,7 +12,7 @@ Trait class to extract underlying value type from numerics and std::atomics of n | | Name | | -------------- | -------------- | -| using T | **[value_type](api/Classes/structbarkeep_1_1_atomic_traits.md#using-value_type)** | +| using T | **[value_type](api/Classes/structbarkeep_1_1_atomic_traits.md#using-value_type)** | @@ -27,13 +27,11 @@ struct barkeep::AtomicTraits; Trait class to extract underlying value type from numerics and std::atomics of numerics. ## Public Types Documentation -### using value_type +### using `value_type` ```cpp using barkeep::AtomicTraits< T >::value_type = T; ``` -------------------------------- - -Updated on 2024-03-28 at 22:58:08 -0400 \ No newline at end of file +------------------------------- \ No newline at end of file diff --git a/docs/api/Classes/structbarkeep_1_1_atomic_traits_3_01std_1_1atomic_3_01_t_01_4_01_4.md b/docs/api/Classes/structbarkeep_1_1_atomic_traits_3_01std_1_1atomic_3_01_t_01_4_01_4.md index d9a7f27..e687a97 100644 --- a/docs/api/Classes/structbarkeep_1_1_atomic_traits_3_01std_1_1atomic_3_01_t_01_4_01_4.md +++ b/docs/api/Classes/structbarkeep_1_1_atomic_traits_3_01std_1_1atomic_3_01_t_01_4_01_4.md @@ -12,7 +12,7 @@ | | Name | | -------------- | -------------- | -| using T | **[value_type](api/Classes/structbarkeep_1_1_atomic_traits_3_01std_1_1atomic_3_01_t_01_4_01_4.md#using-value_type)** | +| using T | **[value_type](api/Classes/structbarkeep_1_1_atomic_traits_3_01std_1_1atomic_3_01_t_01_4_01_4.md#using-value_type)** | @@ -26,13 +26,11 @@ struct barkeep::AtomicTraits< std::atomic< T > >; ## Public Types Documentation -### using value_type +### using `value_type` ```cpp using barkeep::AtomicTraits< std::atomic< T > >::value_type = T; ``` -------------------------------- - -Updated on 2024-03-28 at 22:58:08 -0400 \ No newline at end of file +------------------------------- \ No newline at end of file diff --git a/docs/api/Classes/structbarkeep_1_1_bar_parts.md b/docs/api/Classes/structbarkeep_1_1_bar_parts.md index be70fe2..771b8c1 100644 --- a/docs/api/Classes/structbarkeep_1_1_bar_parts.md +++ b/docs/api/Classes/structbarkeep_1_1_bar_parts.md @@ -12,124 +12,122 @@ | | Name | | -------------- | -------------- | -| std::string | **[left](api/Classes/structbarkeep_1_1_bar_parts.md#variable-left)** | -| std::string | **[right](api/Classes/structbarkeep_1_1_bar_parts.md#variable-right)** | -| [Strings](api/Namespaces/namespacebarkeep.md#using-strings) | **[fill](api/Classes/structbarkeep_1_1_bar_parts.md#variable-fill)** | -| [Strings](api/Namespaces/namespacebarkeep.md#using-strings) | **[empty](api/Classes/structbarkeep_1_1_bar_parts.md#variable-empty)** | -| std::string | **[incomplete_left_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-incomplete_left_modifier)** | -| std::string | **[complete_left_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-complete_left_modifier)** | -| std::string | **[middle_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-middle_modifier)** | -| std::string | **[right_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-right_modifier)** | -| std::string | **[percent_left_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-percent_left_modifier)** | -| std::string | **[percent_right_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-percent_right_modifier)** | -| std::string | **[value_left_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-value_left_modifier)** | -| std::string | **[value_right_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-value_right_modifier)** | -| std::string | **[speed_left_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-speed_left_modifier)** | -| std::string | **[speed_right_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-speed_right_modifier)** | +| std::string | **[left](api/Classes/structbarkeep_1_1_bar_parts.md#variable-left)** | +| std::string | **[right](api/Classes/structbarkeep_1_1_bar_parts.md#variable-right)** | +| [Strings](api/Namespaces/namespacebarkeep.md#using-strings) | **[fill](api/Classes/structbarkeep_1_1_bar_parts.md#variable-fill)** | +| [Strings](api/Namespaces/namespacebarkeep.md#using-strings) | **[empty](api/Classes/structbarkeep_1_1_bar_parts.md#variable-empty)** | +| std::string | **[incomplete_left_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-incomplete_left_modifier)** | +| std::string | **[complete_left_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-complete_left_modifier)** | +| std::string | **[middle_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-middle_modifier)** | +| std::string | **[right_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-right_modifier)** | +| std::string | **[percent_left_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-percent_left_modifier)** | +| std::string | **[percent_right_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-percent_right_modifier)** | +| std::string | **[value_left_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-value_left_modifier)** | +| std::string | **[value_right_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-value_right_modifier)** | +| std::string | **[speed_left_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-speed_left_modifier)** | +| std::string | **[speed_right_modifier](api/Classes/structbarkeep_1_1_bar_parts.md#variable-speed_right_modifier)** | ## Public Attributes Documentation -### variable left +### variable `left` ```cpp std::string left; ``` -### variable right +### variable `right` ```cpp std::string right; ``` -### variable fill +### variable `fill` ```cpp Strings fill; ``` -### variable empty +### variable `empty` ```cpp Strings empty; ``` -### variable incomplete_left_modifier +### variable `incomplete_left_modifier` ```cpp std::string incomplete_left_modifier = ""; ``` -### variable complete_left_modifier +### variable `complete_left_modifier` ```cpp std::string complete_left_modifier = ""; ``` -### variable middle_modifier +### variable `middle_modifier` ```cpp std::string middle_modifier = ""; ``` -### variable right_modifier +### variable `right_modifier` ```cpp std::string right_modifier = ""; ``` -### variable percent_left_modifier +### variable `percent_left_modifier` ```cpp std::string percent_left_modifier = ""; ``` -### variable percent_right_modifier +### variable `percent_right_modifier` ```cpp std::string percent_right_modifier = ""; ``` -### variable value_left_modifier +### variable `value_left_modifier` ```cpp std::string value_left_modifier = ""; ``` -### variable value_right_modifier +### variable `value_right_modifier` ```cpp std::string value_right_modifier = ""; ``` -### variable speed_left_modifier +### variable `speed_left_modifier` ```cpp std::string speed_left_modifier = ""; ``` -### variable speed_right_modifier +### variable `speed_right_modifier` ```cpp std::string speed_right_modifier = ""; ``` -------------------------------- - -Updated on 2024-03-28 at 22:58:08 -0400 \ No newline at end of file +------------------------------- \ No newline at end of file diff --git a/docs/api/Classes/structbarkeep_1_1_counter_config.md b/docs/api/Classes/structbarkeep_1_1_counter_config.md index bab88f9..c4322c1 100644 --- a/docs/api/Classes/structbarkeep_1_1_counter_config.md +++ b/docs/api/Classes/structbarkeep_1_1_counter_config.md @@ -12,21 +12,21 @@ | | Name | | -------------- | -------------- | -| std::ostream * | **[out](api/Classes/structbarkeep_1_1_counter_config.md#variable-out)**
output stream | -| std::string | **[format](api/Classes/structbarkeep_1_1_counter_config.md#variable-format)**
format string to format entire counter | -| std::string | **[message](api/Classes/structbarkeep_1_1_counter_config.md#variable-message)**
message to display with the counter | -| std::optional< double > | **[speed](api/Classes/structbarkeep_1_1_counter_config.md#variable-speed)**
Speed discount factor in [0, 1] to use in computing the speed. Previous increments are weighted by (1-speed). If speed is 0, all increments are weighed equally. If speed is 1, only the most recent increment is considered. If speed is `std::nullopt`, speed is not computed. | -| std::string | **[speed_unit](api/Classes/structbarkeep_1_1_counter_config.md#variable-speed_unit)**
unit of speed text next to speed interval in which the counter is refreshed | -| std::variant< [Duration](api/Namespaces/namespacebarkeep.md#using-duration), double > | **[interval](api/Classes/structbarkeep_1_1_counter_config.md#variable-interval)** | -| bool | **[no_tty](api/Classes/structbarkeep_1_1_counter_config.md#variable-no_tty)**
no-tty mode if true (no \r, slower default refresh) | -| bool | **[show](api/Classes/structbarkeep_1_1_counter_config.md#variable-show)**
show the counter immediately after construction | +| std::ostream * | **[out](api/Classes/structbarkeep_1_1_counter_config.md#variable-out)**
output stream | +| std::string | **[format](api/Classes/structbarkeep_1_1_counter_config.md#variable-format)**
format string to format entire counter | +| std::string | **[message](api/Classes/structbarkeep_1_1_counter_config.md#variable-message)**
message to display with the counter | +| std::optional< double > | **[speed](api/Classes/structbarkeep_1_1_counter_config.md#variable-speed)**
Speed discount factor in [0, 1] to use in computing the speed. Previous increments are weighted by (1-speed). If speed is 0, all increments are weighed equally. If speed is 1, only the most recent increment is considered. If speed is `std::nullopt`, speed is not computed. | +| std::string | **[speed_unit](api/Classes/structbarkeep_1_1_counter_config.md#variable-speed_unit)**
unit of speed text next to speed | +| std::variant< [Duration](api/Namespaces/namespacebarkeep.md#using-duration), double > | **[interval](api/Classes/structbarkeep_1_1_counter_config.md#variable-interval)**
interval in which the counter is refreshed | +| bool | **[no_tty](api/Classes/structbarkeep_1_1_counter_config.md#variable-no_tty)**
no-tty mode if true (no \r, slower default refresh) | +| bool | **[show](api/Classes/structbarkeep_1_1_counter_config.md#variable-show)**
show the counter immediately after construction | ## Public Attributes Documentation -### variable out +### variable `out` ```cpp std::ostream * out = &std::cout; @@ -34,7 +34,7 @@ std::ostream * out = &std::cout; output stream -### variable format +### variable `format` ```cpp std::string format = ""; @@ -42,7 +42,7 @@ std::string format = ""; format string to format entire counter -### variable message +### variable `message` ```cpp std::string message = ""; @@ -50,7 +50,7 @@ std::string message = ""; message to display with the counter -### variable speed +### variable `speed` ```cpp std::optional< double > speed = std::nullopt; @@ -58,22 +58,23 @@ std::optional< double > speed = std::nullopt; Speed discount factor in [0, 1] to use in computing the speed. Previous increments are weighted by (1-speed). If speed is 0, all increments are weighed equally. If speed is 1, only the most recent increment is considered. If speed is `std::nullopt`, speed is not computed. -### variable speed_unit +### variable `speed_unit` ```cpp std::string speed_unit = "it/s"; ``` -unit of speed text next to speed interval in which the counter is refreshed +unit of speed text next to speed -### variable interval +### variable `interval` ```cpp std::variant< Duration, double > interval = Duration{0.}; ``` +interval in which the counter is refreshed -### variable no_tty +### variable `no_tty` ```cpp bool no_tty = false; @@ -81,7 +82,7 @@ bool no_tty = false; no-tty mode if true (no \r, slower default refresh) -### variable show +### variable `show` ```cpp bool show = true; @@ -89,6 +90,4 @@ bool show = true; show the counter immediately after construction -------------------------------- - -Updated on 2024-03-28 at 22:58:08 -0400 \ No newline at end of file +------------------------------- \ No newline at end of file diff --git a/docs/api/Classes/structbarkeep_1_1_iterable_bar_config.md b/docs/api/Classes/structbarkeep_1_1_iterable_bar_config.md index 83e4378..d810c08 100644 --- a/docs/api/Classes/structbarkeep_1_1_iterable_bar_config.md +++ b/docs/api/Classes/structbarkeep_1_1_iterable_bar_config.md @@ -12,14 +12,14 @@ | | Name | | -------------- | -------------- | -| std::ostream * | **[out](api/Classes/structbarkeep_1_1_iterable_bar_config.md#variable-out)**
output stream | -| std::string | **[format](api/Classes/structbarkeep_1_1_iterable_bar_config.md#variable-format)**
format string for the entire progress bar | -| std::string | **[message](api/Classes/structbarkeep_1_1_iterable_bar_config.md#variable-message)**
message to display with the bar | -| std::optional< double > | **[speed](api/Classes/structbarkeep_1_1_iterable_bar_config.md#variable-speed)**
Speed discount factor in [0, 1] to use in computing the speed. Previous increments are weighted by (1-speed). If speed is 0, all increments are weighed equally. If speed is 1, only the most recent increment is considered. If speed is `std::nullopt`, speed is not computed. | -| std::string | **[speed_unit](api/Classes/structbarkeep_1_1_iterable_bar_config.md#variable-speed_unit)**
unit of speed text next to speed | -| [ProgressBarStyle](api/Namespaces/namespacebarkeep.md#enum-progressbarstyle) | **[style](api/Classes/structbarkeep_1_1_iterable_bar_config.md#variable-style)**
style of progress bar interval in which the progress bar is refreshed | -| std::variant< [Duration](api/Namespaces/namespacebarkeep.md#using-duration), double > | **[interval](api/Classes/structbarkeep_1_1_iterable_bar_config.md#variable-interval)** | -| bool | **[no_tty](api/Classes/structbarkeep_1_1_iterable_bar_config.md#variable-no_tty)**
no-tty mode if true (no \r, slower default refresh) | +| std::ostream * | **[out](api/Classes/structbarkeep_1_1_iterable_bar_config.md#variable-out)**
output stream | +| std::string | **[format](api/Classes/structbarkeep_1_1_iterable_bar_config.md#variable-format)**
format string for the entire progress bar | +| std::string | **[message](api/Classes/structbarkeep_1_1_iterable_bar_config.md#variable-message)**
message to display with the bar | +| std::optional< double > | **[speed](api/Classes/structbarkeep_1_1_iterable_bar_config.md#variable-speed)**
Speed discount factor in [0, 1] to use in computing the speed. Previous increments are weighted by (1-speed). If speed is 0, all increments are weighed equally. If speed is 1, only the most recent increment is considered. If speed is `std::nullopt`, speed is not computed. | +| std::string | **[speed_unit](api/Classes/structbarkeep_1_1_iterable_bar_config.md#variable-speed_unit)**
unit of speed text next to speed | +| [ProgressBarStyle](api/Namespaces/namespacebarkeep.md#enum-progressbarstyle) | **[style](api/Classes/structbarkeep_1_1_iterable_bar_config.md#variable-style)**
style of progress bar | +| std::variant< [Duration](api/Namespaces/namespacebarkeep.md#using-duration), double > | **[interval](api/Classes/structbarkeep_1_1_iterable_bar_config.md#variable-interval)**
interval in which the progress bar is refreshed | +| bool | **[no_tty](api/Classes/structbarkeep_1_1_iterable_bar_config.md#variable-no_tty)**
no-tty mode if true (no \r, slower default refresh) | @@ -33,7 +33,7 @@ struct barkeep::IterableBarConfig; ## Public Attributes Documentation -### variable out +### variable `out` ```cpp std::ostream * out = &std::cout; @@ -41,7 +41,7 @@ std::ostream * out = &std::cout; output stream -### variable format +### variable `format` ```cpp std::string format = ""; @@ -49,7 +49,7 @@ std::string format = ""; format string for the entire progress bar -### variable message +### variable `message` ```cpp std::string message = ""; @@ -57,7 +57,7 @@ std::string message = ""; message to display with the bar -### variable speed +### variable `speed` ```cpp std::optional< double > speed = std::nullopt; @@ -65,7 +65,7 @@ std::optional< double > speed = std::nullopt; Speed discount factor in [0, 1] to use in computing the speed. Previous increments are weighted by (1-speed). If speed is 0, all increments are weighed equally. If speed is 1, only the most recent increment is considered. If speed is `std::nullopt`, speed is not computed. -### variable speed_unit +### variable `speed_unit` ```cpp std::string speed_unit = "it/s"; @@ -73,22 +73,23 @@ std::string speed_unit = "it/s"; unit of speed text next to speed -### variable style +### variable `style` ```cpp ProgressBarStyle style = Blocks; ``` -style of progress bar interval in which the progress bar is refreshed +style of progress bar -### variable interval +### variable `interval` ```cpp std::variant< Duration, double > interval = Duration{0.}; ``` +interval in which the progress bar is refreshed -### variable no_tty +### variable `no_tty` ```cpp bool no_tty = false; @@ -96,6 +97,4 @@ bool no_tty = false; no-tty mode if true (no \r, slower default refresh) -------------------------------- - -Updated on 2024-03-28 at 22:58:08 -0400 \ No newline at end of file +------------------------------- \ No newline at end of file diff --git a/docs/api/Classes/structbarkeep_1_1_progress_bar_config.md b/docs/api/Classes/structbarkeep_1_1_progress_bar_config.md index d4fb1fe..4a85269 100644 --- a/docs/api/Classes/structbarkeep_1_1_progress_bar_config.md +++ b/docs/api/Classes/structbarkeep_1_1_progress_bar_config.md @@ -12,16 +12,16 @@ | | Name | | -------------- | -------------- | -| std::ostream * | **[out](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-out)**
output stream | -| ValueType | **[total](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-total)**
total amount of work for a full bar | -| std::string | **[format](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-format)**
format string for the entire progress bar | -| std::string | **[message](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-message)**
message to display with the bar | -| std::optional< double > | **[speed](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-speed)**
Speed discount factor in [0, 1] to use in computing the speed. Previous increments are weighted by (1-speed). If speed is 0, all increments are weighed equally. If speed is 1, only the most recent increment is considered. If speed is `std::nullopt`, speed is not computed. | -| std::string | **[speed_unit](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-speed_unit)**
unit of speed text next to speed progress bar style, or custom style as [BarParts](api/Classes/structbarkeep_1_1_bar_parts.md) | -| std::variant< [ProgressBarStyle](api/Namespaces/namespacebarkeep.md#enum-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](api/Namespaces/namespacebarkeep.md#using-duration), double > | **[interval](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-interval)**
interval in which the progress bar is refreshed | -| bool | **[no_tty](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-no_tty)**
no-tty mode if true (no \r, slower default refresh) | -| bool | **[show](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-show)**
show the progress bar immediately after construction | +| std::ostream * | **[out](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-out)**
output stream | +| ValueType | **[total](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-total)**
total amount of work for a full bar | +| std::string | **[format](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-format)**
format string for the entire progress bar | +| std::string | **[message](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-message)**
message to display with the bar | +| std::optional< double > | **[speed](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-speed)**
Speed discount factor in [0, 1] to use in computing the speed. Previous increments are weighted by (1-speed). If speed is 0, all increments are weighed equally. If speed is 1, only the most recent increment is considered. If speed is `std::nullopt`, speed is not computed. | +| std::string | **[speed_unit](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-speed_unit)**
unit of speed text next to speed | +| std::variant< [ProgressBarStyle](api/Namespaces/namespacebarkeep.md#enum-progressbarstyle), [BarParts](api/Classes/structbarkeep_1_1_bar_parts.md) > | **[style](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-style)**
progress bar style, or custom style as [BarParts](api/Classes/structbarkeep_1_1_bar_parts.md) | +| std::variant< [Duration](api/Namespaces/namespacebarkeep.md#using-duration), double > | **[interval](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-interval)**
interval in which the progress bar is refreshed | +| bool | **[no_tty](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-no_tty)**
no-tty mode if true (no \r, slower default refresh) | +| bool | **[show](api/Classes/structbarkeep_1_1_progress_bar_config.md#variable-show)**
show the progress bar immediately after construction | @@ -35,7 +35,7 @@ struct barkeep::ProgressBarConfig; ## Public Attributes Documentation -### variable out +### variable `out` ```cpp std::ostream * out = &std::cout; @@ -43,7 +43,7 @@ std::ostream * out = &std::cout; output stream -### variable total +### variable `total` ```cpp ValueType total = 100; @@ -51,7 +51,7 @@ ValueType total = 100; total amount of work for a full bar -### variable format +### variable `format` ```cpp std::string format = ""; @@ -59,7 +59,7 @@ std::string format = ""; format string for the entire progress bar -### variable message +### variable `message` ```cpp std::string message = ""; @@ -67,7 +67,7 @@ std::string message = ""; message to display with the bar -### variable speed +### variable `speed` ```cpp std::optional< double > speed = std::nullopt; @@ -75,22 +75,23 @@ std::optional< double > speed = std::nullopt; Speed discount factor in [0, 1] to use in computing the speed. Previous increments are weighted by (1-speed). If speed is 0, all increments are weighed equally. If speed is 1, only the most recent increment is considered. If speed is `std::nullopt`, speed is not computed. -### variable speed_unit +### variable `speed_unit` ```cpp std::string speed_unit = "it/s"; ``` -unit of speed text next to speed progress bar style, or custom style as [BarParts](api/Classes/structbarkeep_1_1_bar_parts.md) +unit of speed text next to speed -### variable style +### variable `style` ```cpp std::variant< ProgressBarStyle, BarParts > style = Blocks; ``` +progress bar style, or custom style as [BarParts](api/Classes/structbarkeep_1_1_bar_parts.md) -### variable interval +### variable `interval` ```cpp std::variant< Duration, double > interval = Duration{0.}; @@ -98,7 +99,7 @@ std::variant< Duration, double > interval = Duration{0.}; interval in which the progress bar is refreshed -### variable no_tty +### variable `no_tty` ```cpp bool no_tty = false; @@ -106,7 +107,7 @@ bool no_tty = false; no-tty mode if true (no \r, slower default refresh) -### variable show +### variable `show` ```cpp bool show = true; @@ -114,6 +115,4 @@ bool show = true; show the progress bar immediately after construction -------------------------------- - -Updated on 2024-03-28 at 22:58:08 -0400 \ No newline at end of file +------------------------------- \ No newline at end of file diff --git a/docs/api/Namespaces/README.md b/docs/api/Namespaces/README.md deleted file mode 100644 index 8420abc..0000000 --- a/docs/api/Namespaces/README.md +++ /dev/null @@ -1,264 +0,0 @@ -# barkeep - - -## Classes - - - -| | Name | -| -------------- | -------------- | -| class | **[barkeep::Animation](api/Classes/classbarkeep_1_1_animation.md)**
Displays a simple animation with a message. | -| struct | **[barkeep::AnimationConfig](api/Classes/structbarkeep_1_1_animation_config.md)**
[Animation](api/Classes/classbarkeep_1_1_animation.md) parameters. | -| class | **[barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)**
Base class to handle all asynchronous displays. | -| struct | **[barkeep::AtomicTraits](api/Classes/structbarkeep_1_1_atomic_traits.md)**
Trait class to extract underlying value type from numerics and std::atomics of numerics. | -| struct | **[barkeep::AtomicTraits< std::atomic< T > >](api/Classes/structbarkeep_1_1_atomic_traits_3_01std_1_1atomic_3_01_t_01_4_01_4.md)** | -| struct | **[barkeep::BarParts](api/Classes/structbarkeep_1_1_bar_parts.md)** | -| class | **[barkeep::Composite](api/Classes/classbarkeep_1_1_composite.md)**
Creates a composite display out of two display that shows them side by side. For instance, you can combine two [Counter](api/Classes/classbarkeep_1_1_counter.md) objects to monitor two variables. | -| class | **[barkeep::Counter](api/Classes/classbarkeep_1_1_counter.md)**
Monitors and displays a single numeric variable. | -| struct | **[barkeep::CounterConfig](api/Classes/structbarkeep_1_1_counter_config.md)**
[Counter](api/Classes/classbarkeep_1_1_counter.md) parameters. | -| class | **[barkeep::IterableBar](api/Classes/classbarkeep_1_1_iterable_bar.md)**
A progress bar that can be used with range-based for loops, that automatically tracks the progress of the loop. | -| struct | **[barkeep::IterableBarConfig](api/Classes/structbarkeep_1_1_iterable_bar_config.md)** | -| class | **[barkeep::ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md)**
Displays a progress bar, by comparing the progress value being monitored to a given total value. Optionally reports speed. | -| struct | **[barkeep::ProgressBarConfig](api/Classes/structbarkeep_1_1_progress_bar_config.md)** | -| class | **[barkeep::Speedometer](api/Classes/classbarkeep_1_1_speedometer.md)**
Helper class to measure and display speed of progress. | - - - - -## Types - - - -| | Name | -| -------------- | -------------- | -| enum unsigned short | **[AnimationStyle](api/Namespaces/namespacebarkeep.md#enum-animationstyle)** { Ellipsis, Clock, Moon, Earth, Bar, Square}
Kind of animation being displayed for [Animation](api/Classes/classbarkeep_1_1_animation.md). | -| enum unsigned short | **[ProgressBarStyle](api/Namespaces/namespacebarkeep.md#enum-progressbarstyle)** { Bars, Blocks, Arrow, Pip}
Kind of bar being displayed for [ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md). | -| using std::vector< std::string > | **[Strings](api/Namespaces/namespacebarkeep.md#using-strings)** | -| using std::vector< [Strings](api/Namespaces/namespacebarkeep.md#using-strings) > | **[StringsList](api/Namespaces/namespacebarkeep.md#using-stringslist)** | -| using std::chrono::duration< double, std::ratio< 1 > > | **[Duration](api/Namespaces/namespacebarkeep.md#using-duration)** | -| template
using typename [AtomicTraits](api/Classes/structbarkeep_1_1_atomic_traits.md)< T >::value_type | **[value_t](api/Namespaces/namespacebarkeep.md#using-value_t)** | -| template
using typename std::conditional_t< std::is_integral_v< T >, std::make_signed< T >, std::common_type< T > >::type | **[signed_t](api/Namespaces/namespacebarkeep.md#using-signed_t)** | - - - - -## Functions - - - -| | Name | -| -------------- | -------------- | -| [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[as_duration](api/Namespaces/namespacebarkeep.md#function-as_duration)**(std::variant< [Duration](api/Namespaces/namespacebarkeep.md#using-duration), double > interval) | -| auto | **[operator\|](api/Namespaces/namespacebarkeep.md#function-operator\|)**(const [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) & left, const [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) & right)
Pipe operator can be used to combine two displays into a [Composite](api/Classes/classbarkeep_1_1_composite.md). | - - - - -## Attributes - - - -| | Name | -| -------------- | -------------- | -| const [StringsList](api/Namespaces/namespacebarkeep.md#using-stringslist) | **[animation_stills_](api/Namespaces/namespacebarkeep.md#variable-animation_stills_)**
Definitions of various stills for [Animation](api/Classes/classbarkeep_1_1_animation.md). AnimationStyle indexes into this. | -| const std::string | **[red](api/Namespaces/namespacebarkeep.md#variable-red)** | -| const std::string | **[green](api/Namespaces/namespacebarkeep.md#variable-green)** | -| const std::string | **[yellow](api/Namespaces/namespacebarkeep.md#variable-yellow)** | -| const std::string | **[blue](api/Namespaces/namespacebarkeep.md#variable-blue)** | -| const std::string | **[magenta](api/Namespaces/namespacebarkeep.md#variable-magenta)** | -| const std::string | **[cyan](api/Namespaces/namespacebarkeep.md#variable-cyan)** | -| const std::string | **[reset](api/Namespaces/namespacebarkeep.md#variable-reset)** | -| const std::vector< [BarParts](api/Classes/structbarkeep_1_1_bar_parts.md) > | **[progress_bar_parts_](api/Namespaces/namespacebarkeep.md#variable-progress_bar_parts_)**
Definitions of various partial bars for [ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md). ProgressBarStyle indexes into this. | - -## Types Documentation - -### enum AnimationStyle - -| Enumerator | Value | Description | -| ---------- | ----- | ----------- | -| Ellipsis | | | -| Clock | | | -| Moon | | | -| Earth | | | -| Bar | | | -| Square | | | - - - -Kind of animation being displayed for [Animation](api/Classes/classbarkeep_1_1_animation.md). - -### enum ProgressBarStyle - -| Enumerator | Value | Description | -| ---------- | ----- | ----------- | -| Bars | | | -| Blocks | | | -| Arrow | | | -| Pip | | | - - - -Kind of bar being displayed for [ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md). - -### using Strings - -```cpp -using barkeep::Strings = std::vector; -``` - - -### using StringsList - -```cpp -using barkeep::StringsList = std::vector; -``` - - -### using Duration - -```cpp -using barkeep::Duration = std::chrono::duration>; -``` - - -### using value_t - -```cpp -template -using barkeep::value_t = typename AtomicTraits::value_type; -``` - - -### using signed_t - -```cpp -template -using barkeep::signed_t = typename std::conditional_t, - std::make_signed, - std::common_type>::type; -``` - - - -## Functions Documentation - -### function as_duration - -```cpp -Duration as_duration( - std::variant< Duration, double > interval -) -``` - - -### function operator\| - -```cpp -auto operator\|( - const AsyncDisplay & left, - const AsyncDisplay & right -) -``` - -Pipe operator can be used to combine two displays into a [Composite](api/Classes/classbarkeep_1_1_composite.md). - - -## Attributes Documentation - -### variable animation_stills_ - -```cpp -static const StringsList animation_stills_ { - {". ", ".. ", "..."}, - {"🕐", "🕜", "🕑", "🕝", "🕒", "🕞", "🕓", "🕟", "🕔", "🕠", "🕕", "🕡", - "🕖", "🕢", "🕗", "🕣", "🕘", "🕤", "🕙", "🕥", "🕚", "🕦", "🕛", "🕧"}, - {"🌕", "🌖", "🌗", "🌘", "🌑", "🌒", "🌓", "🌔"}, - {"🌎", "🌍", "🌏"}, - {"-", "/", "|", "\\"}, - {"▖", "▘", "▝", "▗"}, -}; -``` - -Definitions of various stills for [Animation](api/Classes/classbarkeep_1_1_animation.md). AnimationStyle indexes into this. - -### variable red - -```cpp -static const std::string red = "\033[31m"; -``` - - -### variable green - -```cpp -static const std::string green = "\033[32m"; -``` - - -### variable yellow - -```cpp -static const std::string yellow = "\033[33m"; -``` - - -### variable blue - -```cpp -static const std::string blue = "\033[34m"; -``` - - -### variable magenta - -```cpp -static const std::string magenta = "\033[35m"; -``` - - -### variable cyan - -```cpp -static const std::string cyan = "\033[36m"; -``` - - -### variable reset - -```cpp -static const std::string reset = "\033[0m"; -``` - - -### variable progress_bar_parts_ - -```cpp -static const std::vector< BarParts > progress_bar_parts_ { - {"|", "|", {"|"}, {" "}}, - {"|", "|", {"▏", "▎", "▍", "▌", "▋", "▊", "▉", "█"}, {" "}}, - {"|", "|", {">", "="}, {" "}}, - {"", - "", - {"╸", "━"}, - {"╺", "━"}, - "\033[38;2;249;38;114m", - "\033[38;2;114;156;31m", - "\033[38;5;237m", - reset, - cyan, - reset, - green, - reset, - red, - reset}, -}; -``` - -Definitions of various partial bars for [ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md). ProgressBarStyle indexes into this. - - - - -------------------------------- - -Updated on 2024-03-28 at 22:58:08 -0400 \ No newline at end of file diff --git a/docs/api/Namespaces/namespacebarkeep.md b/docs/api/Namespaces/namespacebarkeep.md index 8420abc..10cd240 100644 --- a/docs/api/Namespaces/namespacebarkeep.md +++ b/docs/api/Namespaces/namespacebarkeep.md @@ -7,20 +7,20 @@ | | Name | | -------------- | -------------- | -| class | **[barkeep::Animation](api/Classes/classbarkeep_1_1_animation.md)**
Displays a simple animation with a message. | -| struct | **[barkeep::AnimationConfig](api/Classes/structbarkeep_1_1_animation_config.md)**
[Animation](api/Classes/classbarkeep_1_1_animation.md) parameters. | -| class | **[barkeep::AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md)**
Base class to handle all asynchronous displays. | -| struct | **[barkeep::AtomicTraits](api/Classes/structbarkeep_1_1_atomic_traits.md)**
Trait class to extract underlying value type from numerics and std::atomics of numerics. | -| struct | **[barkeep::AtomicTraits< std::atomic< T > >](api/Classes/structbarkeep_1_1_atomic_traits_3_01std_1_1atomic_3_01_t_01_4_01_4.md)** | -| struct | **[barkeep::BarParts](api/Classes/structbarkeep_1_1_bar_parts.md)** | -| class | **[barkeep::Composite](api/Classes/classbarkeep_1_1_composite.md)**
Creates a composite display out of two display that shows them side by side. For instance, you can combine two [Counter](api/Classes/classbarkeep_1_1_counter.md) objects to monitor two variables. | -| class | **[barkeep::Counter](api/Classes/classbarkeep_1_1_counter.md)**
Monitors and displays a single numeric variable. | -| struct | **[barkeep::CounterConfig](api/Classes/structbarkeep_1_1_counter_config.md)**
[Counter](api/Classes/classbarkeep_1_1_counter.md) parameters. | -| class | **[barkeep::IterableBar](api/Classes/classbarkeep_1_1_iterable_bar.md)**
A progress bar that can be used with range-based for loops, that automatically tracks the progress of the loop. | -| struct | **[barkeep::IterableBarConfig](api/Classes/structbarkeep_1_1_iterable_bar_config.md)** | -| class | **[barkeep::ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md)**
Displays a progress bar, by comparing the progress value being monitored to a given total value. Optionally reports speed. | -| struct | **[barkeep::ProgressBarConfig](api/Classes/structbarkeep_1_1_progress_bar_config.md)** | -| class | **[barkeep::Speedometer](api/Classes/classbarkeep_1_1_speedometer.md)**
Helper class to measure and display speed of progress. | +| class | **[ barkeep::Animation ](api/Classes/classbarkeep_1_1_animation.md)**
Displays a simple animation with a message. | +| struct | **[ barkeep::AnimationConfig ](api/Classes/structbarkeep_1_1_animation_config.md)**
[Animation](api/Classes/classbarkeep_1_1_animation.md) parameters. | +| class | **[ barkeep::AsyncDisplay ](api/Classes/classbarkeep_1_1_async_display.md)**
Base class to handle all asynchronous displays. | +| struct | **[ barkeep::AtomicTraits ](api/Classes/structbarkeep_1_1_atomic_traits.md)**
Trait class to extract underlying value type from numerics and std::atomics of numerics. | +| struct | **[ barkeep::AtomicTraits< std::atomic< T > > ](api/Classes/structbarkeep_1_1_atomic_traits_3_01std_1_1atomic_3_01_t_01_4_01_4.md)** | +| struct | **[ barkeep::BarParts ](api/Classes/structbarkeep_1_1_bar_parts.md)** | +| class | **[ barkeep::Composite ](api/Classes/classbarkeep_1_1_composite.md)**
Creates a composite display out of two display that shows them side by side. For instance, you can combine two [Counter](api/Classes/classbarkeep_1_1_counter.md) objects to monitor two variables. | +| class | **[ barkeep::Counter ](api/Classes/classbarkeep_1_1_counter.md)**
Monitors and displays a single numeric variable. | +| struct | **[ barkeep::CounterConfig ](api/Classes/structbarkeep_1_1_counter_config.md)**
[Counter](api/Classes/classbarkeep_1_1_counter.md) parameters. | +| class | **[ barkeep::IterableBar ](api/Classes/classbarkeep_1_1_iterable_bar.md)**
A progress bar that can be used with range-based for loops, that automatically tracks the progress of the loop. | +| struct | **[ barkeep::IterableBarConfig ](api/Classes/structbarkeep_1_1_iterable_bar_config.md)** | +| class | **[ barkeep::ProgressBar ](api/Classes/classbarkeep_1_1_progress_bar.md)**
Displays a progress bar, by comparing the progress value being monitored to a given total value. Optionally reports speed. | +| struct | **[ barkeep::ProgressBarConfig ](api/Classes/structbarkeep_1_1_progress_bar_config.md)** | +| class | **[ barkeep::Speedometer ](api/Classes/classbarkeep_1_1_speedometer.md)**
Helper class to measure and display speed of progress. | @@ -31,13 +31,13 @@ | | Name | | -------------- | -------------- | -| enum unsigned short | **[AnimationStyle](api/Namespaces/namespacebarkeep.md#enum-animationstyle)** { Ellipsis, Clock, Moon, Earth, Bar, Square}
Kind of animation being displayed for [Animation](api/Classes/classbarkeep_1_1_animation.md). | -| enum unsigned short | **[ProgressBarStyle](api/Namespaces/namespacebarkeep.md#enum-progressbarstyle)** { Bars, Blocks, Arrow, Pip}
Kind of bar being displayed for [ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md). | -| using std::vector< std::string > | **[Strings](api/Namespaces/namespacebarkeep.md#using-strings)** | -| using std::vector< [Strings](api/Namespaces/namespacebarkeep.md#using-strings) > | **[StringsList](api/Namespaces/namespacebarkeep.md#using-stringslist)** | -| using std::chrono::duration< double, std::ratio< 1 > > | **[Duration](api/Namespaces/namespacebarkeep.md#using-duration)** | -| template
using typename [AtomicTraits](api/Classes/structbarkeep_1_1_atomic_traits.md)< T >::value_type | **[value_t](api/Namespaces/namespacebarkeep.md#using-value_t)** | -| template
using typename std::conditional_t< std::is_integral_v< T >, std::make_signed< T >, std::common_type< T > >::type | **[signed_t](api/Namespaces/namespacebarkeep.md#using-signed_t)** | +| enum unsigned short | **[ AnimationStyle ](api/Namespaces/namespacebarkeep.md#enum-animationstyle)** { `Ellipsis`, `Clock`, `Moon`, `Earth`, `Bar`, `Square`}
Kind of animation being displayed for [Animation](api/Classes/classbarkeep_1_1_animation.md). | +| enum unsigned short | **[ ProgressBarStyle ](api/Namespaces/namespacebarkeep.md#enum-progressbarstyle)** { `Bars`, `Blocks`, `Arrow`, `Pip`}
Kind of bar being displayed for [ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md). | +| using std::vector< std::string > | **[ Strings ](api/Namespaces/namespacebarkeep.md#using-strings)** | +| using std::vector< [Strings](api/Namespaces/namespacebarkeep.md#using-strings) > | **[ StringsList ](api/Namespaces/namespacebarkeep.md#using-stringslist)** | +| using std::chrono::duration< double, std::ratio< 1 > > | **[ Duration ](api/Namespaces/namespacebarkeep.md#using-duration)** | +| template
using typename [AtomicTraits](api/Classes/structbarkeep_1_1_atomic_traits.md)< T >::value_type | **[ value_t ](api/Namespaces/namespacebarkeep.md#using-value_t)** | +| template
using typename std::conditional_t< std::is_integral_v< T >, std::make_signed< T >, std::common_type< T > >::type | **[ signed_t ](api/Namespaces/namespacebarkeep.md#using-signed_t)** | @@ -48,8 +48,8 @@ | | Name | | -------------- | -------------- | -| [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[as_duration](api/Namespaces/namespacebarkeep.md#function-as_duration)**(std::variant< [Duration](api/Namespaces/namespacebarkeep.md#using-duration), double > interval) | -| auto | **[operator\|](api/Namespaces/namespacebarkeep.md#function-operator\|)**(const [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) & left, const [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) & right)
Pipe operator can be used to combine two displays into a [Composite](api/Classes/classbarkeep_1_1_composite.md). | +| [Duration](api/Namespaces/namespacebarkeep.md#using-duration) | **[as_duration](api/Namespaces/namespacebarkeep.md#function-as_duration)**(std::variant< [Duration](api/Namespaces/namespacebarkeep.md#using-duration), double > interval) | +| auto | **[operator\|](api/Namespaces/namespacebarkeep.md#function-operator\|)**(const [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) & left, const [AsyncDisplay](api/Classes/classbarkeep_1_1_async_display.md) & right)
Pipe operator can be used to combine two displays into a [Composite](api/Classes/classbarkeep_1_1_composite.md). | @@ -60,68 +60,68 @@ | | Name | | -------------- | -------------- | -| const [StringsList](api/Namespaces/namespacebarkeep.md#using-stringslist) | **[animation_stills_](api/Namespaces/namespacebarkeep.md#variable-animation_stills_)**
Definitions of various stills for [Animation](api/Classes/classbarkeep_1_1_animation.md). AnimationStyle indexes into this. | -| const std::string | **[red](api/Namespaces/namespacebarkeep.md#variable-red)** | -| const std::string | **[green](api/Namespaces/namespacebarkeep.md#variable-green)** | -| const std::string | **[yellow](api/Namespaces/namespacebarkeep.md#variable-yellow)** | -| const std::string | **[blue](api/Namespaces/namespacebarkeep.md#variable-blue)** | -| const std::string | **[magenta](api/Namespaces/namespacebarkeep.md#variable-magenta)** | -| const std::string | **[cyan](api/Namespaces/namespacebarkeep.md#variable-cyan)** | -| const std::string | **[reset](api/Namespaces/namespacebarkeep.md#variable-reset)** | -| const std::vector< [BarParts](api/Classes/structbarkeep_1_1_bar_parts.md) > | **[progress_bar_parts_](api/Namespaces/namespacebarkeep.md#variable-progress_bar_parts_)**
Definitions of various partial bars for [ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md). ProgressBarStyle indexes into this. | +| const [StringsList](api/Namespaces/namespacebarkeep.md#using-stringslist) | **[animation_stills_](api/Namespaces/namespacebarkeep.md#variable-animation_stills_)**
Definitions of various stills for [Animation](api/Classes/classbarkeep_1_1_animation.md). AnimationStyle indexes into this. | +| const std::string | **[red](api/Namespaces/namespacebarkeep.md#variable-red)** | +| const std::string | **[green](api/Namespaces/namespacebarkeep.md#variable-green)** | +| const std::string | **[yellow](api/Namespaces/namespacebarkeep.md#variable-yellow)** | +| const std::string | **[blue](api/Namespaces/namespacebarkeep.md#variable-blue)** | +| const std::string | **[magenta](api/Namespaces/namespacebarkeep.md#variable-magenta)** | +| const std::string | **[cyan](api/Namespaces/namespacebarkeep.md#variable-cyan)** | +| const std::string | **[reset](api/Namespaces/namespacebarkeep.md#variable-reset)** | +| const std::vector< [BarParts](api/Classes/structbarkeep_1_1_bar_parts.md) > | **[progress_bar_parts_](api/Namespaces/namespacebarkeep.md#variable-progress_bar_parts_)**
Definitions of various partial bars for [ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md). ProgressBarStyle indexes into this. | ## Types Documentation -### enum AnimationStyle +### enum AnimationStyle | Enumerator | Value | Description | | ---------- | ----- | ----------- | -| Ellipsis | | | -| Clock | | | -| Moon | | | -| Earth | | | -| Bar | | | -| Square | | | +| Ellipsis | | | +| Clock | | | +| Moon | | | +| Earth | | | +| Bar | | | +| Square | | | Kind of animation being displayed for [Animation](api/Classes/classbarkeep_1_1_animation.md). -### enum ProgressBarStyle +### enum ProgressBarStyle | Enumerator | Value | Description | | ---------- | ----- | ----------- | -| Bars | | | -| Blocks | | | -| Arrow | | | -| Pip | | | +| Bars | | | +| Blocks | | | +| Arrow | | | +| Pip | | | Kind of bar being displayed for [ProgressBar](api/Classes/classbarkeep_1_1_progress_bar.md). -### using Strings +### using Strings ```cpp using barkeep::Strings = std::vector; ``` -### using StringsList +### using StringsList ```cpp using barkeep::StringsList = std::vector; ``` -### using Duration +### using Duration ```cpp using barkeep::Duration = std::chrono::duration>; ``` -### using value_t +### using value_t ```cpp template @@ -129,7 +129,7 @@ using barkeep::value_t = typename AtomicTraits::value_type; ``` -### using signed_t +### using signed_t ```cpp template @@ -142,7 +142,7 @@ using barkeep::signed_t = typename std::conditional_t, ## Functions Documentation -### function as_duration +### function as_duration ```cpp Duration as_duration( @@ -151,7 +151,7 @@ Duration as_duration( ``` -### function operator\| +### function operator\| ```cpp auto operator\|( @@ -165,7 +165,7 @@ Pipe operator can be used to combine two displays into a [Composite](api/Classes ## Attributes Documentation -### variable animation_stills_ +### variable animation_stills_ ```cpp static const StringsList animation_stills_ { @@ -181,56 +181,56 @@ static const StringsList animation_stills_ { Definitions of various stills for [Animation](api/Classes/classbarkeep_1_1_animation.md). AnimationStyle indexes into this. -### variable red +### variable red ```cpp static const std::string red = "\033[31m"; ``` -### variable green +### variable green ```cpp static const std::string green = "\033[32m"; ``` -### variable yellow +### variable yellow ```cpp static const std::string yellow = "\033[33m"; ``` -### variable blue +### variable blue ```cpp static const std::string blue = "\033[34m"; ``` -### variable magenta +### variable magenta ```cpp static const std::string magenta = "\033[35m"; ``` -### variable cyan +### variable cyan ```cpp static const std::string cyan = "\033[36m"; ``` -### variable reset +### variable reset ```cpp static const std::string reset = "\033[0m"; ``` -### variable progress_bar_parts_ +### variable progress_bar_parts_ ```cpp static const std::vector< BarParts > progress_bar_parts_ { @@ -259,6 +259,4 @@ Definitions of various partial bars for [ProgressBar](api/Classes/classbarkeep_1 -------------------------------- - -Updated on 2024-03-28 at 22:58:08 -0400 \ No newline at end of file +------------------------------- \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 0a74717..10711aa 100644 --- a/docs/index.html +++ b/docs/index.html @@ -18,7 +18,8 @@ repo: 'https://github.com/oir/barkeep/', loadSidebar: true, executeScript: true, - subMaxLevel: 2, + subMaxLevel: 3, + sidebarDisplayLevel: 1, search: { maxAge: 86400000, // Expiration time, the default one day //maxAge: 1, @@ -43,6 +44,9 @@ + + + @@ -70,6 +74,11 @@ --heading-h1-font-weight : 900; --heading-h2-font-weight : 900; } + .codey { + font-family: var(--code-font-family); + font-size: 0.9em; + font-weight: var(--code-font-weight); + } .sidebar-nav { font-size: 14px; } diff --git a/docs/make_docs.py b/docs/make_docs.py index 6ddc904..298c9d4 100755 --- a/docs/make_docs.py +++ b/docs/make_docs.py @@ -13,6 +13,7 @@ # generate doxygen xml subprocess.run(["doxygen", "docs/Doxyfile"], check=True) + # convert doxygen xml to markdown subprocess.run( [ @@ -34,38 +35,31 @@ # make some additions to play nicely with docsify - -os.remove("docs/api/Classes/README.md") -os.remove("docs/api/Namespaces/README.md") +os.remove("docs/api/Namespaces/README.md") # remove the index file def content_fixes(content: str) -> str: - return content.replace("operator|", "operator\|") - - -def merge_files(input_glob: str, output: str, increment_title_levels: bool = True): - # concatenate individual class pages into one page - class_files = sorted(glob.glob(input_glob)) - classes = [open(f).read() for f in class_files] - for i in range(len(classes) - 1): - classes[i] = re.sub( - r"^Updated on .+ at .+ .+$", "", classes[i], flags=re.MULTILINE - ) - catted = content_fixes("\n\n".join(classes)) - - # increase markdown title levels by one - if increment_title_levels: - catted = re.sub(r"^#", "##", catted, flags=re.MULTILINE) - - for f in class_files: - fixed = content_fixes(open(f).read()) - open(f, "w").write(fixed) - - open(output, "w").write(catted) - - -merge_files("docs/api/Classes/*.md", "docs/api/Classes/README.md") -merge_files( - "docs/api/Namespaces/*.md", - "docs/api/Namespaces/README.md", - increment_title_levels=False, -) + content = content.replace("operator|", "operator\|") # TODO: avoid for code blocks + + return content + +# apply minor content fixes to each file +for f in glob.glob("docs/api/Classes/*.md") + glob.glob("docs/api/Namespaces/*.md"): + fixed = content_fixes(open(f).read()) + open(f, "w").write(fixed) + +# update sidebar with class list +class_files = [f for f in sorted(glob.glob("docs/api/Classes/*.md")) if not f.endswith("README.md")] + +class_list_str = "" +for fname in class_files: + content = open(fname).read() + m = re.match(r"# barkeep::(.+)", content) + class_name = m.group(1) + path = fname.removeprefix("docs/") + class_list_str += f" * [{class_name}]({path})\n" + +sidebar = "docs/_sidebar.md" +content = open(sidebar).read() +content = re.sub(r".*", + f"\n{class_list_str}", content, flags=re.DOTALL) +open(sidebar, "w").write(content) \ No newline at end of file diff --git a/docs/template/class_members_details.tmpl b/docs/template/class_members_details.tmpl new file mode 100644 index 0000000..7f9156f --- /dev/null +++ b/docs/template/class_members_details.tmpl @@ -0,0 +1,49 @@ +{% if exists("publicTypes") %}## Public Types Documentation + +{% for child in publicTypes %}### {{child.kind}} `{{child.name}}` + +{{ render("member_details", child) }} +{% endfor %}{% endif -%} + +{% if exists("protectedTypes") %}## Protected Types Documentation + +{% for child in protectedTypes %}### {{child.kind}} `{{child.name}}` + +{{ render("member_details", child) }} +{% endfor %}{% endif -%} + + +{% if exists("publicFunctions") %}## Public Functions Documentation + +{% for child in publicFunctions %}### {{child.kind}} `{{child.name}}` + +{{ render("member_details", child) }} +{% endfor %}{% endif -%} + +{% if exists("protectedFunctions") %}## Protected Functions Documentation + +{% for child in protectedFunctions %}### {{child.kind}} `{{child.name}}` + +{{ render("member_details", child) }} +{% endfor %}{% endif -%} + +{% if exists("publicAttributes") %}## Public Attributes Documentation + +{% for child in publicAttributes %}### {{child.kind}} `{{child.name}}` + +{{ render("member_details", child) }} +{% endfor %}{% endif -%} + +{% if exists("protectedAttributes") %}## Protected Attributes Documentation + +{% for child in protectedAttributes %}### {{child.kind}} `{{child.name}}` + +{{ render("member_details", child) }} +{% endfor %}{% endif -%} + +{% if exists("friends") %}## Friends + +{% for child in friends %}### {{child.kind}} `{{child.name}}` + +{{ render("member_details", child) }} +{% endfor %}{% endif -%} \ No newline at end of file diff --git a/docs/template/class_members_inherited_tables.tmpl b/docs/template/class_members_inherited_tables.tmpl index b9a234e..33ee637 100644 --- a/docs/template/class_members_inherited_tables.tmpl +++ b/docs/template/class_members_inherited_tables.tmpl @@ -37,7 +37,7 @@ {% for child in base.publicTypes -%} | {% if existsIn(child, "templateParams") -%} template <{% for param in child.templateParams -%} -{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} +{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} = {{param.defvalPlain}}{% endif -%} {% if not loop.is_last %},{% endif -%} {% endfor %}\>
{% endif -%} {{child.kind}}{% if child.kind == "enum" and child.strong %} class{% endif %}{% if existsIn(child, "type") %} {{child.type}} {% endif -%}| **[{{child.name}}]({{child.url}})** {% if child.kind == "enum" %}{ {% for enumvalue in child.enumvalues -%} @@ -60,7 +60,7 @@ template <{% for param in child.templateParams -%} {% for child in base.protectedTypes -%} | {% if existsIn(child, "templateParams") -%} template <{% for param in child.templateParams -%} -{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} +{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} = {{param.defvalPlain}}{% endif -%} {% if not loop.is_last %},{% endif -%} {% endfor %}\>
{% endif -%} {{child.kind}}{% if child.kind == "enum" and child.strong %} class{% endif %}{% if existsIn(child, "type") %} {{child.type}} {% endif -%}| **[{{child.name}}]({{child.url}})** {% if child.kind == "enum" %}{ {% for enumvalue in child.enumvalues -%} @@ -72,312 +72,108 @@ template <{% for param in child.templateParams -%} -{% endif -%} -{%- if existsIn(base, "publicSlots") -%} -**Public Slots inherited from [{{base.name}}]({{base.url}})** - - - -| | Name | -| -------------- | -------------- | -{% for child in base.publicSlots -%} -| {% if existsIn(child, "templateParams") -%} -template <{% for param in child.templateParams -%} -{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} -{% if not loop.is_last %},{% endif -%} -{% endfor %}\>
{% endif -%} -{% if child.virtual %}virtual {% endif -%} -{% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})**({% for param in child.params -%} -{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} ={{param.defval}}{% endif -%} -{% if not loop.is_last %}, {% endif -%} -{% endfor %}){% if child.const %} const{% endif -%} -{% if child.override %} override{% endif -%} -{% if child.default %} =default{% endif -%} -{% if child.deleted %} =delete{% endif -%} -{% if child.pureVirtual %} =0{% endif -%} - {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | -{% endfor %} - - - -{% endif -%} -{%- if existsIn(base, "protectedSlots") -%} -**Protected Slots inherited from [{{base.name}}]({{base.url}})** - - - -| | Name | -| -------------- | -------------- | -{% for child in base.protectedSlots -%} -| {% if existsIn(child, "templateParams") -%} -template <{% for param in child.templateParams -%} -{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} -{% if not loop.is_last %},{% endif -%} -{% endfor %}\>
{% endif -%} -{% if child.virtual %}virtual {% endif -%} -{% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})**({% for param in child.params -%} -{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} ={{param.defval}}{% endif -%} -{% if not loop.is_last %}, {% endif -%} -{% endfor %}){% if child.const %} const{% endif -%} -{% if child.override %} override{% endif -%} -{% if child.default %} =default{% endif -%} -{% if child.deleted %} =delete{% endif -%} -{% if child.pureVirtual %} =0{% endif -%} - {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | -{% endfor %} - - - -{% endif -%} -{%- if existsIn(base, "publicSignals") -%} -**Public Signals inherited from [{{base.name}}]({{base.url}})** - - - -| | Name | -| -------------- | -------------- | -{% for child in base.publicSignals -%} -| {% if existsIn(child, "templateParams") -%} -template <{% for param in child.templateParams -%} -{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} -{% if not loop.is_last %},{% endif -%} -{% endfor %}\>
{% endif -%} -{% if child.virtual %}virtual {% endif -%} -{% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})**({% for param in child.params -%} -{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} ={{param.defval}}{% endif -%} -{% if not loop.is_last %}, {% endif -%} -{% endfor %}){% if child.const %} const{% endif -%} -{% if child.override %} override{% endif -%} -{% if child.default %} =default{% endif -%} -{% if child.deleted %} =delete{% endif -%} -{% if child.pureVirtual %} =0{% endif -%} - {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | -{% endfor %} - - - -{% endif -%} -{%- if existsIn(base, "protectedSignals") -%} -**Protected Signals inherited from [{{base.name}}]({{base.url}})** - - - -| | Name | -| -------------- | -------------- | -{% for child in base.protectedSignals -%} -| {% if existsIn(child, "templateParams") -%} -template <{% for param in child.templateParams -%} -{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} -{% if not loop.is_last %},{% endif -%} -{% endfor %}\>
{% endif -%} -{% if child.virtual %}virtual {% endif -%} -{% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})**({% for param in child.params -%} -{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} ={{param.defval}}{% endif -%} -{% if not loop.is_last %}, {% endif -%} -{% endfor %}){% if child.const %} const{% endif -%} -{% if child.override %} override{% endif -%} -{% if child.default %} =default{% endif -%} -{% if child.deleted %} =delete{% endif -%} -{% if child.pureVirtual %} =0{% endif -%} - {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | -{% endfor %} - - - -{% endif -%} -{%- if existsIn(base, "publicEvents") -%} -**Public Events inherited from [{{base.name}}]({{base.url}})** - - - -| | Name | -| -------------- | -------------- | -{% for child in base.publicEvents -%} -| {% if existsIn(child, "templateParams") -%} -template <{% for param in child.templateParams -%} -{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} -{% if not loop.is_last %},{% endif -%} -{% endfor %}\>
{% endif -%} -{% if child.virtual %}virtual {% endif -%} -{% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})**({% for param in child.params -%} -{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} ={{param.defval}}{% endif -%} -{% if not loop.is_last %}, {% endif -%} -{% endfor %}){% if child.const %} const{% endif -%} -{% if child.override %} override{% endif -%} -{% if child.default %} =default{% endif -%} -{% if child.deleted %} =delete{% endif -%} -{% if child.pureVirtual %} =0{% endif -%} - {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | -{% endfor %} - - - -{% endif -%} -{%- if existsIn(base, "protectedEvents") -%} -**Protected Events inherited from [{{base.name}}]({{base.url}})** - - - -| | Name | -| -------------- | -------------- | -{% for child in base.protectedEvents -%} -| {% if existsIn(child, "templateParams") -%} -template <{% for param in child.templateParams -%} -{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} -{% if not loop.is_last %},{% endif -%} -{% endfor %}\>
{% endif -%} -{% if child.virtual %}virtual {% endif -%} -{% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})**({% for param in child.params -%} -{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} ={{param.defval}}{% endif -%} -{% if not loop.is_last %}, {% endif -%} -{% endfor %}){% if child.const %} const{% endif -%} -{% if child.override %} override{% endif -%} -{% if child.default %} =default{% endif -%} -{% if child.deleted %} =delete{% endif -%} -{% if child.pureVirtual %} =0{% endif -%} - {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | -{% endfor %} - - - {% endif -%} {%- if existsIn(base, "publicFunctions") -%} -**Public Functions inherited from [{{base.name}}]({{base.url}})** +**Public Functions inherited from [`{{base.name}}`]({{base.url}})** | | Name | | -------------- | -------------- | {% for child in base.publicFunctions -%} -| {% if existsIn(child, "templateParams") -%} +| {% if existsIn(child, "templateParams") -%} template <{% for param in child.templateParams -%} -{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} +{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} = {{param.defvalPlain}}{% endif -%} {% if not loop.is_last %},{% endif -%} {% endfor %}\>
{% endif -%} {% if child.virtual %}virtual {% endif -%} {% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})**({% for param in child.params -%} -{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} ={{param.defval}}{% endif -%} +| **[{{child.name}}]({{child.url}})**({% for param in child.params -%} +{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} = {{param.defval}}{% endif -%} {% if not loop.is_last %}, {% endif -%} {% endfor %}){% if child.const %} const{% endif -%} {% if child.override %} override{% endif -%} -{% if child.default %} =default{% endif -%} -{% if child.deleted %} =delete{% endif -%} -{% if child.pureVirtual %} =0{% endif -%} - {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | +{% if child.default %} = default{% endif -%} +{% if child.deleted %} = delete{% endif -%} +{% if child.pureVirtual %} = 0{% endif -%} + {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | {% endfor %} {% endif -%} {%- if existsIn(base, "protectedFunctions") -%} -**Protected Functions inherited from [{{base.name}}]({{base.url}})** +**Protected Functions inherited from [`{{base.name}}`]({{base.url}})** | | Name | | -------------- | -------------- | {% for child in base.protectedFunctions -%} -| {% if existsIn(child, "templateParams") -%} +| {% if existsIn(child, "templateParams") -%} template <{% for param in child.templateParams -%} -{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} +{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} = {{param.defvalPlain}}{% endif -%} {% if not loop.is_last %},{% endif -%} {% endfor %}\>
{% endif -%} {% if child.virtual %}virtual {% endif -%} {% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})**({% for param in child.params -%} -{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} ={{param.defval}}{% endif -%} +| **[{{child.name}}]({{child.url}})**({% for param in child.params -%} +{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} = {{param.defval}}{% endif -%} {% if not loop.is_last %}, {% endif -%} {% endfor %}){% if child.const %} const{% endif -%} {% if child.override %} override{% endif -%} -{% if child.default %} =default{% endif -%} -{% if child.deleted %} =delete{% endif -%} -{% if child.pureVirtual %} =0{% endif -%} - {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | -{% endfor %} - - - -{% endif -%} -{%- if existsIn(base, "publicProperties") -%} -**Public Properties inherited from [{{base.name}}]({{base.url}})** - - - -| | Name | -| -------------- | -------------- | -{% for child in base.publicProperties -%} -| {% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})** {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | -{% endfor %} - - - -{% endif -%} -{%- if existsIn(base, "protectedProperties") -%} -**Protected Properties inherited from [{{base.name}}]({{base.url}})** - - - -| | Name | -| -------------- | -------------- | -{% for child in base.protectedProperties -%} -| {% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})** {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | +{% if child.default %} = default{% endif -%} +{% if child.deleted %} = delete{% endif -%} +{% if child.pureVirtual %} = 0{% endif -%} + {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | {% endfor %} {% endif -%} {%- if existsIn(base, "publicAttributes") -%} -**Public Attributes inherited from [{{base.name}}]({{base.url}})** +**Public Attributes inherited from [`{{base.name}}`]({{base.url}})** | | Name | | -------------- | -------------- | {% for child in base.publicAttributes -%} -| {% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})** {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | +| {% if existsIn(child, "type") %}{{child.type}} {% endif -%} +| **[{{child.name}}]({{child.url}})** {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | {% endfor %} {% endif -%} {%- if existsIn(base, "protectedAttributes") -%} -**Protected Attributes inherited from [{{base.name}}]({{base.url}})** +**Protected Attributes inherited from [`{{base.name}}`]({{base.url}})** | | Name | | -------------- | -------------- | {% for child in base.protectedAttributes -%} -| {% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})** {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | +| {% if existsIn(child, "type") %}{{child.type}} {% endif -%} +| **[{{child.name}}]({{child.url}})** {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | {% endfor %} {% endif -%} -{% if existsIn(base, "friends") %}**Friends inherited from [{{base.name}}]({{base.url}})** +{% if existsIn(base, "friends") %}**Friends inherited from [`{{base.name}}`]({{base.url}})** | | Name | | -------------- | -------------- | {% for child in base.friends -%}| {% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})**{% if child.type != "class" and child.type != "struct" -%} +| **[{{child.name}}]({{child.url}})**{% if child.type != "class" and child.type != "struct" -%} ({% for param in child.params -%} -{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} ={{param.defval}}{% endif -%} +{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} = {{param.defval}}{% endif -%} {% if not loop.is_last %}, {% endif -%} {% endfor %}){% if child.const %} const{% endif -%} -{% endif %} {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | +{% endif %} {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | {% endfor %} diff --git a/docs/template/class_members_tables.tmpl b/docs/template/class_members_tables.tmpl index 0ca968a..9ef302f 100644 --- a/docs/template/class_members_tables.tmpl +++ b/docs/template/class_members_tables.tmpl @@ -31,16 +31,16 @@ | | Name | | -------------- | -------------- | {% for child in publicTypes -%} -| {% if existsIn(child, "templateParams") -%} +| {% if existsIn(child, "templateParams") -%} template <{% for param in child.templateParams -%} -{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} +{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} = {{param.defvalPlain}}{% endif -%} {% if not loop.is_last %},{% endif -%} {% endfor %}\>
{% endif -%} -{{child.kind}}{% if child.kind == "enum" and child.strong %} class{% endif %}{% if existsIn(child, "type") %} {{child.type}} {% endif -%}| **[{{child.name}}]({{child.url}})** {% if child.kind == "enum" %}{ {% for enumvalue in child.enumvalues -%} +{{child.kind}}{% if child.kind == "enum" and child.strong %} class{% endif %}{% if existsIn(child, "type") %} {{child.type}} {% endif -%}| **[{{child.name}}]({{child.url}})** {% if child.kind == "enum" %}{ {% for enumvalue in child.enumvalues -%} {{enumvalue.name}}{% if existsIn(enumvalue, "initializer") %} {{enumvalue.initializer}}{% endif -%} {% if not loop.is_last %}, {% endif %}{% endfor -%} }{% endif -%} -{% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | +{% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | {% endfor %} @@ -53,166 +53,20 @@ template <{% for param in child.templateParams -%} | | Name | | -------------- | -------------- | {% for child in protectedTypes -%} -| {% if existsIn(child, "templateParams") -%} +| {% if existsIn(child, "templateParams") -%} template <{% for param in child.templateParams -%} -{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} +{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} = {{param.defvalPlain}}{% endif -%} {% if not loop.is_last %},{% endif -%} {% endfor %}\>
{% endif -%} -{{child.kind}}{% if child.kind == "enum" and child.strong %} class{% endif %}{% if existsIn(child, "type") %} {{child.type}} {% endif -%}| **[{{child.name}}]({{child.url}})** {% if child.kind == "enum" %}{ {% for enumvalue in child.enumvalues -%} +{{child.kind}}{% if child.kind == "enum" and child.strong %} class{% endif %}{% if existsIn(child, "type") %} {{child.type}} {% endif -%}| **[{{child.name}}]({{child.url}})** {% if child.kind == "enum" %}{ {% for enumvalue in child.enumvalues -%} {{enumvalue.name}}{% if existsIn(enumvalue, "initializer") %} {{enumvalue.initializer}}{% endif -%} {% if not loop.is_last %}, {% endif %}{% endfor -%} }{% endif -%} -{% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | +{% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | {% endfor %} -{% endif -%} -{%- if exists("publicSlots") %}## Public Slots - -| | Name | -| -------------- | -------------- | -{% for child in publicSlots -%} -| {% if existsIn(child, "templateParams") -%} -template <{% for param in child.templateParams -%} -{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} -{% if not loop.is_last %},{% endif -%} -{% endfor %}\>
{% endif -%} -{% if child.virtual %}virtual {% endif -%} -{% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})**({% for param in child.params -%} -{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} ={{param.defval}}{% endif -%} -{% if not loop.is_last %}, {% endif -%} -{% endfor %}){% if child.const %} const{% endif -%} -{% if child.override %} override{% endif -%} -{% if child.default %} =default{% endif -%} -{% if child.deleted %} =delete{% endif -%} -{% if child.pureVirtual %} =0{% endif -%} - {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | -{% endfor %} -{% endif -%} -{%- if exists("protectedSlots") %}## Protected Slots - -| | Name | -| -------------- | -------------- | -{% for child in protectedSlots -%} -| {% if existsIn(child, "templateParams") -%} -template <{% for param in child.templateParams -%} -{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} -{% if not loop.is_last %},{% endif -%} -{% endfor %}\>
{% endif -%} -{% if child.virtual %}virtual {% endif -%} -{% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})**({% for param in child.params -%} -{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} ={{param.defval}}{% endif -%} -{% if not loop.is_last %}, {% endif -%} -{% endfor %}){% if child.const %} const{% endif -%} -{% if child.override %} override{% endif -%} -{% if child.default %} =default{% endif -%} -{% if child.deleted %} =delete{% endif -%} -{% if child.pureVirtual %} =0{% endif -%} - {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | -{% endfor %} -{% endif -%} -{%- if exists("publicSignals") %}## Public Signals - -| | Name | -| -------------- | -------------- | -{% for child in publicSignals -%} -| {% if existsIn(child, "templateParams") -%} -template <{% for param in child.templateParams -%} -{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} -{% if not loop.is_last %},{% endif -%} -{% endfor %}\>
{% endif -%} -{% if child.virtual %}virtual {% endif -%} -{% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})**({% for param in child.params -%} -{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} ={{param.defval}}{% endif -%} -{% if not loop.is_last %}, {% endif -%} -{% endfor %}){% if child.const %} const{% endif -%} -{% if child.override %} override{% endif -%} -{% if child.default %} =default{% endif -%} -{% if child.deleted %} =delete{% endif -%} -{% if child.pureVirtual %} =0{% endif -%} - {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | -{% endfor %} -{% endif -%} -{%- if exists("protectedSignals") %}## Protected Signals - -| | Name | -| -------------- | -------------- | -{% for child in protectedSignals -%} -| {% if existsIn(child, "templateParams") -%} -template <{% for param in child.templateParams -%} -{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} -{% if not loop.is_last %},{% endif -%} -{% endfor %}\>
{% endif -%} -{% if child.virtual %}virtual {% endif -%} -{% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})**({% for param in child.params -%} -{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} ={{param.defval}}{% endif -%} -{% if not loop.is_last %}, {% endif -%} -{% endfor %}){% if child.const %} const{% endif -%} -{% if child.override %} override{% endif -%} -{% if child.default %} =default{% endif -%} -{% if child.deleted %} =delete{% endif -%} -{% if child.pureVirtual %} =0{% endif -%} - {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | -{% endfor %} -{% endif -%} -{%- if exists("publicEvents") %}## Public Events - -| | Name | -| -------------- | -------------- | -{% for child in publicEvents -%} -| {% if existsIn(child, "templateParams") -%} -template <{% for param in child.templateParams -%} -{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} -{% if not loop.is_last %},{% endif -%} -{% endfor %}\>
{% endif -%} -{% if child.virtual %}virtual {% endif -%} -{% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})**({% for param in child.params -%} -{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} ={{param.defval}}{% endif -%} -{% if not loop.is_last %}, {% endif -%} -{% endfor %}){% if child.const %} const{% endif -%} -{% if child.override %} override{% endif -%} -{% if child.default %} =default{% endif -%} -{% if child.deleted %} =delete{% endif -%} -{% if child.pureVirtual %} =0{% endif -%} - {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | -{% endfor %} -{% endif -%} -{%- if exists("protectedEvents") %}## Protected Events - -| | Name | -| -------------- | -------------- | -{% for child in protectedEvents -%} -| {% if existsIn(child, "templateParams") -%} -template <{% for param in child.templateParams -%} -{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} -{% if not loop.is_last %},{% endif -%} -{% endfor %}\>
{% endif -%} -{% if child.virtual %}virtual {% endif -%} -{% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})**({% for param in child.params -%} -{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} ={{param.defval}}{% endif -%} -{% if not loop.is_last %}, {% endif -%} -{% endfor %}){% if child.const %} const{% endif -%} -{% if child.override %} override{% endif -%} -{% if child.default %} =default{% endif -%} -{% if child.deleted %} =delete{% endif -%} -{% if child.pureVirtual %} =0{% endif -%} - {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | -{% endfor %} -{% endif -%} -{%- if exists("publicJavaenumconstants") %}## Enum Constants - -| Enum constants | Description | -| -------------- | -------------- | -{% for child in publicJavaenumconstants -%} -| **[{{child.name}}]({{child.url}})**| {% if existsIn(child, "brief") %}{{child.brief}}{% endif %} | -{% endfor %} {% endif -%} {%- if exists("publicFunctions") %}## Public Functions @@ -221,22 +75,22 @@ template <{% for param in child.templateParams -%} | | Name | | -------------- | -------------- | {% for child in publicFunctions -%} -| {% if existsIn(child, "templateParams") -%} +| {% if existsIn(child, "templateParams") -%} template <{% for param in child.templateParams -%} -{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} +{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} = {{param.defvalPlain}}{% endif -%} {% if not loop.is_last %},{% endif -%} {% endfor %}\>
{% endif -%} {% if child.virtual %}virtual {% endif -%} {% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})**({% for param in child.params -%} -{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} ={{param.defval}}{% endif -%} +| **[{{child.name}}]({{child.url}})**({% for param in child.params -%} +{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} = {{param.defval}}{% endif -%} {% if not loop.is_last %}, {% endif -%} {% endfor %}){% if child.const %} const{% endif -%} {% if child.override %} override{% endif -%} -{% if child.default %} =default{% endif -%} -{% if child.deleted %} =delete{% endif -%} -{% if child.pureVirtual %} =0{% endif -%} - {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | +{% if child.default %} = default{% endif -%} +{% if child.deleted %} = delete{% endif -%} +{% if child.pureVirtual %} = 0{% endif -%} + {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | {% endfor %} @@ -249,50 +103,22 @@ template <{% for param in child.templateParams -%} | | Name | | -------------- | -------------- | {% for child in protectedFunctions -%} -| {% if existsIn(child, "templateParams") -%} +| {% if existsIn(child, "templateParams") -%} template <{% for param in child.templateParams -%} -{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} +{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} = {{param.defvalPlain}}{% endif -%} {% if not loop.is_last %},{% endif -%} {% endfor %}\>
{% endif -%} {% if child.virtual %}virtual {% endif -%} {% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})**({% for param in child.params -%} -{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} ={{param.defval}}{% endif -%} +| **[{{child.name}}]({{child.url}})**({% for param in child.params -%} +{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} = {{param.defval}}{% endif -%} {% if not loop.is_last %}, {% endif -%} {% endfor %}){% if child.const %} const{% endif -%} {% if child.override %} override{% endif -%} -{% if child.default %} =default{% endif -%} -{% if child.deleted %} =delete{% endif -%} -{% if child.pureVirtual %} =0{% endif -%} - {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | -{% endfor %} - - - -{% endif -%} -{%- if exists("publicProperties") %}## Public Properties - - - -| | Name | -| -------------- | -------------- | -{% for child in publicProperties -%} -| {% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})** {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | -{% endfor %} - - - -{% endif -%} -{%- if exists("protectedProperties") %}## Protected Properties - - - -| | Name | -| -------------- | -------------- | -{% for child in protectedProperties -%} -| {% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})** {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | +{% if child.default %} = default{% endif -%} +{% if child.deleted %} = delete{% endif -%} +{% if child.pureVirtual %} = 0{% endif -%} + {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | {% endfor %} @@ -305,8 +131,8 @@ template <{% for param in child.templateParams -%} | | Name | | -------------- | -------------- | {% for child in publicAttributes -%} -| {% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})** {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | +| {% if existsIn(child, "type") %}{{child.type}} {% endif -%} + | **[{{child.name}}]({{child.url}})** {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | {% endfor %} @@ -319,8 +145,8 @@ template <{% for param in child.templateParams -%} | | Name | | -------------- | -------------- | {% for child in protectedAttributes -%} -| {% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})** {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | +| {% if existsIn(child, "type") %}{{child.type}} {% endif -%} + | **[{{child.name}}]({{child.url}})** {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | {% endfor %} @@ -333,12 +159,12 @@ template <{% for param in child.templateParams -%} | | Name | | -------------- | -------------- | {% for child in friends -%}| {% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})**{% if child.type != "class" and child.type != "struct" -%} +| **[{{child.name}}]({{child.url}})**{% if child.type != "class" and child.type != "struct" -%} ({% for param in child.params -%} -{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} ={{param.defval}}{% endif -%} +{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} = {{param.defval}}{% endif -%} {% if not loop.is_last %}, {% endif -%} {% endfor %}){% if child.const %} const{% endif -%} -{% endif %} {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | +{% endif %} {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | {% endfor %} diff --git a/docs/template/details.tmpl b/docs/template/details.tmpl new file mode 100644 index 0000000..3975b9d --- /dev/null +++ b/docs/template/details.tmpl @@ -0,0 +1,189 @@ +{% if exists("brief") %}{{brief}} +{% endif -%} + +{% if exists("paramList") %} +**Parameters**: + +{% for param in paramList %} * **{{param.name}}** {{param.text}} +{% endfor %} +{% endif -%} + +{% if exists("returnsList") %} +**Returns**: + +{% for param in returnsList %} * **{{param.name}}** {{param.text}} +{% endfor %} +{% endif -%} + +{% if exists("exceptionsList") %} +**Exceptions**: + +{% for param in exceptionsList %} * **{{param.name}}** {{param.text}} +{% endfor %} +{% endif -%} + +{% if exists("templateParamsList") %} +**Template Parameters**: + +{% for param in templateParamsList %} * **{{param.name}}** {{param.text}} +{% endfor %} +{% endif -%} + +{% if exists("deprecated") %} +**Deprecated**: + +{{deprecated}} +{% endif -%} + +{% if exists("see") %} +**See**: {% if length(see) == 1 %}{{first(see)}}{% else %} + +{% for item in see %} * {{item}} +{% endfor %}{% endif %} +{% endif -%} + +{% if exists("returns") %} +**Return**: {% if length(returns) == 1 %}{{first(returns)}}{% else %} + +{% for item in returns %} * {{item}} +{% endfor %}{% endif %} +{% endif -%} + +{% if exists("authors") %} +**Author**: {% if length(authors) == 1 %}{{first(authors)}}{% else %} + +{% for item in authors %} * {{item}} +{% endfor %}{% endif %} +{% endif -%} + +{% if exists("version") %} +**Version**: {% if length(version) == 1 %}{{first(version)}}{% else %} + +{% for item in version %} * {{item}} +{% endfor %}{% endif %} +{% endif -%} + +{% if exists("since") %} +**Since**: {% if length(since) == 1 %}{{first(since)}}{% else %} + +{% for item in since %} * {{item}} +{% endfor %}{% endif %} +{% endif -%} + +{% if exists("date") %} +**Date**: {% if length(date) == 1 %}{{first(date)}}{% else %} + +{% for item in date %} * {{item}} +{% endfor %}{% endif %} +{% endif -%} + +{% if exists("note") %} +**Note**: {% if length(note) == 1 %}{{first(note)}}{% else %} + +{% for item in note %} * {{item}} +{% endfor %}{% endif %} +{% endif -%} + +{% if exists("bugs") %} +**Bug**: {% if length(bugs) == 1 %}{{first(bugs)}}{% else %} + +{% for item in bugs %} * {{item}} +{% endfor %}{% endif %} +{% endif -%} + +{% if exists("tests") %} +**Test**: {% if length(tests) == 1 %}{{first(tests)}}{% else %} + +{% for item in tests %} * {{item}} +{% endfor %}{% endif %} +{% endif -%} + +{% if exists("todos") %} +**Todo**: {% if length(todos) == 1 %}{{first(todos)}}{% else %} + +{% for item in todos %} * {{item}} +{% endfor %}{% endif %} +{% endif -%} + +{% if exists("warning") %} +**Warning**: {% if length(warning) == 1 %}{{first(warning)}}{% else %} + +{% for item in warning %} * {{item}} +{% endfor %}{% endif %} +{% endif -%} + +{% if exists("pre") %} +**Precondition**: {% if length(pre) == 1 %}{{first(pre)}}{% else %} + +{% for item in pre %} * {{item}} +{% endfor %}{% endif %} +{% endif -%} + +{% if exists("post") %} +**Postcondition**: {% if length(post) == 1 %}{{first(post)}}{% else %} + +{% for item in post %} * {{item}} +{% endfor %}{% endif %} +{% endif -%} + +{% if exists("copyright") %} +**Copyright**: {% if length(copyright) == 1 %}{{first(copyright)}}{% else %} + +{% for item in copyright %} * {{item}} +{% endfor %}{% endif %} +{% endif -%} + +{% if exists("invariant") %} +**Invariant**: {% if length(invariant) == 1 %}{{first(invariant)}}{% else %} + +{% for item in invariant %} * {{item}} +{% endfor %}{% endif %} +{% endif -%} + +{% if exists("remark") %} +**Remark**: {% if length(remark) == 1 %}{{first(remark)}}{% else %} + +{% for item in remark %} * {{item}} +{% endfor %}{% endif %} +{% endif -%} + +{% if exists("attention") %} +**Attention**: {% if length(attention) == 1 %}{{first(attention)}}{% else %} + +{% for item in attention %} * {{item}} +{% endfor %}{% endif %} +{% endif -%} + +{% if exists("par") %} +**Par**: {% if length(par) == 1 %}{{first(par)}}{% else %} + +{% for item in par %} * {{item}} +{% endfor %}{% endif %} +{% endif -%} + +{% if exists("rcs") %} +**Rcs**: {% if length(rcs) == 1 %}{{first(rcs)}}{% else %} + +{% for item in rcs %} * {{item}} +{% endfor %}{% endif %} +{% endif -%} + +{% if exists("reimplements") %} +**Reimplements**: [`{{reimplements.fullname}}`]({{reimplements.url}}) + +{% endif -%} + +{% if exists("reimplementedBy") %} +**Reimplemented by**: {% for impl in reimplementedBy %}[`{{impl.fullname}}`]({{impl.url}}){% if not loop.is_last %}, {% endif %}{% endfor %} + +{% endif -%} + +{% if exists("details") %} +{{details}} + +{% endif -%} + +{% if exists("inbody") %} +{{inbody}} + +{% endif -%} \ No newline at end of file diff --git a/docs/template/footer.tmpl b/docs/template/footer.tmpl new file mode 100644 index 0000000..c6036d7 --- /dev/null +++ b/docs/template/footer.tmpl @@ -0,0 +1 @@ +------------------------------- \ No newline at end of file diff --git a/docs/template/index.tmpl b/docs/template/index.tmpl new file mode 100644 index 0000000..cfb9457 --- /dev/null +++ b/docs/template/index.tmpl @@ -0,0 +1,10 @@ + +{% for child0 in children %}* **{{child0.kind}} [{{child0.title}}]({{child0.url}})** {% if existsIn(child0, "brief") %}
{{child0.brief}}{% endif %}{% if existsIn(child0, "children") %}{% for child1 in child0.children %} + * **{{child1.kind}} [{{last(stripNamespace(child1.title))}}]({{child1.url}})** {% if existsIn(child1, "brief") %}
{{child1.brief}}{% endif %}{% if existsIn(child1, "children") %}{% for child2 in child1.children %} + * **{{child2.kind}} [{{last(stripNamespace(child2.title))}}]({{child2.url}})** {% if existsIn(child2, "brief") %}
{{child2.brief}}{% endif %}{% if existsIn(child2, "children") %}{% for child3 in child2.children %} + * **{{child3.kind}} [{{last(stripNamespace(child3.title))}}]({{child3.url}})** {% if existsIn(child3, "brief") %}
{{child3.brief}}{% endif %}{% if existsIn(child3, "children") %}{% for child4 in child3.children %} + * **{{child4.kind}} [{{last(stripNamespace(child4.title))}}]({{child4.url}})** {% if existsIn(child4, "brief") %}
{{child4.brief}}{% endif %}{% if existsIn(child4, "children") %}{% for child5 in child4.children %} + * **{{child5.kind}} [{{last(stripNamespace(child5.title))}}]({{child5.url}})** {% if existsIn(child5, "brief") %}
{{child5.brief}}{% endif %}{% if existsIn(child5, "children") %}{% for child6 in child5.children %} + * **{{child6.kind}} [{{last(stripNamespace(child6.title))}}]({{child6.url}})** {% if existsIn(child6, "brief") %}
{{child6.brief}}{% endif %}{% if existsIn(child6, "children") %}{% for child7 in child6.children %} + * **{{child7.kind}} [{{last(stripNamespace(child7.title))}}]({{child7.url}})** {% if existsIn(child7, "brief") %}
{{child7.brief}}{% endif %}{% endfor %}{% endif %}{% endfor %}{% endif %}{% endfor %}{% endif %}{% endfor %}{% endif %}{% endfor %}{% endif %}{% endfor %}{% endif %}{% endfor %}{% endif %} +{% endfor %} diff --git a/docs/template/kind_class.tmpl b/docs/template/kind_class.tmpl new file mode 100644 index 0000000..4b640bd --- /dev/null +++ b/docs/template/kind_class.tmpl @@ -0,0 +1,39 @@ +{% include "header" -%} + +{% include "breadcrumbs" %} + +{% if exists("brief") %}{{brief}}{% endif %}{% if hasDetails %} [More...](#detailed-description){% endif %} + +{% if exists("includes") %} +`#include {{includes}}` + +{% endif -%} + +{%- if exists("baseClasses") %}Inherits from {% for child in baseClasses %}{% if existsIn(child, "url") %}[`{{child.name}}`]({{child.url}}){% else %}`{{child.name}}`{% endif %}{% if not loop.is_last %}, {% endif %}{% endfor %} + +{% endif -%} +{%- if exists("derivedClasses") %}Inherited by {% for child in derivedClasses %}{% if existsIn(child, "url") %}[`{{child.name}}`]({{child.url}}){% else %}`{{child.name}}`{% endif %}{% if not loop.is_last %}, {% endif %}{% endfor %} + +{% endif -%} + +{%- include "class_members_tables" -%} + +{% if hasAdditionalMembers %}## Additional inherited members + +{% include "class_members_inherited_tables" %} +{% endif -%} + +{% if hasDetails %}## Detailed Description + +```{{language}}{% if exists("templateParams") %} +template <{% for param in templateParams %}{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif %}{% if not loop.is_last %}, +{% endif %}{% endfor %}>{% endif %} +{% if language == "java" %}{{visibility}} {% endif -%} +{% if kind == "interface" and language != "java" %}class{% else %}{{kind}}{% endif %} {{name}}; +``` + +{% include "details" %}{% endif -%} + +{% include "class_members_details" -%} + +{% include "footer" %} \ No newline at end of file diff --git a/docs/template/member_details.tmpl b/docs/template/member_details.tmpl index 740c6c1..2da02cf 100644 --- a/docs/template/member_details.tmpl +++ b/docs/template/member_details.tmpl @@ -1,7 +1,7 @@ {% if kind in ["function", "slot", "signal", "event"] -%} ```{{language}} {% if exists("templateParams") -%} -template <{% for param in templateParams %}{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} +template <{% for param in templateParams %}{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} = {{param.defvalPlain}}{% endif -%} {% if not loop.is_last %}, {% endif %}{% endfor %}> {% endif -%} @@ -14,7 +14,7 @@ template <{% for param in templateParams %}{{param.typePlain}} {{param.name}}{% {% if exists("typePlain") %}{{typePlain}} {% endif %}{{name}}{% if length(params) > 0 -%} ( -{% for param in params %} {{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} +{% for param in params %} {{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} = {{param.defvalPlain}}{% endif -%} {% if not loop.is_last %},{% endif %} {% endfor -%} ){% else -%} @@ -22,15 +22,15 @@ template <{% for param in templateParams %}{{param.typePlain}} {{param.name}}{% {% if const %} const{% endif -%} {% if override %} override{% endif -%} -{% if default %} =default{% endif -%} -{% if deleted %} =delete{% endif -%} -{% if pureVirtual %} =0{% endif %} +{% if default %} = default{% endif -%} +{% if deleted %} = delete{% endif -%} +{% if pureVirtual %} = 0{% endif %} ```{% endif -%} {% if kind == "enum" -%} | Enumerator | Value | Description | | ---------- | ----- | ----------- | -{% for enumvalue in enumvalues %}| {{enumvalue.name}} | {% if existsIn(enumvalue, "initializer") -%} +{% for enumvalue in enumvalues %}| {{enumvalue.name}} | {% if existsIn(enumvalue, "initializer") -%} {{replace(replace(enumvalue.initializer, "= ", ""), "|", "\\|")}}{% endif -%} | {% if existsIn(enumvalue, "brief") %}{{enumvalue.brief}}{% endif %} {% if existsIn(enumvalue, "details") %}{{enumvalue.details}}{% endif %} | {% endfor %} @@ -50,7 +50,7 @@ template <{% for param in templateParams %}{{param.typePlain}} {{param.name}}{% {% if kind == "using" -%} ```{{language}} {% if exists("templateParams") -%} -template <{% for param in templateParams %}{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} +template <{% for param in templateParams %}{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} = {{param.defvalPlain}}{% endif -%} {% if not loop.is_last %}, {% endif %}{% endfor %}> {% endif -%} @@ -63,7 +63,7 @@ friend {% if exists("typePlain") %}{{typePlain}} {% endif -%} {{name}}{% if exists("params") %}{% endif -%} {% if length(params) > 0 -%} ( -{% for param in params %} {{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} +{% for param in params %} {{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} = {{param.defvalPlain}}{% endif -%} {% if not loop.is_last %}, {% endif %} {% endfor -%} @@ -75,7 +75,7 @@ friend {% if exists("typePlain") %}{{typePlain}} {% endif -%} ```{{language}} #define {{name}}{% if exists("params") -%} ( -{% for param in params %} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} +{% for param in params %} {{param.name}}{% if existsIn(param, "defvalPlain") %} = {{param.defvalPlain}}{% endif -%} {% if not loop.is_last %}, {% endif -%} {% endfor %} diff --git a/docs/template/nonclass_members_details.tmpl b/docs/template/nonclass_members_details.tmpl new file mode 100644 index 0000000..8b6cf5d --- /dev/null +++ b/docs/template/nonclass_members_details.tmpl @@ -0,0 +1,24 @@ +{% if exists("publicTypes") %}## Types Documentation + +{% for child in publicTypes %}### {{child.kind}} {{child.name}} + +{{ render("member_details", child) }} +{% endfor %}{% endif %} +{% if exists("publicFunctions") %}## Functions Documentation + +{% for child in publicFunctions %}### {{child.kind}} {{child.name}} + +{{ render("member_details", child) }} +{% endfor %}{% endif %} +{% if exists("publicAttributes") %}## Attributes Documentation + +{% for child in publicAttributes %}### {{child.kind}} {{child.name}} + +{{ render("member_details", child) }} +{% endfor %}{% endif %} +{% if exists("defines") %}## Macros Documentation + +{% for child in defines %}### {{child.kind}} {{child.name}} + +{{ render("member_details", child) }} +{% endfor %}{% endif %} \ No newline at end of file diff --git a/docs/template/nonclass_members_tables.tmpl b/docs/template/nonclass_members_tables.tmpl index 9d77c7f..8618af5 100644 --- a/docs/template/nonclass_members_tables.tmpl +++ b/docs/template/nonclass_members_tables.tmpl @@ -12,33 +12,6 @@ {% endif -%} -{% if exists("dirs") %}## Directories - - - -| Name | -| -------------- | -{% for child in dirs -%} -| **[{{child.title}}]({{child.url}})** {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | -{%- endfor %} - - - -{% endif -%} - -{% if exists("files") %}## Files - - - -| Name | -| -------------- | -{% for child in files -%} -| **[{{child.title}}]({{child.url}})** {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | -{%- endfor %} - - - -{% endif -%} {%- if exists("namespaces") %}## {% if language == "java" %}Packages{% else %}Namespaces{% endif %} @@ -60,7 +33,7 @@ | | Name | | -------------- | -------------- | {% for child in publicClasses -%} -| {{child.kind}} | **[{{child.name}}]({{child.url}})** {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | +| {{child.kind}} | **[ {{child.name}} ]({{child.url}})** {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | {% endfor %} @@ -73,13 +46,13 @@ | | Name | | -------------- | -------------- | {% for child in publicTypes -%} -| {% if existsIn(child, "templateParams") -%} +| {% if existsIn(child, "templateParams") -%} template <{% for param in child.templateParams -%} {{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} {% if not loop.is_last %},{% endif -%} {% endfor %}\>
{% endif -%} -{{child.kind}}{% if child.kind == "enum" and child.strong %} class{% endif %}{% if existsIn(child, "type") %} {{child.type}} {% endif -%}| **[{{child.name}}]({{child.url}})** {% if child.kind == "enum" %}{ {% for enumvalue in child.enumvalues -%} -{{enumvalue.name}}{% if existsIn(enumvalue, "initializer") %} {{enumvalue.initializer}}{% endif -%} +{{child.kind}}{% if child.kind == "enum" and child.strong %} class{% endif %}{% if existsIn(child, "type") %} {{child.type}} {% endif -%}| **[ {{child.name}} ]({{child.url}})** {% if child.kind == "enum" %}{ {% for enumvalue in child.enumvalues -%} +`{{enumvalue.name}}`{% if existsIn(enumvalue, "initializer") %} `{{enumvalue.initializer}}`{% endif -%} {% if not loop.is_last %}, {% endif %}{% endfor -%} }{% endif -%} {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | @@ -87,62 +60,6 @@ template <{% for param in child.templateParams -%} -{% endif -%} -{%- if exists("publicSlots") %}## Slots - - - -| | Name | -| -------------- | -------------- | -{% for child in publicSlots -%} -| {% if existsIn(child, "templateParams") -%} -template <{% for param in child.templateParams -%} -{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} -{% if not loop.is_last %},{% endif -%} -{% endfor %}\>
{% endif -%} -{% if child.virtual %}virtual {% endif -%} -{% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})**({% for param in child.params -%} -{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} ={{param.defval}}{% endif -%} -{% if not loop.is_last %}, {% endif -%} -{% endfor %}){% if child.const %} const{% endif -%} -{% if child.override %} override{% endif -%} -{% if child.default %} =default{% endif -%} -{% if child.deleted %} =delete{% endif -%} -{% if child.pureVirtual %} =0{% endif -%} - {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | -{% endfor %} - - - -{% endif -%} -{%- if exists("publicSignals") %}## Signals - - - -| | Name | -| -------------- | -------------- | -{% for child in publicSignals -%} -| {% if existsIn(child, "templateParams") -%} -template <{% for param in child.templateParams -%} -{{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} -{% if not loop.is_last %},{% endif -%} -{% endfor %}\>
{% endif -%} -{% if child.virtual %}virtual {% endif -%} -{% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})**({% for param in child.params -%} -{{param.type}} {{param.name}}{% if existsIn(param, "defval") %} ={{param.defval}}{% endif -%} -{% if not loop.is_last %}, {% endif -%} -{% endfor %}){% if child.const %} const{% endif -%} -{% if child.override %} override{% endif -%} -{% if child.default %} =default{% endif -%} -{% if child.deleted %} =delete{% endif -%} -{% if child.pureVirtual %} =0{% endif -%} - {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | -{% endfor %} - - - {% endif -%} {%- if exists("publicFunctions") %}## Functions @@ -151,22 +68,22 @@ template <{% for param in child.templateParams -%} | | Name | | -------------- | -------------- | {% for child in publicFunctions -%} -| {% if existsIn(child, "templateParams") -%} +| {% if existsIn(child, "templateParams") -%} template <{% for param in child.templateParams -%} {{param.typePlain}} {{param.name}}{% if existsIn(param, "defvalPlain") %} ={{param.defvalPlain}}{% endif -%} {% if not loop.is_last %},{% endif -%} {% endfor %}\>
{% endif -%} {% if child.virtual %}virtual {% endif -%} {% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})**({% for param in child.params -%} + | **[{{child.name}}]({{child.url}})**({% for param in child.params -%} {{param.type}} {{param.name}}{% if existsIn(param, "defval") %} ={{param.defval}}{% endif -%} {% if not loop.is_last %}, {% endif -%} {% endfor %}){% if child.const %} const{% endif -%} {% if child.override %} override{% endif -%} -{% if child.default %} =default{% endif -%} -{% if child.deleted %} =delete{% endif -%} -{% if child.pureVirtual %} =0{% endif -%} - {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | +{% if child.default %} = default{% endif -%} +{% if child.deleted %} = delete{% endif -%} +{% if child.pureVirtual %} = 0{% endif -%} + {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | {% endfor %} @@ -179,8 +96,8 @@ template <{% for param in child.templateParams -%} | | Name | | -------------- | -------------- | {% for child in publicAttributes -%} -| {% if existsIn(child, "type") %}{{child.type}} {% endif -%} -| **[{{child.name}}]({{child.url}})** {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | +| {% if existsIn(child, "type") %}{{child.type}} {% endif -%} +| **[{{child.name}}]({{child.url}})** {% if existsIn(child, "brief") %}
{{child.brief}}{% endif %} | {% endfor %} {% endif -%} {%- if exists("defines") %}## Defines