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/Entities/ExtraType.cs | 52 ++++++++++++++++++++++++++-- MediaBrowser.Model/Entities/TrailerType.cs | 24 +++++++++++-- MediaBrowser.Model/Entities/Video3DFormat.cs | 24 +++++++++++-- 3 files changed, 94 insertions(+), 6 deletions(-) (limited to 'MediaBrowser.Model/Entities') 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 } } -- cgit v1.2.3