From d2b6eed671172c51cfb1c6fa5fdaf3ddaa1f161d Mon Sep 17 00:00:00 2001 From: Michele Caini Date: Sun, 7 Apr 2024 17:33:36 +0200 Subject: [PATCH] doc: minor changes --- src/entt/graph/adjacency_matrix.hpp | 16 ++++++++-------- src/entt/resource/resource.hpp | 4 ++-- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/src/entt/graph/adjacency_matrix.hpp b/src/entt/graph/adjacency_matrix.hpp index f7e9bd3d6..b97e14566 100644 --- a/src/entt/graph/adjacency_matrix.hpp +++ b/src/entt/graph/adjacency_matrix.hpp @@ -111,9 +111,9 @@ public: using vertex_iterator = iota_iterator; /*! @brief Edge iterator type. */ using edge_iterator = internal::edge_iterator; - /*! @brief Out edge iterator type. */ + /*! @brief Out-edge iterator type. */ using out_edge_iterator = edge_iterator; - /*! @brief In edge iterator type. */ + /*! @brief In-edge iterator type. */ using in_edge_iterator = edge_iterator; /*! @brief Graph category tag. */ using graph_category = Category; @@ -257,9 +257,9 @@ public: } /** - * @brief Returns an iterable object to visit all out edges of a vertex. - * @param vertex The vertex of which to return all out edges. - * @return An iterable object to visit all out edges of a vertex. + * @brief Returns an iterable object to visit all out-edges of a vertex. + * @param vertex The vertex of which to return all out-edges. + * @return An iterable object to visit all out-edges of a vertex. */ [[nodiscard]] iterable_adaptor out_edges(const vertex_type vertex) const noexcept { const auto it = matrix.cbegin(); @@ -269,9 +269,9 @@ public: } /** - * @brief Returns an iterable object to visit all in edges of a vertex. - * @param vertex The vertex of which to return all in edges. - * @return An iterable object to visit all in edges of a vertex. + * @brief Returns an iterable object to visit all in-edges of a vertex. + * @param vertex The vertex of which to return all in-edges. + * @return An iterable object to visit all in-edges of a vertex. */ [[nodiscard]] iterable_adaptor in_edges(const vertex_type vertex) const noexcept { const auto it = matrix.cbegin(); diff --git a/src/entt/resource/resource.hpp b/src/entt/resource/resource.hpp index b5153b96a..fbe052412 100644 --- a/src/entt/resource/resource.hpp +++ b/src/entt/resource/resource.hpp @@ -37,8 +37,8 @@ public: : value{} {} /** - * @brief Creates a handle from a weak pointer, namely a resource. - * @param res A weak pointer to a resource. + * @brief Creates a new resource handle. + * @param res A handle to a resource. */ explicit resource(handle_type res) noexcept : value{std::move(res)} {}