doc: cleanup

src/entt/entity/group.hpp

@@ -394,9 +394,7 @@ public:
      * @warning
      * Attempting to use an invalid component type results in a compilation
      * error. Attempting to use an entity that doesn't belong to the group
-     * results in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode if the
-     * group doesn't contain the given entity.
+     * results in undefined behavior.
      *
      * @tparam Component Types of components to get.
      * @param entt A valid entity identifier.
@@ -941,9 +939,7 @@ public:
      * @warning
      * Attempting to use an invalid component type results in a compilation
      * error. Attempting to use an entity that doesn't belong to the group
-     * results in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode if the
-     * group doesn't contain the given entity.
+     * results in undefined behavior.
      *
      * @tparam Component Types of components to get.
      * @param entt A valid entity identifier.

src/entt/entity/registry.hpp

@@ -386,9 +386,7 @@ public:
      * @warning
      * Attempting to use an entity that doesn't belong to the registry results
      * in undefined behavior. An entity belongs to the registry even if it has
-     * been previously destroyed and/or recycled.<br/>
-     * An assertion will abort the execution at runtime in debug mode if the
-     * registry doesn't own the given entity.
+     * been previously destroyed and/or recycled.
      *
      * @param entity A valid entity identifier.
      * @return Actual version for the given entity identifier.
@@ -478,8 +476,7 @@ public:
      * registry will continue to work properly in this case.
      *
      * @warning
-     * An assertion will abort the execution at runtime in debug mode if all
-     * pools aren't empty.
+     * All pools must be empty for this to work properly.
      *
      * @tparam It Type of input iterator.
      * @param first An iterator to the first element of the range of entities.
@@ -548,10 +545,7 @@ public:
      *
      * @warning
      * Attempting to use an invalid entity or to assign a component to an entity
-     * that already owns it results in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode in case of
-     * invalid entity or if the entity already owns an instance of the given
-     * component.
+     * that already owns it results in undefined behavior.
      *
      * @tparam Component Type of component to create.
      * @tparam Args Types of arguments to use to construct the component.
@@ -614,9 +608,7 @@ public:
      * Prefer this function anyway because it has slightly better performance.
      *
      * @warning
-     * Attempting to use an invalid entity results in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode in case of
-     * invalid entity.
+     * Attempting to use an invalid entity results in undefined behavior.
      *
      * @tparam Component Type of component to assign or replace.
      * @tparam Args Types of arguments to use to construct the component.
@@ -650,10 +642,7 @@ public:
      *
      * @warning
      * Attempting to use an invalid entity or to patch a component of an entity
-     * that doesn't own it results in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode in case of
-     * invalid entity or if the entity doesn't own an instance of the given
-     * component.
+     * that doesn't own it results in undefined behavior.
      *
      * @tparam Component Type of component to patch.
      * @tparam Func Types of the function objects to invoke.
@@ -676,10 +665,7 @@ public:
      *
      * @warning
      * Attempting to use an invalid entity or to replace a component of an
-     * entity that doesn't own it results in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode in case of
-     * invalid entity or if the entity doesn't own an instance of the given
-     * component.
+     * entity that doesn't own it results in undefined behavior.
      *
      * @tparam Component Type of component to replace.
      * @tparam Args Types of arguments to use to construct the component.
@@ -697,10 +683,7 @@ public:
      *
      * @warning
      * Attempting to use an invalid entity or to remove a component from an
-     * entity that doesn't own it results in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode in case of
-     * invalid entity or if the entity doesn't own an instance of the given
-     * component.
+     * entity that doesn't own it results in undefined behavior.
      *
      * @tparam Component Types of components to remove.
      * @param entity A valid entity identifier.
@@ -739,9 +722,7 @@ public:
      * Prefer this function anyway because it has slightly better performance.
      *
      * @warning
-     * Attempting to use an invalid entity results in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode in case of
-     * invalid entity.
+     * Attempting to use an invalid entity results in undefined behavior.
      *
      * @tparam Component Types of components to remove.
      * @param entity A valid entity identifier.
@@ -766,9 +747,7 @@ public:
      * could lead to undefined behavior.
      *
      * @warning
-     * Attempting to use an invalid entity results in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode in case of
-     * invalid entity.
+     * Attempting to use an invalid entity results in undefined behavior.
      *
      * @param entity A valid entity identifier.
      */
@@ -787,9 +766,7 @@ public:
      * @brief Checks if an entity has all the given components.
      *
      * @warning
-     * Attempting to use an invalid entity results in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode in case of
-     * invalid entity.
+     * Attempting to use an invalid entity results in undefined behavior.
      *
      * @tparam Component Components for which to perform the check.
      * @param entity A valid entity identifier.
