add entity relation docs

friflo · Dec 1, 2024 · dbf9309 · dbf9309
1 parent b30cc46
commit dbf9309
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git 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
@@ -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
     {