diff --git a/src/entt/entity/group.hpp b/src/entt/entity/group.hpp index b6c4a4f34..af89639b3 100644 --- a/src/entt/entity/group.hpp +++ b/src/entt/entity/group.hpp @@ -54,7 +54,7 @@ class basic_group; * all of them because they _share_ entities and components). * * @warning - * Lifetime of a group must overcome the one of the registry that generated it. + * Lifetime of a group must not overcome that of the registry that generated it. * In any other case, attempting to use a group results in undefined behavior. * * @tparam Entity A valid entity type (see entt_traits for more details). @@ -484,7 +484,7 @@ private: * of them because they share the underlying data structure). * * @warning - * Lifetime of a group must overcome the one of the registry that generated it. + * Lifetime of a group must not overcome that of the registry that generated it. * In any other case, attempting to use a group results in undefined behavior. * * @tparam Entity A valid entity type (see entt_traits for more details). diff --git a/src/entt/entity/observer.hpp b/src/entt/entity/observer.hpp index 6e917aabf..e16f42b99 100644 --- a/src/entt/entity/observer.hpp +++ b/src/entt/entity/observer.hpp @@ -159,7 +159,7 @@ constexpr basic_collector<> collector{}; * behavior. * * @warning - * Lifetime of an observer doesn't necessarily have to overcome the one of the + * Lifetime of an observer doesn't necessarily have to overcome that of the * registry to which it is connected. However, the observer must be disconnected * from the registry before being destroyed to avoid crashes due to dangling * pointers. diff --git a/src/entt/entity/runtime_view.hpp b/src/entt/entity/runtime_view.hpp index 397a4c692..4b5570739 100644 --- a/src/entt/entity/runtime_view.hpp +++ b/src/entt/entity/runtime_view.hpp @@ -49,7 +49,7 @@ namespace entt { * have a valid reference and won't be updated accordingly). * * @warning - * Lifetime of a view must overcome the one of the registry that generated it. + * Lifetime of a view must not overcome that of the registry that generated it. * In any other case, attempting to use a view results in undefined behavior. * * @tparam Entity A valid entity type (see entt_traits for more details). diff --git a/src/entt/entity/view.hpp b/src/entt/entity/view.hpp index 7e7d4d10b..abafb6797 100644 --- a/src/entt/entity/view.hpp +++ b/src/entt/entity/view.hpp @@ -55,7 +55,7 @@ class basic_view; * made by means of the registry are immediately reflected by views. * * @warning - * Lifetime of a view must overcome the one of the registry that generated it. + * Lifetime of a view must not overcome that of the registry that generated it. * In any other case, attempting to use a view results in undefined behavior. * * @tparam Entity A valid entity type (see entt_traits for more details). @@ -559,7 +559,7 @@ private: * made by means of the registry are immediately reflected by views. * * @warning - * Lifetime of a view must overcome the one of the registry that generated it. + * Lifetime of a view must not overcome that of the registry that generated it. * In any other case, attempting to use a view results in undefined behavior. * * @tparam Entity A valid entity type (see entt_traits for more details). diff --git a/src/entt/signal/dispatcher.hpp b/src/entt/signal/dispatcher.hpp index 7c3866b5c..37733e9cd 100644 --- a/src/entt/signal/dispatcher.hpp +++ b/src/entt/signal/dispatcher.hpp @@ -24,9 +24,8 @@ namespace entt { * type `Event`, listeners are such that they can be invoked with an argument of * type `const Event &`, no matter what the return type is. * - * The types of the instances are `Class &`. Users must guarantee that the - * lifetimes of the objects overcome the one of the dispatcher itself to avoid - * crashes. + * The dispatcher creates instances of the `sigh` class internally. Refer to the + * documentation of the latter for more details. */ class dispatcher { struct basic_pool { diff --git a/src/entt/signal/sigh.hpp b/src/entt/signal/sigh.hpp index 39bc3e391..7e646ea77 100644 --- a/src/entt/signal/sigh.hpp +++ b/src/entt/signal/sigh.hpp @@ -407,13 +407,13 @@ public: * * The signal isn't responsible for the connected object or the payload. * Users must always guarantee that the lifetime of the instance overcomes - * the one of the delegate. On the other side, the signal handler performs + * the one of the signal. On the other side, the signal handler performs * checks to avoid multiple connections for the same function.
* When used to connect a free function with payload, its signature must be * such that the instance is the first argument before the ones used to - * define the delegate itself. + * define the signal itself. * - * @tparam Candidate Function or member to connect to the delegate. + * @tparam Candidate Function or member to connect to the signal. * @tparam Type Type of class or type of payload. * @param value_or_instance A valid object that fits the purpose. * @return A properly initialized connection object. @@ -433,7 +433,7 @@ public: /** * @brief Disconnects a free function or an unbound member from a signal. - * @tparam Candidate Function or member to disconnect from the delegate. + * @tparam Candidate Function or member to disconnect from the signal. */ template void disconnect() { @@ -446,7 +446,7 @@ public: /** * @brief Disconnects a free function with payload or a bound member from a * signal. - * @tparam Candidate Function or member to disconnect from the delegate. + * @tparam Candidate Function or member to disconnect from the signal. * @tparam Type Type of class or type of payload. * @param value_or_instance A valid object that fits the purpose. */