Michele Caini 2 лет назад
Родитель
Сommit
c0e6759c69

+ 0 - 5
src/entt/container/dense_map.hpp

@@ -464,7 +464,6 @@ public:
     /**
      * @brief Returns an iterator to the beginning.
      *
-     * The returned iterator points to the first instance of the internal array.
      * If the array is empty, the returned iterator will be equal to `end()`.
      *
      * @return An iterator to the first instance of the internal array.
@@ -485,10 +484,6 @@ public:
 
     /**
      * @brief Returns an iterator to the end.
-     *
-     * The returned iterator points to the element following the last instance
-     * of the internal array.
-     *
      * @return An iterator to the element following the last instance of the
      * internal array.
      */

+ 0 - 5
src/entt/container/dense_set.hpp

@@ -410,7 +410,6 @@ public:
     /**
      * @brief Returns an iterator to the beginning.
      *
-     * The returned iterator points to the first instance of the internal array.
      * If the array is empty, the returned iterator will be equal to `end()`.
      *
      * @return An iterator to the first instance of the internal array.
@@ -431,10 +430,6 @@ public:
 
     /**
      * @brief Returns an iterator to the end.
-     *
-     * The returned iterator points to the element following the last instance
-     * of the internal array.
-     *
      * @return An iterator to the element following the last instance of the
      * internal array.
      */

+ 2 - 22
src/entt/entity/group.hpp

@@ -402,8 +402,7 @@ public:
     /**
      * @brief Returns an iterator to the first entity of the group.
      *
-     * The returned iterator points to the first entity of the group. If the
-     * group is empty, the returned iterator will be equal to `end()`.
+     * If the group is empty, the returned iterator will be equal to `end()`.
      *
      * @return An iterator to the first entity of the group.
      */
@@ -413,10 +412,6 @@ 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.
-     *
      * @return An iterator to the entity following the last entity of the
      * group.
      */
@@ -427,7 +422,6 @@ public:
     /**
      * @brief Returns an iterator to the first entity of the reversed group.
      *
-     * The returned iterator points to the first entity of the reversed group.
      * If the group is empty, the returned iterator will be equal to `rend()`.
      *
      * @return An iterator to the first entity of the reversed group.
@@ -439,10 +433,6 @@ public:
     /**
      * @brief Returns an iterator that is past the last entity of the reversed
      * group.
-     *
-     * The returned iterator points to the entity following the last entity of
-     * the reversed group.
-     *
      * @return An iterator to the entity following the last entity of the
      * reversed group.
      */
@@ -816,8 +806,7 @@ public:
     /**
      * @brief Returns an iterator to the first entity of the group.
      *
-     * The returned iterator points to the first entity of the group. If the
-     * group is empty, the returned iterator will be equal to `end()`.
+     * If the group is empty, the returned iterator will be equal to `end()`.
      *
      * @return An iterator to the first entity of the group.
      */
@@ -827,10 +816,6 @@ 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.
-     *
      * @return An iterator to the entity following the last entity of the
      * group.
      */
@@ -841,7 +826,6 @@ public:
     /**
      * @brief Returns an iterator to the first entity of the reversed group.
      *
-     * The returned iterator points to the first entity of the reversed group.
      * If the group is empty, the returned iterator will be equal to `rend()`.
      *
      * @return An iterator to the first entity of the reversed group.
@@ -853,10 +837,6 @@ public:
     /**
      * @brief Returns an iterator that is past the last entity of the reversed
      * group.
-     *
-     * The returned iterator points to the entity following the last entity of
-     * the reversed group.
-     *
      * @return An iterator to the entity following the last entity of the
      * reversed group.
      */

+ 1 - 6
src/entt/entity/observer.hpp

@@ -370,8 +370,7 @@ public:
     /**
      * @brief Returns an iterator to the first entity of the observer.
      *
-     * The returned iterator points to the first entity of the observer. If the
-     * container is empty, the returned iterator will be equal to `end()`.
+     * If the observer is empty, the returned iterator will be equal to `end()`.
      *
      * @return An iterator to the first entity of the observer.
      */
@@ -381,10 +380,6 @@ 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.
-     *
      * @return An iterator to the entity following the last entity of the
      * observer.
      */

+ 1 - 7
src/entt/entity/runtime_view.hpp

@@ -266,9 +266,7 @@ public:
      * @brief Returns an iterator to the first entity that has the given
      * components.
      *
-     * The returned iterator points to the first entity that has the given
-     * components. If the view is empty, the returned iterator will be equal to
-     * `end()`.
+     * If the view is empty, the returned iterator will be equal to `end()`.
      *
      * @return An iterator to the first entity that has the given components.
      */
@@ -279,10 +277,6 @@ public:
     /**
      * @brief Returns an iterator that is past the last entity that has the
      * given components.
-     *
-     * The returned iterator points to the entity following the last entity that
-     * has the given components.
-     *
      * @return An iterator to the entity following the last entity that has the
      * given components.
      */

+ 3 - 13
src/entt/entity/sparse_set.hpp

