aboutsummaryrefslogtreecommitdiff
path: root/Jellyfin.Data/Enums
diff options
context:
space:
mode:
authorPatrick Barron <barronpm@gmail.com>2020-08-31 23:11:58 -0400
committerPatrick Barron <barronpm@gmail.com>2020-08-31 23:11:58 -0400
commita1aece1299cd556f84331323af8e2f675c70b843 (patch)
tree64b81e8346b3bbfa0986f380a7d146c48a3a3f9f /Jellyfin.Data/Enums
parent4e439652da58db4daddbc64eec8a0f62c5de6872 (diff)
Document MediaFileKind.cs
Diffstat (limited to 'Jellyfin.Data/Enums')
-rw-r--r--Jellyfin.Data/Enums/MediaFileKind.cs34
1 files changed, 27 insertions, 7 deletions
diff --git a/Jellyfin.Data/Enums/MediaFileKind.cs b/Jellyfin.Data/Enums/MediaFileKind.cs
index b03591fb8..797c26ec2 100644
--- a/Jellyfin.Data/Enums/MediaFileKind.cs
+++ b/Jellyfin.Data/Enums/MediaFileKind.cs
@@ -1,13 +1,33 @@
-#pragma warning disable CS1591
-
namespace Jellyfin.Data.Enums
{
+ /// <summary>
+ /// An enum representing the type of media file.
+ /// </summary>
public enum MediaFileKind
{
- Main,
- Sidecar,
- AdditionalPart,
- AlternativeFormat,
- AdditionalStream
+ /// <summary>
+ /// The main file.
+ /// </summary>
+ Main = 0,
+
+ /// <summary>
+ /// A sidecar file.
+ /// </summary>
+ Sidecar = 1,
+
+ /// <summary>
+ /// An additional part to the main file.
+ /// </summary>
+ AdditionalPart = 2,
+
+ /// <summary>
+ /// An alternative format to the main file.
+ /// </summary>
+ AlternativeFormat = 3,
+
+ /// <summary>
+ /// An additional stream for the main file.
+ /// </summary>
+ AdditionalStream = 4
}
}