Add XML docs to small model enums and remove CS1591 suppressions
This commit is contained in:
@@ -1,10 +1,18 @@
|
||||
#pragma warning disable CS1591
|
||||
|
||||
namespace MediaBrowser.Model.Configuration
|
||||
{
|
||||
/// <summary>
|
||||
/// The convention used for naming saved images.
|
||||
/// </summary>
|
||||
public enum ImageSavingConvention
|
||||
{
|
||||
/// <summary>
|
||||
/// The legacy naming convention.
|
||||
/// </summary>
|
||||
Legacy,
|
||||
|
||||
/// <summary>
|
||||
/// The naming convention compatible with other media servers and metadata managers.
|
||||
/// </summary>
|
||||
Compatible
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,10 +1,15 @@
|
||||
#nullable disable
|
||||
#pragma warning disable CS1591
|
||||
|
||||
namespace MediaBrowser.Model.Dto
|
||||
{
|
||||
/// <summary>
|
||||
/// Interface for DTOs that reference the id of the server they originate from.
|
||||
/// </summary>
|
||||
public interface IHasServerId
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets the server id.
|
||||
/// </summary>
|
||||
string ServerId { get; }
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,11 +1,23 @@
|
||||
#pragma warning disable CS1591
|
||||
|
||||
namespace MediaBrowser.Model.Dto
|
||||
{
|
||||
/// <summary>
|
||||
/// The type of a media source.
|
||||
/// </summary>
|
||||
public enum MediaSourceType
|
||||
{
|
||||
/// <summary>
|
||||
/// A default media source.
|
||||
/// </summary>
|
||||
Default = 0,
|
||||
|
||||
/// <summary>
|
||||
/// A grouping of media sources.
|
||||
/// </summary>
|
||||
Grouping = 1,
|
||||
|
||||
/// <summary>
|
||||
/// A placeholder media source, for example a disc that has to be inserted.
|
||||
/// </summary>
|
||||
Placeholder = 2
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,10 +1,18 @@
|
||||
#pragma warning disable CS1591
|
||||
|
||||
namespace MediaBrowser.Model.Dto
|
||||
{
|
||||
/// <summary>
|
||||
/// The type of a community rating.
|
||||
/// </summary>
|
||||
public enum RatingType
|
||||
{
|
||||
/// <summary>
|
||||
/// The rating is a numeric score.
|
||||
/// </summary>
|
||||
Score,
|
||||
|
||||
/// <summary>
|
||||
/// The rating is based on likes.
|
||||
/// </summary>
|
||||
Likes
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,10 +1,18 @@
|
||||
#pragma warning disable CS1591
|
||||
|
||||
namespace MediaBrowser.Model.Library
|
||||
{
|
||||
/// <summary>
|
||||
/// The play access of an item.
|
||||
/// </summary>
|
||||
public enum PlayAccess
|
||||
{
|
||||
/// <summary>
|
||||
/// The item can be played.
|
||||
/// </summary>
|
||||
Full = 0,
|
||||
|
||||
/// <summary>
|
||||
/// The item cannot be played.
|
||||
/// </summary>
|
||||
None = 1
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,11 +1,23 @@
|
||||
#pragma warning disable CS1591
|
||||
|
||||
namespace MediaBrowser.Model.LiveTv
|
||||
{
|
||||
/// <summary>
|
||||
/// The day pattern of a recurring timer.
|
||||
/// </summary>
|
||||
public enum DayPattern
|
||||
{
|
||||
/// <summary>
|
||||
/// Every day.
|
||||
/// </summary>
|
||||
Daily,
|
||||
|
||||
/// <summary>
|
||||
/// Monday through Friday.
|
||||
/// </summary>
|
||||
Weekdays,
|
||||
|
||||
/// <summary>
|
||||
/// Saturday and Sunday.
|
||||
/// </summary>
|
||||
Weekends
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,10 +1,18 @@
|
||||
#pragma warning disable CS1591
|
||||
|
||||
namespace MediaBrowser.Model.LiveTv
|
||||
{
|
||||
/// <summary>
|
||||
/// The status of a live TV service.
|
||||
/// </summary>
|
||||
public enum LiveTvServiceStatus
|
||||
{
|
||||
/// <summary>
|
||||
/// The service is available.
|
||||
/// </summary>
|
||||
Ok = 0,
|
||||
|
||||
/// <summary>
|
||||
/// The service is unavailable.
|
||||
/// </summary>
|
||||
Unavailable = 1
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,11 +1,23 @@
|
||||
#pragma warning disable CS1591
|
||||
|
||||
namespace MediaBrowser.Model.MediaInfo
|
||||
{
|
||||
/// <summary>
|
||||
/// The type of timestamps used in a transport stream.
|
||||
/// </summary>
|
||||
public enum TransportStreamTimestamp
|
||||
{
|
||||
/// <summary>
|
||||
/// The stream contains no timestamps.
|
||||
/// </summary>
|
||||
None,
|
||||
|
||||
/// <summary>
|
||||
/// The stream contains zero-value timestamps.
|
||||
/// </summary>
|
||||
Zero,
|
||||
|
||||
/// <summary>
|
||||
/// The stream contains valid timestamps.
|
||||
/// </summary>
|
||||
Valid
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user