@@ -805,9 +782,7 @@ public:
      * @brief Checks if an entity has at least one of the given components.
      *
      * @warning
-     * Attempting to use an invalid entity results in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode in case of
-     * invalid entity.
+     * Attempting to use an invalid entity results in undefined behavior.
      *
      * @tparam Component Components for which to perform the check.
      * @param entity A valid entity identifier.
@@ -825,10 +800,7 @@ public:
      *
      * @warning
      * Attempting to use an invalid entity or to get a component from an entity
-     * that doesn't own it results in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode in case of
-     * invalid entity or if the entity doesn't own an instance of the given
-     * component.
+     * that doesn't own it results in undefined behavior.
      *
      * @tparam Component Types of components to get.
      * @param entity A valid entity identifier.
@@ -871,9 +843,7 @@ public:
      * Prefer this function anyway because it has slightly better performance.
      *
      * @warning
-     * Attempting to use an invalid entity results in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode in case of
-     * invalid entity.
+     * Attempting to use an invalid entity results in undefined behavior.
      *
      * @tparam Component Type of component to get.
      * @tparam Args Types of arguments to use to construct the component.
@@ -892,9 +862,7 @@ public:
      * @brief Returns pointers to the given components for an entity.
      *
      * @warning
-     * Attempting to use an invalid entity results in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode in case of
-     * invalid entity.
+     * Attempting to use an invalid entity results in undefined behavior.
      *
      * @note
      * The registry retains ownership of the pointed-to components.
@@ -1399,9 +1367,7 @@ public:
      * this member function.
      *
      * @warning
-     * Pools of components owned by a group cannot be sorted.<br/>
-     * An assertion will abort the execution at runtime in debug mode in case
-     * the pool is owned by a group.
+     * Pools of components owned by a group cannot be sorted.
      *
      * @tparam Component Type of components to sort.
      * @tparam Compare Type of comparison function object.
@@ -1446,9 +1412,7 @@ public:
      * Any subsequent change to `B` won't affect the order in `A`.
      *
      * @warning
-     * Pools of components owned by a group cannot be sorted.<br/>
-     * An assertion will abort the execution at runtime in debug mode in case
-     * the pool is owned by a group.
+     * Pools of components owned by a group cannot be sorted.
      *
      * @tparam To Type of components to sort.
      * @tparam From Type of components to use to sort.
@@ -1587,9 +1551,7 @@ public:
      *
      * @warning
      * Attempting to get a context variable that doesn't exist results in
-     * undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode in case of
-     * invalid requests.
+     * undefined behavior.
      *
      * @tparam Type Type of object to get.
      * @return A valid reference to the object in the context of the registry.

src/entt/entity/sparse_set.hpp

@@ -361,9 +361,7 @@ public:
      *
      * @warning
      * Attempting to get the position of an entity that doesn't belong to the
-     * sparse set results in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode if the
-     * sparse set doesn't contain the given entity.
+     * sparse set results in undefined behavior.
      *
      * @param entt A valid entity identifier.
      * @return The position of the entity in the sparse set.
@@ -378,9 +376,7 @@ public:
      *
      * @warning
      * Attempting to assign an entity that already belongs to the sparse set
-     * results in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode if the
-     * sparse set already contains the given entity.
+     * results in undefined behavior.
      *
      * @param entt A valid entity identifier.
      */
@@ -395,9 +391,7 @@ public:
      *
      * @warning
      * Attempting to assign an entity that already belongs to the sparse set
-     * results in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode if the
-     * sparse set already contains the given entity.
+     * results in undefined behavior.
      *
      * @tparam It Type of input iterator.
      * @param first An iterator to the first element of the range of entities.
@@ -419,9 +413,7 @@ public:
      *
      * @warning
      * Attempting to remove an entity that doesn't belong to the sparse set
-     * results in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode if the
-     * sparse set doesn't contain the given entity.
+     * results in undefined behavior.
      *
      * @param entt A valid entity identifier.
      */
@@ -461,9 +453,7 @@ public:
      *
      * @warning
      * Attempting to swap entities that don't belong to the sparse set results
-     * in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode if the
-     * sparse set doesn't contain the given entities.
+     * in undefined behavior.
      *
      * @param lhs A valid entity identifier.
      * @param rhs A valid entity identifier.

src/entt/entity/storage.hpp

@@ -312,9 +312,7 @@ public:
      *
      * @warning
      * Attempting to use an entity that doesn't belong to the storage results in
-     * undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode if the
-     * storage doesn't contain the given entity.
+     * undefined behavior.
      *
      * @param entt A valid entity identifier.
      * @return The object associated with the entity.
