From 997093ae3a800ea06e41523d0407de570eaaa4e6 Mon Sep 17 00:00:00 2001 From: mbastian77 Date: Wed, 15 Jul 2026 16:07:56 +0200 Subject: Add XML docs to small entity interfaces and remove CS1591 suppressions --- MediaBrowser.Controller/Entities/IHasSpecialFeatures.cs | 5 +++-- MediaBrowser.Controller/Entities/IHasStartDate.cs | 8 ++++++-- MediaBrowser.Controller/Entities/IItemByName.cs | 15 ++++++++++++--- .../Entities/ISupportsPlaceHolders.cs | 5 +++-- MediaBrowser.Controller/Entities/SourceType.cs | 16 ++++++++++++++-- 5 files changed, 38 insertions(+), 11 deletions(-) (limited to 'MediaBrowser.Controller/Entities') diff --git a/MediaBrowser.Controller/Entities/IHasSpecialFeatures.cs b/MediaBrowser.Controller/Entities/IHasSpecialFeatures.cs index f47d2162f7..0cdc8bce03 100644 --- a/MediaBrowser.Controller/Entities/IHasSpecialFeatures.cs +++ b/MediaBrowser.Controller/Entities/IHasSpecialFeatures.cs @@ -1,12 +1,13 @@ #nullable disable -#pragma warning disable CS1591 - using System; using System.Collections.Generic; namespace MediaBrowser.Controller.Entities { + /// + /// Interface for items that have special features. + /// public interface IHasSpecialFeatures { /// diff --git a/MediaBrowser.Controller/Entities/IHasStartDate.cs b/MediaBrowser.Controller/Entities/IHasStartDate.cs index dab15eb018..47df09d1ce 100644 --- a/MediaBrowser.Controller/Entities/IHasStartDate.cs +++ b/MediaBrowser.Controller/Entities/IHasStartDate.cs @@ -1,11 +1,15 @@ -#pragma warning disable CS1591 - using System; namespace MediaBrowser.Controller.Entities { + /// + /// Interface for items that have a start date. + /// public interface IHasStartDate { + /// + /// Gets or sets the start date. + /// DateTime StartDate { get; set; } } } diff --git a/MediaBrowser.Controller/Entities/IItemByName.cs b/MediaBrowser.Controller/Entities/IItemByName.cs index 4928bda7a2..756dbecb98 100644 --- a/MediaBrowser.Controller/Entities/IItemByName.cs +++ b/MediaBrowser.Controller/Entities/IItemByName.cs @@ -1,19 +1,28 @@ -#pragma warning disable CS1591 - using System.Collections.Generic; namespace MediaBrowser.Controller.Entities { /// - /// Marker interface. + /// Marker interface for items that represent a name, like a genre or a studio. /// public interface IItemByName { + /// + /// Gets the items tagged with this name. + /// + /// The query. + /// The tagged items. IReadOnlyList GetTaggedItems(InternalItemsQuery query); } + /// + /// Interface for by-name items that can also be accessed as a regular library item. + /// public interface IHasDualAccess : IItemByName { + /// + /// Gets a value indicating whether the item is accessed by name. + /// bool IsAccessedByName { get; } } } diff --git a/MediaBrowser.Controller/Entities/ISupportsPlaceHolders.cs b/MediaBrowser.Controller/Entities/ISupportsPlaceHolders.cs index cdda8ea399..0f8904df5c 100644 --- a/MediaBrowser.Controller/Entities/ISupportsPlaceHolders.cs +++ b/MediaBrowser.Controller/Entities/ISupportsPlaceHolders.cs @@ -1,7 +1,8 @@ -#pragma warning disable CS1591 - namespace MediaBrowser.Controller.Entities { + /// + /// Interface for items that can be placeholders. + /// public interface ISupportsPlaceHolders { /// diff --git a/MediaBrowser.Controller/Entities/SourceType.cs b/MediaBrowser.Controller/Entities/SourceType.cs index be19e1bdae..97aa22dc04 100644 --- a/MediaBrowser.Controller/Entities/SourceType.cs +++ b/MediaBrowser.Controller/Entities/SourceType.cs @@ -1,11 +1,23 @@ -#pragma warning disable CS1591 - namespace MediaBrowser.Controller.Entities { + /// + /// The source of an item. + /// public enum SourceType { + /// + /// The item comes from a library. + /// Library = 0, + + /// + /// The item comes from a channel. + /// Channel = 1, + + /// + /// The item comes from live TV. + /// LiveTV = 2 } } -- cgit v1.2.3