Add XML docs to lookup info types and remove CS1591 suppressions

This commit is contained in:
mbastian77
2026-07-15 12:08:08 +02:00
parent b6882c86dc
commit 30f28456de
8 changed files with 32 additions and 16 deletions

View File

@@ -1,11 +1,15 @@
#nullable disable
#pragma warning disable CS1591
namespace MediaBrowser.Controller.Providers
{
/// <summary>
/// The lookup info for books.
/// </summary>
public class BookInfo : ItemLookupInfo
{
/// <summary>
/// Gets or sets the name of the series the book belongs to.
/// </summary>
public string SeriesName { get; set; }
}
}

View File

@@ -1,7 +1,8 @@
#pragma warning disable CS1591
namespace MediaBrowser.Controller.Providers
{
/// <summary>
/// The lookup info for box sets.
/// </summary>
public class BoxSetInfo : ItemLookupInfo
{
}

View File

@@ -1,10 +1,16 @@
#pragma warning disable CS1591
namespace MediaBrowser.Controller.Providers
{
/// <summary>
/// Interface for items that provide lookup info for metadata providers.
/// </summary>
/// <typeparam name="TLookupInfoType">The type of the lookup info.</typeparam>
public interface IHasLookupInfo<out TLookupInfoType>
where TLookupInfoType : ItemLookupInfo, new()
{
/// <summary>
/// Gets the lookup info.
/// </summary>
/// <returns>The lookup info.</returns>
TLookupInfoType GetLookupInfo();
}
}

View File

@@ -1,7 +1,8 @@
#pragma warning disable CS1591
namespace MediaBrowser.Controller.Providers
{
/// <summary>
/// Marker interface for custom metadata providers that run before the regular metadata refresh.
/// </summary>
public interface IPreRefreshProvider : ICustomMetadataProvider
{
}

View File

@@ -1,7 +1,8 @@
#pragma warning disable CS1591
namespace MediaBrowser.Controller.Providers
{
/// <summary>
/// The lookup info for movies.
/// </summary>
public class MovieInfo : ItemLookupInfo
{
}

View File

@@ -1,7 +1,8 @@
#pragma warning disable CS1591
namespace MediaBrowser.Controller.Providers
{
/// <summary>
/// The lookup info for persons.
/// </summary>
public class PersonLookupInfo : ItemLookupInfo
{
}

View File

@@ -1,7 +1,8 @@
#pragma warning disable CS1591
namespace MediaBrowser.Controller.Providers
{
/// <summary>
/// The lookup info for series.
/// </summary>
public class SeriesInfo : ItemLookupInfo
{
}

View File

@@ -1,7 +1,8 @@
#pragma warning disable CS1591
namespace MediaBrowser.Controller.Providers
{
/// <summary>
/// The lookup info for trailers.
/// </summary>
public class TrailerInfo : ItemLookupInfo
{
}