Add XML docs to small entity interfaces and remove CS1591 suppressions

This commit is contained in:
mbastian77
2026-07-15 16:07:56 +02:00
parent b6882c86dc
commit 997093ae3a
5 changed files with 38 additions and 11 deletions
@@ -1,12 +1,13 @@
#nullable disable
#pragma warning disable CS1591
using System;
using System.Collections.Generic;
namespace MediaBrowser.Controller.Entities
{
/// <summary>
/// Interface for items that have special features.
/// </summary>
public interface IHasSpecialFeatures
{
/// <summary>
@@ -1,11 +1,15 @@
#pragma warning disable CS1591
using System;
namespace MediaBrowser.Controller.Entities
{
/// <summary>
/// Interface for items that have a start date.
/// </summary>
public interface IHasStartDate
{
/// <summary>
/// Gets or sets the start date.
/// </summary>
DateTime StartDate { get; set; }
}
}
@@ -1,19 +1,28 @@
#pragma warning disable CS1591
using System.Collections.Generic;
namespace MediaBrowser.Controller.Entities
{
/// <summary>
/// Marker interface.
/// Marker interface for items that represent a name, like a genre or a studio.
/// </summary>
public interface IItemByName
{
/// <summary>
/// Gets the items tagged with this name.
/// </summary>
/// <param name="query">The query.</param>
/// <returns>The tagged items.</returns>
IReadOnlyList<BaseItem> GetTaggedItems(InternalItemsQuery query);
}
/// <summary>
/// Interface for by-name items that can also be accessed as a regular library item.
/// </summary>
public interface IHasDualAccess : IItemByName
{
/// <summary>
/// Gets a value indicating whether the item is accessed by name.
/// </summary>
bool IsAccessedByName { get; }
}
}
@@ -1,7 +1,8 @@
#pragma warning disable CS1591
namespace MediaBrowser.Controller.Entities
{
/// <summary>
/// Interface for items that can be placeholders.
/// </summary>
public interface ISupportsPlaceHolders
{
/// <summary>
+14 -2
View File
@@ -1,11 +1,23 @@
#pragma warning disable CS1591
namespace MediaBrowser.Controller.Entities
{
/// <summary>
/// The source of an item.
/// </summary>
public enum SourceType
{
/// <summary>
/// The item comes from a library.
/// </summary>
Library = 0,
/// <summary>
/// The item comes from a channel.
/// </summary>
Channel = 1,
/// <summary>
/// The item comes from live TV.
/// </summary>
LiveTV = 2
}
}