@@ -351,9 +349,7 @@ public:
      *
      * @warning
      * Attempting to use an entity that already belongs to the storage results
-     * in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode if the
-     * storage already contains the given entity.
+     * in undefined behavior.
      *
      * @tparam Args Types of arguments to use to construct the object.
      * @param entt A valid entity identifier.
@@ -379,9 +375,7 @@ public:
      *
      * @warning
      * Attempting to assign an entity that already belongs to the storage
-     * results in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode if the
-     * storage already contains the given entity.
+     * results in undefined behavior.
      *
      * @tparam It Type of input iterator.
      * @param first An iterator to the first element of the range of entities.
@@ -420,9 +414,7 @@ public:
      *
      * @warning
      * Attempting to use an entity that doesn't belong to the storage results in
-     * undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode if the
-     * storage doesn't contain the given entity.
+     * undefined behavior.
      *
      * @param entt A valid entity identifier.
      */
@@ -449,9 +441,7 @@ public:
      *
      * @warning
      * Attempting to swap entities that don't belong to the sparse set results
-     * in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode if the
-     * sparse set doesn't contain the given entities.
+     * in undefined behavior.
      *
      * @param lhs A valid entity identifier.
      * @param rhs A valid entity identifier.
@@ -551,9 +541,7 @@ public:
      *
      * @warning
      * Attempting to use an entity that already belongs to the storage results
-     * in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode if the
-     * storage already contains the given entity.
+     * in undefined behavior.
      *
      * @tparam Args Types of arguments to use to construct the object.
      * @param entt A valid entity identifier.
@@ -570,9 +558,7 @@ public:
      *
      * @warning
      * Attempting to assign an entity that already belongs to the storage
-     * results in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode if the
-     * storage already contains the given entity.
+     * results in undefined behavior.
      *
      * @tparam It Type of input iterator.
      * @param first An iterator to the first element of the range of entities.

src/entt/entity/view.hpp

@@ -436,9 +436,7 @@ public:
      * @warning
      * Attempting to use an invalid component type results in a compilation
      * error. Attempting to use an entity that doesn't belong to the view
-     * results in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode if the
-     * view doesn't contain the given entity.
+     * results in undefined behavior.
      *
      * @tparam Comp Types of components to get.
      * @param entt A valid entity identifier.
@@ -885,9 +883,7 @@ public:
      * @warning
      * Attempting to use an invalid component type results in a compilation
      * error. Attempting to use an entity that doesn't belong to the view
-     * results in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode if the
-     * view doesn't contain the given entity.
+     * results in undefined behavior.
      *
      * @tparam Comp Types of components to get.
      * @param entt A valid entity identifier.

src/entt/entity/view_pack.hpp

@@ -293,9 +293,7 @@ public:
      * @warning
      * Attempting to use an invalid component type results in a compilation
      * error. Attempting to use an entity that doesn't belong to the pack
-     * results in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode if the
-     * pack doesn't contain the given entity.
+     * results in undefined behavior.
      *
      * @tparam Comp Types of components to get.
      * @param entt A valid entity identifier.

src/entt/meta/meta.hpp

@@ -366,9 +366,7 @@ public:
      *
      * @warning
      * Attempting to perform a cast that isn't viable results in undefined
-     * behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode in case
-     * the cast is not feasible.
+     * behavior.
      *
      * @tparam Type Type to which to cast the instance.
      * @return A reference to the contained instance.

src/entt/resource/handle.hpp

@@ -40,9 +40,7 @@ public:
      * @brief Gets a reference to the managed resource.
      *
      * @warning
-     * The behavior is undefined if the handle doesn't contain a resource.<br/>
-     * An assertion will abort the execution at runtime in debug mode if the
-     * handle is empty.
+     * The behavior is undefined if the handle doesn't contain a resource.
      *
      * @return A reference to the managed resource.
      */
@@ -80,9 +78,7 @@ public:
      * @brief Gets a pointer to the managed resource.
      *
      * @warning
-     * The behavior is undefined if the handle doesn't contain a resource.<br/>
-     * An assertion will abort the execution at runtime in debug mode if the
-     * handle is empty.
+     * The behavior is undefined if the handle doesn't contain a resource.
      *
      * @return A pointer to the managed resource or `nullptr` if the handle
      * contains no resource at all.

src/entt/signal/delegate.hpp

@@ -281,9 +281,7 @@ public:
      *
      * @warning
      * Attempting to trigger an invalid delegate results in undefined
-     * behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode if the
-     * delegate has not yet been set.
+     * behavior.
      *
      * @param args Arguments to use to invoke the underlying function.
      * @return The value returned by the underlying function.