ECS - update EntityData docs

friflo · Jul 31, 2024 · 8c1ef4f · 8c1ef4f
1 parent c4d763d
commit 8c1ef4f
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/src/ECS/Entity.cs b/src/ECS/Entity.cs
@@ -253,7 +253,7 @@ public     ref readonly Tags                Tags { get {
 
     // ------------------------------------ component properties ----------------------------------
 #region component - properties
-    /// <summary> Returns the entity data used to optimize read / write access of entity components. </summary>
+    /// <summary> Returns the entity data used to optimize access of entity components and tags. </summary>
     [Browse(Never)] public EntityData Data { get {
         ref var node = ref store.nodes[Id];
         if (node.archetype != null && Revision == node.revision) {

diff --git a/src/ECS/Entity/EntityData.cs b/src/ECS/Entity/EntityData.cs
@@ -10,7 +10,7 @@
 namespace Friflo.Engine.ECS;
 
 /// <summary>
-/// An <see cref="EntityData"/> is used to optimize read / write access of entity components.br/>
+/// An <see cref="EntityData"/> is used to optimize access of entity components and tags.<br/>
 /// An instance can be returned by <see cref="Entity.Data"/>. 
 /// </summary>
 /// <remarks>
@@ -40,6 +40,8 @@ public readonly ref struct EntityData
 #region fields
     [Browse(Never)] private readonly    StructHeap[]    heapMap;
     [Browse(Never)] private readonly    Archetype       archetype;
+
+    /// <summary> <see cref="Entity"/> id </summary>
                     public  readonly    int             Id;
     [Browse(Never)] private readonly    int             compIndex;
     #endregion