From 60aff8356daba2c23ceb918ee4c4e613b49a98a4 Mon Sep 17 00:00:00 2001 From: rudy-07 Date: Sun, 1 Nov 2026 20:05:44 +0530 Subject: 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. --- MediaBrowser.Model/Channels/ChannelMediaType.cs | 14 ++++++- MediaBrowser.Model/Dto/RecommendationType.cs | 23 ++++++++++- MediaBrowser.Model/Entities/ExtraType.cs | 52 ++++++++++++++++++++++++- MediaBrowser.Model/Entities/TrailerType.cs | 24 +++++++++++- MediaBrowser.Model/Entities/Video3DFormat.cs | 24 +++++++++++- MediaBrowser.Model/MediaInfo/MediaProtocol.cs | 32 ++++++++++++++- 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 { + /// + /// The media type of a channel. + /// public enum ChannelMediaType { + /// + /// An audio channel. + /// Audio = 0, + /// + /// A video channel. + /// Video = 1, + /// + /// A photo channel. + /// 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 { + /// + /// The type of recommendation reason for an item. + /// public enum RecommendationType { + /// + /// The item is similar to a recently played item. + /// SimilarToRecentlyPlayed = 0, + /// + /// The item is similar to a liked item. + /// SimilarToLikedItem = 1, + /// + /// The item has a director in common with a recently played item. + /// HasDirectorFromRecentlyPlayed = 2, + /// + /// The item has an actor in common with a recently played item. + /// HasActorFromRecentlyPlayed = 3, + /// + /// The item has a director that the user liked. + /// HasLikedDirector = 4, + /// + /// The item has an actor that the user liked. + /// 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 { + /// + /// The type of extra media associated with an item. + /// public enum ExtraType { + /// + /// An unknown extra type. + /// Unknown = 0, + + /// + /// A short clip. + /// Clip = 1, + + /// + /// A trailer. + /// Trailer = 2, + + /// + /// A behind-the-scenes video. + /// BehindTheScenes = 3, + + /// + /// A deleted scene. + /// DeletedScene = 4, + + /// + /// An interview. + /// Interview = 5, + + /// + /// A scene. + /// Scene = 6, + + /// + /// A sample video. + /// Sample = 7, + + /// + /// A theme song. + /// ThemeSong = 8, + + /// + /// A theme video. + /// ThemeVideo = 9, + + /// + /// A featurette. + /// Featurette = 10, + + /// + /// A short film. + /// 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 { + /// + /// The type of a trailer. + /// public enum TrailerType { + /// + /// A trailer for media coming soon to theaters. + /// ComingSoonToTheaters = 1, + + /// + /// A trailer for media coming soon to DVD. + /// ComingSoonToDvd = 2, + + /// + /// A trailer for media coming soon to streaming services. + /// ComingSoonToStreaming = 3, + + /// + /// An archived trailer. + /// Archive = 4, + + /// + /// A local trailer stored alongside the media. + /// 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 { + /// + /// The 3D video layout format. + /// public enum Video3DFormat { + /// + /// Half side-by-side format. + /// HalfSideBySide, + + /// + /// Full side-by-side format. + /// FullSideBySide, + + /// + /// Full top-and-bottom format. + /// FullTopAndBottom, + + /// + /// Half top-and-bottom format. + /// HalfTopAndBottom, + + /// + /// Multiview Video Coding format. + /// 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 { + /// + /// The protocol used to access a media source. + /// public enum MediaProtocol { + /// + /// Local filesystem protocol. + /// File = 0, + + /// + /// Hypertext Transfer Protocol. + /// Http = 1, + + /// + /// Real-Time Messaging Protocol. + /// Rtmp = 2, + + /// + /// Real-Time Streaming Protocol. + /// Rtsp = 3, + + /// + /// User Datagram Protocol. + /// Udp = 4, + + /// + /// Real-time Transport Protocol. + /// Rtp = 5, + + /// + /// File Transfer Protocol. + /// Ftp = 6 } } -- cgit v1.2.3