Michele Caini 8 лет назад
Родитель
Сommit
b3b6362cd9
4 измененных файлов с 39 добавлено и 39 удалено
  1. 20 20
      src/entt/entity/view.hpp
  2. 15 16
      src/entt/process/process.hpp
  3. 3 2
      src/entt/signal/dispatcher.hpp
  4. 1 1
      src/entt/signal/sigh.hpp

+ 20 - 20
src/entt/entity/view.hpp

@@ -166,8 +166,8 @@ public:
      * Attempting to use an invalid component type results in a compilation
      * error. Attempting to use an entity that doesn't belong to the view
      * results in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode if
-     * the view doesn't contain the given entity.
+     * An assertion will abort the execution at runtime in debug mode if the
+     * view doesn't contain the given entity.
      *
      * @tparam Comp Type of the component to get.
      * @param entity A valid entity identifier.
@@ -182,15 +182,15 @@ public:
     /**
      * @brief Returns the component assigned to the given entity.
      *
-     * Prefer this function instead of `Registry::get` during iterations.
-     * It has far better performance than its companion function.
+     * Prefer this function instead of `Registry::get` during iterations. It has
+     * far better performance than its companion function.
      *
      * @warning
      * Attempting to use an invalid component type results in a compilation
      * error. Attempting to use an entity that doesn't belong to the view
      * results in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode if
-     * the view doesn't contain the given entity.
+     * An assertion will abort the execution at runtime in debug mode if the
+     * view doesn't contain the given entity.
      *
      * @tparam Comp Type of the component to get.
      * @param entity A valid entity identifier.
@@ -211,8 +211,8 @@ public:
      * Attempting to use invalid component types results in a compilation error.
      * Attempting to use an entity that doesn't belong to the view results in
      * undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode if
-     * the view doesn't contain the given entity.
+     * An assertion will abort the execution at runtime in debug mode if the
+     * view doesn't contain the given entity.
      *
      * @tparam Comp Types of the components to get.
      * @param entity A valid entity identifier.
@@ -235,8 +235,8 @@ public:
      * Attempting to use invalid component types results in a compilation error.
      * Attempting to use an entity that doesn't belong to the view results in
      * undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode if
-     * the view doesn't contain the given entity.
+     * An assertion will abort the execution at runtime in debug mode if the
+     * view doesn't contain the given entity.
      *
      * @tparam Comp Types of the components to get.
      * @param entity A valid entity identifier.
@@ -522,15 +522,15 @@ public:
     /**
      * @brief Returns the component assigned to the given entity.
      *
-     * Prefer this function instead of `Registry::get` during iterations.
-     * It has far better performance than its companion function.
+     * Prefer this function instead of `Registry::get` during iterations. It has
+     * far better performance than its companion function.
      *
      * @warning
      * Attempting to use an invalid component type results in a compilation
      * error. Attempting to use an entity that doesn't belong to the view
      * results in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode if
-     * the view doesn't contain the given entity.
+     * An assertion will abort the execution at runtime in debug mode if the
+     * view doesn't contain the given entity.
      *
      * @tparam Comp Type of the component to get.
      * @param entity A valid entity identifier.
@@ -552,8 +552,8 @@ public:
      * Attempting to use an invalid component type results in a compilation
      * error. Attempting to use an entity that doesn't belong to the view
      * results in undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode if
-     * the view doesn't contain the given entity.
+     * An assertion will abort the execution at runtime in debug mode if the
+     * view doesn't contain the given entity.
      *
      * @tparam Comp Type of the component to get.
      * @param entity A valid entity identifier.
@@ -574,8 +574,8 @@ public:
      * Attempting to use invalid component types results in a compilation error.
      * Attempting to use an entity that doesn't belong to the view results in
      * undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode if
-     * the view doesn't contain the given entity.
+     * An assertion will abort the execution at runtime in debug mode if the
+     * view doesn't contain the given entity.
      *
      * @tparam Comp Types of the components to get.
      * @param entity A valid entity identifier.
@@ -598,8 +598,8 @@ public:
      * Attempting to use invalid component types results in a compilation error.
      * Attempting to use an entity that doesn't belong to the view results in
      * undefined behavior.<br/>
-     * An assertion will abort the execution at runtime in debug mode if
-     * the view doesn't contain the given entity.
+     * An assertion will abort the execution at runtime in debug mode if the
+     * view doesn't contain the given entity.
      *
      * @tparam Comp Types of the components to get.
      * @param entity A valid entity identifier.

+ 15 - 16
src/entt/process/process.hpp

@@ -21,38 +21,37 @@ namespace entt {
  * * @code{.cpp}
  *   void update(Delta, void *);
  *   @endcode
- *   It's invoked once per tick until a process is explicitly aborted or it
- *   terminates either with or without errors. Even though it's not mandatory to
- *   declare this member function, as a rule of thumb each process should at
- *   least define it to work properly. The `void *` parameter is an opaque
- *   pointer to user data (if any) forwarded directly to the process during an
- *   update.
+ * It's invoked once per tick until a process is explicitly aborted or it
+ * terminates either with or without errors. Even though it's not mandatory to
+ * declare this member function, as a rule of thumb each process should at least
+ * define it to work properly. The `void *` parameter is an opaque pointer to
+ * user data (if any) forwarded directly to the process during an update.
  *
  * * @code{.cpp}
  *   void init(void *);
  *   @endcode
- *   It's invoked at the first tick, immediately before an update. The `void *`
- *   parameter is an opaque pointer to user data (if any) forwarded directly to
- *   the process during an update.
+ * It's invoked at the first tick, immediately before an update. The `void *`
+ * parameter is an opaque pointer to user data (if any) forwarded directly to
+ * the process during an update.
  *
  * * @code{.cpp}
  *   void succeeded();
  *   @endcode
- *   It's invoked in case of success, immediately after an update and during the
- *   same tick.
+ * It's invoked in case of success, immediately after an update and during the
+ * same tick.
  *
  * * @code{.cpp}
  *   void failed();
  *   @endcode
- *   It's invoked in case of errors, immediately after an update and during the
- *   same tick.
+ * It's invoked in case of errors, immediately after an update and during the
+ * same tick.
  *
  * * @code{.cpp}
  *   void aborted();
  *   @endcode
- *   It's invoked only if a process is explicitly aborted. There is no guarantee
- *   that it executes in the same tick, this depends solely on whether the
- *   process is aborted immediately or not.
+ * It's invoked only if a process is explicitly aborted. There is no guarantee
+ * that it executes in the same tick, this depends solely on whether the process
+ * is aborted immediately or not.
  *
  * Derived classes can change the internal state of a process by invoking the
  * `succeed` and `fail` protected member functions and even pause or unpause the

+ 3 - 2
src/entt/signal/dispatcher.hpp

@@ -127,8 +127,9 @@ public:
      * automatically detected and unregistered if available.
      *
      * @warning
-     * Disconnecting a listener during an update may lead to unexpected behavior.
-     * Unregister listeners before or after invoking the update if possible.
+     * Disconnecting a listener during an update may lead to unexpected
+     * behavior. Unregister listeners before or after invoking the update if
+     * possible.
      *
      * @tparam Event Type of event from which to disconnect the function.
      * @tparam Class Type of class to which the member function belongs.

+ 1 - 1
src/entt/signal/sigh.hpp

@@ -100,7 +100,7 @@ class SigH;
  *
  * * `Param` is a type to which `Ret` can be converted.
  * * The return type is true if the handler must stop collecting data, false
- *   otherwise.
+ * otherwise.
  *
  * @tparam Ret Return type of a function type.
  * @tparam Args Types of arguments of a function type.