aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Model
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
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')
-rw-r--r--MediaBrowser.Model/Channels/ChannelMediaType.cs14
-rw-r--r--MediaBrowser.Model/Dto/RecommendationType.cs23
-rw-r--r--MediaBrowser.Model/Entities/ExtraType.cs52
-rw-r--r--MediaBrowser.Model/Entities/TrailerType.cs24
-rw-r--r--MediaBrowser.Model/Entities/Video3DFormat.cs24
-rw-r--r--MediaBrowser.Model/MediaInfo/MediaProtocol.cs32
6 files changed, 157 insertions, 12 deletions
diff --git a/MediaBrowser.Model/Channels/ChannelMediaType.cs b/MediaBrowser.Model/Channels/ChannelMediaType.cs
index ba2c06d1b7..fba1fbadcd 100644
--- a/MediaBrowser.Model/Channels/ChannelMediaType.cs
+++ b/MediaBrowser.Model/Channels/ChannelMediaType.cs
@@ -1,13 +1,23 @@
-#pragma warning disable CS1591
-
namespace MediaBrowser.Model.Channels
{
+ /// <summary>
+ /// The media type of a channel.
+ /// </summary>
public enum ChannelMediaType
{
+ /// <summary>
+ /// An audio channel.
+ /// </summary>
Audio = 0,
+ /// <summary>
+ /// A video channel.
+ /// </summary>
Video = 1,
+ /// <summary>
+ /// A photo channel.
+ /// </summary>
Photo = 2
}
}
diff --git a/MediaBrowser.Model/Dto/RecommendationType.cs b/MediaBrowser.Model/Dto/RecommendationType.cs
index 384f20c32b..4786ed4a11 100644
--- a/MediaBrowser.Model/Dto/RecommendationType.cs
+++ b/MediaBrowser.Model/Dto/RecommendationType.cs
@@ -1,19 +1,38 @@
-#pragma warning disable CS1591
-
namespace MediaBrowser.Model.Dto
{
+ /// <summary>
+ /// The type of recommendation reason for an item.
+ /// </summary>
public enum RecommendationType
{
+ /// <summary>
+ /// The item is similar to a recently played item.
+ /// </summary>
SimilarToRecentlyPlayed = 0,
+ /// <summary>
+ /// The item is similar to a liked item.
+ /// </summary>
SimilarToLikedItem = 1,
+ /// <summary>
+ /// The item has a director in common with a recently played item.
+ /// </summary>
HasDirectorFromRecentlyPlayed = 2,
+ /// <summary>
+ /// The item has an actor in common with a recently played item.
+ /// </summary>
HasActorFromRecentlyPlayed = 3,
+ /// <summary>
+ /// The item has a director that the user liked.
+ /// </summary>
HasLikedDirector = 4,
+ /// <summary>
+ /// The item has an actor that the user liked.
+ /// </summary>
HasLikedActor = 5
}
}
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
}
}
diff --git a/MediaBrowser.Model/MediaInfo/MediaProtocol.cs b/MediaBrowser.Model/MediaInfo/MediaProtocol.cs
index b9df01f277..5e888c4750 100644
--- a/MediaBrowser.Model/MediaInfo/MediaProtocol.cs
+++ b/MediaBrowser.Model/MediaInfo/MediaProtocol.cs
@@ -1,15 +1,43 @@
-#pragma warning disable CS1591
-
namespace MediaBrowser.Model.MediaInfo
{
+ /// <summary>
+ /// The protocol used to access a media source.
+ /// </summary>
public enum MediaProtocol
{
+ /// <summary>
+ /// Local filesystem protocol.
+ /// </summary>
File = 0,
+
+ /// <summary>
+ /// Hypertext Transfer Protocol.
+ /// </summary>
Http = 1,
+
+ /// <summary>
+ /// Real-Time Messaging Protocol.
+ /// </summary>
Rtmp = 2,
+
+ /// <summary>
+ /// Real-Time Streaming Protocol.
+ /// </summary>
Rtsp = 3,
+
+ /// <summary>
+ /// User Datagram Protocol.
+ /// </summary>
Udp = 4,
+
+ /// <summary>
+ /// Real-time Transport Protocol.
+ /// </summary>
Rtp = 5,
+
+ /// <summary>
+ /// File Transfer Protocol.
+ /// </summary>
Ftp = 6
}
}