Add full stop at end of comments (SA1629)

2026-06-03 14:28:46 +01:00 · 2020-06-16 10:37:52 +12:00
parent 100e9d586d
commit 9018f8d8be
269 changed files with 816 additions and 816 deletions
--- a/MediaBrowser.Controller/Entities/AggregateFolder.cs
+++ b/MediaBrowser.Controller/Entities/AggregateFolder.cs
@@ -35,7 +35,7 @@ namespace MediaBrowser.Controller.Entities
        public override bool SupportsPlayedStatus => false;

        /// <summary>
-        /// The _virtual children
+        /// The _virtual children.
        /// </summary>
        private readonly ConcurrentBag<BaseItem> _virtualChildren = new ConcurrentBag<BaseItem>();

--- a/MediaBrowser.Controller/Entities/Audio/Audio.cs
+++ b/MediaBrowser.Controller/Entities/Audio/Audio.cs
@@ -11,7 +11,7 @@ using MediaBrowser.Model.Entities;
 namespace MediaBrowser.Controller.Entities.Audio
 {
    /// <summary>
-    /// Class Audio
+    /// Class Audio.
    /// </summary>
    public class Audio : BaseItem,
        IHasAlbumArtist,
--- a/MediaBrowser.Controller/Entities/Audio/MusicAlbum.cs
+++ b/MediaBrowser.Controller/Entities/Audio/MusicAlbum.cs
@@ -15,7 +15,7 @@ using MetadataProvider = MediaBrowser.Model.Entities.MetadataProvider;
 namespace MediaBrowser.Controller.Entities.Audio
 {
    /// <summary>
-    /// Class MusicAlbum
+    /// Class MusicAlbum.
    /// </summary>
    public class MusicAlbum : Folder, IHasAlbumArtist, IHasArtist, IHasMusicGenres, IHasLookupInfo<AlbumInfo>, IMetadataContainer
    {
--- a/MediaBrowser.Controller/Entities/Audio/MusicArtist.cs
+++ b/MediaBrowser.Controller/Entities/Audio/MusicArtist.cs
@@ -15,7 +15,7 @@ using MetadataProvider = MediaBrowser.Model.Entities.MetadataProvider;
 namespace MediaBrowser.Controller.Entities.Audio
 {
    /// <summary>
-    /// Class MusicArtist
+    /// Class MusicArtist.
    /// </summary>
    public class MusicArtist : Folder, IItemByName, IHasMusicGenres, IHasDualAccess, IHasLookupInfo<ArtistInfo>
    {
@@ -111,7 +111,7 @@ namespace MediaBrowser.Controller.Entities.Audio

        /// <summary>
        /// Returns the folder containing the item.
-        /// If the item is a folder, it returns the folder itself
+        /// If the item is a folder, it returns the folder itself.
        /// </summary>
        /// <value>The containing folder path.</value>
        [JsonIgnore]
@@ -201,7 +201,7 @@ namespace MediaBrowser.Controller.Entities.Audio
        }

        /// <summary>
-        /// This is called before any metadata refresh and returns true or false indicating if changes were made
+        /// This is called before any metadata refresh and returns true or false indicating if changes were made.
        /// </summary>
        public override bool BeforeMetadataRefresh(bool replaceAllMetdata)
        {
--- a/MediaBrowser.Controller/Entities/Audio/MusicGenre.cs
+++ b/MediaBrowser.Controller/Entities/Audio/MusicGenre.cs
@@ -7,7 +7,7 @@ using Microsoft.Extensions.Logging;
 namespace MediaBrowser.Controller.Entities.Audio
 {
    /// <summary>
-    /// Class MusicGenre
+    /// Class MusicGenre.
    /// </summary>
    public class MusicGenre : BaseItem, IItemByName
    {
@@ -34,7 +34,7 @@ namespace MediaBrowser.Controller.Entities.Audio

        /// <summary>
        /// Returns the folder containing the item.
-        /// If the item is a folder, it returns the folder itself
+        /// If the item is a folder, it returns the folder itself.
        /// </summary>
        /// <value>The containing folder path.</value>
        [JsonIgnore]
@@ -98,7 +98,7 @@ namespace MediaBrowser.Controller.Entities.Audio
        }

        /// <summary>
-        /// This is called before any metadata refresh and returns true or false indicating if changes were made
+        /// This is called before any metadata refresh and returns true or false indicating if changes were made.
        /// </summary>
        public override bool BeforeMetadataRefresh(bool replaceAllMetdata)
        {
--- a/MediaBrowser.Controller/Entities/BaseItem.cs
+++ b/MediaBrowser.Controller/Entities/BaseItem.cs
@@ -31,12 +31,12 @@ using Microsoft.Extensions.Logging;
 namespace MediaBrowser.Controller.Entities
 {
    /// <summary>
-    /// Class BaseItem
+    /// Class BaseItem.
    /// </summary>
    public abstract class BaseItem : IHasProviderIds, IHasLookupInfo<ItemLookupInfo>, IEquatable<BaseItem>
    {
        /// <summary>
-        /// The supported image extensions
+        /// The supported image extensions.
        /// </summary>
        public static readonly string[] SupportedImageExtensions
            = new[] { ".png", ".jpg", ".jpeg", ".tbn", ".gif" };
@@ -75,7 +75,7 @@ namespace MediaBrowser.Controller.Entities
        public static char SlugChar = '-';

        /// <summary>
-        /// The trailer folder name
+        /// The trailer folder name.
        /// </summary>
        public const string TrailerFolderName = "trailers";
        public const string ThemeSongsFolderName = "theme-music";
@@ -243,7 +243,7 @@ namespace MediaBrowser.Controller.Entities

        /// <summary>
        /// Returns the folder containing the item.
-        /// If the item is a folder, it returns the folder itself
+        /// If the item is a folder, it returns the folder itself.
        /// </summary>
        [JsonIgnore]
        public virtual string ContainingFolderPath
@@ -267,7 +267,7 @@ namespace MediaBrowser.Controller.Entities
        public string ServiceName { get; set; }

        /// <summary>
-        /// If this content came from an external service, the id of the content on that service
+        /// If this content came from an external service, the id of the content on that service.
        /// </summary>
        [JsonIgnore]
        public string ExternalId { get; set; }
@@ -411,7 +411,7 @@ namespace MediaBrowser.Controller.Entities
        }

        /// <summary>
-        /// This is just a helper for convenience
+        /// This is just a helper for convenience.
        /// </summary>
        /// <value>The primary image path.</value>
        [JsonIgnore]
@@ -556,7 +556,7 @@ namespace MediaBrowser.Controller.Entities
        public DateTime DateLastRefreshed { get; set; }

        /// <summary>
-        /// The logger
+        /// The logger.
        /// </summary>
        public static ILoggerFactory LoggerFactory { get; set; }
        public static ILogger<BaseItem> Logger { get; set; }
@@ -799,7 +799,7 @@ namespace MediaBrowser.Controller.Entities
        }

        /// <summary>
-        /// Finds a parent of a given type
+        /// Finds a parent of a given type.
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <returns>``0.</returns>
@@ -1351,7 +1351,7 @@ namespace MediaBrowser.Controller.Entities
        }

        /// <summary>
-        /// Overrides the base implementation to refresh metadata for local trailers
+        /// Overrides the base implementation to refresh metadata for local trailers.
        /// </summary>
        /// <param name="options">The options.</param>
        /// <param name="cancellationToken">The cancellation token.</param>
@@ -1753,7 +1753,7 @@ namespace MediaBrowser.Controller.Entities
        }

        /// <summary>
-        /// Determines if a given user has access to this item
+        /// Determines if a given user has access to this item.
        /// </summary>
        /// <param name="user">The user.</param>
        /// <returns><c>true</c> if [is parental allowed] [the specified user]; otherwise, <c>false</c>.</returns>
@@ -2059,7 +2059,7 @@ namespace MediaBrowser.Controller.Entities
        public virtual bool EnableRememberingTrackSelections => true;

        /// <summary>
-        /// Adds a studio to the item
+        /// Adds a studio to the item.
        /// </summary>
        /// <param name="name">The name.</param>
        /// <exception cref="ArgumentNullException"></exception>
@@ -2095,7 +2095,7 @@ namespace MediaBrowser.Controller.Entities
        }

        /// <summary>
-        /// Adds a genre to the item
+        /// Adds a genre to the item.
        /// </summary>
        /// <param name="name">The name.</param>
        /// <exception cref="ArgumentNullException"></exception>
@@ -2190,7 +2190,7 @@ namespace MediaBrowser.Controller.Entities
        }

        /// <summary>
-        /// Gets an image
+        /// Gets an image.
        /// </summary>
        /// <param name="type">The type.</param>
        /// <param name="imageIndex">Index of the image.</param>
@@ -2506,7 +2506,7 @@ namespace MediaBrowser.Controller.Entities
        }

        /// <summary>
-        /// Gets the file system path to delete when the item is to be deleted
+        /// Gets the file system path to delete when the item is to be deleted.
        /// </summary>
        /// <returns></returns>
        public virtual IEnumerable<FileSystemMetadata> GetDeletePaths()
--- a/MediaBrowser.Controller/Entities/CollectionFolder.cs
+++ b/MediaBrowser.Controller/Entities/CollectionFolder.cs
@@ -18,7 +18,7 @@ namespace MediaBrowser.Controller.Entities
 {
    /// <summary>
    /// Specialized Folder class that points to a subset of the physical folders in the system.
-    /// It is created from the user-specific folders within the system root
+    /// It is created from the user-specific folders within the system root.
    /// </summary>
    public class CollectionFolder : Folder, ICollectionFolder
    {
@@ -140,7 +140,7 @@ namespace MediaBrowser.Controller.Entities
        }

        /// <summary>
-        /// Allow different display preferences for each collection folder
+        /// Allow different display preferences for each collection folder.
        /// </summary>
        /// <value>The display prefs id.</value>
        [JsonIgnore]
--- a/MediaBrowser.Controller/Entities/Extensions.cs
+++ b/MediaBrowser.Controller/Entities/Extensions.cs
@@ -6,7 +6,7 @@ using MediaBrowser.Model.Entities;
 namespace MediaBrowser.Controller.Entities
 {
    /// <summary>
-    /// Class Extensions
+    /// Class Extensions.
    /// </summary>
    public static class Extensions
    {
--- a/MediaBrowser.Controller/Entities/Folder.cs
+++ b/MediaBrowser.Controller/Entities/Folder.cs
@@ -31,7 +31,7 @@ using Series = MediaBrowser.Controller.Entities.TV.Series;
 namespace MediaBrowser.Controller.Entities
 {
    /// <summary>
-    /// Class Folder
+    /// Class Folder.
    /// </summary>
    public class Folder : BaseItem
    {
@@ -172,7 +172,7 @@ namespace MediaBrowser.Controller.Entities
        public virtual IEnumerable<BaseItem> Children => LoadChildren();

        /// <summary>
-        /// thread-safe access to all recursive children of this folder - without regard to user
+        /// thread-safe access to all recursive children of this folder - without regard to user.
        /// </summary>
        /// <value>The recursive children.</value>
        [JsonIgnore]
@@ -229,7 +229,7 @@ namespace MediaBrowser.Controller.Entities
        }

        /// <summary>
-        /// Validates that the children of the folder still exist
+        /// Validates that the children of the folder still exist.
        /// </summary>
        /// <param name="progress">The progress.</param>
        /// <param name="cancellationToken">The cancellation token.</param>
@@ -570,7 +570,7 @@ namespace MediaBrowser.Controller.Entities
        }

        /// <summary>
-        /// Get the children of this folder from the actual file system
+        /// Get the children of this folder from the actual file system.
        /// </summary>
        /// <returns>IEnumerable{BaseItem}.</returns>
        protected virtual IEnumerable<BaseItem> GetNonCachedChildren(IDirectoryService directoryService)
@@ -582,7 +582,7 @@ namespace MediaBrowser.Controller.Entities
        }

        /// <summary>
-        /// Get our children from the repo - stubbed for now
+        /// Get our children from the repo - stubbed for now.
        /// </summary>
        /// <returns>IEnumerable{BaseItem}.</returns>
        protected List<BaseItem> GetCachedChildren()
@@ -1286,7 +1286,7 @@ namespace MediaBrowser.Controller.Entities
        }

        /// <summary>
-        /// Gets allowed recursive children of an item
+        /// Gets allowed recursive children of an item.
        /// </summary>
        /// <param name="user">The user.</param>
        /// <param name="includeLinkedChildren">if set to <c>true</c> [include linked children].</param>
--- a/MediaBrowser.Controller/Entities/Genre.cs
+++ b/MediaBrowser.Controller/Entities/Genre.cs
@@ -8,7 +8,7 @@ using Microsoft.Extensions.Logging;
 namespace MediaBrowser.Controller.Entities
 {
    /// <summary>
-    /// Class Genre
+    /// Class Genre.
    /// </summary>
    public class Genre : BaseItem, IItemByName
    {
@@ -31,7 +31,7 @@ namespace MediaBrowser.Controller.Entities

        /// <summary>
        /// Returns the folder containing the item.
-        /// If the item is a folder, it returns the folder itself
+        /// If the item is a folder, it returns the folder itself.
        /// </summary>
        /// <value>The containing folder path.</value>
        [JsonIgnore]
@@ -96,7 +96,7 @@ namespace MediaBrowser.Controller.Entities
        }

        /// <summary>
-        /// This is called before any metadata refresh and returns true or false indicating if changes were made
+        /// This is called before any metadata refresh and returns true or false indicating if changes were made.
        /// </summary>
        public override bool BeforeMetadataRefresh(bool replaceAllMetdata)
        {
--- a/MediaBrowser.Controller/Entities/ICollectionFolder.cs
+++ b/MediaBrowser.Controller/Entities/ICollectionFolder.cs
@@ -3,7 +3,7 @@ using System;
 namespace MediaBrowser.Controller.Entities
 {
    /// <summary>
-    /// This is just a marker interface to denote top level folders
+    /// This is just a marker interface to denote top level folders.
    /// </summary>
    public interface ICollectionFolder : IHasCollectionType
    {
--- a/MediaBrowser.Controller/Entities/IHasAspectRatio.cs
+++ b/MediaBrowser.Controller/Entities/IHasAspectRatio.cs
@@ -1,7 +1,7 @@
 namespace MediaBrowser.Controller.Entities
 {
    /// <summary>
-    /// Interface IHasAspectRatio
+    /// Interface IHasAspectRatio.
    /// </summary>
    public interface IHasAspectRatio
    {
--- a/MediaBrowser.Controller/Entities/IHasDisplayOrder.cs
+++ b/MediaBrowser.Controller/Entities/IHasDisplayOrder.cs
@@ -1,7 +1,7 @@
 namespace MediaBrowser.Controller.Entities
 {
    /// <summary>
-    /// Interface IHasDisplayOrder
+    /// Interface IHasDisplayOrder.
    /// </summary>
    public interface IHasDisplayOrder
    {
--- a/MediaBrowser.Controller/Entities/IHasScreenshots.cs
+++ b/MediaBrowser.Controller/Entities/IHasScreenshots.cs
@@ -1,7 +1,7 @@
 namespace MediaBrowser.Controller.Entities
 {
    /// <summary>
-    /// Interface IHasScreenshots
+    /// Interface IHasScreenshots.
    /// </summary>
    public interface IHasScreenshots
    {
--- a/MediaBrowser.Controller/Entities/LinkedChild.cs
+++ b/MediaBrowser.Controller/Entities/LinkedChild.cs
@@ -16,7 +16,7 @@ namespace MediaBrowser.Controller.Entities
        public string Id { get; set; }

        /// <summary>
-        /// Serves as a cache
+        /// Serves as a cache.
        /// </summary>
        public Guid? ItemId { get; set; }

--- a/MediaBrowser.Controller/Entities/Movies/BoxSet.cs
+++ b/MediaBrowser.Controller/Entities/Movies/BoxSet.cs
@@ -11,7 +11,7 @@ using MediaBrowser.Model.Querying;
 namespace MediaBrowser.Controller.Entities.Movies
 {
    /// <summary>
-    /// Class BoxSet
+    /// Class BoxSet.
    /// </summary>
    public class BoxSet : Folder, IHasTrailers, IHasDisplayOrder, IHasLookupInfo<BoxSetInfo>
    {
--- a/MediaBrowser.Controller/Entities/Movies/Movie.cs
+++ b/MediaBrowser.Controller/Entities/Movies/Movie.cs
@@ -13,7 +13,7 @@ using MediaBrowser.Model.Providers;
 namespace MediaBrowser.Controller.Entities.Movies
 {
    /// <summary>
-    /// Class Movie
+    /// Class Movie.
    /// </summary>
    public class Movie : Video, IHasSpecialFeatures, IHasTrailers, IHasLookupInfo<MovieInfo>, ISupportsBoxSetGrouping
    {
--- a/MediaBrowser.Controller/Entities/Person.cs
+++ b/MediaBrowser.Controller/Entities/Person.cs
@@ -46,7 +46,7 @@ namespace MediaBrowser.Controller.Entities

        /// <summary>
        /// Returns the folder containing the item.
-        /// If the item is a folder, it returns the folder itself
+        /// If the item is a folder, it returns the folder itself.
        /// </summary>
        /// <value>The containing folder path.</value>
        [JsonIgnore]
@@ -118,7 +118,7 @@ namespace MediaBrowser.Controller.Entities
        }

        /// <summary>
-        /// This is called before any metadata refresh and returns true or false indicating if changes were made
+        /// This is called before any metadata refresh and returns true or false indicating if changes were made.
        /// </summary>
        public override bool BeforeMetadataRefresh(bool replaceAllMetdata)
        {
--- a/MediaBrowser.Controller/Entities/Studio.cs
+++ b/MediaBrowser.Controller/Entities/Studio.cs
@@ -7,7 +7,7 @@ using Microsoft.Extensions.Logging;
 namespace MediaBrowser.Controller.Entities
 {
    /// <summary>
-    /// Class Studio
+    /// Class Studio.
    /// </summary>
    public class Studio : BaseItem, IItemByName
    {
@@ -25,7 +25,7 @@ namespace MediaBrowser.Controller.Entities

        /// <summary>
        /// Returns the folder containing the item.
-        /// If the item is a folder, it returns the folder itself
+        /// If the item is a folder, it returns the folder itself.
        /// </summary>
        /// <value>The containing folder path.</value>
        [JsonIgnore]
@@ -97,7 +97,7 @@ namespace MediaBrowser.Controller.Entities
        }

        /// <summary>
-        /// This is called before any metadata refresh and returns true or false indicating if changes were made
+        /// This is called before any metadata refresh and returns true or false indicating if changes were made.
        /// </summary>
        public override bool BeforeMetadataRefresh(bool replaceAllMetdata)
        {
--- a/MediaBrowser.Controller/Entities/TV/Episode.cs
+++ b/MediaBrowser.Controller/Entities/TV/Episode.cs
@@ -12,7 +12,7 @@ using Microsoft.Extensions.Logging;
 namespace MediaBrowser.Controller.Entities.TV
 {
    /// <summary>
-    /// Class Episode
+    /// Class Episode.
    /// </summary>
    public class Episode : Video, IHasTrailers, IHasLookupInfo<EpisodeInfo>, IHasSeries
    {
@@ -101,7 +101,7 @@ namespace MediaBrowser.Controller.Entities.TV
        }

        /// <summary>
-        /// This Episode's Series Instance
+        /// This Episode's Series Instance.
        /// </summary>
        /// <value>The series.</value>
        [JsonIgnore]
--- a/MediaBrowser.Controller/Entities/TV/Season.cs
+++ b/MediaBrowser.Controller/Entities/TV/Season.cs
@@ -11,7 +11,7 @@ using MediaBrowser.Model.Querying;
 namespace MediaBrowser.Controller.Entities.TV
 {
    /// <summary>
-    /// Class Season
+    /// Class Season.
    /// </summary>
    public class Season : Folder, IHasSeries, IHasLookupInfo<SeasonInfo>
    {
@@ -68,7 +68,7 @@ namespace MediaBrowser.Controller.Entities.TV
        }

        /// <summary>
-        /// This Episode's Series Instance
+        /// This Episode's Series Instance.
        /// </summary>
        /// <value>The series.</value>
        [JsonIgnore]
@@ -225,7 +225,7 @@ namespace MediaBrowser.Controller.Entities.TV
        }

        /// <summary>
-        /// This is called before any metadata refresh and returns true or false indicating if changes were made
+        /// This is called before any metadata refresh and returns true or false indicating if changes were made.
        /// </summary>
        /// <returns><c>true</c> if XXXX, <c>false</c> otherwise.</returns>
        public override bool BeforeMetadataRefresh(bool replaceAllMetdata)
--- a/MediaBrowser.Controller/Entities/TV/Series.cs
+++ b/MediaBrowser.Controller/Entities/TV/Series.cs
@@ -17,7 +17,7 @@ using MetadataProvider = MediaBrowser.Model.Entities.MetadataProvider;
 namespace MediaBrowser.Controller.Entities.TV
 {
    /// <summary>
-    /// Class Series
+    /// Class Series.
    /// </summary>
    public class Series : Folder, IHasTrailers, IHasDisplayOrder, IHasLookupInfo<SeriesInfo>, IMetadataContainer
    {
@@ -54,7 +54,7 @@ namespace MediaBrowser.Controller.Entities.TV
        public IReadOnlyList<Guid> RemoteTrailerIds { get; set; }

        /// <summary>
-        /// airdate, dvd or absolute
+        /// airdate, dvd or absolute.
        /// </summary>
        public string DisplayOrder { get; set; }

--- a/MediaBrowser.Controller/Entities/Trailer.cs
+++ b/MediaBrowser.Controller/Entities/Trailer.cs
@@ -9,7 +9,7 @@ using MediaBrowser.Model.Providers;
 namespace MediaBrowser.Controller.Entities
 {
    /// <summary>
-    /// Class Trailer
+    /// Class Trailer.
    /// </summary>
    public class Trailer : Video, IHasLookupInfo<TrailerInfo>
    {
--- a/MediaBrowser.Controller/Entities/UserItemData.cs
+++ b/MediaBrowser.Controller/Entities/UserItemData.cs
@@ -4,7 +4,7 @@ using System.Text.Json.Serialization;
 namespace MediaBrowser.Controller.Entities
 {
    /// <summary>
-    /// Class UserItemData
+    /// Class UserItemData.
    /// </summary>
    public class UserItemData
    {
@@ -21,11 +21,11 @@ namespace MediaBrowser.Controller.Entities
        public string Key { get; set; }

        /// <summary>
-        /// The _rating
+        /// The _rating.
        /// </summary>
        private double? _rating;
        /// <summary>
-        /// Gets or sets the users 0-10 rating
+        /// Gets or sets the users 0-10 rating.
        /// </summary>
        /// <value>The rating.</value>
        /// <exception cref="ArgumentOutOfRangeException">Rating;A 0 to 10 rating is required for UserItemData.</exception>
--- a/MediaBrowser.Controller/Entities/Video.cs
+++ b/MediaBrowser.Controller/Entities/Video.cs
@@ -17,7 +17,7 @@ using MediaBrowser.Model.MediaInfo;
 namespace MediaBrowser.Controller.Entities
 {
    /// <summary>
-    /// Class Video
+    /// Class Video.
    /// </summary>
    public class Video : BaseItem,
        IHasAspectRatio,
--- a/MediaBrowser.Controller/Entities/Year.cs
+++ b/MediaBrowser.Controller/Entities/Year.cs
@@ -7,7 +7,7 @@ using Microsoft.Extensions.Logging;
 namespace MediaBrowser.Controller.Entities
 {
    /// <summary>
-    /// Class Year
+    /// Class Year.
    /// </summary>
    public class Year : BaseItem, IItemByName
    {
@@ -21,7 +21,7 @@ namespace MediaBrowser.Controller.Entities

        /// <summary>
        /// Returns the folder containing the item.
-        /// If the item is a folder, it returns the folder itself
+        /// If the item is a folder, it returns the folder itself.
        /// </summary>
        /// <value>The containing folder path.</value>
        [JsonIgnore]
@@ -107,7 +107,7 @@ namespace MediaBrowser.Controller.Entities
        }

        /// <summary>
-        /// This is called before any metadata refresh and returns true or false indicating if changes were made
+        /// This is called before any metadata refresh and returns true or false indicating if changes were made.
        /// </summary>
        public override bool BeforeMetadataRefresh(bool replaceAllMetdata)
        {