1- /// Entity annotation is used to on a class to let ObjectBox know it should
2- /// store it - making the class a "persistable Entity".
1+ /// Entity annotation is used on a class to let ObjectBox know it should store
2+ /// it - making the class a "persistable Entity".
33///
44/// This annotation is matched by ObjectBox code generator when you call
55/// `pub run_build_runner build` . The generator creates `objectbox.g.dart` with
@@ -21,10 +21,8 @@ class Entity {
2121 const Entity ({this .uid});
2222}
2323
24- /// Property annotation enables you to explicitly specify configure some details
25- /// about how a field is stored in the database.
26- ///
27- /// Use PropertyType and OBXPropertyFlag values, resp. for type and flag.
24+ /// Property annotation enables you to explicitly configure some details about
25+ /// how a field is stored in the database.
2826class Property {
2927 /// ObjectBox keeps track of entities and properties by assigning them unique
3028 /// identifiers, UIDs, during the code-generation phase. All those UIDs are
@@ -111,7 +109,7 @@ class Id {
111109 const Id ();
112110}
113111
114- /// Transient annotation marks properties that should not be stored in the DB .
112+ /// Transient annotation marks fields that should not be stored in the database .
115113class Transient {
116114 /// Create a Transient annotation.
117115 const Transient ();
@@ -135,7 +133,7 @@ class Index {
135133 /// Index type.
136134 final IndexType /*?*/ type;
137135
138- /// Create an Index annotaion .
136+ /// Create an Index annotation .
139137 const Index ({this .type});
140138}
141139
@@ -153,8 +151,7 @@ enum IndexType {
153151 /// it's default, [hash] .
154152 value,
155153
156- /// Uses a 32-bit hash of the field value to build the index. This is a
157- /// default for [String] properties.
154+ /// Uses a 32-bit hash of the field value; default for [String] properties.
158155 ///
159156 /// Hash collisions should be sporadic and shouldn't impact performance in
160157 /// practice. Because it requires less storage space, it's usually a better
0 commit comments