Fixing up spelling errors and XML formatting. (#2317)

* v8.4.3 (#2305) * Fixed SCP-3114 spelling errors and stylecop XML formatting. --------- Co-authored-by: Misaka-ZeroTwo <[email protected]> Co-authored-by: Nao <[email protected]>
Exiled-Team · Dec 6, 2023 · 879a1f5 · 879a1f5
1 parent 9e5f533
commit 879a1f5
Show file tree

Hide file tree

Showing 337 changed files with 1,879 additions and 1,881 deletions.
diff --git a/Exiled.API/Features/Log.cs b/Exiled.API/Features/Log.cs
@@ -156,8 +156,8 @@ public static void Send(string message, Discord.LogLevel level, ConsoleColor col
         /// Sends an <see cref="Error(object)"/> with the provided message if the condition is false and stops the execution.
         /// <example> For example:
         /// <code>
-        ///     Player ply = Player.Get(2);
-        ///     Log.Assert(ply is not null, "The player with the id 2 is null");
+        /// Player ply = Player.Get(2);
+        /// Log.Assert(ply is not null, "The player with the id 2 is null");
         /// </code>
         /// results in it logging an error if the player is null and not continuing.
         /// </example>

diff --git a/Exiled.API/Structs/ArmorAmmoLimit.cs b/Exiled.API/Structs/ArmorAmmoLimit.cs
@@ -50,8 +50,6 @@ public static implicit operator ArmorAmmoLimit(BodyArmor.ArmorAmmoLimit armorLim
         /// Converts a <see cref="ArmorAmmoLimit"/> to its appropriate base game <see cref="BodyArmor.ArmorAmmoLimit"/>.
         /// </summary>
         /// <param name="armorLimit">armor limit.</param>
-        public static explicit operator BodyArmor.ArmorAmmoLimit(ArmorAmmoLimit armorLimit) =>
-            new()
-                { AmmoType = armorLimit.AmmoType.GetItemType(), Limit = armorLimit.Limit };
+        public static explicit operator BodyArmor.ArmorAmmoLimit(ArmorAmmoLimit armorLimit) => new() { AmmoType = armorLimit.AmmoType.GetItemType(), Limit = armorLimit.Limit };
     }
 }
diff --git a/Exiled.API/Structs/PrimitiveSettings.cs b/Exiled.API/Structs/PrimitiveSettings.cs
@@ -3,64 +3,64 @@
 // Copyright (c) Exiled Team. All rights reserved.
 // Licensed under the CC BY-SA 3.0 license.
 // </copyright>
-// -----------------------------------------------------------------------
-
-namespace Exiled.API.Structs
-{
-    using UnityEngine;
+// -----------------------------------------------------------------------
+
+namespace Exiled.API.Structs
+{
+    using UnityEngine;
+
+    /// <summary>
+    /// Settings for primitives.
+    /// </summary>
+    public struct PrimitiveSettings
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="PrimitiveSettings"/> struct.
+        /// </summary>
+        /// <param name="primitiveType">The type of the primitive.</param>
+        /// <param name="color">The color of the primitive.</param>
+        /// <param name="position">The position of the primitive.</param>
+        /// <param name="rotation">The rotation of the primitive.</param>
+        /// <param name="scale">The scale of the primitive.</param>
+        /// <param name="spawn">Whether or not the primitive should be spawned.</param>
+        public PrimitiveSettings(PrimitiveType primitiveType, Color color, Vector3 position, Vector3 rotation, Vector3 scale, bool spawn)
+        {
+            PrimitiveType = primitiveType;
+            Color = color;
+            Position = position;
+            Rotation = rotation;
+            Scale = scale;
+            Spawn = spawn;
+        }
+
+        /// <summary>
+        /// Gets the primitive type.
+        /// </summary>
+        public PrimitiveType PrimitiveType { get; }
+
+        /// <summary>
+        /// Gets the primitive color.
+        /// </summary>
+        public Color Color { get; }
+
+        /// <summary>
+        /// Gets the primitive position.
+        /// </summary>
+        public Vector3 Position { get; }
+
+        /// <summary>
+        /// Gets the primitive rotation.
+        /// </summary>
+        public Vector3 Rotation { get; }
+
+        /// <summary>
+        /// Gets the primitive scale.
+        /// </summary>
+        public Vector3 Scale { get; }
 
-    /// <summary>
-    /// Settings for primitives.
-    /// </summary>
-    public struct PrimitiveSettings
-    {
-        /// <summary>
-        /// Initializes a new instance of the <see cref="PrimitiveSettings"/> struct.
-        /// </summary>
-        /// <param name="primitiveType">The type of the primitive.</param>
-        /// <param name="color">The color of the primitive.</param>
-        /// <param name="position">The position of the primitive.</param>
-        /// <param name="rotation">The rotation of the primitive.</param>
-        /// <param name="scale">The scale of the primitive.</param>
-        /// <param name="spawn">Whether or not the primitive should be spawned.</param>
-        public PrimitiveSettings(PrimitiveType primitiveType, Color color, Vector3 position, Vector3 rotation, Vector3 scale, bool spawn)
-        {
-            PrimitiveType = primitiveType;
-            Color = color;
-            Position = position;
-            Rotation = rotation;
-            Scale = scale;
-            Spawn = spawn;
-        }
-
-        /// <summary>
-        /// Gets the primitive type.
-        /// </summary>
-        public PrimitiveType PrimitiveType { get; }
-
-        /// <summary>
-        /// Gets the primitive color.
-        /// </summary>
-        public Color Color { get; }
-
-        /// <summary>
-        /// Gets the primitive position.
-        /// </summary>
-        public Vector3 Position { get; }
-
-        /// <summary>
-        /// Gets the primitive rotation.
-        /// </summary>
-        public Vector3 Rotation { get; }
-
-        /// <summary>
-        /// Gets the primitive scale.
-        /// </summary>
-        public Vector3 Scale { get; }
-
-        /// <summary>
-        /// Gets a value indicating whether or not the primitive should be spawned.
-        /// </summary>
-        public bool Spawn { get; }
-    }
+        /// <summary>
+        /// Gets a value indicating whether or not the primitive should be spawned.
+        /// </summary>
+        public bool Spawn { get; }
+    }
 }
diff --git a/Exiled.Events/EventArgs/Cassie/SendingCassieMessageEventArgs.cs b/Exiled.Events/EventArgs/Cassie/SendingCassieMessageEventArgs.cs
@@ -10,21 +10,21 @@ namespace Exiled.Events.EventArgs.Cassie
     using Interfaces;
 
     /// <summary>
-    ///     Contains all the information after sending a C.A.S.S.I.E. message.
+    /// Contains all the information after sending a C.A.S.S.I.E. message.
     /// </summary>
     public class SendingCassieMessageEventArgs : IDeniableEvent
     {
         /// <summary>
-        ///     Initializes a new instance of the <see cref="SendingCassieMessageEventArgs" /> class.
+        /// Initializes a new instance of the <see cref="SendingCassieMessageEventArgs" /> class.
         /// </summary>
         /// <param name="words">
-        ///     <inheritdoc cref="Words" />
+        /// <inheritdoc cref="Words" />
         /// </param>
         /// <param name="makeHold">
-        ///     <inheritdoc cref="MakeHold" />
+        /// <inheritdoc cref="MakeHold" />
         /// </param>
         /// <param name="makeNoise">
-        ///     <inheritdoc cref="MakeNoise" />
+        /// <inheritdoc cref="MakeNoise" />
         /// </param>
         /// <param name="isAllowed">Indicates whether the event can be executed or not.</param>
         public SendingCassieMessageEventArgs(string words, bool makeHold, bool makeNoise, bool isAllowed = true)
@@ -36,22 +36,22 @@ public SendingCassieMessageEventArgs(string words, bool makeHold, bool makeNoise
         }
 
         /// <summary>
-        ///     Gets or sets the message.
+        /// Gets or sets the message.
         /// </summary>
         public string Words { get; set; }
 
         /// <summary>
-        ///     Gets or sets a value indicating whether or not the message should be held.
+        /// Gets or sets a value indicating whether or not the message should be held.
         /// </summary>
         public bool MakeHold { get; set; }
 
         /// <summary>
-        ///     Gets or sets a value indicating whether or not the message should make noise.
+        /// Gets or sets a value indicating whether or not the message should make noise.
         /// </summary>
         public bool MakeNoise { get; set; }
 
         /// <summary>
-        ///     Gets or sets a value indicating whether or not the message can be sent.
+        /// Gets or sets a value indicating whether or not the message can be sent.
         /// </summary>
         public bool IsAllowed { get; set; }
     }

diff --git a/Exiled.Events/EventArgs/Interfaces/IAttackerEvent.cs b/Exiled.Events/EventArgs/Interfaces/IAttackerEvent.cs
@@ -11,17 +11,17 @@ namespace Exiled.Events.EventArgs.Interfaces
     using API.Features.DamageHandlers;
 
     /// <summary>
-    ///     Event args for when a player is taking damage.
+    /// Event args for when a player is taking damage.
     /// </summary>
     public interface IAttackerEvent : IPlayerEvent
     {
         /// <summary>
-        ///     Gets the attacker <see cref="Player" />.
+        /// Gets the attacker <see cref="Player" />.
         /// </summary>
         public Player Attacker { get; }
 
         /// <summary>
-        ///     Gets or sets the <see cref="DamageHandlerBase" /> managing the damage to the target.
+        /// Gets or sets the <see cref="DamageHandlerBase" /> managing the damage to the target.
         /// </summary>
         public CustomDamageHandler DamageHandler { get; set; }
     }

diff --git a/Exiled.Events/EventArgs/Interfaces/ICameraEvent.cs b/Exiled.Events/EventArgs/Interfaces/ICameraEvent.cs
@@ -10,12 +10,12 @@ namespace Exiled.Events.EventArgs.Interfaces
     using API.Features;
 
     /// <summary>
-    ///     Event args used for all <see cref="API.Features.Camera" /> related events.
+    /// Event args used for all <see cref="API.Features.Camera" /> related events.
     /// </summary>
     public interface ICameraEvent : IExiledEvent
     {
         /// <summary>
-        ///     Gets or sets the <see cref="API.Features.Camera" /> triggering the event.
+        /// Gets or sets the <see cref="API.Features.Camera" /> triggering the event.
         /// </summary>
         public Camera Camera { get; set; }
     }

diff --git a/Exiled.Events/EventArgs/Interfaces/IDeniableEvent.cs b/Exiled.Events/EventArgs/Interfaces/IDeniableEvent.cs
@@ -8,12 +8,12 @@
 namespace Exiled.Events.EventArgs.Interfaces
 {
     /// <summary>
-    ///     Event args for events that can be allowed or denied.
+    /// Event args for events that can be allowed or denied.
     /// </summary>
     public interface IDeniableEvent : IExiledEvent
     {
         /// <summary>
-        ///     Gets or sets a value indicating whether or not the event is allowed to continue.
+        /// Gets or sets a value indicating whether or not the event is allowed to continue.
         /// </summary>
         public bool IsAllowed { get; set; }
     }

diff --git a/Exiled.Events/EventArgs/Interfaces/IDoorEvent.cs b/Exiled.Events/EventArgs/Interfaces/IDoorEvent.cs
@@ -10,12 +10,12 @@ namespace Exiled.Events.EventArgs.Interfaces
     using Exiled.API.Features.Doors;
 
     /// <summary>
-    ///     Event args used for all <see cref="API.Features.Doors.Door" /> related events.
+    /// Event args used for all <see cref="API.Features.Doors.Door" /> related events.
     /// </summary>
     public interface IDoorEvent : IExiledEvent
     {
         /// <summary>
-        ///     Gets the <see cref="API.Features.Doors.Door" /> triggering the event.
+        /// Gets the <see cref="API.Features.Doors.Door" /> triggering the event.
         /// </summary>
         public Door Door { get; }
     }

diff --git a/Exiled.Events/EventArgs/Interfaces/IExiledEvent.cs b/Exiled.Events/EventArgs/Interfaces/IExiledEvent.cs
@@ -8,7 +8,7 @@
 namespace Exiled.Events.EventArgs.Interfaces
 {
     /// <summary>
-    ///     The base Exiled Event Args interface to be used by all other event arg interfaces/classes.
+    /// The base Exiled Event Args interface to be used by all other event arg interfaces/classes.
     /// </summary>
     public interface IExiledEvent
     {

diff --git a/Exiled.Events/EventArgs/Interfaces/IFirearmEvent.cs b/Exiled.Events/EventArgs/Interfaces/IFirearmEvent.cs
@@ -10,12 +10,12 @@ namespace Exiled.Events.EventArgs.Interfaces
     using API.Features.Items;
 
     /// <summary>
-    ///     Event args used for all <see cref="API.Features.Items.Firearm" /> related events.
+    /// Event args used for all <see cref="API.Features.Items.Firearm" /> related events.
     /// </summary>
     public interface IFirearmEvent : IItemEvent
     {
         /// <summary>
-        ///     Gets the <see cref="API.Features.Items.Firearm" /> triggering the event.
+        /// Gets the <see cref="API.Features.Items.Firearm" /> triggering the event.
         /// </summary>
         public Firearm Firearm { get; }
     }

diff --git a/Exiled.Events/EventArgs/Interfaces/IGeneratorEvent.cs b/Exiled.Events/EventArgs/Interfaces/IGeneratorEvent.cs
@@ -10,12 +10,12 @@ namespace Exiled.Events.EventArgs.Interfaces
     using API.Features;
 
     /// <summary>
-    ///     Event args used for all <see cref="API.Features.Generator" /> related events.
+    /// Event args used for all <see cref="API.Features.Generator" /> related events.
     /// </summary>
     public interface IGeneratorEvent : IExiledEvent
     {
         /// <summary>
-        ///     Gets the <see cref="API.Features.Generator" /> triggering the event.
+        /// Gets the <see cref="API.Features.Generator" /> triggering the event.
         /// </summary>
         public Generator Generator { get; }
     }

diff --git a/Exiled.Events/EventArgs/Interfaces/IItemEvent.cs b/Exiled.Events/EventArgs/Interfaces/IItemEvent.cs
@@ -10,12 +10,12 @@ namespace Exiled.Events.EventArgs.Interfaces
     using API.Features.Items;
 
     /// <summary>
-    ///     Event args used for all <see cref="API.Features.Items.Item" /> related events.
+    /// Event args used for all <see cref="API.Features.Items.Item" /> related events.
     /// </summary>
     public interface IItemEvent : IExiledEvent
     {
         /// <summary>
-        ///     Gets the <see cref="API.Features.Items.Item" /> triggering the event.
+        /// Gets the <see cref="API.Features.Items.Item" /> triggering the event.
         /// </summary>
         public Item Item { get; }
     }

diff --git a/Exiled.Events/EventArgs/Interfaces/IPickupEvent.cs b/Exiled.Events/EventArgs/Interfaces/IPickupEvent.cs
@@ -10,12 +10,12 @@ namespace Exiled.Events.EventArgs.Interfaces
     using Exiled.API.Features.Pickups;
 
     /// <summary>
-    ///     Event args used for all <see cref="API.Features.Pickups.Pickup" /> related events.
+    /// Event args used for all <see cref="API.Features.Pickups.Pickup" /> related events.
     /// </summary>
     public interface IPickupEvent : IExiledEvent
     {
         /// <summary>
-        ///     Gets the <see cref="API.Features.Pickups.Pickup" /> triggering the event.
+        /// Gets the <see cref="API.Features.Pickups.Pickup" /> triggering the event.
         /// </summary>
         public Pickup Pickup { get; }
     }

diff --git a/Exiled.Events/EventArgs/Interfaces/IPlayerEvent.cs b/Exiled.Events/EventArgs/Interfaces/IPlayerEvent.cs
@@ -10,12 +10,12 @@ namespace Exiled.Events.EventArgs.Interfaces
     using API.Features;
 
     /// <summary>
-    ///     Event args used for all <see cref="API.Features.Player" /> related events.
+    /// Event args used for all <see cref="API.Features.Player" /> related events.
     /// </summary>
     public interface IPlayerEvent : IExiledEvent
     {
         /// <summary>
-        ///     Gets the <see cref="API.Features.Player" /> triggering the event.
+        /// Gets the <see cref="API.Features.Player" /> triggering the event.
         /// </summary>
         public Player Player { get; }
     }

diff --git a/Exiled.Events/EventArgs/Interfaces/IRagdollEvent.cs b/Exiled.Events/EventArgs/Interfaces/IRagdollEvent.cs
@@ -10,12 +10,12 @@ namespace Exiled.Events.EventArgs.Interfaces
     using API.Features;
 
     /// <summary>
-    ///     Event args used for all <see cref="API.Features.Ragdoll" /> related events.
+    /// Event args used for all <see cref="API.Features.Ragdoll" /> related events.
     /// </summary>
     public interface IRagdollEvent : IExiledEvent
     {
         /// <summary>
-        ///     Gets the <see cref="API.Features.Ragdoll" /> triggering the event.
+        /// Gets the <see cref="API.Features.Ragdoll" /> triggering the event.
         /// </summary>
         public Ragdoll Ragdoll { get; }
     }

diff --git a/Exiled.Events/EventArgs/Interfaces/IRoomEvent.cs b/Exiled.Events/EventArgs/Interfaces/IRoomEvent.cs
@@ -10,12 +10,12 @@ namespace Exiled.Events.EventArgs.Interfaces
     using API.Features;
 
     /// <summary>
-    ///     Event args used for all <see cref="API.Features.Room" /> related events.
+    /// Event args used for all <see cref="API.Features.Room" /> related events.
     /// </summary>
     public interface IRoomEvent : IExiledEvent
     {
         /// <summary>
-        ///     Gets the <see cref="API.Features.Room" /> that is a part of the event.
+        /// Gets the <see cref="API.Features.Room" /> that is a part of the event.
         /// </summary>
         public Room Room { get; }
     }

diff --git a/Exiled.Events/EventArgs/Interfaces/IScp0492Event.cs b/Exiled.Events/EventArgs/Interfaces/IScp0492Event.cs
@@ -10,12 +10,12 @@ namespace Exiled.Events.EventArgs.Interfaces
     using Exiled.API.Features.Roles;
 
     /// <summary>
-    ///     Event args used for all <see cref="Scp0492Role" /> related events.
+    /// Event args used for all <see cref="Scp0492Role" /> related events.
     /// </summary>
     public interface IScp0492Event : IPlayerEvent
     {
         /// <summary>
-        ///     Gets the <see cref="Scp0492Role" /> triggering the event.
+        /// Gets the <see cref="Scp0492Role" /> triggering the event.
         /// </summary>
         public Scp0492Role Scp0492 { get; }
     }