refactor: clean up some warnings

Dalamud/DalamudStartInfo.cs

@@ -1,5 +1,5 @@
 using System;
-using Dalamud.DiscordBot;
+#pragma warning disable 1591
 
 namespace Dalamud {
     [Serializable]
@@ -15,6 +15,9 @@ namespace Dalamud {
         public string GameVersion;
     }
 
+    /// <summary>
+    /// Enum describing the language the game loads in.
+    /// </summary>
     public enum ClientLanguage
     {
         Japanese,

Dalamud/Game/Chat/SeIconChar.cs

@@ -3,6 +3,7 @@ using System.Collections.Generic;
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
+#pragma warning disable 1591
 
 namespace Dalamud.Game.Chat
 {

Dalamud/Game/Chat/XivChatType.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Linq;
+#pragma warning disable 1591
 
 namespace Dalamud.Game.Chat
 {

Dalamud/Game/ClientState/Actors/CustomizeIndex.cs

@@ -11,31 +11,134 @@ namespace Dalamud.Game.ClientState.Actors
     /// </summary>
     // TODO: This may need some rework since it may not be entirely accurate (stolen from Sapphire)
     public enum CustomizeIndex {
+        /// <summary>
+        /// The race of the character.
+        /// </summary>
         Race = 0x00,
+
+        /// <summary>
+        /// The gender of the character.
+        /// </summary>
         Gender = 0x01,
+
+        /// <summary>
+        /// The tribe of the character.
+        /// </summary>
         Tribe = 0x04,
+
+        /// <summary>
+        /// The height of the character.
+        /// </summary>
         Height = 0x03,
+
+        /// <summary>
+        /// The model type of the character.
+        /// </summary>
         ModelType = 0x02, // Au Ra: changes horns/tails, everything else: seems to drastically change appearance (flip between two sets, odd/even numbers). sometimes retains hairstyle and other features
+        
+        /// <summary>
+        /// The face type of the character.
+        /// </summary>
         FaceType = 0x05,
+        
+        /// <summary>
+        /// The hair of the character.
+        /// </summary>
         HairStyle = 0x06,
+
+        /// <summary>
+        /// Whether or not the character has hair highlights.
+        /// </summary>
         HasHighlights = 0x07, // negative to enable, positive to disable
+        
+        /// <summary>
+        /// The skin color of the character.
+        /// </summary>
         SkinColor = 0x08,
+        
+        /// <summary>
+        /// The eye color of the character.
+        /// </summary>
         EyeColor = 0x09, // color of character's right eye
+
+        /// <summary>
+        /// The hair color of the character.
+        /// </summary>
         HairColor = 0x0A, // main color
+
+        /// <summary>
+        /// The highlights hair color of the character.
+        /// </summary>
         HairColor2 = 0x0B, // highlights color
+
+        /// <summary>
+        /// The face features of the character.
+        /// </summary>
         FaceFeatures = 0x0C, // seems to be a toggle, (-odd and +even for large face covering), opposite for small
+
+        /// <summary>
+        /// The color of the face features of the character.
+        /// </summary>
         FaceFeaturesColor = 0x0D,
+
+        /// <summary>
+        /// The eyebrows of the character.
+        /// </summary>
         Eyebrows = 0x0E,
+
+        /// <summary>
+        /// The 2nd eye color of the character.
+        /// </summary>
         EyeColor2 = 0x0F, // color of character's left eye
+
+        /// <summary>
+        /// The eye shape of the character.
+        /// </summary>
         EyeShape = 0x10,
+
+        /// <summary>
+        /// The nose shape of the character.
+        /// </summary>
         NoseShape = 0x11,
+
+        /// <summary>
+        /// The jaw shape of the character.
+        /// </summary>
         JawShape = 0x12,
+
+        /// <summary>
+        /// The lip style of the character.
+        /// </summary>
         LipStyle = 0x13, // lip colour depth and shape (negative values around -120 darker/more noticeable, positive no colour)
+
+        /// <summary>
+        /// The lip color of the character.
+        /// </summary>
         LipColor = 0x14,
+
+        /// <summary>
+        /// The race feature size of the character.
+        /// </summary>
         RaceFeatureSize = 0x15,
+
+        /// <summary>
+        /// The race feature type of the character.
+        /// </summary>
         RaceFeatureType = 0x16, // negative or out of range tail shapes for race result in no tail (e.g. Au Ra has max of 4 tail shapes), incorrect value can crash client
+        
+        /// <summary>
+        /// The bust size of the character.
+        /// </summary>
         BustSize = 0x17, // char creator allows up to max of 100, i set to 127 cause who wouldnt but no visible difference
+        
+        /// <summary>
+        /// The face paint of the character.
+        /// </summary>
         Facepaint = 0x18,
+        
+        /// <summary>
+        /// The face paint color of the character.
+        /// </summary>
         FacepaintColor = 0x19,
     }
 }

Dalamud/Game/ClientState/Structs/Actor.cs

@@ -5,6 +5,7 @@ using System.Runtime.InteropServices;
 using System.Text;
 using System.Threading.Tasks;
 using Dalamud.Game.ClientState.Actors;
+#pragma warning disable 1591
 
 namespace Dalamud.Game.ClientState.Structs
 {

Dalamud/Interface/FontAwesomeIcon.cs

@@ -1,5 +1,6 @@
 //Font-Awesome - Version 5.0.9
 using System.Collections.Generic;
+#pragma warning disable 1591
 
 namespace Dalamud.Interface
 {

Dalamud/Plugin/PluginDefinition.cs

@@ -8,14 +8,49 @@ namespace Dalamud.Plugin
 {
     public class PluginDefinition
     {
+        /// <summary>
+        /// The author/s of the plugin.
+        /// </summary>
         public string Author { get; set; }
+
+        /// <summary>
+        /// The public name of the plugin.
+        /// </summary>
         public string Name { get; set; }
+
+        /// <summary>
+        /// The internal name of the plugin, which should match the assembly name of the plugin.
+        /// </summary>
         public string InternalName { get; set; }
+
+        /// <summary>
+        /// The current assembly version of the plugin.
+        /// </summary>
         public string AssemblyVersion { get; set; }
+
+        /// <summary>
+        /// A description of the plugins functions.
+        /// </summary>
         public string Description { get; set; }
+
+        /// <summary>
+        /// The version of the game this plugin works with.
+        /// </summary>
         public string ApplicableVersion { get; set; }
+
+        /// <summary>
+        /// An URL to the website or source code of the plugin.
+        /// </summary>
         public string RepoUrl { get; set; }
+
+        /// <summary>
+        /// Whether or not the plugin is hidden in the plugin installer.
+        /// </summary>
         public bool IsHide { get; set; }
+
+        /// <summary>
+        /// The API level of this plugin. For the current API level, please see <see cref="PluginManager.DALAMUD_API_LEVEL"/> for the currently used API level.
+        /// </summary>
         public int DalamudApiLevel { get; set; }
     }
 }

Dalamud/Plugin/PluginManager.cs

@@ -12,7 +12,7 @@ using Serilog;
 namespace Dalamud.Plugin
 {
     internal class PluginManager {
-        public const int DALAMUD_API_LEVEL = 1;
+        public static int DALAMUD_API_LEVEL = 1;
 
         private readonly Dalamud dalamud;
         private readonly string pluginDirectory;