From dbf930992ae3b8bb36ee96ecee67fe499a11a4ad Mon Sep 17 00:00:00 2001
From: Ullrich Praetz <ullrich@praetz.de>
Date: Sun, 1 Dec 2024 16:23:08 +0100
Subject: [PATCH] add entity relation docs

---
 src/ECS/Relations/EntityRelations.cs    | 4 ++++
 src/ECS/Relations/RelationExtensions.cs | 3 +++
 2 files changed, 7 insertions(+)

diff --git a/src/ECS/Relations/EntityRelations.cs b/src/ECS/Relations/EntityRelations.cs
index 7f8f0021..32a9c9ea 100644
--- a/src/ECS/Relations/EntityRelations.cs
+++ b/src/ECS/Relations/EntityRelations.cs
@@ -3,6 +3,10 @@
 // ReSharper disable once CheckNamespace
 namespace Friflo.Engine.ECS;
 
+/// <summary>
+/// Storage for all entity relations of the specified <typeparamref name="TRelation"/> type.
+/// </summary>
+/// <typeparam name="TRelation"></typeparam>
 public readonly struct EntityRelations <TRelation>
     where TRelation : struct, IRelation
 {
diff --git a/src/ECS/Relations/RelationExtensions.cs b/src/ECS/Relations/RelationExtensions.cs
index 0293cf93..80455caa 100644
--- a/src/ECS/Relations/RelationExtensions.cs
+++ b/src/ECS/Relations/RelationExtensions.cs
@@ -102,6 +102,9 @@ public static EntityLinks<TRelation> GetIncomingLinks<TRelation>(this Entity tar
     #endregion
     
 #region EntityStore
+    /// <summary>
+    /// Return the storage for all entity relations of the specified <typeparamref name="TRelation"/> type.
+    /// </summary>
     public static EntityRelations<TRelation> EntityRelations<TRelation>(this EntityStore store)
         where TRelation : struct, IRelation
     {