Browse Source

doc: minor changes

Michele Caini 1 year ago
parent
commit
0bd37df6f3

+ 1 - 1
src/entt/container/table.hpp

@@ -240,7 +240,7 @@ public:
     /**
      * @brief Move assignment operator.
      * @param other The instance to move from.
-     * @return This table.
+     * @return This container.
      */
     basic_table &operator=(basic_table &&other) noexcept {
         payload = std::move(other.payload);

+ 1 - 1
src/entt/entity/mixin.hpp

@@ -140,7 +140,7 @@ public:
     /**
      * @brief Move assignment operator.
      * @param other The instance to move from.
-     * @return This storage.
+     * @return This mixin.
      */
     basic_sigh_mixin &operator=(basic_sigh_mixin &&other) noexcept {
         underlying_type::operator=(std::move(other));

+ 2 - 2
src/entt/entity/runtime_view.hpp

@@ -178,13 +178,13 @@ public:
 
     /**
      * @brief Default copy assignment operator.
-     * @return This container.
+     * @return This runtime view.
      */
     basic_runtime_view &operator=(const basic_runtime_view &) = default;
 
     /**
      * @brief Default move assignment operator.
-     * @return This container.
+     * @return This runtime view.
      */
     basic_runtime_view &operator=(basic_runtime_view &&) noexcept(std::is_nothrow_move_assignable_v<container_type>) = default;
 

+ 2 - 2
src/entt/graph/adjacency_matrix.hpp

@@ -172,7 +172,7 @@ public:
     /**
      * @brief Default copy assignment operator.
      * @param other The instance to copy from.
-     * @return This container.
+     * @return This adjacency matrix.
      */
     adjacency_matrix &operator=(const adjacency_matrix &other) {
         matrix = other.matrix;
@@ -183,7 +183,7 @@ public:
     /**
      * @brief Default move assignment operator.
      * @param other The instance to move from.
-     * @return This container.
+     * @return This adjacency matrix.
      */
     adjacency_matrix &operator=(adjacency_matrix &&other) noexcept {
         matrix = std::move(other.matrix);

+ 1 - 1
src/entt/process/scheduler.hpp

@@ -132,7 +132,7 @@ public:
     /**
      * @brief Move assignment operator.
      * @param other The instance to move from.
-     * @return This scheduler.
+     * @return This process scheduler.
      */
     basic_scheduler &operator=(basic_scheduler &&other) noexcept {
         ENTT_ASSERT(alloc_traits::is_always_equal::value || get_allocator() == other.get_allocator(), "Copying a scheduler is not allowed");

+ 2 - 2
src/entt/signal/emitter.hpp

@@ -85,14 +85,14 @@ public:
 
     /**
      * @brief Default copy assignment operator, deleted on purpose.
-     * @return This observer.
+     * @return This emitter.
      */
     emitter &operator=(const emitter &) = delete;
 
     /**
      * @brief Move assignment operator.
      * @param other The instance to move from.
-     * @return This dispatcher.
+     * @return This emitter.
      */
     emitter &operator=(emitter &&other) noexcept {
         ENTT_ASSERT(alloc_traits::is_always_equal::value || handlers.second() == other.handlers.second(), "Copying an emitter is not allowed");