Engine - ECS: add docs to query TreeNode's

friflo · Jul 22, 2024 · c57702c · c57702c
1 parent 78a1550
commit c57702c
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/Engine/src/ECS/Entity.cs b/Engine/src/ECS/Entity.cs
@@ -287,6 +287,7 @@ namespace Friflo.Engine.ECS;
     /// <code>
     ///     foreach (var child in entity.ChildEntities)
     /// </code>
+    /// To iterate all entities with child entities use <see cref="TreeNode"/> in a <c>Query()</c>.
     /// </remarks>
                     public  ChildEntities       ChildEntities   => new ChildEntities(this);
 

diff --git a/Engine/src/ECS/Entity/ChildEntities.cs b/Engine/src/ECS/Entity/ChildEntities.cs
@@ -15,7 +15,8 @@
 namespace Friflo.Engine.ECS;
 
 /// <summary>
-/// Return the child entities of an <see cref="Entity"/>.
+/// Return the child entities of an <see cref="Entity"/>.<br/>
+/// To iterate all entities with child entities use <see cref="TreeNode"/> in a <c>Query()</c>.
 /// </summary>
 [DebuggerTypeProxy(typeof(ChildEntitiesDebugView))]
 public readonly struct ChildEntities : IEnumerable<Entity>