From 1566165768877287c6e392119fa40e97f734a728 Mon Sep 17 00:00:00 2001 From: Albie Date: Sun, 25 Apr 2021 08:40:22 +0100 Subject: [PATCH] add more xmldoc --- DragonFruit.Six.Api/Enums/LookupMethod.cs | 3 +++ DragonFruit.Six.Api/Enums/MatchResult.cs | 3 +++ DragonFruit.Six.Api/Enums/OperatorType.cs | 6 ++++++ DragonFruit.Six.Api/Enums/ServerStatus.cs | 3 +++ DragonFruit.Six.Api/Enums/WeaponType.cs | 3 +++ 5 files changed, 18 insertions(+) diff --git a/DragonFruit.Six.Api/Enums/LookupMethod.cs b/DragonFruit.Six.Api/Enums/LookupMethod.cs index 601a9204..0bc19cf2 100644 --- a/DragonFruit.Six.Api/Enums/LookupMethod.cs +++ b/DragonFruit.Six.Api/Enums/LookupMethod.cs @@ -3,6 +3,9 @@ namespace DragonFruit.Six.Api.Enums { + /// + /// Describes how the server should interpret the search queries provided in the request + /// public enum LookupMethod { /// diff --git a/DragonFruit.Six.Api/Enums/MatchResult.cs b/DragonFruit.Six.Api/Enums/MatchResult.cs index abb30637..f62fd889 100644 --- a/DragonFruit.Six.Api/Enums/MatchResult.cs +++ b/DragonFruit.Six.Api/Enums/MatchResult.cs @@ -3,6 +3,9 @@ namespace DragonFruit.Six.Api.Enums { + /// + /// Describes the outcome of a match for a player + /// public enum MatchResult { Unknown = 0, diff --git a/DragonFruit.Six.Api/Enums/OperatorType.cs b/DragonFruit.Six.Api/Enums/OperatorType.cs index e9b43bcb..445241b6 100644 --- a/DragonFruit.Six.Api/Enums/OperatorType.cs +++ b/DragonFruit.Six.Api/Enums/OperatorType.cs @@ -5,6 +5,12 @@ namespace DragonFruit.Six.Api.Enums { + /// + /// Describes the side the operator is on. + /// + /// + /// Used in the Dragon6 Datasets + /// [Flags] public enum OperatorType { diff --git a/DragonFruit.Six.Api/Enums/ServerStatus.cs b/DragonFruit.Six.Api/Enums/ServerStatus.cs index b95dc9dd..0656fd80 100644 --- a/DragonFruit.Six.Api/Enums/ServerStatus.cs +++ b/DragonFruit.Six.Api/Enums/ServerStatus.cs @@ -3,6 +3,9 @@ namespace DragonFruit.Six.Api.Enums { + /// + /// Describes the current state of the Rainbow Six infrastructure + /// public enum ServerStatus { /// diff --git a/DragonFruit.Six.Api/Enums/WeaponType.cs b/DragonFruit.Six.Api/Enums/WeaponType.cs index b4ae9e9c..ae6caeab 100644 --- a/DragonFruit.Six.Api/Enums/WeaponType.cs +++ b/DragonFruit.Six.Api/Enums/WeaponType.cs @@ -5,6 +5,9 @@ namespace DragonFruit.Six.Api.Enums { + /// + /// The categories a weapon can fall under + /// public enum WeaponType { [Description("Assault Rifle")]