Updated documentation

craftersmine.EtherEngine.Content/AudioClip.cs

@@ -13,6 +13,9 @@ namespace craftersmine.EtherEngine.Content
     /// </summary>
     public sealed class AudioClip
     {
+        /// <summary>
+        /// Current audio clip Ogg stream with file
+        /// </summary>
         public OggStream OggStream { get; private set; }
 
         /// <summary>

craftersmine.EtherEngine.Core/AudioChannel.cs

@@ -7,6 +7,9 @@
 
 namespace craftersmine.EtherEngine.Core
 {
+    /// <summary>
+    /// Represents scene audio channel. This class cannot be inherited
+    /// </summary>
     public sealed class AudioChannel
     {
         /// <summary>

craftersmine.EtherEngine.Core/CrashHandler.cs

@@ -8,8 +8,15 @@
 
 namespace craftersmine.EtherEngine.Core
 {
-    public sealed class CrashHandler
+    /// <summary>
+    /// Provides static methods for exception handling
+    /// </summary>
+    public static class CrashHandler
     {
+        /// <summary>
+        /// Handles provided exception, writes exception data to log file, shows message to user and then exits from game
+        /// </summary>
+        /// <param name="ex">Exception to handle</param>
         public static void Handle(Exception ex)
         {
             Debugging.LogException(LogEntryType.Crash, ex);

craftersmine.EtherEngine.Core/EnginePrefabs/DefaultScene.cs

@@ -7,8 +7,14 @@
 
 namespace craftersmine.EtherEngine.Core.EnginePrefabs
 {
+    /// <summary>
+    /// Represents default, empty scene. This class cannot be inherited
+    /// </summary>
     public sealed class DefaultScene : Scene
     {
+        /// <summary>
+        /// Creates new <see cref="DefaultScene"/> instance
+        /// </summary>
         public DefaultScene()
         {
             BackgroundColor = Color.Black;

craftersmine.EtherEngine.Core/Exceptions/SceneManagerException.cs

@@ -6,13 +6,27 @@
 
 namespace craftersmine.EtherEngine.Core.Exceptions
 {
-
+    /// <summary>
+    /// The exception that is thrown when scene manager can't operate with scene
+    /// </summary>
     [Serializable]
     public class SceneManagerException : Exception
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SceneManagerException"/> class with its message string set to a system-supplied message.
+        /// </summary>
         public SceneManagerException() { }
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SceneManagerException"/> class with a specified error message.
+        /// </summary>
         public SceneManagerException(string message) : base(message) { }
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SceneManagerException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
+        /// </summary>
         public SceneManagerException(string message, Exception inner) : base(message, inner) { }
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SceneManagerException"/> class with the specified serialization and context information.
+        /// </summary>
         protected SceneManagerException(
           System.Runtime.Serialization.SerializationInfo info,
           System.Runtime.Serialization.StreamingContext context) : base(info, context) { }

craftersmine.EtherEngine.Core/Game.cs

@@ -31,6 +31,9 @@ public static class Game
         /// </summary>
         public static event EventHandler<CancelEventArgs> GameExiting;
 
+        /// <summary>
+        /// Gets or sets current used sound device
+        /// </summary>
         public static SoundDevice SoundDevice { get; set; }
 
         /// <summary>

craftersmine.EtherEngine.Core/Objects/ParticleSystem.cs

@@ -8,6 +8,9 @@
 
 namespace craftersmine.EtherEngine.Objects
 {
+    /// <summary>
+    /// Represents particle system. This class cannot be inherited
+    /// </summary>
     public sealed class ParticleSystem : GameObject
     {
         internal List<Particle> Particles { get; set; } = new List<Particle>();
@@ -17,15 +20,53 @@ public sealed class ParticleSystem : GameObject
         private Random SizeRanger = new Random();
         private Random ParticleLifetimeRanger = new Random();
 
+        /// <summary>
+        /// Gets or sets particle lifetime
+        /// </summary>
         public int ParticleLifetime { get; set; }
+        /// <summary>
+        /// Gets or sets particle vertical velocity vector
+        /// </summary>
         public float ParticleVerticalVelocity { get; set; }
+        /// <summary>
+        /// Gets or sets particle horizontal velocity vector
+        /// </summary>
         public float ParticleHorizontalVelocity { get; set; }
+        /// <summary>
+        /// Gets or sets particle size
+        /// </summary>
         public int ParticleSize { get; set; }
+        /// <summary>
+        /// Gets or sets true if particles must have variative size, else false
+        /// </summary>
         public bool IsParticleVariativeSize { get; set; }
+        /// <summary>
+        /// Gets used particle instance
+        /// </summary>
         public Particle Particle { get; private set; }
+        /// <summary>
+        /// Gets current max particles limitation
+        /// </summary>
         public int MaxParticles { get; private set; }
+        /// <summary>
+        /// Gets true if particle system is emitting particles, else false
+        /// </summary>
         public bool IsEmitting { get; private set; }
+        /// <summary>
+        /// Gets or sets particle on update behaviour
+        /// </summary>
+        public ParticleOnUpdateDelegate OnUpdateAction { get; set; }
 
+        /// <summary>
+        /// Creates new <see cref="ParticleSystem"/> instance with specified parameters
+        /// </summary>
+        /// <param name="particle">Particle template</param>
+        /// <param name="particleLifetime">Particle lifetime</param>
+        /// <param name="maxParticles">Maximum particles limitaion</param>
+        /// <param name="particleVerticalVelocity">Particle vertical velocity vector</param>
+        /// <param name="particleHorizontalVelocity">Particle horizontal velocity vector</param>
+        /// <param name="particleSize">Particle size</param>
+        /// <param name="variativeSize">True if particles must have variative size, else false</param>
         public ParticleSystem(Particle particle, int particleLifetime, int maxParticles, float particleVerticalVelocity, float particleHorizontalVelocity, int particleSize, bool variativeSize)
         {
             Particle = particle;
@@ -37,7 +78,10 @@ public ParticleSystem(Particle particle, int particleLifetime, int maxParticles,
             MaxParticles = maxParticles;
             Collidable = false;
         }
-
+
+        /// <summary>
+        /// Calls when particle system being created
+        /// </summary>
         public override void OnStart()
         {
             for (int i = 0; i < MaxParticles; i++)
@@ -54,6 +98,9 @@ public override void OnStart()
             Reset();
         }
 
+        /// <summary>
+        /// Start emit particles
+        /// </summary>
         public void Emit()
         {
             if (!IsEmitting)
@@ -64,6 +111,9 @@ public void Emit()
             }
         }
 
+        /// <summary>
+        /// Stop emit particles
+        /// </summary>
         public void StopEmit()
         {
             if (IsEmitting)
@@ -77,6 +127,9 @@ public void StopEmit()
             }
         }
 
+        /// <summary>
+        /// Reset particles
+        /// </summary>
         public void Reset()
         {
             for (int i = 0; i < Particles.Count; i++)
@@ -91,6 +144,9 @@ public void Reset()
             }
         }
 
+        /// <summary>
+        /// Calls when particle system being updated
+        /// </summary>
         public override void OnUpdate()
         {
             if (IsEmitting)
@@ -126,33 +182,81 @@ public override void OnUpdate()
                         Particles[i].Y = this.Y;
                         Particles[i].CurrentLifetime = ParticleLifetimeRanger.Next(-15, 0);
                     }
+                    OnUpdateAction?.Invoke(Particles[i]);
                 }
             }
         }
     }
 
+    /// <summary>
+    /// Represents particle. This class cannot be inherited
+    /// </summary>
     public sealed class Particle : GameObject
     {
+        /// <summary>
+        /// Gets or sets current particle lifetime
+        /// </summary>
         public int CurrentLifetime { get; set; }
+        /// <summary>
+        /// Gets particle lifetime
+        /// </summary>
         public int Lifetime { get; internal set; }
+        /// <summary>
+        /// Gets or sets particle size
+        /// </summary>
         public int ParticleSize { get; set; }
+        /// <summary>
+        /// Gets or sets true if particle lifetime is elapsed
+        /// </summary>
         public bool IsParticleLifetimeElapsed { get; set; }
+        /// <summary>
+        /// Gets current particle vertical velocity vector
+        /// </summary>
         public float VerticalVelocity { get; internal set; }
+        /// <summary>
+        /// Gets current particle horizontal velocity vector
+        /// </summary>
         public float HorizontalVelocity { get; internal set; }
+        /// <summary>
+        /// Gets particle size modifier
+        /// </summary>
         public float SizeModifier { get; internal set; }
 
+        /// <summary>
+        /// Creates new <see cref="Particle"/> instance
+        /// </summary>
+        /// <param name="texture">Particle texture</param>
         public Particle(Texture texture)
         {
             Texture = texture;
             CurrentLifetime = 0;
         }
 
+        /// <summary>
+        /// Clones particle
+        /// </summary>
+        /// <returns></returns>
         public Particle Clone()
         {
             return new Particle(Texture) {
-                CurrentLifetime = CurrentLifetime, Height = Height, ParticleSize = ParticleSize,
-                Texture = Texture, Visible = Visible, Width = Width, X = X, Y = Y,
-                HorizontalVelocity = HorizontalVelocity, VerticalVelocity = VerticalVelocity, SizeModifier = SizeModifier };
+                CurrentLifetime = CurrentLifetime,
+                Height = Height,
+                ParticleSize = ParticleSize,
+                Texture = Texture,
+                Visible = Visible,
+                Width = Width,
+                X = X,
+                Y = Y,
+                HorizontalVelocity = HorizontalVelocity,
+                VerticalVelocity = VerticalVelocity,
+                SizeModifier = SizeModifier
+            };
         }
     }
+
+    /// <summary>
+    /// Represents particle OnUpdate behaviour
+    /// </summary>
+    /// <param name="particle">Updating particle</param>
+    public delegate void ParticleOnUpdateDelegate(Particle particle);
 }

craftersmine.EtherEngine.Input/Gamepad.cs

@@ -9,9 +9,9 @@
 namespace craftersmine.EtherEngine.Input
 {
     /// <summary>
-    /// Allows to use gamepad input
+    /// Provides static methods to handle XInput gamepad input
     /// </summary>
-    public sealed class Gamepad
+    public static class Gamepad
     {
         private static X.Gamepad fstPlayer { get; set; } = X.Gamepad_1;
         private static X.Gamepad secPlayer { get; set; } = X.Gamepad_2;

craftersmine.EtherEngine.Input/Keyboard.cs

@@ -10,9 +10,9 @@
 namespace craftersmine.EtherEngine.Input
 {
     /// <summary>
-    /// Allows to get Keyboard input
+    /// Provides static methods to handle keyboard input
     /// </summary>
-    public sealed class Keyboard
+    public static class Keyboard
     {
         /// <summary>
         /// [ENGINE PROPERTY] Gets or sets keyboard to handle input

craftersmine.EtherEngine.Input/Mouse.cs

@@ -7,7 +7,10 @@
 
 namespace craftersmine.EtherEngine.Input
 {
-    public sealed class Mouse
+    /// <summary>
+    /// Provides static methods to handle mouse input
+    /// </summary>
+    public static class Mouse
     {
         /// <summary>
         /// [ENGINE METHOD] MouseDevice.Move event handler