فهرست منبع

doc: minor changes

Michele Caini 6 سال پیش
والد
کامیت
dc9c1fc762
4فایلهای تغییر یافته به همراه5 افزوده شده و 12 حذف شده
  1. 2 2
      README.md
  2. 0 1
      TODO
  3. 1 1
      docs/md/entity.md
  4. 2 8
      src/entt/entity/observer.hpp

+ 2 - 2
README.md

@@ -262,8 +262,8 @@ The API reference will be created in HTML format within the directory
 @cond TURN_OFF_DOXYGEN
 -->
 It's also available [online](https://skypjack.github.io/entt/) for the latest
-version.<br/>
-Finally, there exists a [wiki](https://github.com/skypjack/entt/wiki) dedicated
+version, that is the last stable tag.<br/>
+Moreover, there exists a [wiki](https://github.com/skypjack/entt/wiki) dedicated
 to the project where users can find all related documentation pages.
 <!--
 @endcond TURN_OFF_DOXYGEN

+ 0 - 1
TODO

@@ -16,4 +16,3 @@
 * observer: user defined filters (eg .replace<T, &function> or .group<T, U, &func>)
 * any-of rule for views/groups (eg entity has A and any of B/C/D)
   - get -> all, exclude -> none
-* extract only the type within type_info, hash its name (more portable)

+ 1 - 1
docs/md/entity.md

@@ -546,7 +546,7 @@ and has not `velocity` before to store it aside. If one of the two conditions of
 the filter isn't respected, the entity is discared, no matter what.
 
 A `where` clause accepts a theoretically unlimited number of types as well as
-multiple elements in the exclusion list. Moreover, every matcher can have it's
+multiple elements in the exclusion list. Moreover, every matcher can have its
 own clause and multiple clauses for the same matcher are combined in a single
 one.
 

+ 2 - 8
src/entt/entity/observer.hpp

@@ -388,8 +388,7 @@ public:
     }
 
     /**
-     * @brief Iterates entities and applies the given function object to them,
-     * then clears the observer.
+     * @brief Iterates entities and applies the given function object to them.
      *
      * The function object is invoked for each entity.<br/>
      * The signature of the function must be equivalent to the following form:
@@ -411,12 +410,7 @@ public:
      * @brief Iterates entities and applies the given function object to them,
      * then clears the observer.
      *
-     * The function object is invoked for each entity.<br/>
-     * The signature of the function must be equivalent to the following form:
-     *
-     * @code{.cpp}
-     * void(const entity_type);
-     * @endcode
+     * @sa each
      *
      * @tparam Func Type of the function object to invoke.
      * @param func A valid function object.