Jelajahi Sumber

doc: minor changes

Michele Caini 2 tahun lalu
induk
melakukan
d0528c7a4d
3 mengubah file dengan 2 tambahan dan 13 penghapusan
  1. 1 1
      src/entt/entity/sparse_set.hpp
  2. 0 10
      src/entt/entity/storage.hpp
  3. 1 2
      src/entt/meta/meta.hpp

+ 1 - 1
src/entt/entity/sparse_set.hpp

@@ -750,7 +750,7 @@ public:
     }
 
     /**
-     * @brief Returns the entity at specified location, without bounds checking.
+     * @brief Returns the entity at specified location.
      * @param pos The position for which to return the entity.
      * @return The entity at specified location.
      */

+ 0 - 10
src/entt/entity/storage.hpp

@@ -856,11 +856,6 @@ public:
 
     /**
      * @brief Returns an empty tuple.
-     *
-     * @warning
-     * Attempting to use an entity that doesn't belong to the storage results in
-     * undefined behavior.
-     *
      * @param entt A valid identifier.
      * @return Returns an empty tuple.
      */
@@ -1043,11 +1038,6 @@ public:
 
     /**
      * @brief Returns an empty tuple.
-     *
-     * @warning
-     * Attempting to use an entity that doesn't belong to the storage results in
-     * undefined behavior.
-     *
      * @param entt A valid identifier.
      * @return Returns an empty tuple.
      */

+ 1 - 2
src/entt/meta/meta.hpp

@@ -1865,8 +1865,7 @@ inline meta_sequence_container::iterator meta_sequence_container::erase(iterator
 }
 
 /**
- * @brief Returns a reference to the element at a given location of a container
- * (no bounds checking is performed).
+ * @brief Returns a reference to the element at a given location of a container.
  * @param pos The position of the element to return.
  * @return A reference to the requested element properly wrapped.
  */