From 78101d97e0ae9781ed139939a5a1482de69fb271 Mon Sep 17 00:00:00 2001 From: Aleksey Loginov Date: Mon, 26 Feb 2024 18:45:38 +0300 Subject: [PATCH 1/2] Update doxy --- src/rpp/rpp/disposables.hpp | 2 +- src/rpp/rpp/disposables/composite_disposable.hpp | 7 +++++++ src/rpp/rpp/disposables/fwd.hpp | 11 +++++++++++ src/rpp/rpp/observers/observer.hpp | 2 ++ 4 files changed, 21 insertions(+), 1 deletion(-) diff --git a/src/rpp/rpp/disposables.hpp b/src/rpp/rpp/disposables.hpp index b127e7719..62b065272 100644 --- a/src/rpp/rpp/disposables.hpp +++ b/src/rpp/rpp/disposables.hpp @@ -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 */ diff --git a/src/rpp/rpp/disposables/composite_disposable.hpp b/src/rpp/rpp/disposables/composite_disposable.hpp index a8d19a546..25b05d9a7 100644 --- a/src/rpp/rpp/disposables/composite_disposable.hpp +++ b/src/rpp/rpp/disposables/composite_disposable.hpp @@ -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 */ @@ -164,6 +165,12 @@ namespace rpp std::atomic 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> { }; diff --git a/src/rpp/rpp/disposables/fwd.hpp b/src/rpp/rpp/disposables/fwd.hpp index 35fe5af26..df961951b 100644 --- a/src/rpp/rpp/disposables/fwd.hpp +++ b/src/rpp/rpp/disposables/fwd.hpp @@ -26,7 +26,18 @@ namespace rpp template class disposable_wrapper_impl; + /** + * @brief Wrapper to keep "simple" disposable. Specialization of rpp::disposable_wrapper_impl + * + * @ingroup disposables + */ using disposable_wrapper = disposable_wrapper_impl; + + /** + * @brief Wrapper to keep "composite" disposable. Specialization of rpp::disposable_wrapper_impl + * + * @ingroup disposables + */ using composite_disposable_wrapper = disposable_wrapper_impl; } // namespace rpp diff --git a/src/rpp/rpp/observers/observer.hpp b/src/rpp/rpp/observers/observer.hpp index e62a67156..f407e847b 100644 --- a/src/rpp/rpp/observers/observer.hpp +++ b/src/rpp/rpp/observers/observer.hpp @@ -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 Strategy> class observer; From d4f37a571718bd51508c3dfa68589197f19217ff Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 26 Feb 2024 15:46:00 +0000 Subject: [PATCH 2/2] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- src/rpp/rpp/disposables/fwd.hpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/rpp/rpp/disposables/fwd.hpp b/src/rpp/rpp/disposables/fwd.hpp index df961951b..188ad94ec 100644 --- a/src/rpp/rpp/disposables/fwd.hpp +++ b/src/rpp/rpp/disposables/fwd.hpp @@ -31,7 +31,7 @@ namespace rpp * * @ingroup disposables */ - using disposable_wrapper = disposable_wrapper_impl; + using disposable_wrapper = disposable_wrapper_impl; /** * @brief Wrapper to keep "composite" disposable. Specialization of rpp::disposable_wrapper_impl