Merge pull request #230 from aspriddell/enum-xmldoc

Add more XMLdocs to enum members
dragonfruitnetwork · Apr 25, 2021 · ac07b7f · ac07b7f
2 parents 95f47a4 + 1566165
commit ac07b7f
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 0 deletions.
diff --git a/DragonFruit.Six.Api/Enums/LookupMethod.cs b/DragonFruit.Six.Api/Enums/LookupMethod.cs
@@ -3,6 +3,9 @@
 
 namespace DragonFruit.Six.Api.Enums
 {
+    /// <summary>
+    /// Describes how the server should interpret the search queries provided in the request
+    /// </summary>
     public enum LookupMethod
     {
         /// <summary>

diff --git a/DragonFruit.Six.Api/Enums/MatchResult.cs b/DragonFruit.Six.Api/Enums/MatchResult.cs
@@ -3,6 +3,9 @@
 
 namespace DragonFruit.Six.Api.Enums
 {
+    /// <summary>
+    /// Describes the outcome of a match for a player
+    /// </summary>
     public enum MatchResult
     {
         Unknown = 0,

diff --git a/DragonFruit.Six.Api/Enums/OperatorType.cs b/DragonFruit.Six.Api/Enums/OperatorType.cs
@@ -5,6 +5,12 @@
 
 namespace DragonFruit.Six.Api.Enums
 {
+    /// <summary>
+    /// Describes the side the operator is on.
+    /// </summary>
+    /// <remarks>
+    /// Used in the Dragon6 Datasets
+    /// </remarks>
     [Flags]
     public enum OperatorType
     {

diff --git a/DragonFruit.Six.Api/Enums/ServerStatus.cs b/DragonFruit.Six.Api/Enums/ServerStatus.cs
@@ -3,6 +3,9 @@
 
 namespace DragonFruit.Six.Api.Enums
 {
+    /// <summary>
+    /// Describes the current state of the Rainbow Six infrastructure
+    /// </summary>
     public enum ServerStatus
     {
         /// <summary>

diff --git a/DragonFruit.Six.Api/Enums/WeaponType.cs b/DragonFruit.Six.Api/Enums/WeaponType.cs
@@ -5,6 +5,9 @@
 
 namespace DragonFruit.Six.Api.Enums
 {
+    /// <summary>
+    /// The categories a weapon can fall under
+    /// </summary>
     public enum WeaponType
     {
         [Description("Assault Rifle")]