Fix warnings MediaBrowser.Model

This commit is contained in:
Bond_009
2020-02-04 01:49:27 +01:00
parent 176e850973
commit f47ad85011
290 changed files with 1132 additions and 290 deletions

View File

@@ -1,9 +1,12 @@
#pragma warning disable CS1591
#pragma warning disable SA1600
using System;
namespace MediaBrowser.Model.Entities
{
/// <summary>
/// Class ChapterInfo
/// Class ChapterInfo.
/// </summary>
public class ChapterInfo
{

View File

@@ -1,3 +1,6 @@
#pragma warning disable CS1591
#pragma warning disable SA1600
namespace MediaBrowser.Model.Entities
{
public static class CollectionType

View File

@@ -3,12 +3,12 @@ using System.Collections.Generic;
namespace MediaBrowser.Model.Entities
{
/// <summary>
/// Defines the display preferences for any item that supports them (usually Folders)
/// Defines the display preferences for any item that supports them (usually Folders).
/// </summary>
public class DisplayPreferences
{
/// <summary>
/// The image scale
/// The image scale.
/// </summary>
private const double ImageScale = .9;
@@ -29,66 +29,79 @@ namespace MediaBrowser.Model.Entities
/// </summary>
/// <value>The user id.</value>
public string Id { get; set; }
/// <summary>
/// Gets or sets the type of the view.
/// </summary>
/// <value>The type of the view.</value>
public string ViewType { get; set; }
/// <summary>
/// Gets or sets the sort by.
/// </summary>
/// <value>The sort by.</value>
public string SortBy { get; set; }
/// <summary>
/// Gets or sets the index by.
/// </summary>
/// <value>The index by.</value>
public string IndexBy { get; set; }
/// <summary>
/// Gets or sets a value indicating whether [remember indexing].
/// </summary>
/// <value><c>true</c> if [remember indexing]; otherwise, <c>false</c>.</value>
public bool RememberIndexing { get; set; }
/// <summary>
/// Gets or sets the height of the primary image.
/// </summary>
/// <value>The height of the primary image.</value>
public int PrimaryImageHeight { get; set; }
/// <summary>
/// Gets or sets the width of the primary image.
/// </summary>
/// <value>The width of the primary image.</value>
public int PrimaryImageWidth { get; set; }
/// <summary>
/// Gets or sets the custom prefs.
/// </summary>
/// <value>The custom prefs.</value>
public Dictionary<string, string> CustomPrefs { get; set; }
/// <summary>
/// Gets or sets the scroll direction.
/// </summary>
/// <value>The scroll direction.</value>
public ScrollDirection ScrollDirection { get; set; }
/// <summary>
/// Gets or sets a value indicating whether to show backdrops on this item.
/// </summary>
/// <value><c>true</c> if showing backdrops; otherwise, <c>false</c>.</value>
public bool ShowBackdrop { get; set; }
/// <summary>
/// Gets or sets a value indicating whether [remember sorting].
/// </summary>
/// <value><c>true</c> if [remember sorting]; otherwise, <c>false</c>.</value>
public bool RememberSorting { get; set; }
/// <summary>
/// Gets or sets the sort order.
/// </summary>
/// <value>The sort order.</value>
public SortOrder SortOrder { get; set; }
/// <summary>
/// Gets or sets a value indicating whether [show sidebar].
/// </summary>
/// <value><c>true</c> if [show sidebar]; otherwise, <c>false</c>.</value>
public bool ShowSidebar { get; set; }
/// <summary>
/// Gets or sets the client
/// </summary>

View File

@@ -1,6 +0,0 @@
namespace MediaBrowser.Model.Entities
{
public class EmptyRequestResult
{
}
}

View File

@@ -1,3 +1,6 @@
#pragma warning disable CS1591
#pragma warning disable SA1600
namespace MediaBrowser.Model.Entities
{
public enum ExtraType

View File

@@ -3,7 +3,7 @@ using System.Collections.Generic;
namespace MediaBrowser.Model.Entities
{
/// <summary>
/// Since BaseItem and DTOBaseItem both have ProviderIds, this interface helps avoid code repition by using extension methods
/// Since BaseItem and DTOBaseItem both have ProviderIds, this interface helps avoid code repition by using extension methods.
/// </summary>
public interface IHasProviderIds
{

View File

@@ -1,56 +1,66 @@
namespace MediaBrowser.Model.Entities
{
/// <summary>
/// Enum ImageType
/// Enum ImageType.
/// </summary>
public enum ImageType
{
/// <summary>
/// The primary
/// The primary.
/// </summary>
Primary = 0,
/// <summary>
/// The art
/// The art.
/// </summary>
Art = 1,
/// <summary>
/// The backdrop
/// The backdrop.
/// </summary>
Backdrop = 2,
/// <summary>
/// The banner
/// The banner.
/// </summary>
Banner = 3,
/// <summary>
/// The logo
/// The logo.
/// </summary>
Logo = 4,
/// <summary>
/// The thumb
/// The thumb.
/// </summary>
Thumb = 5,
/// <summary>
/// The disc
/// The disc.
/// </summary>
Disc = 6,
/// <summary>
/// The box
/// The box.
/// </summary>
Box = 7,
/// <summary>
/// The screenshot
/// The screenshot.
/// </summary>
Screenshot = 8,
/// <summary>
/// The menu
/// The menu.
/// </summary>
Menu = 9,
/// <summary>
/// The chapter image
/// The chapter image.
/// </summary>
Chapter = 10,
/// <summary>
/// The box rear
/// The box rear.
/// </summary>
BoxRear = 11
}

View File

@@ -1,16 +1,17 @@
namespace MediaBrowser.Model.Entities
{
/// <summary>
/// Enum IsoType
/// Enum IsoType.
/// </summary>
public enum IsoType
{
/// <summary>
/// The DVD
/// The DVD.
/// </summary>
Dvd,
/// <summary>
/// The blu ray
/// The blu ray.
/// </summary>
BluRay
}

View File

@@ -1,3 +1,6 @@
#pragma warning disable CS1591
#pragma warning disable SA1600
using System;
namespace MediaBrowser.Model.Entities

View File

@@ -1,24 +1,27 @@
namespace MediaBrowser.Model.Entities
{
/// <summary>
/// Enum LocationType
/// Enum LocationType.
/// </summary>
public enum LocationType
{
/// <summary>
/// The file system
/// The file system.
/// </summary>
FileSystem = 0,
/// <summary>
/// The remote
/// The remote.
/// </summary>
Remote = 1,
/// <summary>
/// The virtual
/// The virtual.
/// </summary>
Virtual = 2,
/// <summary>
/// The offline
/// The offline.
/// </summary>
Offline = 3
}

View File

@@ -1,7 +1,7 @@
namespace MediaBrowser.Model.Entities
{
/// <summary>
/// Class MediaAttachment
/// Class MediaAttachment.
/// </summary>
public class MediaAttachment
{

View File

@@ -1,3 +1,6 @@
#pragma warning disable CS1591
#pragma warning disable SA1600
using System;
using System.Collections.Generic;
using System.Globalization;

View File

@@ -1,24 +1,27 @@
namespace MediaBrowser.Model.Entities
{
/// <summary>
/// Enum MediaStreamType
/// Enum MediaStreamType.
/// </summary>
public enum MediaStreamType
{
/// <summary>
/// The audio
/// The audio.
/// </summary>
Audio,
/// <summary>
/// The video
/// The video.
/// </summary>
Video,
/// <summary>
/// The subtitle
/// The subtitle.
/// </summary>
Subtitle,
/// <summary>
/// The embedded image
/// The embedded image.
/// </summary>
EmbeddedImage
}

View File

@@ -1,27 +1,27 @@
namespace MediaBrowser.Model.Entities
{
/// <summary>
/// Class MediaType
/// Class MediaType.
/// </summary>
public static class MediaType
{
/// <summary>
/// The video
/// The video.
/// </summary>
public const string Video = "Video";
/// <summary>
/// The audio
/// The audio.
/// </summary>
public const string Audio = "Audio";
/// <summary>
/// The photo
/// The photo.
/// </summary>
public const string Photo = "Photo";
/// <summary>
/// The book
/// The book.
/// </summary>
public const string Book = "Book";
}

View File

@@ -1,3 +1,6 @@
#pragma warning disable CS1591
#pragma warning disable SA1600
namespace MediaBrowser.Model.Entities
{
public class MediaUrl

View File

@@ -1,44 +1,52 @@
namespace MediaBrowser.Model.Entities
{
/// <summary>
/// Enum MetadataFields
/// Enum MetadataFields.
/// </summary>
public enum MetadataFields
{
/// <summary>
/// The cast
/// The cast.
/// </summary>
Cast,
/// <summary>
/// The genres
/// The genres.
/// </summary>
Genres,
/// <summary>
/// The production locations
/// The production locations.
/// </summary>
ProductionLocations,
/// <summary>
/// The studios
/// The studios.
/// </summary>
Studios,
/// <summary>
/// The tags
/// The tags.
/// </summary>
Tags,
/// <summary>
/// The name
/// The name.
/// </summary>
Name,
/// <summary>
/// The overview
/// The overview.
/// </summary>
Overview,
/// <summary>
/// The runtime
/// The runtime.
/// </summary>
Runtime,
/// <summary>
/// The official rating
/// The official rating.
/// </summary>
OfficialRating
}

View File

@@ -1,3 +1,6 @@
#pragma warning disable CS1591
#pragma warning disable SA1600
namespace MediaBrowser.Model.Entities
{
/// <summary>

View File

@@ -1,3 +1,6 @@
#pragma warning disable CS1591
#pragma warning disable SA1600
using System;
namespace MediaBrowser.Model.Entities

View File

@@ -1,3 +1,6 @@
#pragma warning disable CS1591
#pragma warning disable SA1600
namespace MediaBrowser.Model.Entities
{
/// <summary>

View File

@@ -1,40 +1,47 @@
namespace MediaBrowser.Model.Entities
{
/// <summary>
/// Struct PersonType
/// Struct PersonType.
/// </summary>
public class PersonType
{
/// <summary>
/// The actor
/// The actor.
/// </summary>
public const string Actor = "Actor";
/// <summary>
/// The director
/// The director.
/// </summary>
public const string Director = "Director";
/// <summary>
/// The composer
/// The composer.
/// </summary>
public const string Composer = "Composer";
/// <summary>
/// The writer
/// The writer.
/// </summary>
public const string Writer = "Writer";
/// <summary>
/// The guest star
/// The guest star.
/// </summary>
public const string GuestStar = "GuestStar";
/// <summary>
/// The producer
/// The producer.
/// </summary>
public const string Producer = "Producer";
/// <summary>
/// The conductor
/// The conductor.
/// </summary>
public const string Conductor = "Conductor";
/// <summary>
/// The lyricist
/// The lyricist.
/// </summary>
public const string Lyricist = "Lyricist";
}

View File

@@ -4,7 +4,7 @@ using System.Collections.Generic;
namespace MediaBrowser.Model.Entities
{
/// <summary>
/// Class ProviderIdsExtensions
/// Class ProviderIdsExtensions.
/// </summary>
public static class ProviderIdsExtensions
{

View File

@@ -1,16 +1,17 @@
namespace MediaBrowser.Model.Entities
{
/// <summary>
/// Enum ScrollDirection
/// Enum ScrollDirection.
/// </summary>
public enum ScrollDirection
{
/// <summary>
/// The horizontal
/// The horizontal.
/// </summary>
Horizontal,
/// <summary>
/// The vertical
/// The vertical.
/// </summary>
Vertical
}

View File

@@ -1,16 +1,17 @@
namespace MediaBrowser.Model.Entities
{
/// <summary>
/// Enum SeriesStatus
/// Enum SeriesStatus.
/// </summary>
public enum SeriesStatus
{
/// <summary>
/// The continuing
/// The continuing.
/// </summary>
Continuing,
/// <summary>
/// The ended
/// The ended.
/// </summary>
Ended
}

View File

@@ -1,16 +1,17 @@
namespace MediaBrowser.Model.Entities
{
/// <summary>
/// Enum SortOrder
/// Enum SortOrder.
/// </summary>
public enum SortOrder
{
/// <summary>
/// The ascending
/// The ascending.
/// </summary>
Ascending,
/// <summary>
/// The descending
/// The descending.
/// </summary>
Descending
}

View File

@@ -1,3 +1,6 @@
#pragma warning disable CS1591
#pragma warning disable SA1600
namespace MediaBrowser.Model.Entities
{
public enum TrailerType

View File

@@ -1,32 +1,37 @@
namespace MediaBrowser.Model.Entities
{
/// <summary>
/// Enum UserDataSaveReason
/// Enum UserDataSaveReason.
/// </summary>
public enum UserDataSaveReason
{
/// <summary>
/// The playback start
/// The playback start.
/// </summary>
PlaybackStart = 1,
/// <summary>
/// The playback progress
/// The playback progress.
/// </summary>
PlaybackProgress = 2,
/// <summary>
/// The playback finished
/// The playback finished.
/// </summary>
PlaybackFinished = 3,
/// <summary>
/// The toggle played
/// The toggle played.
/// </summary>
TogglePlayed = 4,
/// <summary>
/// The update user rating
/// The update user rating.
/// </summary>
UpdateUserRating = 5,
/// <summary>
/// The import
/// The import.
/// </summary>
Import = 6
}

View File

@@ -1,3 +1,6 @@
#pragma warning disable CS1591
#pragma warning disable SA1600
namespace MediaBrowser.Model.Entities
{
public enum Video3DFormat

View File

@@ -1,24 +1,27 @@
namespace MediaBrowser.Model.Entities
{
/// <summary>
/// Enum VideoType
/// Enum VideoType.
/// </summary>
public enum VideoType
{
/// <summary>
/// The video file
/// The video file.
/// </summary>
VideoFile,
/// <summary>
/// The iso
/// The iso.
/// </summary>
Iso,
/// <summary>
/// The DVD
/// The DVD.
/// </summary>
Dvd,
/// <summary>
/// The blu ray
/// The blu ray.
/// </summary>
BluRay
}

View File

@@ -1,3 +1,6 @@
#pragma warning disable CS1591
#pragma warning disable SA1600
using System;
using MediaBrowser.Model.Configuration;