doc: cleanup

src/entt/container/dense_map.hpp

@@ -487,8 +487,7 @@ public:
      * @brief Returns an iterator to the end.
      *
      * The returned iterator points to the element following the last instance
-     * of the internal array. Attempting to dereference the returned iterator
-     * results in undefined behavior.
+     * of the internal array.
      *
      * @return An iterator to the element following the last instance of the
      * internal array.

src/entt/container/dense_set.hpp

@@ -433,8 +433,7 @@ public:
      * @brief Returns an iterator to the end.
      *
      * The returned iterator points to the element following the last instance
-     * of the internal array. Attempting to dereference the returned iterator
-     * results in undefined behavior.
+     * of the internal array.
      *
      * @return An iterator to the element following the last instance of the
      * internal array.

src/entt/entity/group.hpp

@@ -283,7 +283,7 @@ class basic_group;
  * * The entity currently pointed is destroyed.
  *
  * In all other cases, modifying the pools iterated by the group in any way
- * invalidates all the iterators and using them results in undefined behavior.
+ * invalidates all the iterators.
  *
  * @tparam Get Types of storage _observed_ by the group.
  * @tparam Exclude Types of storage used to filter the group.
@@ -415,8 +415,7 @@ public:
      * @brief Returns an iterator that is past the last entity of the group.
      *
      * The returned iterator points to the entity following the last entity of
-     * the group. Attempting to dereference the returned iterator results in
-     * undefined behavior.
+     * the group.
      *
      * @return An iterator to the entity following the last entity of the
      * group.
@@ -442,8 +441,7 @@ public:
      * group.
      *
      * The returned iterator points to the entity following the last entity of
-     * the reversed group. Attempting to dereference the returned iterator
-     * results in undefined behavior.
+     * the reversed group.
      *
      * @return An iterator to the entity following the last entity of the
      * reversed group.
@@ -714,7 +712,7 @@ private:
  * * The entity currently pointed is destroyed.
  *
  * In all other cases, modifying the pools iterated by the group in any way
- * invalidates all the iterators and using them results in undefined behavior.
+ * invalidates all the iterators.
  *
  * @tparam Owned Types of storage _owned_ by the group.
  * @tparam Get Types of storage _observed_ by the group.
@@ -831,8 +829,7 @@ public:
      * @brief Returns an iterator that is past the last entity of the group.
      *
      * The returned iterator points to the entity following the last entity of
-     * the group. Attempting to dereference the returned iterator results in
-     * undefined behavior.
+     * the group.
      *
      * @return An iterator to the entity following the last entity of the
      * group.
@@ -858,8 +855,7 @@ public:
      * group.
      *
      * The returned iterator points to the entity following the last entity of
-     * the reversed group. Attempting to dereference the returned iterator
-     * results in undefined behavior.
+     * the reversed group.
      *
      * @return An iterator to the entity following the last entity of the
      * reversed group.

src/entt/entity/observer.hpp

@@ -146,8 +146,7 @@ inline constexpr basic_collector<> collector{};
  * * The entity currently pointed is destroyed.
  *
  * In all the other cases, modifying the pools of the given components in any
- * way invalidates all the iterators and using them results in undefined
- * behavior.
+ * way invalidates all the iterators.
  *
  * @warning
  * Lifetime of an observer doesn't necessarily have to overcome that of the
@@ -384,8 +383,7 @@ public:
      * @brief Returns an iterator that is past the last entity of the observer.
      *
      * The returned iterator points to the entity following the last entity of
-     * the observer. Attempting to dereference the returned iterator results in
-     * undefined behavior.
+     * the observer.
      *
      * @return An iterator to the entity following the last entity of the
      * observer.

src/entt/entity/runtime_view.hpp

@@ -123,8 +123,7 @@ private:
  * * The entity currently pointed is destroyed.
  *
  * In all the other cases, modifying the pools of the given components in any
- * way invalidates all the iterators and using them results in undefined
- * behavior.
+ * way invalidates all the iterators.
  *
  * @note
  * Views share references to the underlying data structures of the registry that
