Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update doxy #535

Merged
merged 2 commits into from
Feb 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/rpp/rpp/disposables.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
/**
* @defgroup disposables Disposables
* @brief Disposable owns some resource and provides ability to `dispose()` it: destroy/remove/disconnect and etc.
* @details In RPP it used as "reverse subscription": observable sets disposable to observer via `set_upstream(disposable)` with meaning "if you want to cancel me -> dispose this disposable"
* @details In RPP it used as "inverted subscription": observable sets disposable to observer via `set_upstream(disposable)` with meaning "if you want to cancel me -> dispose this disposable"
* @ingroup rpp
*/

Expand Down
7 changes: 7 additions & 0 deletions src/rpp/rpp/disposables/composite_disposable.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ namespace rpp
{
/**
* @brief Disposable which can keep some other sub-disposables. When this root disposable is disposed, then all sub-disposables would be disposed too.
* @tparam Container is type of internal storage used to keep dependencies
*
* @ingroup disposables
*/
Expand Down Expand Up @@ -164,6 +165,12 @@ namespace rpp
std::atomic<State> m_current_state{};
};

/**
* @brief Disposable which can keep some other sub-disposables. When this root disposable is disposed, then all sub-disposables would be disposed too.
* @note By default uses vector as internal storage
*
* @ingroup disposables
*/
class composite_disposable : public composite_disposable_impl<rpp::details::disposables::dynamic_disposables_container<0>>
{
};
Expand Down
13 changes: 12 additions & 1 deletion src/rpp/rpp/disposables/fwd.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,18 @@ namespace rpp
template<rpp::constraint::decayed_type TDisposable>
class disposable_wrapper_impl;

using disposable_wrapper = disposable_wrapper_impl<interface_disposable>;
/**
* @brief Wrapper to keep "simple" disposable. Specialization of rpp::disposable_wrapper_impl
*
* @ingroup disposables
*/
using disposable_wrapper = disposable_wrapper_impl<interface_disposable>;

/**
* @brief Wrapper to keep "composite" disposable. Specialization of rpp::disposable_wrapper_impl
*
* @ingroup disposables
*/
using composite_disposable_wrapper = disposable_wrapper_impl<interface_composite_disposable>;
} // namespace rpp

Expand Down
2 changes: 2 additions & 0 deletions src/rpp/rpp/observers/observer.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,8 @@ namespace rpp
*
* @tparam Type of value this observer can handle
* @tparam Strategy used to provide logic over observer's callbacks
*
* @ingroup observers
*/
template<constraint::decayed_type Type, constraint::observer_strategy<Type> Strategy>
class observer;
Expand Down
Loading