Engine - ECS: add TreeNode docs

friflo · Jul 21, 2024 · f11f449 · f11f449
1 parent fa97d9f
commit f11f449
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 5 deletions.
diff --git a/Engine/src/ECS/Collections/IdArray/IdArray.cs b/Engine/src/ECS/Collections/IdArray/IdArray.cs
@@ -41,7 +41,7 @@ private string GetString()
 
 internal static class IdArrayExtensions {
 
-    internal static ReadOnlySpan<int> GetSpan(this ref IdArray array, IdArrayHeap heap, EntityStoreBase store)
+    internal static ReadOnlySpan<int> GetSpan(this IdArray array, IdArrayHeap heap, EntityStoreBase store)
     {
         int count = array.count;
         int start = array.start;

diff --git a/Engine/src/ECS/Components/TreeNode.cs b/Engine/src/ECS/Components/TreeNode.cs
@@ -27,7 +27,7 @@ public struct TreeNode : IComponent
     /// <summary> returns the number of <see cref="Entity.ChildEntities"/>.</summary>
     public          int                 ChildCount  => childIds.count;
 
-    /// <summary> Property is obsolete. Use <see cref="GetChildIds"/> instead. </summary>
+    /// <summary>Property is obsolete. Use <see cref="GetChildIds"/> instead. </summary>
     [Obsolete($"Use {nameof(GetChildIds)}()")]
     public          ReadOnlySpan<int>   ChildIds    => throw new InvalidOperationException($"ChildIds is obsolete. Use {nameof(GetChildIds)}()");
 
@@ -38,9 +38,17 @@ public struct TreeNode : IComponent
                     internal    IdArray childIds;   //  8
     #endregion
 
+    /// <summary>
+    /// Returns the child entities.<br/>
+    /// Executes in O(1).
+    /// </summary>
     public ChildEntities  GetChildEntities(EntityStore store) => new ChildEntities(store, this);
 
-    /// same as <see cref="IdArrayExtensions.GetSpan"/>
+    // same as <see cref="IdArrayExtensions.GetSpan"/>
+    /// <summary>
+    /// Returns the child entity ids.<br/>
+    /// Executes in O(1).
+    /// </summary>
     public ReadOnlySpan<int>  GetChildIds(EntityStore store)
     {
         var count = childIds.count;

diff --git a/Engine/src/ECS/Entity.cs b/Engine/src/ECS/Entity.cs
@@ -466,7 +466,7 @@ public bool RemoveTags(in Tags tags) {
     /// See <a href="https://github.com/friflo/Friflo.Json.Fliox/wiki/Examples-~-General#child-entities">Example.</a>
     /// </summary>
     /// <remarks>
-    /// Executes in O(1).<br/>
+    /// Executes in O(1) in case the child has no parent.<br/>
     /// The subtree structure of the added entity remains unchanged<br/>
     /// </remarks>
     /// <returns>
@@ -483,7 +483,7 @@ public int AddChild(Entity child) {
     }
     /// <summary>Insert the given <paramref name="child"/> as a child to the entity at the passed <paramref name="index"/>.</summary>
     /// <remarks>
-    /// Executes in O(1) in case <paramref name="index"/> == <see cref="ChildCount"/>.<br/>
+    /// Executes in O(1) in case the child has no paren and <paramref name="index"/> == <see cref="ChildCount"/>.<br/>
     /// Otherwise, O(N). N = <see cref="ChildCount"/> - <paramref name="index"/><br/>
     /// The subtree structure of the added entity remains unchanged<br/>
     /// </remarks>