Browse Source

Document PersonRoleType.cs

Patrick Barron 4 years ago
parent
commit
0110b2472d
1 changed files with 62 additions and 14 deletions
  1. 62 14
      Jellyfin.Data/Enums/PersonRoleType.cs

+ 62 - 14
Jellyfin.Data/Enums/PersonRoleType.cs

@@ -1,20 +1,68 @@
-#pragma warning disable CS1591
-
 namespace Jellyfin.Data.Enums
 namespace Jellyfin.Data.Enums
 {
 {
+    /// <summary>
+    /// An enum representing a person's role in a specific media item.
+    /// </summary>
     public enum PersonRoleType
     public enum PersonRoleType
     {
     {
-        Other,
-        Director,
-        Artist,
-        OriginalArtist,
-        Actor,
-        VoiceActor,
-        Producer,
-        Remixer,
-        Conductor,
-        Composer,
-        Author,
-        Editor
+        /// <summary>
+        /// Another role, not covered by the other types.
+        /// </summary>
+        Other = 0,
+
+        /// <summary>
+        /// The director of the media.
+        /// </summary>
+        Director = 1,
+
+        /// <summary>
+        /// An artist.
+        /// </summary>
+        Artist = 2,
+
+        /// <summary>
+        /// The original artist.
+        /// </summary>
+        OriginalArtist = 3,
+
+        /// <summary>
+        /// An actor.
+        /// </summary>
+        Actor = 4,
+
+        /// <summary>
+        /// A voice actor.
+        /// </summary>
+        VoiceActor = 5,
+
+        /// <summary>
+        /// A producer.
+        /// </summary>
+        Producer = 6,
+
+        /// <summary>
+        /// A remixer.
+        /// </summary>
+        Remixer = 7,
+
+        /// <summary>
+        /// A conductor.
+        /// </summary>
+        Conductor = 8,
+
+        /// <summary>
+        /// A composer.
+        /// </summary>
+        Composer = 9,
+
+        /// <summary>
+        /// An author.
+        /// </summary>
+        Author = 10,
+
+        /// <summary>
+        /// An editor.
+        /// </summary>
+        Editor = 11
     }
     }
 }
 }