Parcourir la source

doc: minor changes to make doxygen happy

Michele Caini il y a 5 ans
Parent
commit
d5e7005edd
2 fichiers modifiés avec 21 ajouts et 2 suppressions
  1. 2 1
      TODO
  2. 19 1
      src/entt/entity/view.hpp

+ 2 - 1
TODO

@@ -7,10 +7,11 @@
 * custom pools example (multi instance, tables, enable/disable, and so on...)
 
 WIP:
+* HP: make non-const try_get thread safe, add user data to type_info
+* HP: make pools available (registry/view/group), review operator| for views
 * HP: resource, forward the id to the loader from the cache and if constexpr the call to load, update doc and describe customization points
 * HP: any_vector for context variables
 * HP: make const registry::view thread safe, switch to a view<T...>{registry} model (long term goal)
-* HP: review registry::get, registry::try_get
 * HP: weak reference wrapper example with custom storage
 * HP: paginate pools
 * HP: headless (sparse set only) view

+ 19 - 1
src/entt/entity/view.hpp

@@ -533,6 +533,15 @@ public:
         return iterable_view{*this};
     }
 
+    /**
+     * @brief Combines two views in a _more specific_ one (friend function).
+     * @tparam Id A valid entity type (see entt_traits for more details).
+     * @tparam ELhs Filter list of the first view.
+     * @tparam CLhs Component list of the first view.
+     * @tparam ERhs Filter list of the second view.
+     * @tparam CRhs Component list of the second view.
+     * @return A more specific view.
+     */
     template<typename Id, typename... ELhs, typename... CLhs, typename... ERhs, typename... CRhs>
     friend auto operator|(const basic_view<Id, exclude_t<ELhs...>, CLhs...> &, const basic_view<Id, exclude_t<ERhs...>, CRhs...> &);
 
@@ -923,6 +932,15 @@ public:
         return iterable_view{*std::get<0>(pools)};
     }
 
+    /**
+     * @brief Combines two views in a _more specific_ one (friend function).
+     * @tparam Id A valid entity type (see entt_traits for more details).
+     * @tparam ELhs Filter list of the first view.
+     * @tparam CLhs Component list of the first view.
+     * @tparam ERhs Filter list of the second view.
+     * @tparam CRhs Component list of the second view.
+     * @return A more specific view.
+     */
     template<typename Id, typename... ELhs, typename... CLhs, typename... ERhs, typename... CRhs>
     friend auto operator|(const basic_view<Id, exclude_t<ELhs...>, CLhs...> &, const basic_view<Id, exclude_t<ERhs...>, CRhs...> &);
 
@@ -951,7 +969,7 @@ basic_view(Storage &... storage) ENTT_NOEXCEPT
  * @tparam CRhs Component list of the second view.
  * @param lhs A valid reference to the first view.
  * @param rhs A valid reference to the second view.
- * @return A more specific and correctly initialized view.
+ * @return A more specific view.
  */
 template<typename Entity, typename... ELhs, typename... CLhs, typename... ERhs, typename... CRhs>
 [[nodiscard]] auto operator|(const basic_view<Entity, exclude_t<ELhs...>, CLhs...> &lhs, const basic_view<Entity, exclude_t<ERhs...>, CRhs...> &rhs) {