Merge pull request #400 from Mahsaap/Summaries

Many Summaries added.

TwitchLib.Api.Core.Enums/AuthScopesEnum.cs

@@ -2,6 +2,9 @@
 
 namespace TwitchLib.Api.Core.Enums
 {
+    /// <summary>
+    /// Auth Scopes
+    /// </summary>
     public enum AuthScopes
     {
         /// <summary>
@@ -336,11 +339,19 @@ public enum AuthScopes
         /// </summary>
         User_Read_Follows,
 
+        /// <summary>
+        /// View the list of channels a user moderates.
+        /// </summary>
+        User_Read_Moderated_Channels,
+
         /// <summary>
         /// View if an authorized user is subscribed to specific channels.
         /// </summary>
         User_Read_Subscriptions,
 
+        /// <summary>
+        /// User write chat
+        /// </summary>
         User_Write_Chat,
 
         /// <summary>

TwitchLib.Api.Core.Enums/BitsLeaderboardPeriodEnum.cs

@@ -1,11 +1,33 @@
 namespace TwitchLib.Api.Core.Enums
 {
+    /// <summary>
+    /// Enum representing Bits Leaderboard Period
+    /// </summary>
     public enum BitsLeaderboardPeriodEnum
     {
+        /// <summary>
+        /// A Day
+        /// </summary>
         Day,
+
+        /// <summary>
+        /// A Week
+        /// </summary>
         Week,
+
+        /// <summary>
+        /// A Month
+        /// </summary>
         Month,
+
+        /// <summary>
+        /// A Year
+        /// </summary>
         Year,
+
+        /// <summary>
+        /// All-Time or everything
+        /// </summary>
         All
     }
 }

TwitchLib.Api.Core.Enums/BlockUserReasonEnum.cs

@@ -1,9 +1,23 @@
 namespace TwitchLib.Api.Core.Enums
 {
+    /// <summary>
+    /// Enum representing the reason a User was blocked
+    /// </summary>
     public enum BlockUserReasonEnum
     {
+        /// <summary>
+        /// Spam
+        /// </summary>
         Spam,
+
+        /// <summary>
+        /// Harrassment
+        /// </summary>
         Harassment,
+
+        /// <summary>
+        /// Some other reason
+        /// </summary>
         Other
     }
 }

TwitchLib.Api.Core.Enums/BlockUserSourceContextEnum.cs

@@ -1,8 +1,18 @@
 namespace TwitchLib.Api.Core.Enums
 {
+    /// <summary>
+    /// Enum representing where the source context was for the blocked user
+    /// </summary>
     public enum BlockUserSourceContextEnum
     {
+        /// <summary>
+        /// In chat
+        /// </summary>
         Chat,
+
+        /// <summary>
+        /// In a whisper
+        /// </summary>
         Whisper
     }
 }

TwitchLib.Api.Core.Enums/CodeStatusEnum.cs

@@ -1,15 +1,53 @@
 namespace TwitchLib.Api.Core.Enums
 {
+    /// <summary>
+    /// Enum representing code status
+    /// </summary>
     public enum CodeStatusEnum
     {
+        /// <summary>
+        /// Successfully Redeemed
+        /// </summary>
         SUCCESSFULLY_REDEEMED,
+
+        /// <summary>
+        /// Already Claimed
+        /// </summary>
         ALREADY_CLAIMED,
+
+        /// <summary>
+        /// Expired
+        /// </summary>
         EXPIRED,
+
+        /// <summary>
+        /// User not eligible
+        /// </summary>
         USER_NOT_ELIGIBLE,
+
+        /// <summary>
+        /// Not found
+        /// </summary>
         NOT_FOUND,
+
+        /// <summary>
+        /// Inactive
+        /// </summary>
         INACTIVE,
+
+        /// <summary>
+        /// Unused
+        /// </summary>
         UNUSED,
+
+        /// <summary>
+        /// Incorrect format
+        /// </summary>
         INCORRECT_FORMAT,
+
+        /// <summary>
+        /// Internal error
+        /// </summary>
         INTERNAL_ERROR
     }
 }

TwitchLib.Api.Core.Enums/CustomRewardRedemptionStatusEnum.cs

@@ -1,9 +1,23 @@
 namespace TwitchLib.Api.Core.Enums
 {
+    /// <summary>
+    /// Enum representing the custeom reward redemption status
+    /// </summary>
     public enum CustomRewardRedemptionStatus
     {
+        /// <summary>
+        /// Not completed
+        /// </summary>
         UNFULFILLED,
+
+        /// <summary>
+        /// Completed
+        /// </summary>
         FULFILLED,
+
+        /// <summary>
+        /// Cancelled
+        /// </summary>
         CANCELED
     }
 }

TwitchLib.Api.Core.Enums/DropEntitlementUpdateStatus.cs

@@ -1,11 +1,33 @@
 namespace TwitchLib.Api.Core.Enums
 {
+    /// <summary>
+    /// Enum representing drop entitlement update status
+    /// </summary>
     public enum DropEntitlementUpdateStatus
     {
+        /// <summary>
+        /// Completed
+        /// </summary>
         SUCCESS,
+
+        /// <summary>
+        /// Not Authorized
+        /// </summary>
         UNAUTHORIZED,
+
+        /// <summary>
+        /// Failed
+        /// </summary>
         UPDATE_FAILED,
+
+        /// <summary>
+        /// Invalid Id
+        /// </summary>
         INVALID_ID,
+
+        /// <summary>
+        /// Not found
+        /// </summary>
         NOT_FOUND
     }
 }

TwitchLib.Api.Core.Enums/EventSubTransportMethod.cs

@@ -1,9 +1,23 @@
 namespace TwitchLib.Api.Core.Enums
 {
+    /// <summary>
+    /// Enum representing the eventsub transport method
+    /// </summary>
     public enum EventSubTransportMethod
     {
+        /// <summary>
+        /// Webhook
+        /// </summary>
         Webhook,
+
+        /// <summary>
+        /// Websocket
+        /// </summary>
         Websocket,
+
+        /// <summary>
+        /// Conduit
+        /// </summary>
         Conduit
     }
 }

TwitchLib.Api.Core.Enums/ExtensionStateEnum.cs

@@ -1,15 +1,53 @@
 namespace TwitchLib.Api.Core.Enums
 {
+    /// <summary>
+    /// Enum representing the extension state
+    /// </summary>
     public enum ExtensionState
     {
+        /// <summary>
+        /// In testing
+        /// </summary>
         InTest,
+
+        /// <summary>
+        /// In review
+        /// </summary>
         InReview,
+
+        /// <summary>
+        /// Rejected
+        /// </summary>
         Rejected,
+
+        /// <summary>
+        /// Approved
+        /// </summary>
         Approved,
+
+        /// <summary>
+        /// Released
+        /// </summary>
         Released,
+
+        /// <summary>
+        /// Deprecated
+        /// </summary>
         Deprecated,
+
+        /// <summary>
+        /// Pending action
+        /// </summary>
         PendingAction,
+
+        /// <summary>
+        /// Assets uploaded
+        /// </summary>
         AssetsUploaded,
+
+        /// <summary>
+        /// Deleted
+        /// </summary>
         Deleted
     }
 }

TwitchLib.Api.Core.Enums/ExtensionTypeEnum.cs

@@ -1,9 +1,23 @@
 namespace TwitchLib.Api.Core.Enums
 {
+    /// <summary>
+    /// Enum representing the extension type
+    /// </summary>
     public enum ExtensionType
     {
+        /// <summary>
+        /// Extenion is a panel
+        /// </summary>
         Panel,
+
+        /// <summary>
+        /// Extension is an overlay
+        /// </summary>
         Overlay,
+
+        /// <summary>
+        /// Extension is a component
+        /// </summary>
         Component
     }
 }

TwitchLib.Api.Core.Enums/FulfillmentStatus.cs

@@ -1,8 +1,18 @@
 namespace TwitchLib.Api.Core.Enums
 {
+    /// <summary>
+    /// Enum representing the fulfullment status
+    /// </summary>
     public enum FulfillmentStatus
     {
+        /// <summary>
+        /// Claimed
+        /// </summary>
         CLAIMED,
+
+        /// <summary>
+        /// Fulfilled
+        /// </summary>
         FULFILLED
     }
 }

TwitchLib.Api.Core.Enums/ManageHeldAutoModMessageAction.cs

@@ -1,8 +1,18 @@
 namespace TwitchLib.Api.Core.Enums
 {
+    /// <summary>
+    /// Enum representing the action related to manage held auto mod action
+    /// </summary>
     public enum ManageHeldAutoModMessageActionEnum
     {
+        /// <summary>
+        /// Allow the messsage
+        /// </summary>
         ALLOW,
+
+        /// <summary>
+        /// Deny the message
+        /// </summary>
         DENY
     }
 }

TwitchLib.Api.Core.Enums/PollStatusEnum.cs

@@ -1,8 +1,18 @@
 namespace TwitchLib.Api.Core.Enums
 {
+    /// <summary>
+    /// Enum representing the poll status
+    /// </summary>
     public enum PollStatusEnum
     {
+        /// <summary>
+        /// Poll Terminated
+        /// </summary>
         TERMINATED,
+
+        /// <summary>
+        /// Poll Archived
+        /// </summary>
         ARCHIVED
     }
 }