Skip to content

Commit

Permalink
docs(core): fix docs warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
RiscadoA committed Aug 25, 2023
1 parent 42c5706 commit b725fb4
Show file tree
Hide file tree
Showing 9 changed files with 12 additions and 11 deletions.
2 changes: 1 addition & 1 deletion core/include/cubos/core/data/fs/module.dox
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/// @dir
/// @brief @ref Filesystem utilities directory.
/// @brief Filesystem utilities directory.

#pragma once

Expand Down
2 changes: 1 addition & 1 deletion core/include/cubos/core/data/fs/standard_archive.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions core/include/cubos/core/ecs/blueprint.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
2 changes: 1 addition & 1 deletion core/include/cubos/core/ecs/commands.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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 <typename ComponentType>
Expand Down
2 changes: 1 addition & 1 deletion core/include/cubos/core/ecs/entity_manager.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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<Entity, std::string> 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.
Expand Down
2 changes: 1 addition & 1 deletion core/include/cubos/core/ecs/event_pipe.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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();

Expand Down
2 changes: 1 addition & 1 deletion core/include/cubos/core/ecs/registry.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
8 changes: 4 additions & 4 deletions core/include/cubos/core/memory/guards.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -17,8 +19,6 @@ namespace cubos::core::memory
/// using AssetMetaRead = core::memory::ReadGuard<AssetMeta, std::shared_lock<std::shared_mutex>>;
/// @endcode
///
/// @tparam T Guarded object type.
/// @tparam Lock Held lock type.
/// @ingroup core-memory
template <typename T, typename Lock>
class ReadGuard
Expand Down Expand Up @@ -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.
Expand All @@ -78,8 +80,6 @@ namespace cubos::core::memory
/// using AssetMetaWrite = core::memory::WriteGuard<AssetMeta, std::unique_lock<std::shared_mutex>>;
/// @endcode
///
/// @tparam T Guarded object type.
/// @tparam Lock Held lock type.
/// @ingroup core-memory
template <typename T, typename Lock>
class WriteGuard
Expand Down
2 changes: 1 addition & 1 deletion core/include/cubos/core/module.dox
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit b725fb4

Please sign in to comment.