From ebeec9cd18ca2632cf014ca9820eb657fb03c3c0 Mon Sep 17 00:00:00 2001 From: Ricardo Antunes Date: Fri, 25 Aug 2023 13:36:17 +0100 Subject: [PATCH] docs(core): fix docs warnings --- core/include/cubos/core/data/fs/module.dox | 2 +- core/include/cubos/core/data/fs/standard_archive.hpp | 2 +- core/include/cubos/core/ecs/blueprint.hpp | 1 + core/include/cubos/core/ecs/commands.hpp | 2 +- core/include/cubos/core/ecs/entity_manager.hpp | 2 +- core/include/cubos/core/ecs/event_pipe.hpp | 2 +- core/include/cubos/core/ecs/registry.hpp | 2 +- core/include/cubos/core/memory/guards.hpp | 8 ++++---- core/include/cubos/core/module.dox | 2 +- 9 files changed, 12 insertions(+), 11 deletions(-) diff --git a/core/include/cubos/core/data/fs/module.dox b/core/include/cubos/core/data/fs/module.dox index 4e3637b09..b8f6f00d6 100644 --- a/core/include/cubos/core/data/fs/module.dox +++ b/core/include/cubos/core/data/fs/module.dox @@ -1,5 +1,5 @@ /// @dir -/// @brief @ref Filesystem utilities directory. +/// @brief Filesystem utilities directory. #pragma once diff --git a/core/include/cubos/core/data/fs/standard_archive.hpp b/core/include/cubos/core/data/fs/standard_archive.hpp index d9a2084f0..e3351c68b 100644 --- a/core/include/cubos/core/data/fs/standard_archive.hpp +++ b/core/include/cubos/core/data/fs/standard_archive.hpp @@ -57,7 +57,7 @@ namespace cubos::core::data }; /// @brief Recursively adds all files in the directory to the archive. - /// @param Id of the directory. + /// @param parent Id of the directory. void generate(std::size_t parent); std::filesystem::path mOsPath; ///< Path to the directory in the real file system. diff --git a/core/include/cubos/core/ecs/blueprint.hpp b/core/include/cubos/core/ecs/blueprint.hpp index ebc702872..23c541a59 100644 --- a/core/include/cubos/core/ecs/blueprint.hpp +++ b/core/include/cubos/core/ecs/blueprint.hpp @@ -82,6 +82,7 @@ namespace cubos::core::ecs /// @brief Merges the data of another buffer of the same type into this one. /// @param other Buffer to merge from. + /// @param prefix Prefix to add to the names of the components of the other buffer. /// @param src Context to use when serializing the components from the other buffer. /// @param dst Context to use when deserializing the components to this buffer. virtual void merge(IBuffer* other, const std::string& prefix, data::Context& src, data::Context& dst) = 0; diff --git a/core/include/cubos/core/ecs/commands.hpp b/core/include/cubos/core/ecs/commands.hpp index ac90c17c1..5bccf5347 100644 --- a/core/include/cubos/core/ecs/commands.hpp +++ b/core/include/cubos/core/ecs/commands.hpp @@ -214,7 +214,7 @@ namespace cubos::core::ecs virtual void move(Entity entity, ComponentManager& manager) = 0; }; - /// @brief Implementation of the @ref IBuffer interface for a component type + /// @brief Implementation of the above interface for a component type /// @p ComponentType. /// @tparam ComponentType Component type. template diff --git a/core/include/cubos/core/ecs/entity_manager.hpp b/core/include/cubos/core/ecs/entity_manager.hpp index cb15e95d3..826bfacb9 100644 --- a/core/include/cubos/core/ecs/entity_manager.hpp +++ b/core/include/cubos/core/ecs/entity_manager.hpp @@ -15,7 +15,7 @@ namespace cubos::core::ecs { /// @brief Identifies an entity. /// - /// When serializing/deserializing, if there's a @ref + /// When serializing/deserializing, if there's a /// data::SerializationMap in the context, it will be used to /// (de)serialize strings representing the entities. Otherwise, the identifiers will be /// (de)serialized as objects with two fields: their index and their generation. diff --git a/core/include/cubos/core/ecs/event_pipe.hpp b/core/include/cubos/core/ecs/event_pipe.hpp index 45003a32b..ccad42923 100644 --- a/core/include/cubos/core/ecs/event_pipe.hpp +++ b/core/include/cubos/core/ecs/event_pipe.hpp @@ -50,7 +50,7 @@ namespace cubos::core::ecs /// /// This is necessary to keep track of when its okay to delete events on @ref clear(). /// - /// @note This is called on @ref SystemFetcher::prepare(). + /// @note This is called on @ref impl::SystemFetcher::prepare(). /// @see EventReader void addReader(); diff --git a/core/include/cubos/core/ecs/registry.hpp b/core/include/cubos/core/ecs/registry.hpp index b886b81a0..fb71ba26d 100644 --- a/core/include/cubos/core/ecs/registry.hpp +++ b/core/include/cubos/core/ecs/registry.hpp @@ -115,7 +115,7 @@ namespace cubos::core::ecs } // namespace cubos::core::ecs /// @brief Macro used to register a component type as an alternative to calling -/// @ref Registry::add() manually. +/// @ref cubos::core::ecs::Registry::add() manually. /// @warning Care must be taken to ensure that this macro is included from at least one translation /// unit (think of it as a .cpp file) in the executable, otherwise the component type may not be /// registered. E.g.: keeping it hidden in a .cpp file on a library may not work. diff --git a/core/include/cubos/core/memory/guards.hpp b/core/include/cubos/core/memory/guards.hpp index 19e841bfd..dc2d623a8 100644 --- a/core/include/cubos/core/memory/guards.hpp +++ b/core/include/cubos/core/memory/guards.hpp @@ -7,6 +7,8 @@ namespace cubos::core::memory { /// @brief Provides safe read-only access to an object using a lock. + /// @tparam T Guarded object type. + /// @tparam Lock Held lock type. /// /// This class was created because there are multiple parts of the code that need to provide /// access to objects in a thread-safe manner. @@ -17,8 +19,6 @@ namespace cubos::core::memory /// using AssetMetaRead = core::memory::ReadGuard>; /// @endcode /// - /// @tparam T Guarded object type. - /// @tparam Lock Held lock type. /// @ingroup core-memory template class ReadGuard @@ -68,6 +68,8 @@ namespace cubos::core::memory }; /// @brief Provides safe read-write access to an object using a lock. + /// @tparam T Guarded object type. + /// @tparam Lock Held lock type. /// /// This class was created because there are multiple parts of the code that need to provide /// access to objects in a thread-safe manner. @@ -78,8 +80,6 @@ namespace cubos::core::memory /// using AssetMetaWrite = core::memory::WriteGuard>; /// @endcode /// - /// @tparam T Guarded object type. - /// @tparam Lock Held lock type. /// @ingroup core-memory template class WriteGuard diff --git a/core/include/cubos/core/module.dox b/core/include/cubos/core/module.dox index 0437821bf..2352b845a 100644 --- a/core/include/cubos/core/module.dox +++ b/core/include/cubos/core/module.dox @@ -8,7 +8,7 @@ namespace cubos::core { - /// @defgroup core + /// @defgroup core Core /// @brief CUBOS. core library. /// /// The core library contains loose utilities and functionality on which the rest of the CUBOS.