aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Model/Entities
diff options
context:
space:
mode:
authorrudy-07 <kanhaiffco2007@gmail.com>2026-11-01 20:05:44 +0530
committerrudy-07 <kanhaiffco2007@gmail.com>2026-11-01 20:05:44 +0530
commit60aff8356daba2c23ceb918ee4c4e613b49a98a4 (patch)
treea0fa30620cfd46d5dc664d1ee7f7a4b07dad684c /MediaBrowser.Model/Entities
parent5b385862fb97201d954a6ac7c9c745d791a738fa (diff)
Add XML docs to small model enums
Add XML documentation to several small enums in MediaBrowser.Model (ExtraType, TrailerType, Video3DFormat, MediaProtocol, RecommendationType, ChannelMediaType) and remove the #pragma warning disable CS1591 suppressions from those files. Part of #2149.
Diffstat (limited to 'MediaBrowser.Model/Entities')
-rw-r--r--MediaBrowser.Model/Entities/ExtraType.cs52
-rw-r--r--MediaBrowser.Model/Entities/TrailerType.cs24
-rw-r--r--MediaBrowser.Model/Entities/Video3DFormat.cs24
3 files changed, 94 insertions, 6 deletions
diff --git a/MediaBrowser.Model/Entities/ExtraType.cs b/MediaBrowser.Model/Entities/ExtraType.cs
index 66da80d96b..899185ffd0 100644
--- a/MediaBrowser.Model/Entities/ExtraType.cs
+++ b/MediaBrowser.Model/Entities/ExtraType.cs
@@ -1,20 +1,68 @@
-#pragma warning disable CS1591
-
namespace MediaBrowser.Model.Entities
{
+ /// <summary>
+ /// The type of extra media associated with an item.
+ /// </summary>
public enum ExtraType
{
+ /// <summary>
+ /// An unknown extra type.
+ /// </summary>
Unknown = 0,
+
+ /// <summary>
+ /// A short clip.
+ /// </summary>
Clip = 1,
+
+ /// <summary>
+ /// A trailer.
+ /// </summary>
Trailer = 2,
+
+ /// <summary>
+ /// A behind-the-scenes video.
+ /// </summary>
BehindTheScenes = 3,
+
+ /// <summary>
+ /// A deleted scene.
+ /// </summary>
DeletedScene = 4,
+
+ /// <summary>
+ /// An interview.
+ /// </summary>
Interview = 5,
+
+ /// <summary>
+ /// A scene.
+ /// </summary>
Scene = 6,
+
+ /// <summary>
+ /// A sample video.
+ /// </summary>
Sample = 7,
+
+ /// <summary>
+ /// A theme song.
+ /// </summary>
ThemeSong = 8,
+
+ /// <summary>
+ /// A theme video.
+ /// </summary>
ThemeVideo = 9,
+
+ /// <summary>
+ /// A featurette.
+ /// </summary>
Featurette = 10,
+
+ /// <summary>
+ /// A short film.
+ /// </summary>
Short = 11
}
}
diff --git a/MediaBrowser.Model/Entities/TrailerType.cs b/MediaBrowser.Model/Entities/TrailerType.cs
index 68d992b0d0..54f6ddb4a6 100644
--- a/MediaBrowser.Model/Entities/TrailerType.cs
+++ b/MediaBrowser.Model/Entities/TrailerType.cs
@@ -1,13 +1,33 @@
-#pragma warning disable CS1591
-
namespace MediaBrowser.Model.Entities
{
+ /// <summary>
+ /// The type of a trailer.
+ /// </summary>
public enum TrailerType
{
+ /// <summary>
+ /// A trailer for media coming soon to theaters.
+ /// </summary>
ComingSoonToTheaters = 1,
+
+ /// <summary>
+ /// A trailer for media coming soon to DVD.
+ /// </summary>
ComingSoonToDvd = 2,
+
+ /// <summary>
+ /// A trailer for media coming soon to streaming services.
+ /// </summary>
ComingSoonToStreaming = 3,
+
+ /// <summary>
+ /// An archived trailer.
+ /// </summary>
Archive = 4,
+
+ /// <summary>
+ /// A local trailer stored alongside the media.
+ /// </summary>
LocalTrailer = 5
}
}
diff --git a/MediaBrowser.Model/Entities/Video3DFormat.cs b/MediaBrowser.Model/Entities/Video3DFormat.cs
index a4f62e18b4..c7866c246a 100644
--- a/MediaBrowser.Model/Entities/Video3DFormat.cs
+++ b/MediaBrowser.Model/Entities/Video3DFormat.cs
@@ -1,13 +1,33 @@
-#pragma warning disable CS1591
-
namespace MediaBrowser.Model.Entities
{
+ /// <summary>
+ /// The 3D video layout format.
+ /// </summary>
public enum Video3DFormat
{
+ /// <summary>
+ /// Half side-by-side format.
+ /// </summary>
HalfSideBySide,
+
+ /// <summary>
+ /// Full side-by-side format.
+ /// </summary>
FullSideBySide,
+
+ /// <summary>
+ /// Full top-and-bottom format.
+ /// </summary>
FullTopAndBottom,
+
+ /// <summary>
+ /// Half top-and-bottom format.
+ /// </summary>
HalfTopAndBottom,
+
+ /// <summary>
+ /// Multiview Video Coding format.
+ /// </summary>
MVC
}
}