Skip to content

Commit

Permalink
wip update doxy docs
Browse files Browse the repository at this point in the history
  • Loading branch information
YarikTH committed Jan 3, 2024
1 parent 12a535c commit 80cab49
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
4 changes: 2 additions & 2 deletions include/ureact/events.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -429,7 +429,7 @@ class event_source<E>::iterator final
};

/*!
* @brief Interface for events<S> that allows construction and assigment only for Owner class
* @brief Interface for `ureact::events<E>` that allows construction and assigment only for Owner class
*
* member_events is intended to be used as type for public members, so everybody can freely
* access its public interface while being restricted from reassignment that should be allowed
Expand Down Expand Up @@ -464,7 +464,7 @@ class member_events : public events<E>
};

/*!
* @brief Interface for event_source<S> that allows construction and assigment only for Owner class
* @brief Interface for `ureact::event_source<E>` that allows construction and assigment only for Owner class
*
* member_event_source is intended to be used as type for public members, so everybody can freely
* access its public interface while being restricted from reassignment that should be allowed
Expand Down
4 changes: 2 additions & 2 deletions include/ureact/signal.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -481,7 +481,7 @@ class var_signal : public signal<S>
};

/*!
* @brief Interface for signal<S> that allows construction and assigment only for Owner class
* @brief Interface for `signal<S>` that allows construction and assigment only for Owner class
*
* member_signal is intended to be used as type for public members, so everybody can freely
* access its public interface while being restricted from reassignment that should be allowed
Expand Down Expand Up @@ -516,7 +516,7 @@ class member_signal : public signal<S>
};

/*!
* @brief Interface for var_signal<S> that allows construction and assigment only for Owner class
* @brief Interface for `var_signal<S>` that allows construction and assigment only for Owner class
*
* member_var_signal is intended to be used as type for public members, so everybody can freely
* access its public interface while being restricted from reassignment that should be allowed
Expand Down
18 changes: 9 additions & 9 deletions include/ureact/utility/type_traits.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ template <typename S>
class signal;

/*!
* @brief Return if type is signal or its inheritor
* @brief Return if type is @ref signal or its inheritor
*/
template <typename T>
struct is_signal : detail::is_base_of_template<signal, T>
Expand All @@ -199,7 +199,7 @@ template <typename S>
class var_signal;

/*!
* @brief Return if type is var_signal or its inheritor
* @brief Return if type is @ref var_signal or its inheritor
*/
template <typename T>
struct is_var_signal : detail::is_base_of_template<var_signal, T>
Expand All @@ -218,7 +218,7 @@ template <typename... Values>
class signal_pack;

/*!
* @brief Return if type is signal_pack
* @brief Return if type is @ref signal_pack
*/
template <typename T>
struct is_signal_pack : detail::is_base_of_template<signal_pack, T>
Expand All @@ -233,7 +233,7 @@ inline constexpr bool is_signal_pack_v = is_signal_pack<T>::value;


/*!
* @brief Return if type is signal's inheritor or signal_pack
* @brief Return if type is @ref signal's inheritor or @ref signal_pack
*/
template <typename T>
struct is_signal_or_pack : std::disjunction<is_signal<T>, is_signal_pack<T>>
Expand All @@ -252,7 +252,7 @@ template <typename E>
class events;

/*!
* @brief Return if type is events or its inheritor
* @brief Return if type is @ref events or its inheritor
*/
template <typename T>
struct is_event : detail::is_base_of_template<events, T>
Expand All @@ -271,7 +271,7 @@ template <typename E>
class event_source;

/*!
* @brief Return if type is event_source or its inheritor
* @brief Return if type is @ref event_source or its inheritor
*/
template <typename T>
struct is_event_source : detail::is_base_of_template<event_source, T>
Expand All @@ -289,7 +289,7 @@ inline constexpr bool is_event_source_v = is_event_source<T>::value;
class observer;

/*!
* @brief Return if type is observer
* @brief Return if type is @ref observer
*/
template <typename T>
struct is_observer : std::is_same<T, observer>
Expand All @@ -304,7 +304,7 @@ inline constexpr bool is_observer_v = is_observer<T>::value;


/*!
* @brief Return if type is signal or event inheritor
* @brief Return if type is @ref signal or @ref event inheritor
*/
template <typename T>
struct is_observable : std::disjunction<is_signal<T>, is_event<T>>
Expand All @@ -319,7 +319,7 @@ inline constexpr bool is_observable_v = is_observable<T>::value;


/*!
* @brief Return if type is signal or event or observer
* @brief Return if type is @ref signal or @ref events or @ref observer
*/
template <typename T>
struct is_reactive : std::disjunction<is_observable<T>, is_observer<T>>
Expand Down

0 comments on commit 80cab49

Please sign in to comment.