Engine - ECS: add SymbolColor docs

friflo · May 18, 2024 · 4d6b7f7 · 4d6b7f7
1 parent 4b7ccf5
commit 4d6b7f7
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/Engine/src/ECS/Base/SchemaType.cs b/Engine/src/ECS/Base/SchemaType.cs
@@ -159,12 +159,21 @@ private static BlittableType AreAllMembersBlittable(Type type)
     }
 }
 
+/// <summary>
+/// The color assigned to a component or tag via <see cref="ComponentSymbolAttribute"/> for display in a UI or CLI.
+/// </summary>
 public readonly struct SymbolColor
 {
+    /// <summary> Gets the red component value of this Color. </summary>
     public readonly byte r;
+
+    /// <summary> Gets the green component value of this Color. </summary>
     public readonly byte g;
+
+    /// <summary> Gets the blue component value of this Color. </summary>
     public readonly byte b;
 
+    /// <summary> Create a <see cref="SymbolColor"/> with the specified color components. </summary>
     public SymbolColor (byte r, byte g, byte b) {
         this.r = r;
         this.g = g;