ソースを参照

doc: updated wiki for meta (close #448)

Michele Caini 6 年 前
コミット
34f05fb8dc
1 ファイル変更14 行追加15 行削除
  1. 14 15
      docs/md/meta.md

+ 14 - 15
docs/md/meta.md

@@ -46,13 +46,13 @@ identifier is required, it's likely that a user defined literal is used as
 follows:
 
 ```cpp
-auto factory = entt::meta<my_type>().type("reflected_type"_hs);
+auto factory = entt::meta<my_type>().alias("reflected_type"_hs);
 ```
 
 For what it's worth, this is likely completely equivalent to:
 
 ```cpp
-auto factory = entt::meta<my_type>().type(42);
+auto factory = entt::meta<my_type>().alias(42);
 ```
 
 Obviously, human-readable identifiers are more convenient to use and highly
@@ -75,7 +75,7 @@ The returned value is a factory object to use to continue building the meta
 type. In order to make the type _visible_, users can assign it an identifier:
 
 ```cpp
-auto factory = entt::meta<my_type>().type("reflected_type"_hs);
+auto factory = entt::meta<my_type>().alias("reflected_type"_hs);
 ```
 
 When working with named types, it isn't even necessary to specify the
@@ -490,7 +490,7 @@ object.<br/>
 Apparently, it's more difficult to say than to do:
 
 ```cpp
-entt::meta<my_type>().type("reflected_type"_hs).prop("tooltip"_hs, "message");
+entt::meta<my_type>().alias("reflected_type"_hs).prop("tooltip"_hs, "message");
 ```
 
 Properties are always in the key/value form. There are no restrictions on the
@@ -500,26 +500,25 @@ Multiple formats are supported when it comes to defining a property:
 * Properties as key/value pairs:
 
   ```cpp
-  entt::meta<my_type>().type("reflected_type"_hs).prop("tooltip"_hs, "message");
+  entt::meta<my_type>().alias("reflected_type"_hs).prop("tooltip"_hs, "message");
   ```
 
 * Properties as `std::pair`s:
 
   ```cpp
-  entt::meta<my_type>().type("reflected_type"_hs).prop(std::make_pair("tooltip"_hs, "message"));
+  entt::meta<my_type>().alias("reflected_type"_hs).prop(std::make_pair("tooltip"_hs, "message"));
   ```
 
 * Key only properties:
 
   ```cpp
-  entt::meta<my_type>().type("reflected_type"_hs).prop(my_enum::key_only);
+  entt::meta<my_type>().alias("reflected_type"_hs).prop(my_enum::key_only);
   ```
 
 * Properties as `std::tuple`s:
 
   ```cpp
-  entt::meta<my_type>().type("reflected_type"_hs)
-          .prop(std::make_tuple(std::make_pair("tooltip"_hs, "message"), my_enum::key_only));
+  entt::meta<my_type>().alias("reflected_type"_hs).prop(std::make_tuple(std::make_pair("tooltip"_hs, "message"), my_enum::key_only));
   ```
 
   A tuple contains one or more properties. All of them are treated individually.
@@ -527,7 +526,7 @@ Multiple formats are supported when it comes to defining a property:
 * Annotations:
 
   ```cpp
-  entt::meta<my_type>().type("reflected_type"_hs).prop(&property_generator);
+  entt::meta<my_type>().alias("reflected_type"_hs).prop(&property_generator);
   ```
 
   An annotation is an invocable object that returns one or more properties. All
@@ -538,11 +537,11 @@ each property to associate with the last meta object created:
 
 ```cpp
 entt::meta<my_type>()
-        .type("reflected_type"_hs)
-            .prop(entt::hashed_string{"Name"}, "Reflected Type")
-        .data<&my_type::data_member>("member"_hs)
-            .prop(std::make_pair("tooltip"_hs, "Member"))
-            .prop(my_enum::a_value, 42);
+    .alias("reflected_type"_hs)
+        .prop(entt::hashed_string{"Name"}, "Reflected Type")
+    .data<&my_type::data_member>("member"_hs)
+        .prop(std::make_pair("tooltip"_hs, "Member"))
+        .prop(my_enum::a_value, 42);
 ```
 
 Alternatively, the `props` function is available to associate several properties