Browse Source

updated doc

Michele Caini 6 years ago
parent
commit
9e9e3d43a8
2 changed files with 4 additions and 4 deletions
  1. 2 2
      docs/md/entity.md
  2. 2 2
      docs/md/faq.md

+ 2 - 2
docs/md/entity.md

@@ -169,10 +169,10 @@ alias `entt::registry` for `entt::basic_registry<entt::entity>`.
 Entities are represented by _entity identifiers_. An entity identifier is an
 Entities are represented by _entity identifiers_. An entity identifier is an
 opaque type that users should not inspect or modify in any way. It carries
 opaque type that users should not inspect or modify in any way. It carries
 information about the entity itself and its version.<br/>
 information about the entity itself and its version.<br/>
-User defined identifiers can be introduced by means of the `ENTT_ENTITY_TYPE`
+User defined identifiers can be introduced by means of the `ENTT_OPAQUE_TYPE`
 macro if needed.
 macro if needed.
 
 
-A registry can be used both to construct and to destroy entities:
+A registry is used both to construct and to destroy entities:
 
 
 ```cpp
 ```cpp
 // constructs a naked entity with no components and returns its identifier
 // constructs a naked entity with no components and returns its identifier

+ 2 - 2
docs/md/faq.md

@@ -99,7 +99,7 @@ Custom entity identifiers are definitely a good idea in two cases at least:
 
 
 These identifiers are nothing more than enum classes with some salt.<br/>
 These identifiers are nothing more than enum classes with some salt.<br/>
 To simplify the creation of new identifiers, `EnTT` provides the macro
 To simplify the creation of new identifiers, `EnTT` provides the macro
-`ENTT_ENTITY_TYPE` that accepts two arguments:
+`ENTT_OPAQUE_TYPE` that accepts two arguments:
 
 
 * The name you want to give to the new identifier (watch out for namespaces).
 * The name you want to give to the new identifier (watch out for namespaces).
 * The underlying type to use (either `std::uint16_t`, `std::uint32_t`
 * The underlying type to use (either `std::uint16_t`, `std::uint32_t`
@@ -108,7 +108,7 @@ To simplify the creation of new identifiers, `EnTT` provides the macro
 In fact, this is the definition of `entt::entity`:
 In fact, this is the definition of `entt::entity`:
 
 
 ```cpp
 ```cpp
-ENTT_ENTITY_TYPE(entity, std::uint32_t)
+ENTT_OPAQUE_TYPE(entity, std::uint32_t)
 ```
 ```
 
 
 The use of this macro is highly recommended, so as not to run into problems if
 The use of this macro is highly recommended, so as not to run into problems if