Browse Source

doc: help doxygen not to go crazy (thanks to @erez-o for pointing this out)

Michele Caini 5 years ago
parent
commit
fbf3b9ce4d
3 changed files with 29 additions and 20 deletions
  1. 21 10
      src/entt/entity/fwd.hpp
  2. 2 3
      src/entt/resource/fwd.hpp
  3. 6 7
      src/entt/signal/fwd.hpp

+ 21 - 10
src/entt/entity/fwd.hpp

@@ -8,73 +8,82 @@
 namespace entt {
 
 
-/*! @class basic_registry */
 template <typename>
 class basic_registry;
 
-/*! @class basic_view */
+
 template<typename...>
 class basic_view;
 
-/*! @class basic_runtime_view */
+
 template<typename>
 class basic_runtime_view;
 
-/*! @class basic_group */
+
 template<typename...>
 class basic_group;
 
-/*! @class basic_observer */
+
 template<typename>
 class basic_observer;
 
-/*! @struct basic_actor */
+
 template <typename>
 struct basic_actor;
 
-/*! @class basic_handle */
+
 template<typename>
 struct basic_handle;
 
-/*! @class basic_snapshot */
+
 template<typename>
 class basic_snapshot;
 
-/*! @class basic_snapshot_loader */
+
 template<typename>
 class basic_snapshot_loader;
 
-/*! @class basic_continuous_loader */
+
 template<typename>
 class basic_continuous_loader;
 
+
 /*! @brief Default entity identifier. */
 enum class entity: id_type {};
 
+
 /*! @brief Alias declaration for the most common use case. */
 using registry = basic_registry<entity>;
 
+
 /*! @brief Alias declaration for the most common use case. */
 using observer = basic_observer<entity>;
 
+
 /*! @brief Alias declaration for the most common use case. */
 using actor [[deprecated("Consider using the handle class instead")]] = basic_actor<entity>;
 
+
 /*! @brief Alias declaration for the most common use case. */
 using handle = basic_handle<entity>;
 
+
 /*! @brief Alias declaration for the most common use case. */
 using const_handle = basic_handle<const entity>;
 
+
 /*! @brief Alias declaration for the most common use case. */
 using snapshot = basic_snapshot<entity>;
 
+
 /*! @brief Alias declaration for the most common use case. */
 using snapshot_loader = basic_snapshot_loader<entity>;
 
+
 /*! @brief Alias declaration for the most common use case. */
 using continuous_loader = basic_continuous_loader<entity>;
 
+
 /**
  * @brief Alias declaration for the most common use case.
  * @tparam Types Types of components iterated by the view.
@@ -82,9 +91,11 @@ using continuous_loader = basic_continuous_loader<entity>;
 template<typename... Types>
 using view = basic_view<entity, Types...>;
 
+
 /*! @brief Alias declaration for the most common use case. */
 using runtime_view = basic_runtime_view<entity>;
 
+
 /**
  * @brief Alias declaration for the most common use case.
  * @tparam Types Types of components iterated by the group.

+ 2 - 3
src/entt/resource/fwd.hpp

@@ -5,15 +5,14 @@
 namespace entt {
 
 
-/*! @struct cache */
 template<typename>
 struct resource_cache;
 
-/*! @class handle */
+
 template<typename>
 class resource_handle;
 
-/*! @class loader */
+
 template<typename, typename>
 class resource_loader;
 

+ 6 - 7
src/entt/signal/fwd.hpp

@@ -5,28 +5,27 @@
 namespace entt {
 
 
-/*! @class delegate */
 template<typename>
 class delegate;
 
-/*! @class dispatcher */
+
 class dispatcher;
 
-/*! @class emitter */
+
 template<typename>
 class emitter;
 
-/*! @class connection */
+
 class connection;
 
-/*! @class scoped_connection */
+
 struct scoped_connection;
 
-/*! @class sink */
+
 template<typename>
 class sink;
 
-/*! @class sigh */
+
 template<typename>
 class sigh;