From 1ac1b0ab2d7d1c278344d20a13a5adaded0fb30d Mon Sep 17 00:00:00 2001
From: Ricardo Antunes <me@riscadoa.com>
Date: Sun, 1 Oct 2023 16:26:18 +0100
Subject: [PATCH] docs(ecs): add core-ecs-entity module

---
 core/include/cubos/core/ecs/entity/entity.hpp  | 4 ++--
 core/include/cubos/core/ecs/entity/hash.hpp    | 4 ++--
 core/include/cubos/core/ecs/entity/manager.hpp | 6 +++---
 core/include/cubos/core/ecs/entity/module.dox  | 9 +++++++++
 4 files changed, 16 insertions(+), 7 deletions(-)
 create mode 100644 core/include/cubos/core/ecs/entity/module.dox

diff --git a/core/include/cubos/core/ecs/entity/entity.hpp b/core/include/cubos/core/ecs/entity/entity.hpp
index f27871f03..7726166cf 100644
--- a/core/include/cubos/core/ecs/entity/entity.hpp
+++ b/core/include/cubos/core/ecs/entity/entity.hpp
@@ -1,6 +1,6 @@
 /// @file
 /// @brief Struct @ref cubos::core::ecs::Entity.
-/// @ingroup core-ecs
+/// @ingroup core-ecs-entity
 
 #pragma once
 
@@ -16,7 +16,7 @@ namespace cubos::core::ecs
     /// (de)serialize strings representing the entities. Otherwise, the identifiers will be
     /// (de)serialized as objects with two fields: their index and their generation.
     ///
-    /// @ingroup core-ecs
+    /// @ingroup core-ecs-entity
     struct Entity
     {
         /// @brief Type used to store which components an entity has.
diff --git a/core/include/cubos/core/ecs/entity/hash.hpp b/core/include/cubos/core/ecs/entity/hash.hpp
index f187380fb..2da9641d8 100644
--- a/core/include/cubos/core/ecs/entity/hash.hpp
+++ b/core/include/cubos/core/ecs/entity/hash.hpp
@@ -1,6 +1,6 @@
 /// @file
 /// @brief Struct @ref cubos::core::ecs::EntityHash.
-/// @ingroup core-ecs
+/// @ingroup core-ecs-entity
 
 #pragma once
 
@@ -14,7 +14,7 @@ namespace cubos::core::ecs
     ///
     /// Can be used to allow @ref Entity objects to be used as keys in an `std::unordered_map`.
     ///
-    /// @ingroup core-ecs
+    /// @ingroup core-ecs-entity
     struct EntityHash
     {
         std::size_t operator()(const Entity& entity) const noexcept;
diff --git a/core/include/cubos/core/ecs/entity/manager.hpp b/core/include/cubos/core/ecs/entity/manager.hpp
index aa41fea93..d6adbae10 100644
--- a/core/include/cubos/core/ecs/entity/manager.hpp
+++ b/core/include/cubos/core/ecs/entity/manager.hpp
@@ -1,6 +1,6 @@
 /// @file
 /// @brief Class @ref cubos::core::ecs::EntityManager.
-/// @ingroup core-ecs
+/// @ingroup core-ecs-entity
 
 #pragma once
 
@@ -14,11 +14,11 @@
 
 namespace cubos::core::ecs
 {
-    /// @brief Holds and manages entities and their component masks.
+    /// @brief Internal type which holds and manages entities and their component masks.
     ///
     /// Used internally by @ref World.
     ///
-    /// @ingroup core-ecs
+    /// @ingroup core-ecs-entity
     class EntityManager final
     {
     public:
diff --git a/core/include/cubos/core/ecs/entity/module.dox b/core/include/cubos/core/ecs/entity/module.dox
new file mode 100644
index 000000000..a63b792f3
--- /dev/null
+++ b/core/include/cubos/core/ecs/entity/module.dox
@@ -0,0 +1,9 @@
+/// @dir
+/// @brief @ref core-ecs-entity directory.
+
+namespace cubos::core::ecs
+{
+    /// @defgroup core-ecs-entity Entity
+    /// @ingroup core-ecs
+    /// @brief Entity part of the ECS.
+}