@@ -542,8 +542,7 @@ public:
     /**
      * @brief Returns an iterator to the beginning.
      *
-     * The returned iterator points to the first entity of the internal packed
-     * array. If the sparse set is empty, the returned iterator will be equal to
+     * If the sparse set is empty, the returned iterator will be equal to
      * `end()`.
      *
      * @return An iterator to the first entity of the sparse set.
@@ -560,10 +559,6 @@ public:
 
     /**
      * @brief Returns an iterator to the end.
-     *
-     * The returned iterator points to the element following the last entity in
-     * a sparse set.
-     *
      * @return An iterator to the element following the last entity of a sparse
      * set.
      */
@@ -579,9 +574,8 @@ public:
     /**
      * @brief Returns a reverse iterator to the beginning.
      *
-     * The returned iterator points to the first entity of the reversed internal
-     * packed array. If the sparse set is empty, the returned iterator will be
-     * equal to `rend()`.
+     * If the sparse set is empty, the returned iterator will be equal to
+     * `rend()`.
      *
      * @return An iterator to the first entity of the reversed internal packed
      * array.
@@ -597,10 +591,6 @@ 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.
-     *
      * @return An iterator to the element following the last entity of the
      * reversed sparse set.
      */

+ 1 - 12
src/entt/entity/storage.hpp

@@ -539,7 +539,6 @@ public:
     /**
      * @brief Returns an iterator to the beginning.
      *
-     * The returned iterator points to the first instance of the internal array.
      * If the storage is empty, the returned iterator will be equal to `end()`.
      *
      * @return An iterator to the first instance of the internal array.
@@ -562,10 +561,6 @@ public:
 
     /**
      * @brief Returns an iterator to the end.
-     *
-     * The returned iterator points to the element following the last instance
-     * of the internal array.
-     *
      * @return An iterator to the element following the last instance of the
      * internal array.
      */
@@ -586,9 +581,7 @@ public:
     /**
      * @brief Returns a reverse iterator to the beginning.
      *
-     * The returned iterator points to the first instance of the reversed
-     * internal array. If the storage is empty, the returned iterator will be
-     * equal to `rend()`.
+     * If the storage is empty, the returned iterator will be equal to `rend()`.
      *
      * @return An iterator to the first instance of the reversed internal array.
      */
@@ -608,10 +601,6 @@ 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.
-     *
      * @return An iterator to the element following the last instance of the
      * reversed internal array.
      */

+ 3 - 18
src/entt/entity/view.hpp

@@ -389,8 +389,7 @@ public:
     /**
      * @brief Returns an iterator to the first entity of the view.
      *
-     * The returned iterator points to the first entity of the view. If the view
-     * is empty, the returned iterator will be equal to `end()`.
+     * If the view is empty, the returned iterator will be equal to `end()`.
      *
      * @return An iterator to the first entity of the view.
      */
@@ -400,10 +399,6 @@ 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.
-     *
      * @return An iterator to the entity following the last entity of the view.
      */
     [[nodiscard]] iterator end() const noexcept {
@@ -694,8 +689,7 @@ public:
     /**
      * @brief Returns an iterator to the first entity of the view.
      *
-     * The returned iterator points to the first entity of the view. If the view
-     * is empty, the returned iterator will be equal to `end()`.
+     * If the view is empty, the returned iterator will be equal to `end()`.
      *
      * @return An iterator to the first entity of the view.
      */
@@ -705,10 +699,6 @@ 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.
-     *
      * @return An iterator to the entity following the last entity of the view.
      */
     [[nodiscard]] iterator end() const noexcept {
@@ -718,8 +708,7 @@ public:
     /**
      * @brief Returns an iterator to the first entity of the reversed view.
      *
-     * The returned iterator points to the first entity of the reversed view. If
-     * the view is empty, the returned iterator will be equal to `rend()`.
+     * If the view is empty, the returned iterator will be equal to `rend()`.
      *
      * @return An iterator to the first entity of the reversed view.
      */
@@ -730,10 +719,6 @@ public:
     /**
      * @brief Returns an iterator that is past the last entity of the reversed
      * view.
-     *
-     * The returned iterator points to the entity following the last entity of
-     * the reversed view.
-     *
      * @return An iterator to the entity following the last entity of the
      * reversed view.
      */

+ 1 - 6
src/entt/resource/cache.hpp

@@ -241,8 +241,7 @@ public:
     /**
      * @brief Returns an iterator to the beginning.
      *
-     * The returned iterator points to the first instance of the cache. If the
-     * cache is empty, the returned iterator will be equal to `end()`.
+     * If the cache is empty, the returned iterator will be equal to `end()`.
      *
      * @return An iterator to the first instance of the internal cache.
      */
@@ -262,10 +261,6 @@ public:
 
     /**
      * @brief Returns an iterator to the end.
-     *
-     * The returned iterator points to the element following the last instance
-     * of the cache.
-     *
      * @return An iterator to the element following the last instance of the
      * internal cache.
      */