Browse Source

doc: correct definition for ranges (close #560)

Michele Caini 5 years ago
parent
commit
c0a7f84382

+ 8 - 8
src/entt/entity/group.hpp

@@ -233,7 +233,7 @@ public:
      * @brief Direct access to the list of components of a given pool.
      *
      * The returned pointer is such that range
-     * `[raw<Component>(), raw<Component>() + size<Component>()]` is always a
+     * `[raw<Component>(), raw<Component>() + size<Component>())` is always a
      * valid range, even if the container is empty.
      *
      * @note
@@ -252,7 +252,7 @@ public:
      * @brief Direct access to the list of entities of a given pool.
      *
      * The returned pointer is such that range
-     * `[data<Component>(), data<Component>() + size<Component>()]` is always a
+     * `[data<Component>(), data<Component>() + size<Component>())` is always a
      * valid range, even if the container is empty.
      *
      * @note
@@ -270,7 +270,7 @@ public:
     /**
      * @brief Direct access to the list of entities.
      *
-     * The returned pointer is such that range `[data(), data() + size()]` is
+     * The returned pointer is such that range `[data(), data() + size())` is
      * always a valid range, even if the container is empty.
      *
      * @note
@@ -796,10 +796,10 @@ public:
      * @brief Direct access to the list of components of a given pool.
      *
      * The returned pointer is such that range
-     * `[raw<Component>(), raw<Component>() + size<Component>()]` is always a
+     * `[raw<Component>(), raw<Component>() + size<Component>())` is always a
      * valid range, even if the container is empty.<br/>
      * Moreover, in case the group owns the given component, the range
-     * `[raw<Component>(), raw<Component>() + size()]` is such that it contains
+     * `[raw<Component>(), raw<Component>() + size())` is such that it contains
      * the instances that are part of the group itself.
      *
      * @note
@@ -818,10 +818,10 @@ public:
      * @brief Direct access to the list of entities of a given pool.
      *
      * The returned pointer is such that range
-     * `[data<Component>(), data<Component>() + size<Component>()]` is always a
+     * `[data<Component>(), data<Component>() + size<Component>())` is always a
      * valid range, even if the container is empty.<br/>
      * Moreover, in case the group owns the given component, the range
-     * `[data<Component>(), data<Component>() + size()]` is such that it
+     * `[data<Component>(), data<Component>() + size())` is such that it
      * contains the entities that are part of the group itself.
      *
      * @note
@@ -839,7 +839,7 @@ public:
     /**
      * @brief Direct access to the list of entities.
      *
-     * The returned pointer is such that range `[data(), data() + size()]` is
+     * The returned pointer is such that range `[data(), data() + size())` is
      * always a valid range, even if the container is empty.
      *
      * @note

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

@@ -355,7 +355,7 @@ public:
     /**
      * @brief Direct access to the list of entities of the observer.
      *
-     * The returned pointer is such that range `[data(), data() + size()]` is
+     * The returned pointer is such that range `[data(), data() + size())` is
      * always a valid range, even if the container is empty.
      *
      * @note

+ 3 - 3
src/entt/entity/registry.hpp

@@ -294,7 +294,7 @@ public:
      * @brief Direct access to the list of components of a given pool.
      *
      * The returned pointer is such that range
-     * `[raw<Component>(), raw<Component>() + size<Component>()]` is always a
+     * `[raw<Component>(), raw<Component>() + size<Component>())` is always a
      * valid range, even if the container is empty.
      *
      * Components are in the reverse order as imposed by the sorting
@@ -322,7 +322,7 @@ public:
      * @brief Direct access to the list of entities of a given pool.
      *
      * The returned pointer is such that range
-     * `[data<Component>(), data<Component>() + size<Component>()]` is always a
+     * `[data<Component>(), data<Component>() + size<Component>())` is always a
      * valid range, even if the container is empty.
      *
      * Entities are in the reverse order as imposed by the sorting
@@ -339,7 +339,7 @@ public:
     /**
      * @brief Direct access to the list of entities of a registry.
      *
-     * The returned pointer is such that range `[data(), data() + size()]` is
+     * The returned pointer is such that range `[data(), data() + size())` is
      * always a valid range, even if the container is empty.
      *
      * @warning

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

@@ -266,7 +266,7 @@ public:
     /**
      * @brief Direct access to the internal packed array.
      *
-     * The returned pointer is such that range `[data(), data() + size()]` is
+     * The returned pointer is such that range `[data(), data() + size())` is
      * always a valid range, even if the container is empty.
      *
      * @note

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

@@ -194,7 +194,7 @@ public:
     /**
      * @brief Direct access to the array of objects.
      *
-     * The returned pointer is such that range `[raw(), raw() + size()]` is
+     * The returned pointer is such that range `[raw(), raw() + size())` is
      * always a valid range, even if the container is empty.
      *
      * @note

+ 4 - 4
src/entt/entity/view.hpp

@@ -390,7 +390,7 @@ public:
      * @brief Direct access to the list of components of a given pool.
      *
      * The returned pointer is such that range
-     * `[raw<Comp>(), raw<Comp>() + size<Comp>()]` is always a valid range, even
+     * `[raw<Comp>(), raw<Comp>() + size<Comp>())` is always a valid range, even
      * if the container is empty.
      *
      * @note
@@ -409,7 +409,7 @@ public:
      * @brief Direct access to the list of entities of a given pool.
      *
      * The returned pointer is such that range
-     * `[data<Comp>(), data<Comp>() + size<Comp>()]` is always a valid range,
+     * `[data<Comp>(), data<Comp>() + size<Comp>())` is always a valid range,
      * even if the container is empty.
      *
      * @note
@@ -848,7 +848,7 @@ public:
     /**
      * @brief Direct access to the list of components.
      *
-     * The returned pointer is such that range `[raw(), raw() + size()]` is
+     * The returned pointer is such that range `[raw(), raw() + size())` is
      * always a valid range, even if the container is empty.
      *
      * @note
@@ -864,7 +864,7 @@ public:
     /**
      * @brief Direct access to the list of entities.
      *
-     * The returned pointer is such that range `[data(), data() + size()]` is
+     * The returned pointer is such that range `[data(), data() + size())` is
      * always a valid range, even if the container is empty.
      *
      * @note