Documentation

ScriptCore/Core/EngineObject.cs

@@ -1,11 +1,14 @@
 namespace GlitchyEngine.Core;
 
+/// <summary>
+/// The base class for all classes that represent something that belongs to the engine (Entities, Components and Assets).
+/// </summary>
 public abstract class EngineObject
 {
     protected internal UUID _uuid;
 
     /// <summary>
-    /// UUID used for identifying the object in the engine.
+    /// UUID (Universally Unique Identifier) used for identifying the object in the engine.
     /// </summary>
     public UUID UUID => _uuid;
 

ScriptCore/Core/UUID.cs

@@ -7,13 +7,24 @@ public struct UUID
 {
     private ulong _uuid;
 
+    /// <summary>
+    /// Create a new instance of a <see cref="UUID"/> with the given value as ID.
+    /// </summary>
+    /// <param name="uuid">The id.</param>
     public UUID(ulong uuid)
     {
         _uuid = uuid;
     }
 
-    public static UUID Zero = new UUID(0);
+    /// <summary>
+    /// A <see cref="UUID"/> with the ID 0.
+    /// </summary>
+    public static readonly UUID Zero = new UUID(0);
 
+    /// <summary>
+    /// Creates a new random <see cref="UUID"/>.
+    /// </summary>
+    /// <returns>The newly created <see cref="UUID"/></returns>
     public static UUID CreateNew()
     {
         ScriptGlue.UUID_CreateNew(out UUID id);