Browse Source

Document UnratedItem.cs

Patrick Barron 4 years ago
parent
commit
b1b2d399f8
1 changed files with 47 additions and 11 deletions
  1. 47 11
      Jellyfin.Data/Enums/UnratedItem.cs

+ 47 - 11
Jellyfin.Data/Enums/UnratedItem.cs

@@ -1,17 +1,53 @@
-#pragma warning disable CS1591
-
 namespace Jellyfin.Data.Enums
 namespace Jellyfin.Data.Enums
 {
 {
+    /// <summary>
+    /// An enum representing an unrated item.
+    /// </summary>
     public enum UnratedItem
     public enum UnratedItem
     {
     {
-        Movie,
-        Trailer,
-        Series,
-        Music,
-        Book,
-        LiveTvChannel,
-        LiveTvProgram,
-        ChannelContent,
-        Other
+        /// <summary>
+        /// A movie.
+        /// </summary>
+        Movie = 0,
+
+        /// <summary>
+        /// A trailer.
+        /// </summary>
+        Trailer = 1,
+
+        /// <summary>
+        /// A series.
+        /// </summary>
+        Series = 2,
+
+        /// <summary>
+        /// Music.
+        /// </summary>
+        Music = 3,
+
+        /// <summary>
+        /// A book.
+        /// </summary>
+        Book = 4,
+
+        /// <summary>
+        /// A live TV channel
+        /// </summary>
+        LiveTvChannel = 5,
+
+        /// <summary>
+        /// A live TV program.
+        /// </summary>
+        LiveTvProgram = 6,
+
+        /// <summary>
+        /// Channel content.
+        /// </summary>
+        ChannelContent = 7,
+
+        /// <summary>
+        /// Another type, not covered by the other fields.
+        /// </summary>
+        Other = 8
     }
     }
 }
 }