Skip to content

Commit

Permalink
docs(ecs): add core-ecs-entity module
Browse files Browse the repository at this point in the history
  • Loading branch information
RiscadoA committed Oct 1, 2023
1 parent db332f1 commit e9d6360
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 7 deletions.
4 changes: 2 additions & 2 deletions core/include/cubos/core/ecs/entity/entity.hpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/// @file
/// @brief Struct @ref cubos::core::ecs::Entity.
/// @ingroup core-ecs
/// @ingroup core-ecs-entity

#pragma once

Expand All @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions core/include/cubos/core/ecs/entity/hash.hpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/// @file
/// @brief Struct @ref cubos::core::ecs::EntityHash.
/// @ingroup core-ecs
/// @ingroup core-ecs-entity

#pragma once

Expand All @@ -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;
Expand Down
6 changes: 3 additions & 3 deletions core/include/cubos/core/ecs/entity/manager.hpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/// @file
/// @brief Class @ref cubos::core::ecs::EntityManager.
/// @ingroup core-ecs
/// @ingroup core-ecs-entity

#pragma once

Expand All @@ -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:
Expand Down
9 changes: 9 additions & 0 deletions core/include/cubos/core/ecs/entity/module.dox
Original file line number Diff line number Diff line change
@@ -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.
}

0 comments on commit e9d6360

Please sign in to comment.