@@ -282,8 +281,7 @@ public:
      * given components.
      *
      * The returned iterator points to the entity following the last entity that
-     * has the given components. Attempting to dereference the returned iterator
-     * results in undefined behavior.
+     * has the given components.
      *
      * @return An iterator to the entity following the last entity that has the
      * given components.

src/entt/entity/sparse_set.hpp

@@ -562,8 +562,7 @@ public:
      * @brief Returns an iterator to the end.
      *
      * The returned iterator points to the element following the last entity in
-     * a sparse set. Attempting to dereference the returned iterator results in
-     * undefined behavior.
+     * a sparse set.
      *
      * @return An iterator to the element following the last entity of a sparse
      * set.
@@ -600,8 +599,7 @@ public:
      * @brief Returns a reverse iterator to the end.
      *
      * The returned iterator points to the element following the last entity in
-     * the reversed sparse set. Attempting to dereference the returned iterator
-     * results in undefined behavior.
+     * the reversed sparse set.
      *
      * @return An iterator to the element following the last entity of the
      * reversed sparse set.

src/entt/entity/storage.hpp

@@ -564,8 +564,7 @@ public:
      * @brief Returns an iterator to the end.
      *
      * The returned iterator points to the element following the last instance
-     * of the internal array. Attempting to dereference the returned iterator
-     * results in undefined behavior.
+     * of the internal array.
      *
      * @return An iterator to the element following the last instance of the
      * internal array.
@@ -611,8 +610,7 @@ public:
      * @brief Returns a reverse iterator to the end.
      *
      * The returned iterator points to the element following the last instance
-     * of the reversed internal array. Attempting to dereference the returned
-     * iterator results in undefined behavior.
+     * of the reversed internal array.
      *
      * @return An iterator to the element following the last instance of the
      * reversed internal array.

src/entt/entity/view.hpp

@@ -200,7 +200,7 @@ class basic_view;
  * * The entity currently pointed is destroyed.
  *
  * In all other cases, modifying the storage iterated by the view in any way
- * invalidates all the iterators and using them results in undefined behavior.
+ * invalidates all the iterators.
  *
  * @tparam Get Types of storage iterated by the view.
  * @tparam Exclude Types of storage used to filter the view.
@@ -402,8 +402,7 @@ public:
      * @brief Returns an iterator that is past the last entity of the view.
      *
      * The returned iterator points to the entity following the last entity of
-     * the view. Attempting to dereference the returned iterator results in
-     * undefined behavior.
+     * the view.
      *
      * @return An iterator to the entity following the last entity of the view.
      */
@@ -584,7 +583,7 @@ private:
  * * The entity currently pointed is destroyed.
  *
  * In all other cases, modifying the storage iterated by the view in any way
- * invalidates all the iterators and using them results in undefined behavior.
+ * invalidates all the iterators.
  *
  * @tparam Get Type of storage iterated by the view.
  */
@@ -708,8 +707,7 @@ public:
      * @brief Returns an iterator that is past the last entity of the view.
      *
      * The returned iterator points to the entity following the last entity of
-     * the view. Attempting to dereference the returned iterator results in
-     * undefined behavior.
+     * the view.
      *
      * @return An iterator to the entity following the last entity of the view.
      */
@@ -734,8 +732,7 @@ public:
      * view.
      *
      * The returned iterator points to the entity following the last entity of
-     * the reversed view. Attempting to dereference the returned iterator
-     * results in undefined behavior.
+     * the reversed view.
      *
      * @return An iterator to the entity following the last entity of the
      * reversed view.

src/entt/resource/cache.hpp

@@ -264,8 +264,7 @@ public:
      * @brief Returns an iterator to the end.
      *
      * The returned iterator points to the element following the last instance
-     * of the cache. Attempting to dereference the returned iterator results in
-     * undefined behavior.
+     * of the cache.
      *
      * @return An iterator to the element following the last instance of the
      * internal cache.