diff --git a/Emby.Dlna/Didl/DidlBuilder.cs b/Emby.Dlna/Didl/DidlBuilder.cs
index aa7a118157..66baa9512c 100644
--- a/Emby.Dlna/Didl/DidlBuilder.cs
+++ b/Emby.Dlna/Didl/DidlBuilder.cs
@@ -705,7 +705,7 @@ namespace Emby.Dlna.Didl
}
///
- /// Adds fields used by both items and folders
+ /// Adds fields used by both items and folders.
///
private void AddCommonFields(BaseItem item, StubType? itemStubType, BaseItem context, XmlWriter writer, Filter filter)
{
diff --git a/Emby.Dlna/DlnaManager.cs b/Emby.Dlna/DlnaManager.cs
index ef8df854bb..cbe4ea643c 100644
--- a/Emby.Dlna/DlnaManager.cs
+++ b/Emby.Dlna/DlnaManager.cs
@@ -475,7 +475,7 @@ namespace Emby.Dlna
///
/// Recreates the object using serialization, to ensure it's not a subclass.
- /// If it's a subclass it may not serlialize properly to xml (different root element tag name)
+ /// If it's a subclass it may not serlialize properly to xml (different root element tag name).
///
///
///
diff --git a/Emby.Dlna/PlayTo/Device.cs b/Emby.Dlna/PlayTo/Device.cs
index 12757a1233..6982e7333d 100644
--- a/Emby.Dlna/PlayTo/Device.cs
+++ b/Emby.Dlna/PlayTo/Device.cs
@@ -233,7 +233,7 @@ namespace Emby.Dlna.PlayTo
}
///
- /// Sets volume on a scale of 0-100
+ /// Sets volume on a scale of 0-100.
///
public async Task SetVolume(int value, CancellationToken cancellationToken)
{
diff --git a/Emby.Naming/Common/MediaType.cs b/Emby.Naming/Common/MediaType.cs
index cc18ce4cdd..148833765f 100644
--- a/Emby.Naming/Common/MediaType.cs
+++ b/Emby.Naming/Common/MediaType.cs
@@ -5,17 +5,17 @@ namespace Emby.Naming.Common
public enum MediaType
{
///
- /// The audio
+ /// The audio.
///
Audio = 0,
///
- /// The photo
+ /// The photo.
///
Photo = 1,
///
- /// The video
+ /// The video.
///
Video = 2
}
diff --git a/Emby.Server.Implementations/ApplicationHost.cs b/Emby.Server.Implementations/ApplicationHost.cs
index 5772dd479d..23f0571a1d 100644
--- a/Emby.Server.Implementations/ApplicationHost.cs
+++ b/Emby.Server.Implementations/ApplicationHost.cs
@@ -956,7 +956,7 @@ namespace Emby.Server.Implementations
}
///
- /// Notifies that the kernel that a change has been made that requires a restart
+ /// Notifies that the kernel that a change has been made that requires a restart.
///
public void NotifyPendingRestart()
{
diff --git a/Emby.Server.Implementations/Data/BaseSqliteRepository.cs b/Emby.Server.Implementations/Data/BaseSqliteRepository.cs
index 53c9ccdbf3..8a3716380b 100644
--- a/Emby.Server.Implementations/Data/BaseSqliteRepository.cs
+++ b/Emby.Server.Implementations/Data/BaseSqliteRepository.cs
@@ -247,12 +247,12 @@ namespace Emby.Server.Implementations.Data
public enum SynchronousMode
{
///
- /// SQLite continues without syncing as soon as it has handed data off to the operating system
+ /// SQLite continues without syncing as soon as it has handed data off to the operating system.
///
Off = 0,
///
- /// SQLite database engine will still sync at the most critical moments
+ /// SQLite database engine will still sync at the most critical moments.
///
Normal = 1,
diff --git a/Emby.Server.Implementations/Data/SqliteDisplayPreferencesRepository.cs b/Emby.Server.Implementations/Data/SqliteDisplayPreferencesRepository.cs
index 63d0321b73..5597155a8d 100644
--- a/Emby.Server.Implementations/Data/SqliteDisplayPreferencesRepository.cs
+++ b/Emby.Server.Implementations/Data/SqliteDisplayPreferencesRepository.cs
@@ -59,7 +59,7 @@ namespace Emby.Server.Implementations.Data
}
///
- /// Opens the connection to the database
+ /// Opens the connection to the database.
///
/// Task.
private void InitializeInternal()
@@ -77,7 +77,7 @@ namespace Emby.Server.Implementations.Data
}
///
- /// Save the display preferences associated with an item in the repo
+ /// Save the display preferences associated with an item in the repo.
///
/// The display preferences.
/// The user id.
@@ -122,7 +122,7 @@ namespace Emby.Server.Implementations.Data
}
///
- /// Save all display preferences associated with a user in the repo
+ /// Save all display preferences associated with a user in the repo.
///
/// The display preferences.
/// The user id.
diff --git a/Emby.Server.Implementations/Data/SqliteItemRepository.cs b/Emby.Server.Implementations/Data/SqliteItemRepository.cs
index f09ecaa297..da37a8c866 100644
--- a/Emby.Server.Implementations/Data/SqliteItemRepository.cs
+++ b/Emby.Server.Implementations/Data/SqliteItemRepository.cs
@@ -102,7 +102,7 @@ namespace Emby.Server.Implementations.Data
protected override TempStoreMode TempStore => TempStoreMode.Memory;
///
- /// Opens the connection to the database
+ /// Opens the connection to the database.
///
public void Initialize(SqliteUserDataRepository userDataRepo, IUserManager userManager)
{
@@ -548,7 +548,7 @@ namespace Emby.Server.Implementations.Data
}
///
- /// Save a standard item in the repo
+ /// Save a standard item in the repo.
///
/// The item.
/// The cancellation token.
@@ -1208,7 +1208,7 @@ namespace Emby.Server.Implementations.Data
}
///
- /// Internal retrieve from items or users table
+ /// Internal retrieve from items or users table.
///
/// The id.
/// BaseItem.
@@ -1988,7 +1988,7 @@ namespace Emby.Server.Implementations.Data
}
///
- /// Gets chapters for an item
+ /// Gets chapters for an item.
///
/// The item.
/// IEnumerable{ChapterInfo}.
@@ -2016,7 +2016,7 @@ namespace Emby.Server.Implementations.Data
}
///
- /// Gets a single chapter for an item
+ /// Gets a single chapter for an item.
///
/// The item.
/// The index.
diff --git a/Emby.Server.Implementations/Data/SqliteUserDataRepository.cs b/Emby.Server.Implementations/Data/SqliteUserDataRepository.cs
index 023125c924..4a78aac8e6 100644
--- a/Emby.Server.Implementations/Data/SqliteUserDataRepository.cs
+++ b/Emby.Server.Implementations/Data/SqliteUserDataRepository.cs
@@ -238,7 +238,7 @@ namespace Emby.Server.Implementations.Data
}
///
- /// Persist all user data for the specified user
+ /// Persist all user data for the specified user.
///
private void PersistAllUserData(long internalUserId, UserItemData[] userDataList, CancellationToken cancellationToken)
{
@@ -312,7 +312,7 @@ namespace Emby.Server.Implementations.Data
}
///
- /// Return all user-data associated with the given user
+ /// Return all user-data associated with the given user.
///
///
///
@@ -342,7 +342,7 @@ namespace Emby.Server.Implementations.Data
}
///
- /// Read a row from the specified reader into the provided userData object
+ /// Read a row from the specified reader into the provided userData object.
///
///
private UserItemData ReadRow(IReadOnlyList reader)
diff --git a/Emby.Server.Implementations/Dto/DtoService.cs b/Emby.Server.Implementations/Dto/DtoService.cs
index f5a58cc6d6..3d5460b8cc 100644
--- a/Emby.Server.Implementations/Dto/DtoService.cs
+++ b/Emby.Server.Implementations/Dto/DtoService.cs
@@ -74,7 +74,7 @@ namespace Emby.Server.Implementations.Dto
}
///
- /// Converts a BaseItem to a DTOBaseItem
+ /// Converts a BaseItem to a DTOBaseItem.
///
/// The item.
/// The fields.
@@ -444,7 +444,7 @@ namespace Emby.Server.Implementations.Dto
}
///
- /// Gets client-side Id of a server-side BaseItem
+ /// Gets client-side Id of a server-side BaseItem.
///
/// The item.
/// System.String.
@@ -540,7 +540,7 @@ namespace Emby.Server.Implementations.Dto
}
///
- /// Attaches People DTO's to a DTOBaseItem
+ /// Attaches People DTO's to a DTOBaseItem.
///
/// The dto.
/// The item.
@@ -733,7 +733,7 @@ namespace Emby.Server.Implementations.Dto
}
///
- /// Sets simple property values on a DTOBaseItem
+ /// Sets simple property values on a DTOBaseItem.
///
/// The dto.
/// The item.
diff --git a/Emby.Server.Implementations/HttpClientManager/HttpClientManager.cs b/Emby.Server.Implementations/HttpClientManager/HttpClientManager.cs
index 87977494a1..25adc58126 100644
--- a/Emby.Server.Implementations/HttpClientManager/HttpClientManager.cs
+++ b/Emby.Server.Implementations/HttpClientManager/HttpClientManager.cs
@@ -140,7 +140,7 @@ namespace Emby.Server.Implementations.HttpClientManager
=> SendAsync(options, HttpMethod.Get);
///
- /// Performs a GET request and returns the resulting stream
+ /// Performs a GET request and returns the resulting stream.
///
/// The options.
/// Task{Stream}.
diff --git a/Emby.Server.Implementations/HttpServer/FileWriter.cs b/Emby.Server.Implementations/HttpServer/FileWriter.cs
index 0b61e40b05..590eee1b48 100644
--- a/Emby.Server.Implementations/HttpServer/FileWriter.cs
+++ b/Emby.Server.Implementations/HttpServer/FileWriter.cs
@@ -32,12 +32,12 @@ namespace Emby.Server.Implementations.HttpServer
private readonly IFileSystem _fileSystem;
///
- /// The _options
+ /// The _options.
///
private readonly IDictionary _options = new Dictionary();
///
- /// The _requested ranges
+ /// The _requested ranges.
///
private List> _requestedRanges;
diff --git a/Emby.Server.Implementations/HttpServer/HttpListenerHost.cs b/Emby.Server.Implementations/HttpServer/HttpListenerHost.cs
index e52acc5489..c3428ee62a 100644
--- a/Emby.Server.Implementations/HttpServer/HttpListenerHost.cs
+++ b/Emby.Server.Implementations/HttpServer/HttpListenerHost.cs
@@ -592,7 +592,7 @@ namespace Emby.Server.Implementations.HttpServer
}
///
- /// Get the default CORS headers
+ /// Get the default CORS headers.
///
///
///
diff --git a/Emby.Server.Implementations/HttpServer/HttpResultFactory.cs b/Emby.Server.Implementations/HttpServer/HttpResultFactory.cs
index d254d394fa..ad31b3e1ea 100644
--- a/Emby.Server.Implementations/HttpServer/HttpResultFactory.cs
+++ b/Emby.Server.Implementations/HttpServer/HttpResultFactory.cs
@@ -692,7 +692,7 @@ namespace Emby.Server.Implementations.HttpServer
///
- /// When the browser sends the IfModifiedDate, it's precision is limited to seconds, so this will account for that
+ /// When the browser sends the IfModifiedDate, it's precision is limited to seconds, so this will account for that.
///
/// The date.
/// DateTime.
diff --git a/Emby.Server.Implementations/HttpServer/RangeRequestWriter.cs b/Emby.Server.Implementations/HttpServer/RangeRequestWriter.cs
index 94cedb918f..540340272a 100644
--- a/Emby.Server.Implementations/HttpServer/RangeRequestWriter.cs
+++ b/Emby.Server.Implementations/HttpServer/RangeRequestWriter.cs
@@ -40,17 +40,17 @@ namespace Emby.Server.Implementations.HttpServer
private const int BufferSize = 81920;
///
- /// The _options
+ /// The _options.
///
private readonly Dictionary _options = new Dictionary();
///
- /// The us culture
+ /// The us culture.
///
private static readonly CultureInfo UsCulture = new CultureInfo("en-US");
///
- /// Additional HTTP Headers
+ /// Additional HTTP Headers.
///
/// The headers.
public IDictionary Headers => _options;
@@ -116,7 +116,7 @@ namespace Emby.Server.Implementations.HttpServer
}
///
- /// The _requested ranges
+ /// The _requested ranges.
///
private List> _requestedRanges;
///
diff --git a/Emby.Server.Implementations/Library/CoreResolutionIgnoreRule.cs b/Emby.Server.Implementations/Library/CoreResolutionIgnoreRule.cs
index 218e5a0c6d..e140009ea9 100644
--- a/Emby.Server.Implementations/Library/CoreResolutionIgnoreRule.cs
+++ b/Emby.Server.Implementations/Library/CoreResolutionIgnoreRule.cs
@@ -8,7 +8,7 @@ using MediaBrowser.Model.IO;
namespace Emby.Server.Implementations.Library
{
///
- /// Provides the core resolver ignore rules
+ /// Provides the core resolver ignore rules.
///
public class CoreResolutionIgnoreRule : IResolverIgnoreRule
{
diff --git a/Emby.Server.Implementations/Library/IgnorePatterns.cs b/Emby.Server.Implementations/Library/IgnorePatterns.cs
index d12b5855b2..8c40989489 100644
--- a/Emby.Server.Implementations/Library/IgnorePatterns.cs
+++ b/Emby.Server.Implementations/Library/IgnorePatterns.cs
@@ -4,12 +4,12 @@ using DotNet.Globbing;
namespace Emby.Server.Implementations.Library
{
///
- /// Glob patterns for files to ignore
+ /// Glob patterns for files to ignore.
///
public static class IgnorePatterns
{
///
- /// Files matching these glob patterns will be ignored
+ /// Files matching these glob patterns will be ignored.
///
public static readonly string[] Patterns = new string[]
{
@@ -64,7 +64,7 @@ namespace Emby.Server.Implementations.Library
private static readonly Glob[] _globs = Patterns.Select(p => Glob.Parse(p, _globOptions)).ToArray();
///
- /// Returns true if the supplied path should be ignored
+ /// Returns true if the supplied path should be ignored.
///
public static bool ShouldIgnore(string path)
{
diff --git a/Emby.Server.Implementations/Library/LibraryManager.cs b/Emby.Server.Implementations/Library/LibraryManager.cs
index 46f4332829..893af4cae2 100644
--- a/Emby.Server.Implementations/Library/LibraryManager.cs
+++ b/Emby.Server.Implementations/Library/LibraryManager.cs
@@ -97,13 +97,13 @@ namespace Emby.Server.Implementations.Library
private IIntroProvider[] IntroProviders { get; set; }
///
- /// Gets or sets the list of entity resolution ignore rules
+ /// Gets or sets the list of entity resolution ignore rules.
///
/// The entity resolution ignore rules.
private IResolverIgnoreRule[] EntityResolutionIgnoreRules { get; set; }
///
- /// Gets or sets the list of currently registered entity resolvers
+ /// Gets or sets the list of currently registered entity resolvers.
///
/// The entity resolvers enumerable.
private IItemResolver[] EntityResolvers { get; set; }
@@ -209,12 +209,12 @@ namespace Emby.Server.Implementations.Library
}
///
- /// The _root folder
+ /// The _root folder.
///
private volatile AggregateFolder _rootFolder;
///
- /// The _root folder sync lock
+ /// The _root folder sync lock.
///
private readonly object _rootFolderSyncLock = new object();
@@ -627,7 +627,7 @@ namespace Emby.Server.Implementations.Library
}
///
- /// Determines whether a path should be ignored based on its contents - called after the contents have been read
+ /// Determines whether a path should be ignored based on its contents - called after the contents have been read.
///
/// The args.
/// true if XXXX, false otherwise
@@ -909,7 +909,7 @@ namespace Emby.Server.Implementations.Library
}
///
- /// Gets a Genre
+ /// Gets a Genre.
///
/// The name.
/// Task{Genre}.
@@ -990,7 +990,7 @@ namespace Emby.Server.Implementations.Library
}
///
- /// Reloads the root media folder
+ /// Reloads the root media folder.
///
/// The progress.
/// The cancellation token.
diff --git a/Emby.Server.Implementations/Library/ResolverHelper.cs b/Emby.Server.Implementations/Library/ResolverHelper.cs
index 7ca15b4e55..4e4cac75bf 100644
--- a/Emby.Server.Implementations/Library/ResolverHelper.cs
+++ b/Emby.Server.Implementations/Library/ResolverHelper.cs
@@ -107,7 +107,7 @@ namespace Emby.Server.Implementations.Library
}
///
- /// Ensures DateCreated and DateModified have values
+ /// Ensures DateCreated and DateModified have values.
///
/// The file system.
/// The item.
diff --git a/Emby.Server.Implementations/Library/Resolvers/ItemResolver.cs b/Emby.Server.Implementations/Library/Resolvers/ItemResolver.cs
index 32ccc7fdd4..9ca76095b2 100644
--- a/Emby.Server.Implementations/Library/Resolvers/ItemResolver.cs
+++ b/Emby.Server.Implementations/Library/Resolvers/ItemResolver.cs
@@ -28,7 +28,7 @@ namespace Emby.Server.Implementations.Library.Resolvers
public virtual ResolverPriority Priority => ResolverPriority.First;
///
- /// Sets initial values on the newly resolved item
+ /// Sets initial values on the newly resolved item.
///
/// The item.
/// The args.
diff --git a/Emby.Server.Implementations/Library/UserDataManager.cs b/Emby.Server.Implementations/Library/UserDataManager.cs
index 9e17fa672c..175b3af572 100644
--- a/Emby.Server.Implementations/Library/UserDataManager.cs
+++ b/Emby.Server.Implementations/Library/UserDataManager.cs
@@ -103,7 +103,7 @@ namespace Emby.Server.Implementations.Library
}
///
- /// Retrieve all user data for the given user
+ /// Retrieve all user data for the given user.
///
///
///
@@ -188,7 +188,7 @@ namespace Emby.Server.Implementations.Library
}
///
- /// Converts a UserItemData to a DTOUserItemData
+ /// Converts a UserItemData to a DTOUserItemData.
///
/// The data.
/// DtoUserItemData.
diff --git a/Emby.Server.Implementations/LiveTv/RefreshChannelsScheduledTask.cs b/Emby.Server.Implementations/LiveTv/RefreshChannelsScheduledTask.cs
index 8e7d60a15a..f1b61f7c7d 100644
--- a/Emby.Server.Implementations/LiveTv/RefreshChannelsScheduledTask.cs
+++ b/Emby.Server.Implementations/LiveTv/RefreshChannelsScheduledTask.cs
@@ -35,7 +35,7 @@ namespace Emby.Server.Implementations.LiveTv
}
///
- /// Creates the triggers that define when the task will run
+ /// Creates the triggers that define when the task will run.
///
/// IEnumerable{BaseTaskTrigger}.
public IEnumerable GetDefaultTriggers()
diff --git a/Emby.Server.Implementations/Networking/NetworkManager.cs b/Emby.Server.Implementations/Networking/NetworkManager.cs
index 2909cdd0db..d12b5a9371 100644
--- a/Emby.Server.Implementations/Networking/NetworkManager.cs
+++ b/Emby.Server.Implementations/Networking/NetworkManager.cs
@@ -411,7 +411,7 @@ namespace Emby.Server.Implementations.Networking
}
///
- /// Gets a random port number that is currently available
+ /// Gets a random port number that is currently available.
///
/// System.Int32.
public int GetRandomUnusedTcpPort()
diff --git a/Emby.Server.Implementations/ScheduledTasks/ScheduledTaskWorker.cs b/Emby.Server.Implementations/ScheduledTasks/ScheduledTaskWorker.cs
index 2031a1c6db..8a900f42cd 100644
--- a/Emby.Server.Implementations/ScheduledTasks/ScheduledTaskWorker.cs
+++ b/Emby.Server.Implementations/ScheduledTasks/ScheduledTaskWorker.cs
@@ -18,7 +18,7 @@ using Microsoft.Extensions.Logging;
namespace Emby.Server.Implementations.ScheduledTasks
{
///
- /// Class ScheduledTaskWorker
+ /// Class ScheduledTaskWorker.
///
public class ScheduledTaskWorker : IScheduledTaskWorker
{
@@ -111,11 +111,11 @@ namespace Emby.Server.Implementations.ScheduledTasks
private bool _readFromFile = false;
///
- /// The _last execution result
+ /// The _last execution result.
///
private TaskResult _lastExecutionResult;
///
- /// The _last execution result sync lock
+ /// The _last execution result sync lock.
///
private readonly object _lastExecutionResultSyncLock = new object();
///
@@ -184,7 +184,7 @@ namespace Emby.Server.Implementations.ScheduledTasks
public string Category => ScheduledTask.Category;
///
- /// Gets the current cancellation token
+ /// Gets the current cancellation token.
///
/// The current cancellation token source.
private CancellationTokenSource CurrentCancellationTokenSource { get; set; }
@@ -281,7 +281,7 @@ namespace Emby.Server.Implementations.ScheduledTasks
}
///
- /// The _id
+ /// The _id.
///
private string _id;
@@ -361,7 +361,7 @@ namespace Emby.Server.Implementations.ScheduledTasks
private Task _currentTask;
///
- /// Executes the task
+ /// Executes the task.
///
/// Task options.
/// Task.
@@ -456,7 +456,7 @@ namespace Emby.Server.Implementations.ScheduledTasks
}
///
- /// Stops the task if it is currently executing
+ /// Stops the task if it is currently executing.
///
/// Cannot cancel a Task unless it is in the Running state.
public void Cancel()
@@ -688,7 +688,7 @@ namespace Emby.Server.Implementations.ScheduledTasks
}
///
- /// Converts a TaskTriggerInfo into a concrete BaseTaskTrigger
+ /// Converts a TaskTriggerInfo into a concrete BaseTaskTrigger.
///
/// The info.
/// BaseTaskTrigger.
@@ -758,7 +758,7 @@ namespace Emby.Server.Implementations.ScheduledTasks
}
///
- /// Disposes each trigger
+ /// Disposes each trigger.
///
private void DisposeTriggers()
{
diff --git a/Emby.Server.Implementations/ScheduledTasks/TaskManager.cs b/Emby.Server.Implementations/ScheduledTasks/TaskManager.cs
index 94220ac5d1..0ad4253e4b 100644
--- a/Emby.Server.Implementations/ScheduledTasks/TaskManager.cs
+++ b/Emby.Server.Implementations/ScheduledTasks/TaskManager.cs
@@ -15,7 +15,7 @@ using Microsoft.Extensions.Logging;
namespace Emby.Server.Implementations.ScheduledTasks
{
///
- /// Class TaskManager
+ /// Class TaskManager.
///
public class TaskManager : ITaskManager
{
@@ -23,13 +23,13 @@ namespace Emby.Server.Implementations.ScheduledTasks
public event EventHandler TaskCompleted;
///
- /// Gets the list of Scheduled Tasks
+ /// Gets the list of Scheduled Tasks.
///
/// The scheduled tasks.
public IScheduledTaskWorker[] ScheduledTasks { get; private set; }
///
- /// The _task queue
+ /// The _task queue.
///
private readonly ConcurrentQueue> _taskQueue =
new ConcurrentQueue>();
@@ -81,7 +81,7 @@ namespace Emby.Server.Implementations.ScheduledTasks
}
///
- /// Cancels if running
+ /// Cancels if running.
///
///
public void CancelIfRunning()
diff --git a/Emby.Server.Implementations/ScheduledTasks/Tasks/DeleteCacheFileTask.cs b/Emby.Server.Implementations/ScheduledTasks/Tasks/DeleteCacheFileTask.cs
index 966b549b23..e29fcfb5f1 100644
--- a/Emby.Server.Implementations/ScheduledTasks/Tasks/DeleteCacheFileTask.cs
+++ b/Emby.Server.Implementations/ScheduledTasks/Tasks/DeleteCacheFileTask.cs
@@ -13,7 +13,7 @@ using MediaBrowser.Model.Globalization;
namespace Emby.Server.Implementations.ScheduledTasks.Tasks
{
///
- /// Deletes old cache files
+ /// Deletes old cache files.
///
public class DeleteCacheFileTask : IScheduledTask, IConfigurableScheduledTask
{
@@ -44,7 +44,7 @@ namespace Emby.Server.Implementations.ScheduledTasks.Tasks
}
///
- /// Creates the triggers that define when the task will run
+ /// Creates the triggers that define when the task will run.
///
/// IEnumerable{BaseTaskTrigger}.
public IEnumerable GetDefaultTriggers()
@@ -57,7 +57,7 @@ namespace Emby.Server.Implementations.ScheduledTasks.Tasks
}
///
- /// Returns the task to be executed
+ /// Returns the task to be executed.
///
/// The cancellation token.
/// The progress.
@@ -93,7 +93,7 @@ namespace Emby.Server.Implementations.ScheduledTasks.Tasks
///
- /// Deletes the cache files from directory with a last write time less than a given date
+ /// Deletes the cache files from directory with a last write time less than a given date.
///
/// The task cancellation token.
/// The directory.
diff --git a/Emby.Server.Implementations/ScheduledTasks/Tasks/DeleteTranscodeFileTask.cs b/Emby.Server.Implementations/ScheduledTasks/Tasks/DeleteTranscodeFileTask.cs
index 53cf9a0a5f..6914081673 100644
--- a/Emby.Server.Implementations/ScheduledTasks/Tasks/DeleteTranscodeFileTask.cs
+++ b/Emby.Server.Implementations/ScheduledTasks/Tasks/DeleteTranscodeFileTask.cs
@@ -13,7 +13,7 @@ using MediaBrowser.Model.Globalization;
namespace Emby.Server.Implementations.ScheduledTasks.Tasks
{
///
- /// Deletes all transcoding temp files
+ /// Deletes all transcoding temp files.
///
public class DeleteTranscodeFileTask : IScheduledTask, IConfigurableScheduledTask
{
diff --git a/Emby.Server.Implementations/ScheduledTasks/Triggers/DailyTrigger.cs b/Emby.Server.Implementations/ScheduledTasks/Triggers/DailyTrigger.cs
index c7819d4c0f..eb628ec5fe 100644
--- a/Emby.Server.Implementations/ScheduledTasks/Triggers/DailyTrigger.cs
+++ b/Emby.Server.Implementations/ScheduledTasks/Triggers/DailyTrigger.cs
@@ -28,7 +28,7 @@ namespace Emby.Server.Implementations.ScheduledTasks
private Timer Timer { get; set; }
///
- /// Stars waiting for the trigger action
+ /// Stars waiting for the trigger action.
///
/// The last result.
/// The logger.
@@ -51,7 +51,7 @@ namespace Emby.Server.Implementations.ScheduledTasks
}
///
- /// Stops waiting for the trigger action
+ /// Stops waiting for the trigger action.
///
public void Stop()
{
diff --git a/Emby.Server.Implementations/ScheduledTasks/Triggers/IntervalTrigger.cs b/Emby.Server.Implementations/ScheduledTasks/Triggers/IntervalTrigger.cs
index 74cd4ef1ea..247a6785ad 100644
--- a/Emby.Server.Implementations/ScheduledTasks/Triggers/IntervalTrigger.cs
+++ b/Emby.Server.Implementations/ScheduledTasks/Triggers/IntervalTrigger.cs
@@ -7,7 +7,7 @@ using Microsoft.Extensions.Logging;
namespace Emby.Server.Implementations.ScheduledTasks
{
///
- /// Represents a task trigger that runs repeatedly on an interval
+ /// Represents a task trigger that runs repeatedly on an interval.
///
public class IntervalTrigger : ITaskTrigger
{
@@ -31,7 +31,7 @@ namespace Emby.Server.Implementations.ScheduledTasks
private DateTime _lastStartDate;
///
- /// Stars waiting for the trigger action
+ /// Stars waiting for the trigger action.
///
/// The last result.
/// The logger.
@@ -70,7 +70,7 @@ namespace Emby.Server.Implementations.ScheduledTasks
}
///
- /// Stops waiting for the trigger action
+ /// Stops waiting for the trigger action.
///
public void Stop()
{
diff --git a/Emby.Server.Implementations/ScheduledTasks/Triggers/StartupTrigger.cs b/Emby.Server.Implementations/ScheduledTasks/Triggers/StartupTrigger.cs
index e171a9e9f5..96e5d88970 100644
--- a/Emby.Server.Implementations/ScheduledTasks/Triggers/StartupTrigger.cs
+++ b/Emby.Server.Implementations/ScheduledTasks/Triggers/StartupTrigger.cs
@@ -25,7 +25,7 @@ namespace Emby.Server.Implementations.ScheduledTasks
}
///
- /// Stars waiting for the trigger action
+ /// Stars waiting for the trigger action.
///
/// The last result.
/// The logger.
@@ -42,7 +42,7 @@ namespace Emby.Server.Implementations.ScheduledTasks
}
///
- /// Stops waiting for the trigger action
+ /// Stops waiting for the trigger action.
///
public void Stop()
{
diff --git a/Emby.Server.Implementations/ScheduledTasks/Triggers/WeeklyTrigger.cs b/Emby.Server.Implementations/ScheduledTasks/Triggers/WeeklyTrigger.cs
index ad0b57af6e..4f1bf5c19a 100644
--- a/Emby.Server.Implementations/ScheduledTasks/Triggers/WeeklyTrigger.cs
+++ b/Emby.Server.Implementations/ScheduledTasks/Triggers/WeeklyTrigger.cs
@@ -6,12 +6,12 @@ using Microsoft.Extensions.Logging;
namespace Emby.Server.Implementations.ScheduledTasks
{
///
- /// Represents a task trigger that fires on a weekly basis
+ /// Represents a task trigger that fires on a weekly basis.
///
public class WeeklyTrigger : ITaskTrigger
{
///
- /// Get the time of day to trigger the task to run
+ /// Get the time of day to trigger the task to run.
///
/// The time of day.
public TimeSpan TimeOfDay { get; set; }
@@ -34,7 +34,7 @@ namespace Emby.Server.Implementations.ScheduledTasks
private Timer Timer { get; set; }
///
- /// Stars waiting for the trigger action
+ /// Stars waiting for the trigger action.
///
/// The last result.
/// The logger.
@@ -77,7 +77,7 @@ namespace Emby.Server.Implementations.ScheduledTasks
}
///
- /// Stops waiting for the trigger action
+ /// Stops waiting for the trigger action.
///
public void Stop()
{
diff --git a/Emby.Server.Implementations/Services/ServiceHandler.cs b/Emby.Server.Implementations/Services/ServiceHandler.cs
index 7f44357e1b..a42f88ea09 100644
--- a/Emby.Server.Implementations/Services/ServiceHandler.cs
+++ b/Emby.Server.Implementations/Services/ServiceHandler.cs
@@ -180,7 +180,7 @@ namespace Emby.Server.Implementations.Services
=> string.Equals(method, expected, StringComparison.OrdinalIgnoreCase);
///
- /// Duplicate params have their values joined together in a comma-delimited string
+ /// Duplicate params have their values joined together in a comma-delimited string.
///
private static Dictionary GetFlattenedRequestParams(HttpRequest request)
{
diff --git a/Emby.Server.Implementations/Services/UrlExtensions.cs b/Emby.Server.Implementations/Services/UrlExtensions.cs
index e3b6aa1975..92e36b60e0 100644
--- a/Emby.Server.Implementations/Services/UrlExtensions.cs
+++ b/Emby.Server.Implementations/Services/UrlExtensions.cs
@@ -9,7 +9,7 @@ namespace Emby.Server.Implementations.Services
/// Donated by Ivan Korneliuk from his post:
/// http://korneliuk.blogspot.com/2012/08/servicestack-reusing-dtos.html
///
- /// Modified to only allow using routes matching the supplied HTTP Verb
+ /// Modified to only allow using routes matching the supplied HTTP Verb.
///
public static class UrlExtensions
{
diff --git a/Emby.Server.Implementations/Session/SessionManager.cs b/Emby.Server.Implementations/Session/SessionManager.cs
index 07e443ef52..75fdedd107 100644
--- a/Emby.Server.Implementations/Session/SessionManager.cs
+++ b/Emby.Server.Implementations/Session/SessionManager.cs
@@ -843,7 +843,7 @@ namespace Emby.Server.Implementations.Session
}
///
- /// Used to report that playback has ended for an item
+ /// Used to report that playback has ended for an item.
///
/// The info.
/// Task.
diff --git a/Emby.Server.Implementations/Session/SessionWebSocketListener.cs b/Emby.Server.Implementations/Session/SessionWebSocketListener.cs
index 1e8b25e38e..b9db6ecd0e 100644
--- a/Emby.Server.Implementations/Session/SessionWebSocketListener.cs
+++ b/Emby.Server.Implementations/Session/SessionWebSocketListener.cs
@@ -14,7 +14,7 @@ using Microsoft.Extensions.Logging;
namespace Emby.Server.Implementations.Session
{
///
- /// Class SessionWebSocketListener
+ /// Class SessionWebSocketListener.
///
public sealed class SessionWebSocketListener : IWebSocketListener, IDisposable
{
@@ -34,12 +34,12 @@ namespace Emby.Server.Implementations.Session
public const float ForceKeepAliveFactor = 0.75f;
///
- /// The _session manager
+ /// The _session manager.
///
private readonly ISessionManager _sessionManager;
///
- /// The _logger
+ /// The _logger.
///
private readonly ILogger _logger;
private readonly ILoggerFactory _loggerFactory;
diff --git a/Emby.Server.Implementations/Sorting/AlbumArtistComparer.cs b/Emby.Server.Implementations/Sorting/AlbumArtistComparer.cs
index 0804b01fca..7657cc74e1 100644
--- a/Emby.Server.Implementations/Sorting/AlbumArtistComparer.cs
+++ b/Emby.Server.Implementations/Sorting/AlbumArtistComparer.cs
@@ -8,7 +8,7 @@ using MediaBrowser.Model.Querying;
namespace Emby.Server.Implementations.Sorting
{
///
- /// Class AlbumArtistComparer
+ /// Class AlbumArtistComparer.
///
public class AlbumArtistComparer : IBaseItemComparer
{
diff --git a/Emby.Server.Implementations/Sorting/AlbumComparer.cs b/Emby.Server.Implementations/Sorting/AlbumComparer.cs
index 3831a0d2d8..7dfdd9ecff 100644
--- a/Emby.Server.Implementations/Sorting/AlbumComparer.cs
+++ b/Emby.Server.Implementations/Sorting/AlbumComparer.cs
@@ -7,7 +7,7 @@ using MediaBrowser.Model.Querying;
namespace Emby.Server.Implementations.Sorting
{
///
- /// Class AlbumComparer
+ /// Class AlbumComparer.
///
public class AlbumComparer : IBaseItemComparer
{
diff --git a/Emby.Server.Implementations/Sorting/CriticRatingComparer.cs b/Emby.Server.Implementations/Sorting/CriticRatingComparer.cs
index adb78dec53..fa136c36d0 100644
--- a/Emby.Server.Implementations/Sorting/CriticRatingComparer.cs
+++ b/Emby.Server.Implementations/Sorting/CriticRatingComparer.cs
@@ -5,7 +5,7 @@ using MediaBrowser.Model.Querying;
namespace Emby.Server.Implementations.Sorting
{
///
- /// Class CriticRatingComparer
+ /// Class CriticRatingComparer.
///
public class CriticRatingComparer : IBaseItemComparer
{
diff --git a/Emby.Server.Implementations/Sorting/DateCreatedComparer.cs b/Emby.Server.Implementations/Sorting/DateCreatedComparer.cs
index 8501bd9ee8..ea981e8402 100644
--- a/Emby.Server.Implementations/Sorting/DateCreatedComparer.cs
+++ b/Emby.Server.Implementations/Sorting/DateCreatedComparer.cs
@@ -6,7 +6,7 @@ using MediaBrowser.Model.Querying;
namespace Emby.Server.Implementations.Sorting
{
///
- /// Class DateCreatedComparer
+ /// Class DateCreatedComparer.
///
public class DateCreatedComparer : IBaseItemComparer
{
diff --git a/Emby.Server.Implementations/Sorting/DatePlayedComparer.cs b/Emby.Server.Implementations/Sorting/DatePlayedComparer.cs
index 5e527ea257..16bd2aff86 100644
--- a/Emby.Server.Implementations/Sorting/DatePlayedComparer.cs
+++ b/Emby.Server.Implementations/Sorting/DatePlayedComparer.cs
@@ -8,7 +8,7 @@ using MediaBrowser.Model.Querying;
namespace Emby.Server.Implementations.Sorting
{
///
- /// Class DatePlayedComparer
+ /// Class DatePlayedComparer.
///
public class DatePlayedComparer : IUserBaseItemComparer
{
diff --git a/Emby.Server.Implementations/Sorting/NameComparer.cs b/Emby.Server.Implementations/Sorting/NameComparer.cs
index 4eb1549f58..da020d8d8e 100644
--- a/Emby.Server.Implementations/Sorting/NameComparer.cs
+++ b/Emby.Server.Implementations/Sorting/NameComparer.cs
@@ -6,7 +6,7 @@ using MediaBrowser.Model.Querying;
namespace Emby.Server.Implementations.Sorting
{
///
- /// Class NameComparer
+ /// Class NameComparer.
///
public class NameComparer : IBaseItemComparer
{
diff --git a/Emby.Server.Implementations/Sorting/PlayCountComparer.cs b/Emby.Server.Implementations/Sorting/PlayCountComparer.cs
index afbaaf6ab8..5c28303229 100644
--- a/Emby.Server.Implementations/Sorting/PlayCountComparer.cs
+++ b/Emby.Server.Implementations/Sorting/PlayCountComparer.cs
@@ -7,7 +7,7 @@ using MediaBrowser.Model.Querying;
namespace Emby.Server.Implementations.Sorting
{
///
- /// Class PlayCountComparer
+ /// Class PlayCountComparer.
///
public class PlayCountComparer : IUserBaseItemComparer
{
diff --git a/Emby.Server.Implementations/Sorting/PremiereDateComparer.cs b/Emby.Server.Implementations/Sorting/PremiereDateComparer.cs
index 491057a851..92ac04dc66 100644
--- a/Emby.Server.Implementations/Sorting/PremiereDateComparer.cs
+++ b/Emby.Server.Implementations/Sorting/PremiereDateComparer.cs
@@ -6,7 +6,7 @@ using MediaBrowser.Model.Querying;
namespace Emby.Server.Implementations.Sorting
{
///
- /// Class PremiereDateComparer
+ /// Class PremiereDateComparer.
///
public class PremiereDateComparer : IBaseItemComparer
{
diff --git a/Emby.Server.Implementations/Sorting/ProductionYearComparer.cs b/Emby.Server.Implementations/Sorting/ProductionYearComparer.cs
index 472a07eb36..e2857df0b9 100644
--- a/Emby.Server.Implementations/Sorting/ProductionYearComparer.cs
+++ b/Emby.Server.Implementations/Sorting/ProductionYearComparer.cs
@@ -5,7 +5,7 @@ using MediaBrowser.Model.Querying;
namespace Emby.Server.Implementations.Sorting
{
///
- /// Class ProductionYearComparer
+ /// Class ProductionYearComparer.
///
public class ProductionYearComparer : IBaseItemComparer
{
diff --git a/Emby.Server.Implementations/Sorting/RandomComparer.cs b/Emby.Server.Implementations/Sorting/RandomComparer.cs
index bde8b4534d..7739d04182 100644
--- a/Emby.Server.Implementations/Sorting/RandomComparer.cs
+++ b/Emby.Server.Implementations/Sorting/RandomComparer.cs
@@ -6,7 +6,7 @@ using MediaBrowser.Model.Querying;
namespace Emby.Server.Implementations.Sorting
{
///
- /// Class RandomComparer
+ /// Class RandomComparer.
///
public class RandomComparer : IBaseItemComparer
{
diff --git a/Emby.Server.Implementations/Sorting/RuntimeComparer.cs b/Emby.Server.Implementations/Sorting/RuntimeComparer.cs
index 1d2bdde260..f165123eab 100644
--- a/Emby.Server.Implementations/Sorting/RuntimeComparer.cs
+++ b/Emby.Server.Implementations/Sorting/RuntimeComparer.cs
@@ -6,7 +6,7 @@ using MediaBrowser.Model.Querying;
namespace Emby.Server.Implementations.Sorting
{
///
- /// Class RuntimeComparer
+ /// Class RuntimeComparer.
///
public class RuntimeComparer : IBaseItemComparer
{
diff --git a/Emby.Server.Implementations/Sorting/SortNameComparer.cs b/Emby.Server.Implementations/Sorting/SortNameComparer.cs
index cc0571c782..93389fc3e8 100644
--- a/Emby.Server.Implementations/Sorting/SortNameComparer.cs
+++ b/Emby.Server.Implementations/Sorting/SortNameComparer.cs
@@ -6,7 +6,7 @@ using MediaBrowser.Model.Querying;
namespace Emby.Server.Implementations.Sorting
{
///
- /// Class SortNameComparer
+ /// Class SortNameComparer.
///
public class SortNameComparer : IBaseItemComparer
{
diff --git a/Emby.Server.Implementations/Udp/UdpServer.cs b/Emby.Server.Implementations/Udp/UdpServer.cs
index a26f714b12..bf8a436b4c 100644
--- a/Emby.Server.Implementations/Udp/UdpServer.cs
+++ b/Emby.Server.Implementations/Udp/UdpServer.cs
@@ -18,7 +18,7 @@ namespace Emby.Server.Implementations.Udp
public sealed class UdpServer : IDisposable
{
///
- /// The _logger
+ /// The _logger.
///
private readonly ILogger _logger;
private readonly IServerApplicationHost _appHost;
diff --git a/Jellyfin.Data/Entities/Artwork.cs b/Jellyfin.Data/Entities/Artwork.cs
index bebcc37d33..852d742a58 100644
--- a/Jellyfin.Data/Entities/Artwork.cs
+++ b/Jellyfin.Data/Entities/Artwork.cs
@@ -24,7 +24,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
///
///
@@ -64,7 +64,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for Id
+ /// Backing field for Id.
///
internal int _Id;
///
@@ -77,7 +77,7 @@ namespace Jellyfin.Data.Entities
partial void GetId(ref int result);
///
- /// Identity, Indexed, Required
+ /// Identity, Indexed, Required.
///
[Key]
[Required]
@@ -102,7 +102,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Path
+ /// Backing field for Path.
///
protected string _Path;
///
@@ -141,7 +141,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Kind
+ /// Backing field for Kind.
///
internal Enums.ArtKind _Kind;
///
@@ -154,7 +154,7 @@ namespace Jellyfin.Data.Entities
partial void GetKind(ref Enums.ArtKind result);
///
- /// Indexed, Required
+ /// Indexed, Required.
///
[Required]
public Enums.ArtKind Kind
@@ -178,7 +178,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Required, ConcurrenyToken
+ /// Required, ConcurrenyToken.
///
[ConcurrencyCheck]
[Required]
diff --git a/Jellyfin.Data/Entities/Book.cs b/Jellyfin.Data/Entities/Book.cs
index faefc74000..c4d12496e6 100644
--- a/Jellyfin.Data/Entities/Book.cs
+++ b/Jellyfin.Data/Entities/Book.cs
@@ -28,7 +28,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
/// This is whats gets displayed in the Urls and API requests. This could also be a string.
public Book(Guid urlid, DateTime dateadded)
diff --git a/Jellyfin.Data/Entities/BookMetadata.cs b/Jellyfin.Data/Entities/BookMetadata.cs
index 6c72c27322..47578dc46b 100644
--- a/Jellyfin.Data/Entities/BookMetadata.cs
+++ b/Jellyfin.Data/Entities/BookMetadata.cs
@@ -27,7 +27,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
/// The title or name of the object
/// ISO-639-3 3-character language codes
@@ -64,7 +64,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for ISBN
+ /// Backing field for ISBN.
///
protected long? _ISBN;
///
diff --git a/Jellyfin.Data/Entities/Chapter.cs b/Jellyfin.Data/Entities/Chapter.cs
index 3d59fe6b88..d5b2b39ce7 100644
--- a/Jellyfin.Data/Entities/Chapter.cs
+++ b/Jellyfin.Data/Entities/Chapter.cs
@@ -25,7 +25,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
/// ISO-639-3 3-character language codes
///
@@ -60,7 +60,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for Id
+ /// Backing field for Id.
///
internal int _Id;
///
@@ -73,7 +73,7 @@ namespace Jellyfin.Data.Entities
partial void GetId(ref int result);
///
- /// Identity, Indexed, Required
+ /// Identity, Indexed, Required.
///
[Key]
[Required]
@@ -99,7 +99,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Name
+ /// Backing field for Name.
///
protected string _Name;
///
@@ -137,7 +137,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Language
+ /// Backing field for Language.
///
protected string _Language;
///
@@ -151,7 +151,7 @@ namespace Jellyfin.Data.Entities
///
/// Required, Min length = 3, Max length = 3
- /// ISO-639-3 3-character language codes
+ /// ISO-639-3 3-character language codes.
///
[Required]
[MinLength(3)]
@@ -178,7 +178,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for TimeStart
+ /// Backing field for TimeStart.
///
protected long _TimeStart;
///
@@ -191,7 +191,7 @@ namespace Jellyfin.Data.Entities
partial void GetTimeStart(ref long result);
///
- /// Required
+ /// Required.
///
[Required]
public long TimeStart
@@ -215,7 +215,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for TimeEnd
+ /// Backing field for TimeEnd.
///
protected long? _TimeEnd;
///
@@ -248,7 +248,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Required, ConcurrenyToken
+ /// Required, ConcurrenyToken.
///
[ConcurrencyCheck]
[Required]
diff --git a/Jellyfin.Data/Entities/Collection.cs b/Jellyfin.Data/Entities/Collection.cs
index caf20f9169..d2f441d030 100644
--- a/Jellyfin.Data/Entities/Collection.cs
+++ b/Jellyfin.Data/Entities/Collection.cs
@@ -9,7 +9,7 @@ namespace Jellyfin.Data.Entities
partial void Init();
///
- /// Default constructor
+ /// Default constructor.
///
public Collection()
{
@@ -23,7 +23,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for Id
+ /// Backing field for Id.
///
internal int _Id;
///
@@ -36,7 +36,7 @@ namespace Jellyfin.Data.Entities
partial void GetId(ref int result);
///
- /// Identity, Indexed, Required
+ /// Identity, Indexed, Required.
///
[Key]
[Required]
@@ -62,7 +62,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Name
+ /// Backing field for Name.
///
protected string _Name;
///
@@ -100,7 +100,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Required, ConcurrenyToken
+ /// Required, ConcurrenyToken.
///
[ConcurrencyCheck]
[Required]
diff --git a/Jellyfin.Data/Entities/CollectionItem.cs b/Jellyfin.Data/Entities/CollectionItem.cs
index 1a10780500..7cfdbbe167 100644
--- a/Jellyfin.Data/Entities/CollectionItem.cs
+++ b/Jellyfin.Data/Entities/CollectionItem.cs
@@ -28,7 +28,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
///
///
@@ -67,7 +67,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for Id
+ /// Backing field for Id.
///
internal int _Id;
///
@@ -80,7 +80,7 @@ namespace Jellyfin.Data.Entities
partial void GetId(ref int result);
///
- /// Identity, Indexed, Required
+ /// Identity, Indexed, Required.
///
[Key]
[Required]
@@ -106,7 +106,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Required, ConcurrenyToken
+ /// Required, ConcurrenyToken.
///
[ConcurrencyCheck]
[Required]
@@ -122,7 +122,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Required
+ /// Required.
///
[ForeignKey("LibraryItem_Id")]
public virtual LibraryItem LibraryItem { get; set; }
diff --git a/Jellyfin.Data/Entities/Company.cs b/Jellyfin.Data/Entities/Company.cs
index eefc581c66..908e41f3de 100644
--- a/Jellyfin.Data/Entities/Company.cs
+++ b/Jellyfin.Data/Entities/Company.cs
@@ -28,7 +28,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
///
///
@@ -75,7 +75,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for Id
+ /// Backing field for Id.
///
internal int _Id;
///
@@ -88,7 +88,7 @@ namespace Jellyfin.Data.Entities
partial void GetId(ref int result);
///
- /// Identity, Indexed, Required
+ /// Identity, Indexed, Required.
///
[Key]
[Required]
@@ -114,7 +114,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Required, ConcurrenyToken
+ /// Required, ConcurrenyToken.
///
[ConcurrencyCheck]
[Required]
diff --git a/Jellyfin.Data/Entities/CompanyMetadata.cs b/Jellyfin.Data/Entities/CompanyMetadata.cs
index 6a601c6e35..240cccbff5 100644
--- a/Jellyfin.Data/Entities/CompanyMetadata.cs
+++ b/Jellyfin.Data/Entities/CompanyMetadata.cs
@@ -24,7 +24,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
/// The title or name of the object
/// ISO-639-3 3-character language codes
@@ -60,7 +60,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for Description
+ /// Backing field for Description.
///
protected string _Description;
///
@@ -98,7 +98,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Headquarters
+ /// Backing field for Headquarters.
///
protected string _Headquarters;
///
@@ -136,7 +136,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Country
+ /// Backing field for Country.
///
protected string _Country;
///
@@ -174,7 +174,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Homepage
+ /// Backing field for Homepage.
///
protected string _Homepage;
///
diff --git a/Jellyfin.Data/Entities/CustomItem.cs b/Jellyfin.Data/Entities/CustomItem.cs
index 5f6fc3a231..4463915914 100644
--- a/Jellyfin.Data/Entities/CustomItem.cs
+++ b/Jellyfin.Data/Entities/CustomItem.cs
@@ -28,7 +28,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
/// This is whats gets displayed in the Urls and API requests. This could also be a string.
public CustomItem(Guid urlid, DateTime dateadded)
diff --git a/Jellyfin.Data/Entities/CustomItemMetadata.cs b/Jellyfin.Data/Entities/CustomItemMetadata.cs
index ee37aaaa97..b81408aa68 100644
--- a/Jellyfin.Data/Entities/CustomItemMetadata.cs
+++ b/Jellyfin.Data/Entities/CustomItemMetadata.cs
@@ -23,7 +23,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
/// The title or name of the object
/// ISO-639-3 3-character language codes
diff --git a/Jellyfin.Data/Entities/Episode.cs b/Jellyfin.Data/Entities/Episode.cs
index 6f4353a6f6..405c815cd0 100644
--- a/Jellyfin.Data/Entities/Episode.cs
+++ b/Jellyfin.Data/Entities/Episode.cs
@@ -31,7 +31,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
/// This is whats gets displayed in the Urls and API requests. This could also be a string.
///
@@ -66,7 +66,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for EpisodeNumber
+ /// Backing field for EpisodeNumber.
///
protected int? _EpisodeNumber;
///
diff --git a/Jellyfin.Data/Entities/EpisodeMetadata.cs b/Jellyfin.Data/Entities/EpisodeMetadata.cs
index 17057cb1db..4999842aa2 100644
--- a/Jellyfin.Data/Entities/EpisodeMetadata.cs
+++ b/Jellyfin.Data/Entities/EpisodeMetadata.cs
@@ -24,7 +24,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
/// The title or name of the object
/// ISO-639-3 3-character language codes
@@ -60,7 +60,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for Outline
+ /// Backing field for Outline.
///
protected string _Outline;
///
@@ -98,7 +98,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Plot
+ /// Backing field for Plot.
///
protected string _Plot;
///
@@ -136,7 +136,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Tagline
+ /// Backing field for Tagline.
///
protected string _Tagline;
///
diff --git a/Jellyfin.Data/Entities/Genre.cs b/Jellyfin.Data/Entities/Genre.cs
index b56e356678..0f6f681a44 100644
--- a/Jellyfin.Data/Entities/Genre.cs
+++ b/Jellyfin.Data/Entities/Genre.cs
@@ -25,7 +25,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
///
///
@@ -56,7 +56,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for Id
+ /// Backing field for Id.
///
internal int _Id;
///
@@ -69,7 +69,7 @@ namespace Jellyfin.Data.Entities
partial void GetId(ref int result);
///
- /// Identity, Indexed, Required
+ /// Identity, Indexed, Required.
///
[Key]
[Required]
@@ -95,7 +95,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Name
+ /// Backing field for Name.
///
internal string _Name;
///
@@ -134,7 +134,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Required, ConcurrenyToken
+ /// Required, ConcurrenyToken.
///
[ConcurrencyCheck]
[Required]
diff --git a/Jellyfin.Data/Entities/Library.cs b/Jellyfin.Data/Entities/Library.cs
index 4c7f7e7b71..a091ece03f 100644
--- a/Jellyfin.Data/Entities/Library.cs
+++ b/Jellyfin.Data/Entities/Library.cs
@@ -25,7 +25,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
///
public Library(string name)
@@ -51,7 +51,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for Id
+ /// Backing field for Id.
///
internal int _Id;
///
@@ -64,7 +64,7 @@ namespace Jellyfin.Data.Entities
partial void GetId(ref int result);
///
- /// Identity, Indexed, Required
+ /// Identity, Indexed, Required.
///
[Key]
[Required]
@@ -90,7 +90,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Name
+ /// Backing field for Name.
///
protected string _Name;
///
@@ -129,7 +129,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Required, ConcurrenyToken
+ /// Required, ConcurrenyToken.
///
[ConcurrencyCheck]
[Required]
diff --git a/Jellyfin.Data/Entities/LibraryItem.cs b/Jellyfin.Data/Entities/LibraryItem.cs
index bfc2f7ddbd..d29d6250e5 100644
--- a/Jellyfin.Data/Entities/LibraryItem.cs
+++ b/Jellyfin.Data/Entities/LibraryItem.cs
@@ -17,7 +17,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
/// This is whats gets displayed in the Urls and API requests. This could also be a string.
protected LibraryItem(Guid urlid, DateTime dateadded)
@@ -33,7 +33,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for Id
+ /// Backing field for Id.
///
internal int _Id;
///
@@ -46,7 +46,7 @@ namespace Jellyfin.Data.Entities
partial void GetId(ref int result);
///
- /// Identity, Indexed, Required
+ /// Identity, Indexed, Required.
///
[Key]
[Required]
@@ -72,7 +72,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for UrlId
+ /// Backing field for UrlId.
///
internal Guid _UrlId;
///
@@ -110,7 +110,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for DateAdded
+ /// Backing field for DateAdded.
///
protected DateTime _DateAdded;
///
@@ -123,7 +123,7 @@ namespace Jellyfin.Data.Entities
partial void GetDateAdded(ref DateTime result);
///
- /// Required
+ /// Required.
///
[Required]
public DateTime DateAdded
@@ -147,7 +147,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Required, ConcurrenyToken
+ /// Required, ConcurrenyToken.
///
[ConcurrencyCheck]
[Required]
@@ -163,7 +163,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Required
+ /// Required.
///
[ForeignKey("LibraryRoot_Id")]
public virtual LibraryRoot LibraryRoot { get; set; }
diff --git a/Jellyfin.Data/Entities/LibraryRoot.cs b/Jellyfin.Data/Entities/LibraryRoot.cs
index fa1e6f14c6..d9a4f62e50 100644
--- a/Jellyfin.Data/Entities/LibraryRoot.cs
+++ b/Jellyfin.Data/Entities/LibraryRoot.cs
@@ -25,7 +25,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
/// Absolute Path
public LibraryRoot(string path)
@@ -51,7 +51,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for Id
+ /// Backing field for Id.
///
internal int _Id;
///
@@ -64,7 +64,7 @@ namespace Jellyfin.Data.Entities
partial void GetId(ref int result);
///
- /// Identity, Indexed, Required
+ /// Identity, Indexed, Required.
///
[Key]
[Required]
@@ -90,7 +90,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Path
+ /// Backing field for Path.
///
protected string _Path;
///
@@ -104,7 +104,7 @@ namespace Jellyfin.Data.Entities
///
/// Required, Max length = 65535
- /// Absolute Path
+ /// Absolute Path.
///
[Required]
[MaxLength(65535)]
@@ -130,7 +130,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for NetworkPath
+ /// Backing field for NetworkPath.
///
protected string _NetworkPath;
///
@@ -169,7 +169,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Required, ConcurrenyToken
+ /// Required, ConcurrenyToken.
///
[ConcurrencyCheck]
[Required]
@@ -185,7 +185,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Required
+ /// Required.
///
[ForeignKey("Library_Id")]
public virtual Library Library { get; set; }
diff --git a/Jellyfin.Data/Entities/MediaFile.cs b/Jellyfin.Data/Entities/MediaFile.cs
index 1c14c6c874..6e6602bfae 100644
--- a/Jellyfin.Data/Entities/MediaFile.cs
+++ b/Jellyfin.Data/Entities/MediaFile.cs
@@ -28,7 +28,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
/// Relative to the LibraryRoot
///
@@ -64,7 +64,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for Id
+ /// Backing field for Id.
///
internal int _Id;
///
@@ -77,7 +77,7 @@ namespace Jellyfin.Data.Entities
partial void GetId(ref int result);
///
- /// Identity, Indexed, Required
+ /// Identity, Indexed, Required.
///
[Key]
[Required]
@@ -103,7 +103,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Path
+ /// Backing field for Path.
///
protected string _Path;
///
@@ -117,7 +117,7 @@ namespace Jellyfin.Data.Entities
///
/// Required, Max length = 65535
- /// Relative to the LibraryRoot
+ /// Relative to the LibraryRoot.
///
[Required]
[MaxLength(65535)]
@@ -143,7 +143,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Kind
+ /// Backing field for Kind.
///
protected Enums.MediaFileKind _Kind;
///
@@ -156,7 +156,7 @@ namespace Jellyfin.Data.Entities
partial void GetKind(ref Enums.MediaFileKind result);
///
- /// Required
+ /// Required.
///
[Required]
public Enums.MediaFileKind Kind
@@ -180,7 +180,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Required, ConcurrenyToken
+ /// Required, ConcurrenyToken.
///
[ConcurrencyCheck]
[Required]
diff --git a/Jellyfin.Data/Entities/MediaFileStream.cs b/Jellyfin.Data/Entities/MediaFileStream.cs
index 8819ddcd0d..823988d6c9 100644
--- a/Jellyfin.Data/Entities/MediaFileStream.cs
+++ b/Jellyfin.Data/Entities/MediaFileStream.cs
@@ -25,7 +25,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
///
///
@@ -55,7 +55,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for Id
+ /// Backing field for Id.
///
internal int _Id;
///
@@ -68,7 +68,7 @@ namespace Jellyfin.Data.Entities
partial void GetId(ref int result);
///
- /// Identity, Indexed, Required
+ /// Identity, Indexed, Required.
///
[Key]
[Required]
@@ -94,7 +94,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for StreamNumber
+ /// Backing field for StreamNumber.
///
protected int _StreamNumber;
///
@@ -107,7 +107,7 @@ namespace Jellyfin.Data.Entities
partial void GetStreamNumber(ref int result);
///
- /// Required
+ /// Required.
///
[Required]
public int StreamNumber
@@ -131,7 +131,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Required, ConcurrenyToken
+ /// Required, ConcurrenyToken.
///
[ConcurrencyCheck]
[Required]
diff --git a/Jellyfin.Data/Entities/Metadata.cs b/Jellyfin.Data/Entities/Metadata.cs
index 4e5868e754..a6ca61709a 100644
--- a/Jellyfin.Data/Entities/Metadata.cs
+++ b/Jellyfin.Data/Entities/Metadata.cs
@@ -24,7 +24,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
/// The title or name of the object
/// ISO-639-3 3-character language codes
@@ -50,7 +50,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for Id
+ /// Backing field for Id.
///
internal int _Id;
///
@@ -63,7 +63,7 @@ namespace Jellyfin.Data.Entities
partial void GetId(ref int result);
///
- /// Identity, Indexed, Required
+ /// Identity, Indexed, Required.
///
[Key]
[Required]
@@ -89,7 +89,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Title
+ /// Backing field for Title.
///
protected string _Title;
///
@@ -103,7 +103,7 @@ namespace Jellyfin.Data.Entities
///
/// Required, Max length = 1024
- /// The title or name of the object
+ /// The title or name of the object.
///
[Required]
[MaxLength(1024)]
@@ -129,7 +129,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for OriginalTitle
+ /// Backing field for OriginalTitle.
///
protected string _OriginalTitle;
///
@@ -167,7 +167,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for SortTitle
+ /// Backing field for SortTitle.
///
protected string _SortTitle;
///
@@ -205,7 +205,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Language
+ /// Backing field for Language.
///
protected string _Language;
///
@@ -219,7 +219,7 @@ namespace Jellyfin.Data.Entities
///
/// Required, Min length = 3, Max length = 3
- /// ISO-639-3 3-character language codes
+ /// ISO-639-3 3-character language codes.
///
[Required]
[MinLength(3)]
@@ -246,7 +246,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for ReleaseDate
+ /// Backing field for ReleaseDate.
///
protected DateTimeOffset? _ReleaseDate;
///
@@ -279,7 +279,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for DateAdded
+ /// Backing field for DateAdded.
///
protected DateTime _DateAdded;
///
@@ -292,7 +292,7 @@ namespace Jellyfin.Data.Entities
partial void GetDateAdded(ref DateTime result);
///
- /// Required
+ /// Required.
///
[Required]
public DateTime DateAdded
@@ -316,7 +316,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for DateModified
+ /// Backing field for DateModified.
///
protected DateTime _DateModified;
///
@@ -329,7 +329,7 @@ namespace Jellyfin.Data.Entities
partial void GetDateModified(ref DateTime result);
///
- /// Required
+ /// Required.
///
[Required]
public DateTime DateModified
@@ -353,7 +353,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Required, ConcurrenyToken
+ /// Required, ConcurrenyToken.
///
[ConcurrencyCheck]
[Required]
diff --git a/Jellyfin.Data/Entities/MetadataProvider.cs b/Jellyfin.Data/Entities/MetadataProvider.cs
index 9b09fc5a6c..8c6c4000a0 100644
--- a/Jellyfin.Data/Entities/MetadataProvider.cs
+++ b/Jellyfin.Data/Entities/MetadataProvider.cs
@@ -25,7 +25,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
///
public MetadataProvider(string name)
@@ -51,7 +51,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for Id
+ /// Backing field for Id.
///
internal int _Id;
///
@@ -64,7 +64,7 @@ namespace Jellyfin.Data.Entities
partial void GetId(ref int result);
///
- /// Identity, Indexed, Required
+ /// Identity, Indexed, Required.
///
[Key]
[Required]
@@ -90,7 +90,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Name
+ /// Backing field for Name.
///
protected string _Name;
///
@@ -129,7 +129,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Required, ConcurrenyToken
+ /// Required, ConcurrenyToken.
///
[ConcurrencyCheck]
[Required]
diff --git a/Jellyfin.Data/Entities/MetadataProviderId.cs b/Jellyfin.Data/Entities/MetadataProviderId.cs
index bcd2bad54d..67ffc4f0cd 100644
--- a/Jellyfin.Data/Entities/MetadataProviderId.cs
+++ b/Jellyfin.Data/Entities/MetadataProviderId.cs
@@ -28,7 +28,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
///
///
@@ -77,7 +77,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for Id
+ /// Backing field for Id.
///
internal int _Id;
///
@@ -90,7 +90,7 @@ namespace Jellyfin.Data.Entities
partial void GetId(ref int result);
///
- /// Identity, Indexed, Required
+ /// Identity, Indexed, Required.
///
[Key]
[Required]
@@ -116,7 +116,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for ProviderId
+ /// Backing field for ProviderId.
///
protected string _ProviderId;
///
@@ -155,7 +155,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Required, ConcurrenyToken
+ /// Required, ConcurrenyToken.
///
[ConcurrencyCheck]
[Required]
@@ -171,7 +171,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Required
+ /// Required.
///
[ForeignKey("MetadataProvider_Id")]
public virtual MetadataProvider MetadataProvider { get; set; }
diff --git a/Jellyfin.Data/Entities/Movie.cs b/Jellyfin.Data/Entities/Movie.cs
index ad2504b0dd..64326ca3a4 100644
--- a/Jellyfin.Data/Entities/Movie.cs
+++ b/Jellyfin.Data/Entities/Movie.cs
@@ -28,7 +28,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
/// This is whats gets displayed in the Urls and API requests. This could also be a string.
public Movie(Guid urlid, DateTime dateadded)
diff --git a/Jellyfin.Data/Entities/MovieMetadata.cs b/Jellyfin.Data/Entities/MovieMetadata.cs
index 6c9156a2da..cb722c015f 100644
--- a/Jellyfin.Data/Entities/MovieMetadata.cs
+++ b/Jellyfin.Data/Entities/MovieMetadata.cs
@@ -28,7 +28,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
/// The title or name of the object
/// ISO-639-3 3-character language codes
@@ -65,7 +65,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for Outline
+ /// Backing field for Outline.
///
protected string _Outline;
///
@@ -103,7 +103,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Plot
+ /// Backing field for Plot.
///
protected string _Plot;
///
@@ -141,7 +141,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Tagline
+ /// Backing field for Tagline.
///
protected string _Tagline;
///
@@ -179,7 +179,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Country
+ /// Backing field for Country.
///
protected string _Country;
///
diff --git a/Jellyfin.Data/Entities/MusicAlbum.cs b/Jellyfin.Data/Entities/MusicAlbum.cs
index e07f4357b4..9afea1fb69 100644
--- a/Jellyfin.Data/Entities/MusicAlbum.cs
+++ b/Jellyfin.Data/Entities/MusicAlbum.cs
@@ -28,7 +28,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
/// This is whats gets displayed in the Urls and API requests. This could also be a string.
public MusicAlbum(Guid urlid, DateTime dateadded)
diff --git a/Jellyfin.Data/Entities/MusicAlbumMetadata.cs b/Jellyfin.Data/Entities/MusicAlbumMetadata.cs
index cf0363b7d7..4b9f9cb626 100644
--- a/Jellyfin.Data/Entities/MusicAlbumMetadata.cs
+++ b/Jellyfin.Data/Entities/MusicAlbumMetadata.cs
@@ -28,7 +28,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
/// The title or name of the object
/// ISO-639-3 3-character language codes
@@ -65,7 +65,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for Barcode
+ /// Backing field for Barcode.
///
protected string _Barcode;
///
@@ -103,7 +103,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for LabelNumber
+ /// Backing field for LabelNumber.
///
protected string _LabelNumber;
///
@@ -141,7 +141,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Country
+ /// Backing field for Country.
///
protected string _Country;
///
diff --git a/Jellyfin.Data/Entities/Person.cs b/Jellyfin.Data/Entities/Person.cs
index 9cc568e6e6..e9b91a19e8 100644
--- a/Jellyfin.Data/Entities/Person.cs
+++ b/Jellyfin.Data/Entities/Person.cs
@@ -28,7 +28,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
///
///
@@ -59,7 +59,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for Id
+ /// Backing field for Id.
///
internal int _Id;
///
@@ -72,7 +72,7 @@ namespace Jellyfin.Data.Entities
partial void GetId(ref int result);
///
- /// Identity, Indexed, Required
+ /// Identity, Indexed, Required.
///
[Key]
[Required]
@@ -98,7 +98,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for UrlId
+ /// Backing field for UrlId.
///
protected Guid _UrlId;
///
@@ -111,7 +111,7 @@ namespace Jellyfin.Data.Entities
partial void GetUrlId(ref Guid result);
///
- /// Required
+ /// Required.
///
[Required]
public Guid UrlId
@@ -135,7 +135,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Name
+ /// Backing field for Name.
///
protected string _Name;
///
@@ -174,7 +174,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for SourceId
+ /// Backing field for SourceId.
///
protected string _SourceId;
///
@@ -212,7 +212,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for DateAdded
+ /// Backing field for DateAdded.
///
protected DateTime _DateAdded;
///
@@ -225,7 +225,7 @@ namespace Jellyfin.Data.Entities
partial void GetDateAdded(ref DateTime result);
///
- /// Required
+ /// Required.
///
[Required]
public DateTime DateAdded
@@ -249,7 +249,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for DateModified
+ /// Backing field for DateModified.
///
protected DateTime _DateModified;
///
@@ -262,7 +262,7 @@ namespace Jellyfin.Data.Entities
partial void GetDateModified(ref DateTime result);
///
- /// Required
+ /// Required.
///
[Required]
public DateTime DateModified
@@ -286,7 +286,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Required, ConcurrenyToken
+ /// Required, ConcurrenyToken.
///
[ConcurrencyCheck]
[Required]
diff --git a/Jellyfin.Data/Entities/PersonRole.cs b/Jellyfin.Data/Entities/PersonRole.cs
index e0492ea6a5..2f14044ac2 100644
--- a/Jellyfin.Data/Entities/PersonRole.cs
+++ b/Jellyfin.Data/Entities/PersonRole.cs
@@ -31,7 +31,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
///
///
@@ -65,7 +65,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for Id
+ /// Backing field for Id.
///
internal int _Id;
///
@@ -78,7 +78,7 @@ namespace Jellyfin.Data.Entities
partial void GetId(ref int result);
///
- /// Identity, Indexed, Required
+ /// Identity, Indexed, Required.
///
[Key]
[Required]
@@ -104,7 +104,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Role
+ /// Backing field for Role.
///
protected string _Role;
///
@@ -142,7 +142,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Type
+ /// Backing field for Type.
///
protected Enums.PersonRoleType _Type;
///
@@ -155,7 +155,7 @@ namespace Jellyfin.Data.Entities
partial void GetType(ref Enums.PersonRoleType result);
///
- /// Required
+ /// Required.
///
[Required]
public Enums.PersonRoleType Type
@@ -179,7 +179,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Required, ConcurrenyToken
+ /// Required, ConcurrenyToken.
///
[ConcurrencyCheck]
[Required]
@@ -195,7 +195,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Required
+ /// Required.
///
[ForeignKey("Person_Id")]
diff --git a/Jellyfin.Data/Entities/Photo.cs b/Jellyfin.Data/Entities/Photo.cs
index 226730126a..9da55fe430 100644
--- a/Jellyfin.Data/Entities/Photo.cs
+++ b/Jellyfin.Data/Entities/Photo.cs
@@ -28,7 +28,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
/// This is whats gets displayed in the Urls and API requests. This could also be a string.
public Photo(Guid urlid, DateTime dateadded)
diff --git a/Jellyfin.Data/Entities/PhotoMetadata.cs b/Jellyfin.Data/Entities/PhotoMetadata.cs
index 2bb239cdd0..5a9cf5b66a 100644
--- a/Jellyfin.Data/Entities/PhotoMetadata.cs
+++ b/Jellyfin.Data/Entities/PhotoMetadata.cs
@@ -24,7 +24,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
/// The title or name of the object
/// ISO-639-3 3-character language codes
diff --git a/Jellyfin.Data/Entities/ProviderMapping.cs b/Jellyfin.Data/Entities/ProviderMapping.cs
index e86d9737fc..4125eabcd6 100644
--- a/Jellyfin.Data/Entities/ProviderMapping.cs
+++ b/Jellyfin.Data/Entities/ProviderMapping.cs
@@ -25,7 +25,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
///
///
@@ -65,7 +65,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Identity, Indexed, Required
+ /// Identity, Indexed, Required.
///
[Key]
[Required]
@@ -97,7 +97,7 @@ namespace Jellyfin.Data.Entities
public string ProviderData { get; set; }
///
- /// Required, ConcurrenyToken
+ /// Required, ConcurrenyToken.
///
[ConcurrencyCheck]
[Required]
diff --git a/Jellyfin.Data/Entities/Rating.cs b/Jellyfin.Data/Entities/Rating.cs
index 490090bfa6..2c27dbd496 100644
--- a/Jellyfin.Data/Entities/Rating.cs
+++ b/Jellyfin.Data/Entities/Rating.cs
@@ -25,7 +25,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
///
///
@@ -55,7 +55,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for Id
+ /// Backing field for Id.
///
internal int _Id;
///
@@ -68,7 +68,7 @@ namespace Jellyfin.Data.Entities
partial void GetId(ref int result);
///
- /// Identity, Indexed, Required
+ /// Identity, Indexed, Required.
///
[Key]
[Required]
@@ -94,7 +94,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Value
+ /// Backing field for Value.
///
protected double _Value;
///
@@ -107,7 +107,7 @@ namespace Jellyfin.Data.Entities
partial void GetValue(ref double result);
///
- /// Required
+ /// Required.
///
[Required]
public double Value
@@ -131,7 +131,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Votes
+ /// Backing field for Votes.
///
protected int? _Votes;
///
@@ -164,7 +164,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Required, ConcurrenyToken
+ /// Required, ConcurrenyToken.
///
[ConcurrencyCheck]
[Required]
diff --git a/Jellyfin.Data/Entities/RatingSource.cs b/Jellyfin.Data/Entities/RatingSource.cs
index cf8af2270c..2a4bed7ecc 100644
--- a/Jellyfin.Data/Entities/RatingSource.cs
+++ b/Jellyfin.Data/Entities/RatingSource.cs
@@ -5,7 +5,7 @@ using System.ComponentModel.DataAnnotations.Schema;
namespace Jellyfin.Data.Entities
{
///
- /// This is the entity to store review ratings, not age ratings
+ /// This is the entity to store review ratings, not age ratings.
///
public partial class RatingSource
{
@@ -28,7 +28,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
///
///
@@ -62,7 +62,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for Id
+ /// Backing field for Id.
///
internal int _Id;
///
@@ -75,7 +75,7 @@ namespace Jellyfin.Data.Entities
partial void GetId(ref int result);
///
- /// Identity, Indexed, Required
+ /// Identity, Indexed, Required.
///
[Key]
[Required]
@@ -101,7 +101,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Name
+ /// Backing field for Name.
///
protected string _Name;
///
@@ -139,7 +139,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for MaximumValue
+ /// Backing field for MaximumValue.
///
protected double _MaximumValue;
///
@@ -152,7 +152,7 @@ namespace Jellyfin.Data.Entities
partial void GetMaximumValue(ref double result);
///
- /// Required
+ /// Required.
///
[Required]
public double MaximumValue
@@ -176,7 +176,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for MinimumValue
+ /// Backing field for MinimumValue.
///
protected double _MinimumValue;
///
@@ -189,7 +189,7 @@ namespace Jellyfin.Data.Entities
partial void GetMinimumValue(ref double result);
///
- /// Required
+ /// Required.
///
[Required]
public double MinimumValue
@@ -213,7 +213,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Required, ConcurrenyToken
+ /// Required, ConcurrenyToken.
///
[ConcurrencyCheck]
[Required]
diff --git a/Jellyfin.Data/Entities/Release.cs b/Jellyfin.Data/Entities/Release.cs
index 6be524a0f9..098a78ca04 100644
--- a/Jellyfin.Data/Entities/Release.cs
+++ b/Jellyfin.Data/Entities/Release.cs
@@ -29,7 +29,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
///
///
@@ -87,7 +87,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for Id
+ /// Backing field for Id.
///
internal int _Id;
///
@@ -100,7 +100,7 @@ namespace Jellyfin.Data.Entities
partial void GetId(ref int result);
///
- /// Identity, Indexed, Required
+ /// Identity, Indexed, Required.
///
[Key]
[Required]
@@ -126,7 +126,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Name
+ /// Backing field for Name.
///
protected string _Name;
///
@@ -165,7 +165,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Required, ConcurrenyToken
+ /// Required, ConcurrenyToken.
///
[ConcurrencyCheck]
[Required]
diff --git a/Jellyfin.Data/Entities/Season.cs b/Jellyfin.Data/Entities/Season.cs
index 631adb12cb..03b3805cfb 100644
--- a/Jellyfin.Data/Entities/Season.cs
+++ b/Jellyfin.Data/Entities/Season.cs
@@ -31,7 +31,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
/// This is whats gets displayed in the Urls and API requests. This could also be a string.
///
@@ -66,7 +66,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for SeasonNumber
+ /// Backing field for SeasonNumber.
///
protected int? _SeasonNumber;
///
diff --git a/Jellyfin.Data/Entities/SeasonMetadata.cs b/Jellyfin.Data/Entities/SeasonMetadata.cs
index 2efbf6467c..35ff6e89ab 100644
--- a/Jellyfin.Data/Entities/SeasonMetadata.cs
+++ b/Jellyfin.Data/Entities/SeasonMetadata.cs
@@ -25,7 +25,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
/// The title or name of the object
/// ISO-639-3 3-character language codes
@@ -61,7 +61,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for Outline
+ /// Backing field for Outline.
///
protected string _Outline;
///
diff --git a/Jellyfin.Data/Entities/Series.cs b/Jellyfin.Data/Entities/Series.cs
index 386d3a8acd..69b1854ab3 100644
--- a/Jellyfin.Data/Entities/Series.cs
+++ b/Jellyfin.Data/Entities/Series.cs
@@ -20,7 +20,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
/// This is whats gets displayed in the Urls and API requests. This could also be a string.
public Series(Guid urlid, DateTime dateadded)
@@ -47,7 +47,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for AirsDayOfWeek
+ /// Backing field for AirsDayOfWeek.
///
protected DayOfWeek? _AirsDayOfWeek;
///
@@ -80,7 +80,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for AirsTime
+ /// Backing field for AirsTime.
///
protected DateTimeOffset? _AirsTime;
///
@@ -93,7 +93,7 @@ namespace Jellyfin.Data.Entities
partial void GetAirsTime(ref DateTimeOffset? result);
///
- /// The time the show airs, ignore the date portion
+ /// The time the show airs, ignore the date portion.
///
public DateTimeOffset? AirsTime
{
@@ -116,7 +116,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for FirstAired
+ /// Backing field for FirstAired.
///
protected DateTimeOffset? _FirstAired;
///
diff --git a/Jellyfin.Data/Entities/SeriesMetadata.cs b/Jellyfin.Data/Entities/SeriesMetadata.cs
index f49c5a3b22..e72de07fd4 100644
--- a/Jellyfin.Data/Entities/SeriesMetadata.cs
+++ b/Jellyfin.Data/Entities/SeriesMetadata.cs
@@ -28,7 +28,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
/// The title or name of the object
/// ISO-639-3 3-character language codes
@@ -65,7 +65,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for Outline
+ /// Backing field for Outline.
///
protected string _Outline;
///
@@ -103,7 +103,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Plot
+ /// Backing field for Plot.
///
protected string _Plot;
///
@@ -141,7 +141,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Tagline
+ /// Backing field for Tagline.
///
protected string _Tagline;
///
@@ -179,7 +179,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Backing field for Country
+ /// Backing field for Country.
///
protected string _Country;
///
diff --git a/Jellyfin.Data/Entities/Track.cs b/Jellyfin.Data/Entities/Track.cs
index fc9dfb3707..59a9eb4af2 100644
--- a/Jellyfin.Data/Entities/Track.cs
+++ b/Jellyfin.Data/Entities/Track.cs
@@ -31,7 +31,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
/// This is whats gets displayed in the Urls and API requests. This could also be a string.
///
@@ -66,7 +66,7 @@ namespace Jellyfin.Data.Entities
*************************************************************************/
///
- /// Backing field for TrackNumber
+ /// Backing field for TrackNumber.
///
protected int? _TrackNumber;
///
diff --git a/Jellyfin.Data/Entities/TrackMetadata.cs b/Jellyfin.Data/Entities/TrackMetadata.cs
index 7b99c06837..05bb953f8e 100644
--- a/Jellyfin.Data/Entities/TrackMetadata.cs
+++ b/Jellyfin.Data/Entities/TrackMetadata.cs
@@ -24,7 +24,7 @@ namespace Jellyfin.Data.Entities
}
///
- /// Public constructor with required data
+ /// Public constructor with required data.
///
/// The title or name of the object
/// ISO-639-3 3-character language codes
diff --git a/Jellyfin.Data/Enums/PreferenceKind.cs b/Jellyfin.Data/Enums/PreferenceKind.cs
index de8eecc734..a54d789afb 100644
--- a/Jellyfin.Data/Enums/PreferenceKind.cs
+++ b/Jellyfin.Data/Enums/PreferenceKind.cs
@@ -26,7 +26,7 @@ namespace Jellyfin.Data.Enums
EnabledDevices = 3,
///
- /// A list of enabled channels
+ /// A list of enabled channels.
///
EnabledChannels = 4,
diff --git a/Jellyfin.Server.Implementations/JellyfinDb.cs b/Jellyfin.Server.Implementations/JellyfinDb.cs
index d77cd432bf..53120a763e 100644
--- a/Jellyfin.Server.Implementations/JellyfinDb.cs
+++ b/Jellyfin.Server.Implementations/JellyfinDb.cs
@@ -101,7 +101,7 @@ namespace Jellyfin.Server.Implementations
///
/// Repository for global::Jellyfin.Data.Entities.RatingSource - This is the entity to
- /// store review ratings, not age ratings
+ /// store review ratings, not age ratings.
///
public virtual DbSet RatingSources { get; set; }
diff --git a/MediaBrowser.Api/ApiEntryPoint.cs b/MediaBrowser.Api/ApiEntryPoint.cs
index 9e651fb197..b041effb2e 100644
--- a/MediaBrowser.Api/ApiEntryPoint.cs
+++ b/MediaBrowser.Api/ApiEntryPoint.cs
@@ -43,7 +43,7 @@ namespace MediaBrowser.Api
private readonly IMediaSourceManager _mediaSourceManager;
///
- /// The active transcoding jobs
+ /// The active transcoding jobs.
///
private readonly List _activeTranscodingJobs = new List();
@@ -293,7 +293,7 @@ namespace MediaBrowser.Api
///
///
- /// The progressive
+ /// The progressive.
///
/// Called when [transcode failed to start].
///
diff --git a/MediaBrowser.Api/BaseApiService.cs b/MediaBrowser.Api/BaseApiService.cs
index a91a9b580c..63a31a7452 100644
--- a/MediaBrowser.Api/BaseApiService.cs
+++ b/MediaBrowser.Api/BaseApiService.cs
@@ -17,7 +17,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api
{
///
- /// Class BaseApiService
+ /// Class BaseApiService.
///
public abstract class BaseApiService : IService, IRequiresRequest
{
diff --git a/MediaBrowser.Api/ChannelService.cs b/MediaBrowser.Api/ChannelService.cs
index 3cab9fb66f..8c336b1c9d 100644
--- a/MediaBrowser.Api/ChannelService.cs
+++ b/MediaBrowser.Api/ChannelService.cs
@@ -36,7 +36,7 @@ namespace MediaBrowser.Api
public int? StartIndex { get; set; }
///
- /// The maximum number of items to return
+ /// The maximum number of items to return.
///
/// The limit.
[ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
@@ -90,7 +90,7 @@ namespace MediaBrowser.Api
public int? StartIndex { get; set; }
///
- /// The maximum number of items to return
+ /// The maximum number of items to return.
///
/// The limit.
[ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
@@ -149,7 +149,7 @@ namespace MediaBrowser.Api
public int? StartIndex { get; set; }
///
- /// The maximum number of items to return
+ /// The maximum number of items to return.
///
/// The limit.
[ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
diff --git a/MediaBrowser.Api/ConfigurationService.cs b/MediaBrowser.Api/ConfigurationService.cs
index 3ad51de8de..19369cccae 100644
--- a/MediaBrowser.Api/ConfigurationService.cs
+++ b/MediaBrowser.Api/ConfigurationService.cs
@@ -11,7 +11,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api
{
///
- /// Class GetConfiguration
+ /// Class GetConfiguration.
///
[Route("/System/Configuration", "GET", Summary = "Gets application configuration")]
[Authenticated]
@@ -28,7 +28,7 @@ namespace MediaBrowser.Api
}
///
- /// Class UpdateConfiguration
+ /// Class UpdateConfiguration.
///
[Route("/System/Configuration", "POST", Summary = "Updates application configuration")]
[Authenticated(Roles = "Admin")]
@@ -65,12 +65,12 @@ namespace MediaBrowser.Api
public class ConfigurationService : BaseApiService
{
///
- /// The _json serializer
+ /// The _json serializer.
///
private readonly IJsonSerializer _jsonSerializer;
///
- /// The _configuration manager
+ /// The _configuration manager.
///
private readonly IServerConfigurationManager _configurationManager;
diff --git a/MediaBrowser.Api/DisplayPreferencesService.cs b/MediaBrowser.Api/DisplayPreferencesService.cs
index 62c4ff43f2..c3ed40ad3c 100644
--- a/MediaBrowser.Api/DisplayPreferencesService.cs
+++ b/MediaBrowser.Api/DisplayPreferencesService.cs
@@ -10,7 +10,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api
{
///
- /// Class UpdateDisplayPreferences
+ /// Class UpdateDisplayPreferences.
///
[Route("/DisplayPreferences/{DisplayPreferencesId}", "POST", Summary = "Updates a user's display preferences for an item")]
public class UpdateDisplayPreferences : DisplayPreferences, IReturnVoid
@@ -44,17 +44,17 @@ namespace MediaBrowser.Api
}
///
- /// Class DisplayPreferencesService
+ /// Class DisplayPreferencesService.
///
[Authenticated]
public class DisplayPreferencesService : BaseApiService
{
///
- /// The _display preferences manager
+ /// The _display preferences manager.
///
private readonly IDisplayPreferencesRepository _displayPreferencesManager;
///
- /// The _json serializer
+ /// The _json serializer.
///
private readonly IJsonSerializer _jsonSerializer;
diff --git a/MediaBrowser.Api/EnvironmentService.cs b/MediaBrowser.Api/EnvironmentService.cs
index 765774dee8..720a710258 100644
--- a/MediaBrowser.Api/EnvironmentService.cs
+++ b/MediaBrowser.Api/EnvironmentService.cs
@@ -12,7 +12,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api
{
///
- /// Class GetDirectoryContents
+ /// Class GetDirectoryContents.
///
[Route("/Environment/DirectoryContents", "GET", Summary = "Gets the contents of a given directory in the file system")]
public class GetDirectoryContents : IReturn>
@@ -67,7 +67,7 @@ namespace MediaBrowser.Api
}
///
- /// Class GetDrives
+ /// Class GetDrives.
///
[Route("/Environment/Drives", "GET", Summary = "Gets available drives from the server's file system")]
public class GetDrives : IReturn>
@@ -75,7 +75,7 @@ namespace MediaBrowser.Api
}
///
- /// Class GetNetworkComputers
+ /// Class GetNetworkComputers.
///
[Route("/Environment/NetworkDevices", "GET", Summary = "Gets a list of devices on the network")]
public class GetNetworkDevices : IReturn>
@@ -104,7 +104,7 @@ namespace MediaBrowser.Api
}
///
- /// Class EnvironmentService
+ /// Class EnvironmentService.
///
[Authenticated(Roles = "Admin", AllowBeforeStartupWizard = true)]
public class EnvironmentService : BaseApiService
@@ -113,7 +113,7 @@ namespace MediaBrowser.Api
private const string UncSeparatorString = "\\";
///
- /// The _network manager
+ /// The _network manager.
///
private readonly INetworkManager _networkManager;
private readonly IFileSystem _fileSystem;
@@ -221,7 +221,7 @@ namespace MediaBrowser.Api
}
///
- /// Gets the list that is returned when an empty path is supplied
+ /// Gets the list that is returned when an empty path is supplied.
///
/// IEnumerable{FileSystemEntryInfo}.
private IEnumerable GetDrives()
diff --git a/MediaBrowser.Api/IHasItemFields.cs b/MediaBrowser.Api/IHasItemFields.cs
index 6359de77dc..ad4f1b4891 100644
--- a/MediaBrowser.Api/IHasItemFields.cs
+++ b/MediaBrowser.Api/IHasItemFields.cs
@@ -5,7 +5,7 @@ using MediaBrowser.Model.Querying;
namespace MediaBrowser.Api
{
///
- /// Interface IHasItemFields
+ /// Interface IHasItemFields.
///
public interface IHasItemFields
{
diff --git a/MediaBrowser.Api/Images/ImageByNameService.cs b/MediaBrowser.Api/Images/ImageByNameService.cs
index 45b7d0c100..2d405ac3d8 100644
--- a/MediaBrowser.Api/Images/ImageByNameService.cs
+++ b/MediaBrowser.Api/Images/ImageByNameService.cs
@@ -16,7 +16,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api.Images
{
///
- /// Class GetGeneralImage
+ /// Class GetGeneralImage.
///
[Route("/Images/General/{Name}/{Type}", "GET", Summary = "Gets a general image by name")]
public class GetGeneralImage
@@ -33,7 +33,7 @@ namespace MediaBrowser.Api.Images
}
///
- /// Class GetRatingImage
+ /// Class GetRatingImage.
///
[Route("/Images/Ratings/{Theme}/{Name}", "GET", Summary = "Gets a rating image by name")]
public class GetRatingImage
@@ -54,7 +54,7 @@ namespace MediaBrowser.Api.Images
}
///
- /// Class GetMediaInfoImage
+ /// Class GetMediaInfoImage.
///
[Route("/Images/MediaInfo/{Theme}/{Name}", "GET", Summary = "Gets a media info image by name")]
public class GetMediaInfoImage
@@ -93,12 +93,12 @@ namespace MediaBrowser.Api.Images
}
///
- /// Class ImageByNameService
+ /// Class ImageByNameService.
///
public class ImageByNameService : BaseApiService
{
///
- /// The _app paths
+ /// The _app paths.
///
private readonly IServerApplicationPaths _appPaths;
diff --git a/MediaBrowser.Api/Images/ImageRequest.cs b/MediaBrowser.Api/Images/ImageRequest.cs
index 71ff09b63f..0f3455548d 100644
--- a/MediaBrowser.Api/Images/ImageRequest.cs
+++ b/MediaBrowser.Api/Images/ImageRequest.cs
@@ -4,30 +4,30 @@ using MediaBrowser.Model.Services;
namespace MediaBrowser.Api.Images
{
///
- /// Class ImageRequest
+ /// Class ImageRequest.
///
public class ImageRequest : DeleteImageRequest
{
///
- /// The max width
+ /// The max width.
///
[ApiMember(Name = "MaxWidth", Description = "The maximum image width to return.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int? MaxWidth { get; set; }
///
- /// The max height
+ /// The max height.
///
[ApiMember(Name = "MaxHeight", Description = "The maximum image height to return.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int? MaxHeight { get; set; }
///
- /// The width
+ /// The width.
///
[ApiMember(Name = "Width", Description = "The fixed image width to return.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int? Width { get; set; }
///
- /// The height
+ /// The height.
///
[ApiMember(Name = "Height", Description = "The fixed image height to return.", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int? Height { get; set; }
@@ -79,7 +79,7 @@ namespace MediaBrowser.Api.Images
}
///
- /// Class DeleteImageRequest
+ /// Class DeleteImageRequest.
///
public class DeleteImageRequest
{
diff --git a/MediaBrowser.Api/Images/ImageService.cs b/MediaBrowser.Api/Images/ImageService.cs
index 6f2956c5d1..8426a9a4f8 100644
--- a/MediaBrowser.Api/Images/ImageService.cs
+++ b/MediaBrowser.Api/Images/ImageService.cs
@@ -58,7 +58,7 @@ namespace MediaBrowser.Api.Images
}
///
- /// Class UpdateItemImageIndex
+ /// Class UpdateItemImageIndex.
///
[Route("/Items/{Id}/Images/{Type}/{Index}/Index", "POST", Summary = "Updates the index for an item image")]
[Authenticated(Roles = "admin")]
@@ -94,7 +94,7 @@ namespace MediaBrowser.Api.Images
}
///
- /// Class GetPersonImage
+ /// Class GetPersonImage.
///
[Route("/Artists/{Name}/Images/{Type}", "GET")]
[Route("/Artists/{Name}/Images/{Type}/{Index}", "GET")]
@@ -131,7 +131,7 @@ namespace MediaBrowser.Api.Images
}
///
- /// Class GetUserImage
+ /// Class GetUserImage.
///
[Route("/Users/{Id}/Images/{Type}", "GET")]
[Route("/Users/{Id}/Images/{Type}/{Index}", "GET")]
@@ -148,7 +148,7 @@ namespace MediaBrowser.Api.Images
}
///
- /// Class DeleteItemImage
+ /// Class DeleteItemImage.
///
[Route("/Items/{Id}/Images/{Type}", "DELETE")]
[Route("/Items/{Id}/Images/{Type}/{Index}", "DELETE")]
@@ -164,7 +164,7 @@ namespace MediaBrowser.Api.Images
}
///
- /// Class DeleteUserImage
+ /// Class DeleteUserImage.
///
[Route("/Users/{Id}/Images/{Type}", "DELETE")]
[Route("/Users/{Id}/Images/{Type}/{Index}", "DELETE")]
@@ -180,7 +180,7 @@ namespace MediaBrowser.Api.Images
}
///
- /// Class PostUserImage
+ /// Class PostUserImage.
///
[Route("/Users/{Id}/Images/{Type}", "POST")]
[Route("/Users/{Id}/Images/{Type}/{Index}", "POST")]
@@ -195,14 +195,14 @@ namespace MediaBrowser.Api.Images
public string Id { get; set; }
///
- /// The raw Http Request Input Stream
+ /// The raw Http Request Input Stream.
///
/// The request stream.
public Stream RequestStream { get; set; }
}
///
- /// Class PostItemImage
+ /// Class PostItemImage.
///
[Route("/Items/{Id}/Images/{Type}", "POST")]
[Route("/Items/{Id}/Images/{Type}/{Index}", "POST")]
@@ -217,14 +217,14 @@ namespace MediaBrowser.Api.Images
public string Id { get; set; }
///
- /// The raw Http Request Input Stream
+ /// The raw Http Request Input Stream.
///
/// The request stream.
public Stream RequestStream { get; set; }
}
///
- /// Class ImageService
+ /// Class ImageService.
///
public class ImageService : BaseApiService
{
diff --git a/MediaBrowser.Api/Images/RemoteImageService.cs b/MediaBrowser.Api/Images/RemoteImageService.cs
index 2633a5d3c6..86464b4b9a 100644
--- a/MediaBrowser.Api/Images/RemoteImageService.cs
+++ b/MediaBrowser.Api/Images/RemoteImageService.cs
@@ -33,7 +33,7 @@ namespace MediaBrowser.Api.Images
public int? StartIndex { get; set; }
///
- /// The maximum number of items to return
+ /// The maximum number of items to return.
///
/// The limit.
[ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
diff --git a/MediaBrowser.Api/Library/LibraryService.cs b/MediaBrowser.Api/Library/LibraryService.cs
index 46bc43605a..6555864dc5 100644
--- a/MediaBrowser.Api/Library/LibraryService.cs
+++ b/MediaBrowser.Api/Library/LibraryService.cs
@@ -49,7 +49,7 @@ namespace MediaBrowser.Api.Library
}
///
- /// Class GetCriticReviews
+ /// Class GetCriticReviews.
///
[Route("/Items/{Id}/CriticReviews", "GET", Summary = "Gets critic reviews for an item")]
[Authenticated]
@@ -70,7 +70,7 @@ namespace MediaBrowser.Api.Library
public int? StartIndex { get; set; }
///
- /// The maximum number of items to return
+ /// The maximum number of items to return.
///
/// The limit.
[ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
@@ -78,7 +78,7 @@ namespace MediaBrowser.Api.Library
}
///
- /// Class GetThemeSongs
+ /// Class GetThemeSongs.
///
[Route("/Items/{Id}/ThemeSongs", "GET", Summary = "Gets theme songs for an item")]
[Authenticated]
@@ -103,7 +103,7 @@ namespace MediaBrowser.Api.Library
}
///
- /// Class GetThemeVideos
+ /// Class GetThemeVideos.
///
[Route("/Items/{Id}/ThemeVideos", "GET", Summary = "Gets theme videos for an item")]
[Authenticated]
@@ -128,7 +128,7 @@ namespace MediaBrowser.Api.Library
}
///
- /// Class GetThemeVideos
+ /// Class GetThemeVideos.
///
[Route("/Items/{Id}/ThemeMedia", "GET", Summary = "Gets theme videos and songs for an item")]
[Authenticated]
@@ -205,7 +205,7 @@ namespace MediaBrowser.Api.Library
}
///
- /// Class GetPhyscialPaths
+ /// Class GetPhyscialPaths.
///
[Route("/Library/PhysicalPaths", "GET", Summary = "Gets a list of physical paths from virtual folders")]
[Authenticated(Roles = "Admin")]
@@ -321,7 +321,7 @@ namespace MediaBrowser.Api.Library
}
///
- /// Class LibraryService
+ /// Class LibraryService.
///
public class LibraryService : BaseApiService
{
diff --git a/MediaBrowser.Api/Library/LibraryStructureService.cs b/MediaBrowser.Api/Library/LibraryStructureService.cs
index 1e300814f6..b69550ed1a 100644
--- a/MediaBrowser.Api/Library/LibraryStructureService.cs
+++ b/MediaBrowser.Api/Library/LibraryStructureService.cs
@@ -19,7 +19,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api.Library
{
///
- /// Class GetDefaultVirtualFolders
+ /// Class GetDefaultVirtualFolders.
///
[Route("/Library/VirtualFolders", "GET")]
public class GetVirtualFolders : IReturn>
@@ -166,18 +166,18 @@ namespace MediaBrowser.Api.Library
}
///
- /// Class LibraryStructureService
+ /// Class LibraryStructureService.
///
[Authenticated(Roles = "Admin", AllowBeforeStartupWizard = true)]
public class LibraryStructureService : BaseApiService
{
///
- /// The _app paths
+ /// The _app paths.
///
private readonly IServerApplicationPaths _appPaths;
///
- /// The _library manager
+ /// The _library manager.
///
private readonly ILibraryManager _libraryManager;
private readonly ILibraryMonitor _libraryMonitor;
diff --git a/MediaBrowser.Api/LiveTv/LiveTvService.cs b/MediaBrowser.Api/LiveTv/LiveTvService.cs
index 84141e9ae4..830372dd8e 100644
--- a/MediaBrowser.Api/LiveTv/LiveTvService.cs
+++ b/MediaBrowser.Api/LiveTv/LiveTvService.cs
@@ -31,7 +31,7 @@ using Microsoft.Net.Http.Headers;
namespace MediaBrowser.Api.LiveTv
{
///
- /// This is insecure right now to avoid windows phone refactoring
+ /// This is insecure right now to avoid windows phone refactoring.
///
[Route("/LiveTv/Info", "GET", Summary = "Gets available live tv services.")]
[Authenticated]
@@ -72,7 +72,7 @@ namespace MediaBrowser.Api.LiveTv
public bool? IsSports { get; set; }
///
- /// The maximum number of items to return
+ /// The maximum number of items to return.
///
/// The limit.
[ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
@@ -100,7 +100,7 @@ namespace MediaBrowser.Api.LiveTv
public string EnableImageTypes { get; set; }
///
- /// Fields to return within the items, in addition to basic information
+ /// Fields to return within the items, in addition to basic information.
///
/// The fields.
[ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
@@ -188,7 +188,7 @@ namespace MediaBrowser.Api.LiveTv
public string EnableImageTypes { get; set; }
///
- /// Fields to return within the items, in addition to basic information
+ /// Fields to return within the items, in addition to basic information.
///
/// The fields.
[ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
@@ -255,7 +255,7 @@ namespace MediaBrowser.Api.LiveTv
public string EnableImageTypes { get; set; }
///
- /// Fields to return within the items, in addition to basic information
+ /// Fields to return within the items, in addition to basic information.
///
/// The fields.
[ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
@@ -417,7 +417,7 @@ namespace MediaBrowser.Api.LiveTv
public Guid LibrarySeriesId { get; set; }
///
- /// Fields to return within the items, in addition to basic information
+ /// Fields to return within the items, in addition to basic information.
///
/// The fields.
[ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
@@ -480,7 +480,7 @@ namespace MediaBrowser.Api.LiveTv
public string GenreIds { get; set; }
///
- /// Fields to return within the items, in addition to basic information
+ /// Fields to return within the items, in addition to basic information.
///
/// The fields.
[ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
diff --git a/MediaBrowser.Api/LocalizationService.cs b/MediaBrowser.Api/LocalizationService.cs
index 6a69d26568..d6b5f51950 100644
--- a/MediaBrowser.Api/LocalizationService.cs
+++ b/MediaBrowser.Api/LocalizationService.cs
@@ -8,7 +8,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api
{
///
- /// Class GetCultures
+ /// Class GetCultures.
///
[Route("/Localization/Cultures", "GET", Summary = "Gets known cultures")]
public class GetCultures : IReturn
@@ -16,7 +16,7 @@ namespace MediaBrowser.Api
}
///
- /// Class GetCountries
+ /// Class GetCountries.
///
[Route("/Localization/Countries", "GET", Summary = "Gets known countries")]
public class GetCountries : IReturn
@@ -24,7 +24,7 @@ namespace MediaBrowser.Api
}
///
- /// Class ParentalRatings
+ /// Class ParentalRatings.
///
[Route("/Localization/ParentalRatings", "GET", Summary = "Gets known parental ratings")]
public class GetParentalRatings : IReturn
@@ -32,7 +32,7 @@ namespace MediaBrowser.Api
}
///
- /// Class ParentalRatings
+ /// Class ParentalRatings.
///
[Route("/Localization/Options", "GET", Summary = "Gets localization options")]
public class GetLocalizationOptions : IReturn
@@ -40,13 +40,13 @@ namespace MediaBrowser.Api
}
///
- /// Class CulturesService
+ /// Class CulturesService.
///
[Authenticated(AllowBeforeStartupWizard = true)]
public class LocalizationService : BaseApiService
{
///
- /// The _localization
+ /// The _localization.
///
private readonly ILocalizationManager _localization;
diff --git a/MediaBrowser.Api/Movies/MoviesService.cs b/MediaBrowser.Api/Movies/MoviesService.cs
index 88ca0aa23c..34cccffa38 100644
--- a/MediaBrowser.Api/Movies/MoviesService.cs
+++ b/MediaBrowser.Api/Movies/MoviesService.cs
@@ -65,13 +65,13 @@ namespace MediaBrowser.Api.Movies
}
///
- /// Class MoviesService
+ /// Class MoviesService.
///
[Authenticated]
public class MoviesService : BaseApiService
{
///
- /// The _user manager
+ /// The _user manager.
///
private readonly IUserManager _userManager;
diff --git a/MediaBrowser.Api/Movies/TrailersService.cs b/MediaBrowser.Api/Movies/TrailersService.cs
index a7758b100e..ca9f9d03b2 100644
--- a/MediaBrowser.Api/Movies/TrailersService.cs
+++ b/MediaBrowser.Api/Movies/TrailersService.cs
@@ -18,18 +18,18 @@ namespace MediaBrowser.Api.Movies
}
///
- /// Class TrailersService
+ /// Class TrailersService.
///
[Authenticated]
public class TrailersService : BaseApiService
{
///
- /// The _user manager
+ /// The _user manager.
///
private readonly IUserManager _userManager;
///
- /// The _library manager
+ /// The _library manager.
///
private readonly ILibraryManager _libraryManager;
diff --git a/MediaBrowser.Api/Music/AlbumsService.cs b/MediaBrowser.Api/Music/AlbumsService.cs
index f257d10141..74d3cce12a 100644
--- a/MediaBrowser.Api/Music/AlbumsService.cs
+++ b/MediaBrowser.Api/Music/AlbumsService.cs
@@ -27,16 +27,16 @@ namespace MediaBrowser.Api.Music
public class AlbumsService : BaseApiService
{
///
- /// The _user manager
+ /// The _user manager.
///
private readonly IUserManager _userManager;
///
- /// The _user data repository
+ /// The _user data repository.
///
private readonly IUserDataManager _userDataRepository;
///
- /// The _library manager
+ /// The _library manager.
///
private readonly ILibraryManager _libraryManager;
private readonly IItemRepository _itemRepo;
diff --git a/MediaBrowser.Api/PackageService.cs b/MediaBrowser.Api/PackageService.cs
index 444354a992..a63d06ad5f 100644
--- a/MediaBrowser.Api/PackageService.cs
+++ b/MediaBrowser.Api/PackageService.cs
@@ -14,7 +14,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api
{
///
- /// Class GetPackage
+ /// Class GetPackage.
///
[Route("/Packages/{Name}", "GET", Summary = "Gets a package, by name or assembly guid")]
[Authenticated]
@@ -36,7 +36,7 @@ namespace MediaBrowser.Api
}
///
- /// Class GetPackages
+ /// Class GetPackages.
///
[Route("/Packages", "GET", Summary = "Gets available packages")]
[Authenticated]
@@ -45,7 +45,7 @@ namespace MediaBrowser.Api
}
///
- /// Class InstallPackage
+ /// Class InstallPackage.
///
[Route("/Packages/Installed/{Name}", "POST", Summary = "Installs a package")]
[Authenticated(Roles = "Admin")]
@@ -74,7 +74,7 @@ namespace MediaBrowser.Api
}
///
- /// Class CancelPackageInstallation
+ /// Class CancelPackageInstallation.
///
[Route("/Packages/Installing/{Id}", "DELETE", Summary = "Cancels a package installation")]
[Authenticated(Roles = "Admin")]
@@ -89,7 +89,7 @@ namespace MediaBrowser.Api
}
///
- /// Class PackageService
+ /// Class PackageService.
///
public class PackageService : BaseApiService
{
diff --git a/MediaBrowser.Api/Playback/BaseStreamingService.cs b/MediaBrowser.Api/Playback/BaseStreamingService.cs
index 009a957b65..84ed5dcac4 100644
--- a/MediaBrowser.Api/Playback/BaseStreamingService.cs
+++ b/MediaBrowser.Api/Playback/BaseStreamingService.cs
@@ -28,7 +28,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api.Playback
{
///
- /// Class BaseStreamingService
+ /// Class BaseStreamingService.
///
public abstract class BaseStreamingService : BaseApiService
{
diff --git a/MediaBrowser.Api/Playback/Hls/BaseHlsService.cs b/MediaBrowser.Api/Playback/Hls/BaseHlsService.cs
index 5a2bf2ea3d..418cd92b3d 100644
--- a/MediaBrowser.Api/Playback/Hls/BaseHlsService.cs
+++ b/MediaBrowser.Api/Playback/Hls/BaseHlsService.cs
@@ -20,7 +20,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api.Playback.Hls
{
///
- /// Class BaseHlsService
+ /// Class BaseHlsService.
///
public abstract class BaseHlsService : BaseStreamingService
{
diff --git a/MediaBrowser.Api/Playback/Hls/HlsSegmentService.cs b/MediaBrowser.Api/Playback/Hls/HlsSegmentService.cs
index 87ccde2e04..8a3d00283f 100644
--- a/MediaBrowser.Api/Playback/Hls/HlsSegmentService.cs
+++ b/MediaBrowser.Api/Playback/Hls/HlsSegmentService.cs
@@ -13,7 +13,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api.Playback.Hls
{
///
- /// Class GetHlsAudioSegment
+ /// Class GetHlsAudioSegment.
///
// Can't require authentication just yet due to seeing some requests come from Chrome without full query string
//[Authenticated]
@@ -37,7 +37,7 @@ namespace MediaBrowser.Api.Playback.Hls
}
///
- /// Class GetHlsVideoSegment
+ /// Class GetHlsVideoSegment.
///
[Route("/Videos/{Id}/hls/{PlaylistId}/stream.m3u8", "GET")]
[Authenticated]
@@ -66,7 +66,7 @@ namespace MediaBrowser.Api.Playback.Hls
}
///
- /// Class GetHlsVideoSegment
+ /// Class GetHlsVideoSegment.
///
// Can't require authentication just yet due to seeing some requests come from Chrome without full query string
//[Authenticated]
diff --git a/MediaBrowser.Api/Playback/Hls/VideoHlsService.cs b/MediaBrowser.Api/Playback/Hls/VideoHlsService.cs
index aefb3f019b..9562f9953a 100644
--- a/MediaBrowser.Api/Playback/Hls/VideoHlsService.cs
+++ b/MediaBrowser.Api/Playback/Hls/VideoHlsService.cs
@@ -22,7 +22,7 @@ namespace MediaBrowser.Api.Playback.Hls
}
///
- /// Class VideoHlsService
+ /// Class VideoHlsService.
///
[Authenticated]
public class VideoHlsService : BaseHlsService
diff --git a/MediaBrowser.Api/Playback/Progressive/AudioService.cs b/MediaBrowser.Api/Playback/Progressive/AudioService.cs
index 34c7986ca5..d51787df27 100644
--- a/MediaBrowser.Api/Playback/Progressive/AudioService.cs
+++ b/MediaBrowser.Api/Playback/Progressive/AudioService.cs
@@ -15,7 +15,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api.Playback.Progressive
{
///
- /// Class GetAudioStream
+ /// Class GetAudioStream.
///
[Route("/Audio/{Id}/stream.{Container}", "GET", Summary = "Gets an audio stream")]
[Route("/Audio/{Id}/stream", "GET", Summary = "Gets an audio stream")]
@@ -26,7 +26,7 @@ namespace MediaBrowser.Api.Playback.Progressive
}
///
- /// Class AudioService
+ /// Class AudioService.
///
// TODO: In order to autheneticate this in the future, Dlna playback will require updating
//[Authenticated]
diff --git a/MediaBrowser.Api/Playback/Progressive/BaseProgressiveStreamingService.cs b/MediaBrowser.Api/Playback/Progressive/BaseProgressiveStreamingService.cs
index 85c7e0e7d6..2ebf0e420d 100644
--- a/MediaBrowser.Api/Playback/Progressive/BaseProgressiveStreamingService.cs
+++ b/MediaBrowser.Api/Playback/Progressive/BaseProgressiveStreamingService.cs
@@ -21,7 +21,7 @@ using Microsoft.Net.Http.Headers;
namespace MediaBrowser.Api.Playback.Progressive
{
///
- /// Class BaseProgressiveStreamingService
+ /// Class BaseProgressiveStreamingService.
///
public abstract class BaseProgressiveStreamingService : BaseStreamingService
{
diff --git a/MediaBrowser.Api/Playback/Progressive/VideoService.cs b/MediaBrowser.Api/Playback/Progressive/VideoService.cs
index a35e6c201b..c3f6b905cb 100644
--- a/MediaBrowser.Api/Playback/Progressive/VideoService.cs
+++ b/MediaBrowser.Api/Playback/Progressive/VideoService.cs
@@ -15,7 +15,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api.Playback.Progressive
{
///
- /// Class GetVideoStream
+ /// Class GetVideoStream.
///
[Route("/Videos/{Id}/stream.mpegts", "GET")]
[Route("/Videos/{Id}/stream.ts", "GET")]
@@ -62,7 +62,7 @@ namespace MediaBrowser.Api.Playback.Progressive
}
///
- /// Class VideoService
+ /// Class VideoService.
///
// TODO: In order to autheneticate this in the future, Dlna playback will require updating
//[Authenticated]
diff --git a/MediaBrowser.Api/Playback/StaticRemoteStreamWriter.cs b/MediaBrowser.Api/Playback/StaticRemoteStreamWriter.cs
index 3b8b299957..7e2e337ad1 100644
--- a/MediaBrowser.Api/Playback/StaticRemoteStreamWriter.cs
+++ b/MediaBrowser.Api/Playback/StaticRemoteStreamWriter.cs
@@ -8,17 +8,17 @@ using MediaBrowser.Model.Services;
namespace MediaBrowser.Api.Playback
{
///
- /// Class StaticRemoteStreamWriter
+ /// Class StaticRemoteStreamWriter.
///
public class StaticRemoteStreamWriter : IAsyncStreamWriter, IHasHeaders
{
///
- /// The _input stream
+ /// The _input stream.
///
private readonly HttpResponseInfo _response;
///
- /// The _options
+ /// The _options.
///
private readonly IDictionary _options = new Dictionary();
diff --git a/MediaBrowser.Api/Playback/StreamRequest.cs b/MediaBrowser.Api/Playback/StreamRequest.cs
index 397898a7ed..67c334e489 100644
--- a/MediaBrowser.Api/Playback/StreamRequest.cs
+++ b/MediaBrowser.Api/Playback/StreamRequest.cs
@@ -4,7 +4,7 @@ using MediaBrowser.Model.Services;
namespace MediaBrowser.Api.Playback
{
///
- /// Class StreamRequest
+ /// Class StreamRequest.
///
public class StreamRequest : BaseEncodingJobOptions
{
diff --git a/MediaBrowser.Api/PlaylistService.cs b/MediaBrowser.Api/PlaylistService.cs
index d5def03bec..5513c08922 100644
--- a/MediaBrowser.Api/PlaylistService.cs
+++ b/MediaBrowser.Api/PlaylistService.cs
@@ -95,14 +95,14 @@ namespace MediaBrowser.Api
public int? StartIndex { get; set; }
///
- /// The maximum number of items to return
+ /// The maximum number of items to return.
///
/// The limit.
[ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int? Limit { get; set; }
///
- /// Fields to return within the items, in addition to basic information
+ /// Fields to return within the items, in addition to basic information.
///
/// The fields.
[ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
diff --git a/MediaBrowser.Api/PluginService.cs b/MediaBrowser.Api/PluginService.cs
index 1d092a5d43..7d976ceaac 100644
--- a/MediaBrowser.Api/PluginService.cs
+++ b/MediaBrowser.Api/PluginService.cs
@@ -15,7 +15,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api
{
///
- /// Class Plugins
+ /// Class Plugins.
///
[Route("/Plugins", "GET", Summary = "Gets a list of currently installed plugins")]
[Authenticated]
@@ -25,7 +25,7 @@ namespace MediaBrowser.Api
}
///
- /// Class UninstallPlugin
+ /// Class UninstallPlugin.
///
[Route("/Plugins/{Id}", "DELETE", Summary = "Uninstalls a plugin")]
[Authenticated(Roles = "Admin")]
@@ -40,7 +40,7 @@ namespace MediaBrowser.Api
}
///
- /// Class GetPluginConfiguration
+ /// Class GetPluginConfiguration.
///
[Route("/Plugins/{Id}/Configuration", "GET", Summary = "Gets a plugin's configuration")]
[Authenticated]
@@ -55,7 +55,7 @@ namespace MediaBrowser.Api
}
///
- /// Class UpdatePluginConfiguration
+ /// Class UpdatePluginConfiguration.
///
[Route("/Plugins/{Id}/Configuration", "POST", Summary = "Updates a plugin's configuration")]
[Authenticated]
@@ -69,7 +69,7 @@ namespace MediaBrowser.Api
public string Id { get; set; }
///
- /// The raw Http Request Input Stream
+ /// The raw Http Request Input Stream.
///
/// The request stream.
public Stream RequestStream { get; set; }
@@ -86,7 +86,7 @@ namespace MediaBrowser.Api
}
///
- /// Class GetPluginSecurityInfo
+ /// Class GetPluginSecurityInfo.
///
[Route("/Plugins/SecurityInfo", "GET", Summary = "Gets plugin registration information", IsHidden = true)]
[Authenticated]
@@ -95,7 +95,7 @@ namespace MediaBrowser.Api
}
///
- /// Class UpdatePluginSecurityInfo
+ /// Class UpdatePluginSecurityInfo.
///
[Route("/Plugins/SecurityInfo", "POST", Summary = "Updates plugin registration information", IsHidden = true)]
[Authenticated(Roles = "Admin")]
@@ -145,17 +145,17 @@ namespace MediaBrowser.Api
public bool IsMBSupporter { get; set; }
}
///
- /// Class PluginsService
+ /// Class PluginsService.
///
public class PluginService : BaseApiService
{
///
- /// The _json serializer
+ /// The _json serializer.
///
private readonly IJsonSerializer _jsonSerializer;
///
- /// The _app host
+ /// The _app host.
///
private readonly IApplicationHost _appHost;
private readonly IInstallationManager _installationManager;
diff --git a/MediaBrowser.Api/ScheduledTasks/ScheduledTaskService.cs b/MediaBrowser.Api/ScheduledTasks/ScheduledTaskService.cs
index e08a8482e0..86b00316ad 100644
--- a/MediaBrowser.Api/ScheduledTasks/ScheduledTaskService.cs
+++ b/MediaBrowser.Api/ScheduledTasks/ScheduledTaskService.cs
@@ -11,7 +11,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api.ScheduledTasks
{
///
- /// Class GetScheduledTask
+ /// Class GetScheduledTask.
///
[Route("/ScheduledTasks/{Id}", "GET", Summary = "Gets a scheduled task, by Id")]
public class GetScheduledTask : IReturn
@@ -25,7 +25,7 @@ namespace MediaBrowser.Api.ScheduledTasks
}
///
- /// Class GetScheduledTasks
+ /// Class GetScheduledTasks.
///
[Route("/ScheduledTasks", "GET", Summary = "Gets scheduled tasks")]
public class GetScheduledTasks : IReturn
@@ -38,7 +38,7 @@ namespace MediaBrowser.Api.ScheduledTasks
}
///
- /// Class StartScheduledTask
+ /// Class StartScheduledTask.
///
[Route("/ScheduledTasks/Running/{Id}", "POST", Summary = "Starts a scheduled task")]
public class StartScheduledTask : IReturnVoid
@@ -52,7 +52,7 @@ namespace MediaBrowser.Api.ScheduledTasks
}
///
- /// Class StopScheduledTask
+ /// Class StopScheduledTask.
///
[Route("/ScheduledTasks/Running/{Id}", "DELETE", Summary = "Stops a scheduled task")]
public class StopScheduledTask : IReturnVoid
@@ -66,7 +66,7 @@ namespace MediaBrowser.Api.ScheduledTasks
}
///
- /// Class UpdateScheduledTaskTriggers
+ /// Class UpdateScheduledTaskTriggers.
///
[Route("/ScheduledTasks/{Id}/Triggers", "POST", Summary = "Updates the triggers for a scheduled task")]
public class UpdateScheduledTaskTriggers : List, IReturnVoid
@@ -80,7 +80,7 @@ namespace MediaBrowser.Api.ScheduledTasks
}
///
- /// Class ScheduledTasksService
+ /// Class ScheduledTasksService.
///
[Authenticated(Roles = "Admin")]
public class ScheduledTaskService : BaseApiService
diff --git a/MediaBrowser.Api/ScheduledTasks/ScheduledTasksWebSocketListener.cs b/MediaBrowser.Api/ScheduledTasks/ScheduledTasksWebSocketListener.cs
index 14b9b3618b..25dd39f2de 100644
--- a/MediaBrowser.Api/ScheduledTasks/ScheduledTasksWebSocketListener.cs
+++ b/MediaBrowser.Api/ScheduledTasks/ScheduledTasksWebSocketListener.cs
@@ -9,7 +9,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api.ScheduledTasks
{
///
- /// Class ScheduledTasksWebSocketListener
+ /// Class ScheduledTasksWebSocketListener.
///
public class ScheduledTasksWebSocketListener : BasePeriodicWebSocketListener, WebSocketListenerState>
{
diff --git a/MediaBrowser.Api/SearchService.cs b/MediaBrowser.Api/SearchService.cs
index 4a2f96ed86..64ee69300e 100644
--- a/MediaBrowser.Api/SearchService.cs
+++ b/MediaBrowser.Api/SearchService.cs
@@ -18,7 +18,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api
{
///
- /// Class GetSearchHints
+ /// Class GetSearchHints.
///
[Route("/Search/Hints", "GET", Summary = "Gets search hints based on a search term")]
public class GetSearchHints : IReturn
@@ -31,7 +31,7 @@ namespace MediaBrowser.Api
public int? StartIndex { get; set; }
///
- /// The maximum number of items to return
+ /// The maximum number of items to return.
///
/// The limit.
[ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
@@ -45,7 +45,7 @@ namespace MediaBrowser.Api
public Guid UserId { get; set; }
///
- /// Search characters used to find items
+ /// Search characters used to find items.
///
/// The index by.
[ApiMember(Name = "SearchTerm", Description = "The search term to filter on", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "GET")]
@@ -104,13 +104,13 @@ namespace MediaBrowser.Api
}
///
- /// Class SearchService
+ /// Class SearchService.
///
[Authenticated]
public class SearchService : BaseApiService
{
///
- /// The _search engine
+ /// The _search engine.
///
private readonly ISearchEngine _searchEngine;
private readonly ILibraryManager _libraryManager;
diff --git a/MediaBrowser.Api/Sessions/SessionInfoWebSocketListener.cs b/MediaBrowser.Api/Sessions/SessionInfoWebSocketListener.cs
index 175984575d..2400d6defe 100644
--- a/MediaBrowser.Api/Sessions/SessionInfoWebSocketListener.cs
+++ b/MediaBrowser.Api/Sessions/SessionInfoWebSocketListener.cs
@@ -8,7 +8,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api.Sessions
{
///
- /// Class SessionInfoWebSocketListener
+ /// Class SessionInfoWebSocketListener.
///
public class SessionInfoWebSocketListener : BasePeriodicWebSocketListener, WebSocketListenerState>
{
@@ -19,7 +19,7 @@ namespace MediaBrowser.Api.Sessions
protected override string Name => "Sessions";
///
- /// The _kernel
+ /// The _kernel.
///
private readonly ISessionManager _sessionManager;
diff --git a/MediaBrowser.Api/Sessions/SessionService.cs b/MediaBrowser.Api/Sessions/SessionService.cs
index d986eea65a..50adc56980 100644
--- a/MediaBrowser.Api/Sessions/SessionService.cs
+++ b/MediaBrowser.Api/Sessions/SessionService.cs
@@ -46,14 +46,14 @@ namespace MediaBrowser.Api.Sessions
public string Id { get; set; }
///
- /// Artist, Genre, Studio, Person, or any kind of BaseItem
+ /// Artist, Genre, Studio, Person, or any kind of BaseItem.
///
/// The type of the item.
[ApiMember(Name = "ItemType", Description = "The type of item to browse to.", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "POST")]
public string ItemType { get; set; }
///
- /// Artist name, genre name, item Id, etc
+ /// Artist name, genre name, item Id, etc.
///
/// The item identifier.
[ApiMember(Name = "ItemId", Description = "The Id of the item.", IsRequired = true, DataType = "string", ParameterType = "query", Verb = "POST")]
diff --git a/MediaBrowser.Api/SimilarItemsHelper.cs b/MediaBrowser.Api/SimilarItemsHelper.cs
index c4df0a7ed6..84abf7b8d5 100644
--- a/MediaBrowser.Api/SimilarItemsHelper.cs
+++ b/MediaBrowser.Api/SimilarItemsHelper.cs
@@ -14,7 +14,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api
{
///
- /// Class BaseGetSimilarItemsFromItem
+ /// Class BaseGetSimilarItemsFromItem.
///
public class BaseGetSimilarItemsFromItem : BaseGetSimilarItems
{
@@ -50,14 +50,14 @@ namespace MediaBrowser.Api
public Guid UserId { get; set; }
///
- /// The maximum number of items to return
+ /// The maximum number of items to return.
///
/// The limit.
[ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int? Limit { get; set; }
///
- /// Fields to return within the items, in addition to basic information
+ /// Fields to return within the items, in addition to basic information.
///
/// The fields.
[ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
@@ -65,7 +65,7 @@ namespace MediaBrowser.Api
}
///
- /// Class SimilarItemsHelper
+ /// Class SimilarItemsHelper.
///
public static class SimilarItemsHelper
{
diff --git a/MediaBrowser.Api/System/ActivityLogService.cs b/MediaBrowser.Api/System/ActivityLogService.cs
index a6bacad4fc..7ca31c21ab 100644
--- a/MediaBrowser.Api/System/ActivityLogService.cs
+++ b/MediaBrowser.Api/System/ActivityLogService.cs
@@ -22,7 +22,7 @@ namespace MediaBrowser.Api.System
public int? StartIndex { get; set; }
///
- /// The maximum number of items to return
+ /// The maximum number of items to return.
///
/// The limit.
[ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
diff --git a/MediaBrowser.Api/System/ActivityLogWebSocketListener.cs b/MediaBrowser.Api/System/ActivityLogWebSocketListener.cs
index 8e4860be4b..39976371a9 100644
--- a/MediaBrowser.Api/System/ActivityLogWebSocketListener.cs
+++ b/MediaBrowser.Api/System/ActivityLogWebSocketListener.cs
@@ -8,7 +8,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api.System
{
///
- /// Class SessionInfoWebSocketListener
+ /// Class SessionInfoWebSocketListener.
///
public class ActivityLogWebSocketListener : BasePeriodicWebSocketListener
{
@@ -19,7 +19,7 @@ namespace MediaBrowser.Api.System
protected override string Name => "ActivityLogEntry";
///
- /// The _kernel
+ /// The _kernel.
///
private readonly IActivityManager _activityManager;
diff --git a/MediaBrowser.Api/System/SystemService.cs b/MediaBrowser.Api/System/SystemService.cs
index 4f10a4ad2e..e0e20d828e 100644
--- a/MediaBrowser.Api/System/SystemService.cs
+++ b/MediaBrowser.Api/System/SystemService.cs
@@ -18,7 +18,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api.System
{
///
- /// Class GetSystemInfo
+ /// Class GetSystemInfo.
///
[Route("/System/Info", "GET", Summary = "Gets information about the server")]
[Authenticated(EscapeParentalControl = true, AllowBeforeStartupWizard = true)]
@@ -38,7 +38,7 @@ namespace MediaBrowser.Api.System
}
///
- /// Class RestartApplication
+ /// Class RestartApplication.
///
[Route("/System/Restart", "POST", Summary = "Restarts the application, if needed")]
[Authenticated(Roles = "Admin", AllowLocal = true)]
@@ -83,12 +83,12 @@ namespace MediaBrowser.Api.System
}
///
- /// Class SystemInfoService
+ /// Class SystemInfoService.
///
public class SystemService : BaseApiService
{
///
- /// The _app host
+ /// The _app host.
///
private readonly IServerApplicationHost _appHost;
private readonly IApplicationPaths _appPaths;
diff --git a/MediaBrowser.Api/TvShowsService.cs b/MediaBrowser.Api/TvShowsService.cs
index 3e8daef033..165abd613d 100644
--- a/MediaBrowser.Api/TvShowsService.cs
+++ b/MediaBrowser.Api/TvShowsService.cs
@@ -19,7 +19,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api
{
///
- /// Class GetNextUpEpisodes
+ /// Class GetNextUpEpisodes.
///
[Route("/Shows/NextUp", "GET", Summary = "Gets a list of next up episodes")]
public class GetNextUpEpisodes : IReturn>, IHasDtoOptions
@@ -39,14 +39,14 @@ namespace MediaBrowser.Api
public int? StartIndex { get; set; }
///
- /// The maximum number of items to return
+ /// The maximum number of items to return.
///
/// The limit.
[ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int? Limit { get; set; }
///
- /// Fields to return within the items, in addition to basic information
+ /// Fields to return within the items, in addition to basic information.
///
/// The fields.
[ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
@@ -100,14 +100,14 @@ namespace MediaBrowser.Api
public int? StartIndex { get; set; }
///
- /// The maximum number of items to return
+ /// The maximum number of items to return.
///
/// The limit.
[ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int? Limit { get; set; }
///
- /// Fields to return within the items, in addition to basic information
+ /// Fields to return within the items, in addition to basic information.
///
/// The fields.
[ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
@@ -144,7 +144,7 @@ namespace MediaBrowser.Api
public Guid UserId { get; set; }
///
- /// Fields to return within the items, in addition to basic information
+ /// Fields to return within the items, in addition to basic information.
///
/// The fields.
[ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
@@ -176,7 +176,7 @@ namespace MediaBrowser.Api
public int? StartIndex { get; set; }
///
- /// The maximum number of items to return
+ /// The maximum number of items to return.
///
/// The limit.
[ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
@@ -212,7 +212,7 @@ namespace MediaBrowser.Api
public Guid UserId { get; set; }
///
- /// Fields to return within the items, in addition to basic information
+ /// Fields to return within the items, in addition to basic information.
///
/// The fields.
[ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
@@ -244,18 +244,18 @@ namespace MediaBrowser.Api
}
///
- /// Class TvShowsService
+ /// Class TvShowsService.
///
[Authenticated]
public class TvShowsService : BaseApiService
{
///
- /// The _user manager
+ /// The _user manager.
///
private readonly IUserManager _userManager;
///
- /// The _library manager
+ /// The _library manager.
///
private readonly ILibraryManager _libraryManager;
diff --git a/MediaBrowser.Api/UserLibrary/ArtistsService.cs b/MediaBrowser.Api/UserLibrary/ArtistsService.cs
index bef91d54df..9875e02084 100644
--- a/MediaBrowser.Api/UserLibrary/ArtistsService.cs
+++ b/MediaBrowser.Api/UserLibrary/ArtistsService.cs
@@ -14,7 +14,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api.UserLibrary
{
///
- /// Class GetArtists
+ /// Class GetArtists.
///
[Route("/Artists", "GET", Summary = "Gets all artists from a given item, folder, or the entire library")]
public class GetArtists : GetItemsByName
@@ -45,7 +45,7 @@ namespace MediaBrowser.Api.UserLibrary
}
///
- /// Class ArtistsService
+ /// Class ArtistsService.
///
[Authenticated]
public class ArtistsService : BaseItemsByNameService
diff --git a/MediaBrowser.Api/UserLibrary/BaseItemsByNameService.cs b/MediaBrowser.Api/UserLibrary/BaseItemsByNameService.cs
index 3d9db90bd6..fd639caf11 100644
--- a/MediaBrowser.Api/UserLibrary/BaseItemsByNameService.cs
+++ b/MediaBrowser.Api/UserLibrary/BaseItemsByNameService.cs
@@ -15,7 +15,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api.UserLibrary
{
///
- /// Class BaseItemsByNameService
+ /// Class BaseItemsByNameService.
///
/// The type of the T item type.
public abstract class BaseItemsByNameService : BaseApiService
@@ -52,7 +52,7 @@ namespace MediaBrowser.Api.UserLibrary
protected IUserManager UserManager { get; }
///
- /// Gets the library manager
+ /// Gets the library manager.
///
protected ILibraryManager LibraryManager { get; }
@@ -376,7 +376,7 @@ namespace MediaBrowser.Api.UserLibrary
}
///
- /// Class GetItemsByName
+ /// Class GetItemsByName.
///
public class GetItemsByName : BaseItemsRequest, IReturn>
{
diff --git a/MediaBrowser.Api/UserLibrary/BaseItemsRequest.cs b/MediaBrowser.Api/UserLibrary/BaseItemsRequest.cs
index d9b52b10ef..344861a496 100644
--- a/MediaBrowser.Api/UserLibrary/BaseItemsRequest.cs
+++ b/MediaBrowser.Api/UserLibrary/BaseItemsRequest.cs
@@ -111,14 +111,14 @@ namespace MediaBrowser.Api.UserLibrary
public int? StartIndex { get; set; }
///
- /// The maximum number of items to return
+ /// The maximum number of items to return.
///
/// The limit.
[ApiMember(Name = "Limit", Description = "Optional. The maximum number of records to return", IsRequired = false, DataType = "int", ParameterType = "query", Verb = "GET")]
public int? Limit { get; set; }
///
- /// Whether or not to perform the query recursively
+ /// Whether or not to perform the query recursively.
///
/// true if recursive; otherwise, false.
[ApiMember(Name = "Recursive", Description = "When searching within folders, this determines whether or not the search will be recursive. true/false", IsRequired = false, DataType = "boolean", ParameterType = "query", Verb = "GET")]
@@ -141,7 +141,7 @@ namespace MediaBrowser.Api.UserLibrary
public string ParentId { get; set; }
///
- /// Fields to return within the items, in addition to basic information
+ /// Fields to return within the items, in addition to basic information.
///
/// The fields.
[ApiMember(Name = "Fields", Description = "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
@@ -162,14 +162,14 @@ namespace MediaBrowser.Api.UserLibrary
public string IncludeItemTypes { get; set; }
///
- /// Filters to apply to the results
+ /// Filters to apply to the results.
///
/// The filters.
[ApiMember(Name = "Filters", Description = "Optional. Specify additional filters to apply. This allows multiple, comma delimeted. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
public string Filters { get; set; }
///
- /// Gets or sets the Isfavorite option
+ /// Gets or sets the Isfavorite option.
///
/// IsFavorite
[ApiMember(Name = "IsFavorite", Description = "Optional filter by items that are marked as favorite, or not.", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
@@ -190,7 +190,7 @@ namespace MediaBrowser.Api.UserLibrary
public string ImageTypes { get; set; }
///
- /// What to sort the results by
+ /// What to sort the results by.
///
/// The sort by.
[ApiMember(Name = "SortBy", Description = "Optional. Specify one or more sort orders, comma delimeted. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
@@ -200,7 +200,7 @@ namespace MediaBrowser.Api.UserLibrary
public bool? IsPlayed { get; set; }
///
- /// Limit results to items containing specific genres
+ /// Limit results to items containing specific genres.
///
/// The genres.
[ApiMember(Name = "Genres", Description = "Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
@@ -215,7 +215,7 @@ namespace MediaBrowser.Api.UserLibrary
public string Tags { get; set; }
///
- /// Limit results to items containing specific years
+ /// Limit results to items containing specific years.
///
/// The years.
[ApiMember(Name = "Years", Description = "Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
@@ -234,7 +234,7 @@ namespace MediaBrowser.Api.UserLibrary
public string EnableImageTypes { get; set; }
///
- /// Limit results to items containing a specific person
+ /// Limit results to items containing a specific person.
///
/// The person.
[ApiMember(Name = "Person", Description = "Optional. If specified, results will be filtered to include only those containing the specified person.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
@@ -244,14 +244,14 @@ namespace MediaBrowser.Api.UserLibrary
public string PersonIds { get; set; }
///
- /// If the Person filter is used, this can also be used to restrict to a specific person type
+ /// If the Person filter is used, this can also be used to restrict to a specific person type.
///
/// The type of the person.
[ApiMember(Name = "PersonTypes", Description = "Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET")]
public string PersonTypes { get; set; }
///
- /// Limit results to items containing specific studios
+ /// Limit results to items containing specific studios.
///
/// The studios.
[ApiMember(Name = "Studios", Description = "Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimeted.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "GET", AllowMultiple = true)]
diff --git a/MediaBrowser.Api/UserLibrary/GenresService.cs b/MediaBrowser.Api/UserLibrary/GenresService.cs
index 1fa272a5f7..7bdfbac981 100644
--- a/MediaBrowser.Api/UserLibrary/GenresService.cs
+++ b/MediaBrowser.Api/UserLibrary/GenresService.cs
@@ -14,7 +14,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api.UserLibrary
{
///
- /// Class GetGenres
+ /// Class GetGenres.
///
[Route("/Genres", "GET", Summary = "Gets all genres from a given item, folder, or the entire library")]
public class GetGenres : GetItemsByName
@@ -22,7 +22,7 @@ namespace MediaBrowser.Api.UserLibrary
}
///
- /// Class GetGenre
+ /// Class GetGenre.
///
[Route("/Genres/{Name}", "GET", Summary = "Gets a genre, by name")]
public class GetGenre : IReturn
@@ -43,7 +43,7 @@ namespace MediaBrowser.Api.UserLibrary
}
///
- /// Class GenresService
+ /// Class GenresService.
///
[Authenticated]
public class GenresService : BaseItemsByNameService
diff --git a/MediaBrowser.Api/UserLibrary/ItemsService.cs b/MediaBrowser.Api/UserLibrary/ItemsService.cs
index 49d534c364..7efe0552c6 100644
--- a/MediaBrowser.Api/UserLibrary/ItemsService.cs
+++ b/MediaBrowser.Api/UserLibrary/ItemsService.cs
@@ -20,7 +20,7 @@ using MusicAlbum = MediaBrowser.Controller.Entities.Audio.MusicAlbum;
namespace MediaBrowser.Api.UserLibrary
{
///
- /// Class GetItems
+ /// Class GetItems.
///
[Route("/Items", "GET", Summary = "Gets items based on a query.")]
[Route("/Users/{UserId}/Items", "GET", Summary = "Gets items based on a query.")]
@@ -34,18 +34,18 @@ namespace MediaBrowser.Api.UserLibrary
}
///
- /// Class ItemsService
+ /// Class ItemsService.
///
[Authenticated]
public class ItemsService : BaseApiService
{
///
- /// The _user manager
+ /// The _user manager.
///
private readonly IUserManager _userManager;
///
- /// The _library manager
+ /// The _library manager.
///
private readonly ILibraryManager _libraryManager;
private readonly ILocalizationManager _localization;
@@ -496,7 +496,7 @@ namespace MediaBrowser.Api.UserLibrary
}
///
- /// Class DateCreatedComparer
+ /// Class DateCreatedComparer.
///
public class DateCreatedComparer : IComparer
{
diff --git a/MediaBrowser.Api/UserLibrary/PersonsService.cs b/MediaBrowser.Api/UserLibrary/PersonsService.cs
index 3204e5219f..7924339ed3 100644
--- a/MediaBrowser.Api/UserLibrary/PersonsService.cs
+++ b/MediaBrowser.Api/UserLibrary/PersonsService.cs
@@ -14,7 +14,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api.UserLibrary
{
///
- /// Class GetPersons
+ /// Class GetPersons.
///
[Route("/Persons", "GET", Summary = "Gets all persons from a given item, folder, or the entire library")]
public class GetPersons : GetItemsByName
@@ -22,7 +22,7 @@ namespace MediaBrowser.Api.UserLibrary
}
///
- /// Class GetPerson
+ /// Class GetPerson.
///
[Route("/Persons/{Name}", "GET", Summary = "Gets a person, by name")]
public class GetPerson : IReturn
@@ -43,7 +43,7 @@ namespace MediaBrowser.Api.UserLibrary
}
///
- /// Class PersonsService
+ /// Class PersonsService.
///
[Authenticated]
public class PersonsService : BaseItemsByNameService
diff --git a/MediaBrowser.Api/UserLibrary/PlaystateService.cs b/MediaBrowser.Api/UserLibrary/PlaystateService.cs
index ab231626bb..d809cc2e79 100644
--- a/MediaBrowser.Api/UserLibrary/PlaystateService.cs
+++ b/MediaBrowser.Api/UserLibrary/PlaystateService.cs
@@ -14,7 +14,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api.UserLibrary
{
///
- /// Class MarkPlayedItem
+ /// Class MarkPlayedItem.
///
[Route("/Users/{UserId}/PlayedItems/{Id}", "POST", Summary = "Marks an item as played")]
public class MarkPlayedItem : IReturn
@@ -38,7 +38,7 @@ namespace MediaBrowser.Api.UserLibrary
}
///
- /// Class MarkUnplayedItem
+ /// Class MarkUnplayedItem.
///
[Route("/Users/{UserId}/PlayedItems/{Id}", "DELETE", Summary = "Marks an item as unplayed")]
public class MarkUnplayedItem : IReturn
@@ -81,7 +81,7 @@ namespace MediaBrowser.Api.UserLibrary
}
///
- /// Class OnPlaybackStart
+ /// Class OnPlaybackStart.
///
[Route("/Users/{UserId}/PlayingItems/{Id}", "POST", Summary = "Reports that a user has begun playing an item")]
public class OnPlaybackStart : IReturnVoid
@@ -123,7 +123,7 @@ namespace MediaBrowser.Api.UserLibrary
}
///
- /// Class OnPlaybackProgress
+ /// Class OnPlaybackProgress.
///
[Route("/Users/{UserId}/PlayingItems/{Id}/Progress", "POST", Summary = "Reports a user's playback progress")]
public class OnPlaybackProgress : IReturnVoid
@@ -181,7 +181,7 @@ namespace MediaBrowser.Api.UserLibrary
}
///
- /// Class OnPlaybackStopped
+ /// Class OnPlaybackStopped.
///
[Route("/Users/{UserId}/PlayingItems/{Id}", "DELETE", Summary = "Reports that a user has stopped playing an item")]
public class OnPlaybackStopped : IReturnVoid
diff --git a/MediaBrowser.Api/UserLibrary/StudiosService.cs b/MediaBrowser.Api/UserLibrary/StudiosService.cs
index 683ce5d09d..66350955f5 100644
--- a/MediaBrowser.Api/UserLibrary/StudiosService.cs
+++ b/MediaBrowser.Api/UserLibrary/StudiosService.cs
@@ -13,7 +13,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api.UserLibrary
{
///
- /// Class GetStudios
+ /// Class GetStudios.
///
[Route("/Studios", "GET", Summary = "Gets all studios from a given item, folder, or the entire library")]
public class GetStudios : GetItemsByName
@@ -21,7 +21,7 @@ namespace MediaBrowser.Api.UserLibrary
}
///
- /// Class GetStudio
+ /// Class GetStudio.
///
[Route("/Studios/{Name}", "GET", Summary = "Gets a studio, by name")]
public class GetStudio : IReturn
@@ -42,7 +42,7 @@ namespace MediaBrowser.Api.UserLibrary
}
///
- /// Class StudiosService
+ /// Class StudiosService.
///
[Authenticated]
public class StudiosService : BaseItemsByNameService
diff --git a/MediaBrowser.Api/UserLibrary/UserLibraryService.cs b/MediaBrowser.Api/UserLibrary/UserLibraryService.cs
index f758528859..f9cbba4104 100644
--- a/MediaBrowser.Api/UserLibrary/UserLibraryService.cs
+++ b/MediaBrowser.Api/UserLibrary/UserLibraryService.cs
@@ -20,7 +20,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api.UserLibrary
{
///
- /// Class GetItem
+ /// Class GetItem.
///
[Route("/Users/{UserId}/Items/{Id}", "GET", Summary = "Gets an item from a user's library")]
public class GetItem : IReturn
@@ -41,7 +41,7 @@ namespace MediaBrowser.Api.UserLibrary
}
///
- /// Class GetItem
+ /// Class GetItem.
///
[Route("/Users/{UserId}/Items/Root", "GET", Summary = "Gets the root folder from a user's library")]
public class GetRootFolder : IReturn
@@ -55,7 +55,7 @@ namespace MediaBrowser.Api.UserLibrary
}
///
- /// Class GetIntros
+ /// Class GetIntros.
///
[Route("/Users/{UserId}/Items/{Id}/Intros", "GET", Summary = "Gets intros to play before the main media item plays")]
public class GetIntros : IReturn>
@@ -76,7 +76,7 @@ namespace MediaBrowser.Api.UserLibrary
}
///
- /// Class MarkFavoriteItem
+ /// Class MarkFavoriteItem.
///
[Route("/Users/{UserId}/FavoriteItems/{Id}", "POST", Summary = "Marks an item as a favorite")]
public class MarkFavoriteItem : IReturn
@@ -97,7 +97,7 @@ namespace MediaBrowser.Api.UserLibrary
}
///
- /// Class UnmarkFavoriteItem
+ /// Class UnmarkFavoriteItem.
///
[Route("/Users/{UserId}/FavoriteItems/{Id}", "DELETE", Summary = "Unmarks an item as a favorite")]
public class UnmarkFavoriteItem : IReturn
@@ -118,7 +118,7 @@ namespace MediaBrowser.Api.UserLibrary
}
///
- /// Class ClearUserItemRating
+ /// Class ClearUserItemRating.
///
[Route("/Users/{UserId}/Items/{Id}/Rating", "DELETE", Summary = "Deletes a user's saved personal rating for an item")]
public class DeleteUserItemRating : IReturn
@@ -139,7 +139,7 @@ namespace MediaBrowser.Api.UserLibrary
}
///
- /// Class UpdateUserItemRating
+ /// Class UpdateUserItemRating.
///
[Route("/Users/{UserId}/Items/{Id}/Rating", "POST", Summary = "Updates a user's rating for an item")]
public class UpdateUserItemRating : IReturn
@@ -167,7 +167,7 @@ namespace MediaBrowser.Api.UserLibrary
}
///
- /// Class GetLocalTrailers
+ /// Class GetLocalTrailers.
///
[Route("/Users/{UserId}/Items/{Id}/LocalTrailers", "GET", Summary = "Gets local trailers for an item")]
public class GetLocalTrailers : IReturn
@@ -188,7 +188,7 @@ namespace MediaBrowser.Api.UserLibrary
}
///
- /// Class GetSpecialFeatures
+ /// Class GetSpecialFeatures.
///
[Route("/Users/{UserId}/Items/{Id}/SpecialFeatures", "GET", Summary = "Gets special features for an item")]
public class GetSpecialFeatures : IReturn
@@ -259,7 +259,7 @@ namespace MediaBrowser.Api.UserLibrary
}
///
- /// Class UserLibraryService
+ /// Class UserLibraryService.
///
[Authenticated]
public class UserLibraryService : BaseApiService
diff --git a/MediaBrowser.Api/UserLibrary/YearsService.cs b/MediaBrowser.Api/UserLibrary/YearsService.cs
index d023ee90ab..0523f89fa7 100644
--- a/MediaBrowser.Api/UserLibrary/YearsService.cs
+++ b/MediaBrowser.Api/UserLibrary/YearsService.cs
@@ -13,7 +13,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api.UserLibrary
{
///
- /// Class GetYears
+ /// Class GetYears.
///
[Route("/Years", "GET", Summary = "Gets all years from a given item, folder, or the entire library")]
public class GetYears : GetItemsByName
@@ -21,7 +21,7 @@ namespace MediaBrowser.Api.UserLibrary
}
///
- /// Class GetYear
+ /// Class GetYear.
///
[Route("/Years/{Year}", "GET", Summary = "Gets a year")]
public class GetYear : IReturn
@@ -42,7 +42,7 @@ namespace MediaBrowser.Api.UserLibrary
}
///
- /// Class YearsService
+ /// Class YearsService.
///
[Authenticated]
public class YearsService : BaseItemsByNameService
diff --git a/MediaBrowser.Api/UserService.cs b/MediaBrowser.Api/UserService.cs
index 9cb9baf631..131def5542 100644
--- a/MediaBrowser.Api/UserService.cs
+++ b/MediaBrowser.Api/UserService.cs
@@ -19,7 +19,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Api
{
///
- /// Class GetUsers
+ /// Class GetUsers.
///
[Route("/Users", "GET", Summary = "Gets a list of users")]
[Authenticated]
@@ -41,7 +41,7 @@ namespace MediaBrowser.Api
}
///
- /// Class GetUser
+ /// Class GetUser.
///
[Route("/Users/{Id}", "GET", Summary = "Gets a user by Id")]
[Authenticated(EscapeParentalControl = true)]
@@ -56,7 +56,7 @@ namespace MediaBrowser.Api
}
///
- /// Class DeleteUser
+ /// Class DeleteUser.
///
[Route("/Users/{Id}", "DELETE", Summary = "Deletes a user")]
[Authenticated(Roles = "Admin")]
@@ -71,7 +71,7 @@ namespace MediaBrowser.Api
}
///
- /// Class AuthenticateUser
+ /// Class AuthenticateUser.
///
[Route("/Users/{Id}/Authenticate", "POST", Summary = "Authenticates a user")]
public class AuthenticateUser : IReturn
@@ -95,7 +95,7 @@ namespace MediaBrowser.Api
}
///
- /// Class AuthenticateUser
+ /// Class AuthenticateUser.
///
[Route("/Users/AuthenticateByName", "POST", Summary = "Authenticates a user")]
public class AuthenticateUserByName : IReturn
@@ -119,7 +119,7 @@ namespace MediaBrowser.Api
}
///
- /// Class UpdateUserPassword
+ /// Class UpdateUserPassword.
///
[Route("/Users/{Id}/Password", "POST", Summary = "Updates a user's password")]
[Authenticated]
@@ -149,7 +149,7 @@ namespace MediaBrowser.Api
}
///
- /// Class UpdateUserEasyPassword
+ /// Class UpdateUserEasyPassword.
///
[Route("/Users/{Id}/EasyPassword", "POST", Summary = "Updates a user's easy password")]
[Authenticated]
@@ -177,7 +177,7 @@ namespace MediaBrowser.Api
}
///
- /// Class UpdateUser
+ /// Class UpdateUser.
///
[Route("/Users/{Id}", "POST", Summary = "Updates a user")]
[Authenticated]
@@ -186,7 +186,7 @@ namespace MediaBrowser.Api
}
///
- /// Class UpdateUser
+ /// Class UpdateUser.
///
[Route("/Users/{Id}/Policy", "POST", Summary = "Updates a user policy")]
[Authenticated(Roles = "admin")]
@@ -197,7 +197,7 @@ namespace MediaBrowser.Api
}
///
- /// Class UpdateUser
+ /// Class UpdateUser.
///
[Route("/Users/{Id}/Configuration", "POST", Summary = "Updates a user configuration")]
[Authenticated]
@@ -208,7 +208,7 @@ namespace MediaBrowser.Api
}
///
- /// Class CreateUser
+ /// Class CreateUser.
///
[Route("/Users/New", "POST", Summary = "Creates a user")]
[Authenticated(Roles = "Admin")]
@@ -236,7 +236,7 @@ namespace MediaBrowser.Api
}
///
- /// Class UsersService
+ /// Class UsersService.
///
public class UserService : BaseApiService
{
diff --git a/MediaBrowser.Controller/Channels/InternalChannelFeatures.cs b/MediaBrowser.Controller/Channels/InternalChannelFeatures.cs
index 60455e68ae..1f4a26064c 100644
--- a/MediaBrowser.Controller/Channels/InternalChannelFeatures.cs
+++ b/MediaBrowser.Controller/Channels/InternalChannelFeatures.cs
@@ -18,7 +18,7 @@ namespace MediaBrowser.Controller.Channels
public List ContentTypes { get; set; }
///
- /// Represents the maximum number of records the channel allows retrieving at a time
+ /// Represents the maximum number of records the channel allows retrieving at a time.
///
public int? MaxPageSize { get; set; }
diff --git a/MediaBrowser.Controller/Configuration/IServerConfigurationManager.cs b/MediaBrowser.Controller/Configuration/IServerConfigurationManager.cs
index 6660743e62..a5c5e3bccf 100644
--- a/MediaBrowser.Controller/Configuration/IServerConfigurationManager.cs
+++ b/MediaBrowser.Controller/Configuration/IServerConfigurationManager.cs
@@ -4,7 +4,7 @@ using MediaBrowser.Model.Configuration;
namespace MediaBrowser.Controller.Configuration
{
///
- /// Interface IServerConfigurationManager
+ /// Interface IServerConfigurationManager.
///
public interface IServerConfigurationManager : IConfigurationManager
{
diff --git a/MediaBrowser.Controller/Drawing/IImageProcessor.cs b/MediaBrowser.Controller/Drawing/IImageProcessor.cs
index f1873d5396..488692c036 100644
--- a/MediaBrowser.Controller/Drawing/IImageProcessor.cs
+++ b/MediaBrowser.Controller/Drawing/IImageProcessor.cs
@@ -10,7 +10,7 @@ using MediaBrowser.Model.Entities;
namespace MediaBrowser.Controller.Drawing
{
///
- /// Interface IImageProcessor
+ /// Interface IImageProcessor.
///
public interface IImageProcessor
{
diff --git a/MediaBrowser.Controller/Dto/IDtoService.cs b/MediaBrowser.Controller/Dto/IDtoService.cs
index 56e6c47c4b..0dadc283ee 100644
--- a/MediaBrowser.Controller/Dto/IDtoService.cs
+++ b/MediaBrowser.Controller/Dto/IDtoService.cs
@@ -7,7 +7,7 @@ using MediaBrowser.Model.Querying;
namespace MediaBrowser.Controller.Dto
{
///
- /// Interface IDtoService
+ /// Interface IDtoService.
///
public interface IDtoService
{
diff --git a/MediaBrowser.Controller/Entities/AggregateFolder.cs b/MediaBrowser.Controller/Entities/AggregateFolder.cs
index fd0dc31cc4..e1c800e619 100644
--- 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;
///
- /// The _virtual children
+ /// The _virtual children.
///
private readonly ConcurrentBag _virtualChildren = new ConcurrentBag();
diff --git a/MediaBrowser.Controller/Entities/Audio/Audio.cs b/MediaBrowser.Controller/Entities/Audio/Audio.cs
index 7d10e68317..98f802b5d5 100644
--- 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
{
///
- /// Class Audio
+ /// Class Audio.
///
public class Audio : BaseItem,
IHasAlbumArtist,
diff --git a/MediaBrowser.Controller/Entities/Audio/MusicAlbum.cs b/MediaBrowser.Controller/Entities/Audio/MusicAlbum.cs
index c3514e0f62..5a1ddeecef 100644
--- 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
{
///
- /// Class MusicAlbum
+ /// Class MusicAlbum.
///
public class MusicAlbum : Folder, IHasAlbumArtist, IHasArtist, IHasMusicGenres, IHasLookupInfo, IMetadataContainer
{
diff --git a/MediaBrowser.Controller/Entities/Audio/MusicArtist.cs b/MediaBrowser.Controller/Entities/Audio/MusicArtist.cs
index cbba1914a5..ea5c41caa4 100644
--- 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
{
///
- /// Class MusicArtist
+ /// Class MusicArtist.
///
public class MusicArtist : Folder, IItemByName, IHasMusicGenres, IHasDualAccess, IHasLookupInfo
{
@@ -111,7 +111,7 @@ namespace MediaBrowser.Controller.Entities.Audio
///
/// 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.
///
/// The containing folder path.
[JsonIgnore]
@@ -202,7 +202,7 @@ namespace MediaBrowser.Controller.Entities.Audio
}
///
- /// 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.
///
public override bool BeforeMetadataRefresh(bool replaceAllMetdata)
{
diff --git a/MediaBrowser.Controller/Entities/Audio/MusicGenre.cs b/MediaBrowser.Controller/Entities/Audio/MusicGenre.cs
index 61f35b9427..4f6aa07767 100644
--- 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
{
///
- /// Class MusicGenre
+ /// Class MusicGenre.
///
public class MusicGenre : BaseItem, IItemByName
{
@@ -35,7 +35,7 @@ namespace MediaBrowser.Controller.Entities.Audio
///
/// 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.
///
/// The containing folder path.
[JsonIgnore]
@@ -100,7 +100,7 @@ namespace MediaBrowser.Controller.Entities.Audio
}
///
- /// 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.
///
public override bool BeforeMetadataRefresh(bool replaceAllMetdata)
{
diff --git a/MediaBrowser.Controller/Entities/BaseItem.cs b/MediaBrowser.Controller/Entities/BaseItem.cs
index d356cdfd69..d76409afc8 100644
--- a/MediaBrowser.Controller/Entities/BaseItem.cs
+++ b/MediaBrowser.Controller/Entities/BaseItem.cs
@@ -31,12 +31,12 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Controller.Entities
{
///
- /// Class BaseItem
+ /// Class BaseItem.
///
public abstract class BaseItem : IHasProviderIds, IHasLookupInfo, IEquatable
{
///
- /// The supported image extensions
+ /// The supported image extensions.
///
public static readonly string[] SupportedImageExtensions
= new[] { ".png", ".jpg", ".jpeg", ".tbn", ".gif" };
@@ -75,7 +75,7 @@ namespace MediaBrowser.Controller.Entities
public static char SlugChar = '-';
///
- /// The trailer folder name
+ /// The trailer folder name.
///
public const string TrailerFolderName = "trailers";
public const string ThemeSongsFolderName = "theme-music";
@@ -244,7 +244,7 @@ namespace MediaBrowser.Controller.Entities
///
/// 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.
///
[JsonIgnore]
public virtual string ContainingFolderPath
@@ -268,7 +268,7 @@ namespace MediaBrowser.Controller.Entities
public string ServiceName { get; set; }
///
- /// 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.
///
[JsonIgnore]
public string ExternalId { get; set; }
@@ -412,7 +412,7 @@ namespace MediaBrowser.Controller.Entities
}
///
- /// This is just a helper for convenience
+ /// This is just a helper for convenience.
///
/// The primary image path.
[JsonIgnore]
@@ -558,7 +558,7 @@ namespace MediaBrowser.Controller.Entities
public DateTime DateLastRefreshed { get; set; }
///
- /// The logger
+ /// The logger.
///
public static ILoggerFactory LoggerFactory { get; set; }
@@ -813,7 +813,7 @@ namespace MediaBrowser.Controller.Entities
}
///
- /// Finds a parent of a given type
+ /// Finds a parent of a given type.
///
///
/// ``0.
@@ -1367,7 +1367,7 @@ namespace MediaBrowser.Controller.Entities
}
///
- /// Overrides the base implementation to refresh metadata for local trailers
+ /// Overrides the base implementation to refresh metadata for local trailers.
///
/// The options.
/// The cancellation token.
@@ -1769,7 +1769,7 @@ namespace MediaBrowser.Controller.Entities
}
///
- /// Determines if a given user has access to this item
+ /// Determines if a given user has access to this item.
///
/// The user.
/// true if [is parental allowed] [the specified user]; otherwise, false.
@@ -2075,7 +2075,7 @@ namespace MediaBrowser.Controller.Entities
public virtual bool EnableRememberingTrackSelections => true;
///
- /// Adds a studio to the item
+ /// Adds a studio to the item.
///
/// The name.
///
@@ -2111,7 +2111,7 @@ namespace MediaBrowser.Controller.Entities
}
///
- /// Adds a genre to the item
+ /// Adds a genre to the item.
///
/// The name.
///
@@ -2206,7 +2206,7 @@ namespace MediaBrowser.Controller.Entities
}
///
- /// Gets an image
+ /// Gets an image.
///
/// The type.
/// Index of the image.
@@ -2522,7 +2522,7 @@ namespace MediaBrowser.Controller.Entities
}
///
- /// 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.
///
///
public virtual IEnumerable GetDeletePaths()
diff --git a/MediaBrowser.Controller/Entities/CollectionFolder.cs b/MediaBrowser.Controller/Entities/CollectionFolder.cs
index 5023c16035..5c02bd2b54 100644
--- a/MediaBrowser.Controller/Entities/CollectionFolder.cs
+++ b/MediaBrowser.Controller/Entities/CollectionFolder.cs
@@ -18,7 +18,7 @@ namespace MediaBrowser.Controller.Entities
{
///
/// 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.
///
public class CollectionFolder : Folder, ICollectionFolder
{
@@ -142,7 +142,7 @@ namespace MediaBrowser.Controller.Entities
}
///
- /// Allow different display preferences for each collection folder
+ /// Allow different display preferences for each collection folder.
///
/// The display prefs id.
[JsonIgnore]
diff --git a/MediaBrowser.Controller/Entities/Extensions.cs b/MediaBrowser.Controller/Entities/Extensions.cs
index d2ca11740e..3a34c668cf 100644
--- a/MediaBrowser.Controller/Entities/Extensions.cs
+++ b/MediaBrowser.Controller/Entities/Extensions.cs
@@ -6,7 +6,7 @@ using MediaBrowser.Model.Entities;
namespace MediaBrowser.Controller.Entities
{
///
- /// Class Extensions
+ /// Class Extensions.
///
public static class Extensions
{
diff --git a/MediaBrowser.Controller/Entities/Folder.cs b/MediaBrowser.Controller/Entities/Folder.cs
index 77551702a6..d4fa8f9b30 100644
--- 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
{
///
- /// Class Folder
+ /// Class Folder.
///
public class Folder : BaseItem
{
@@ -175,7 +175,7 @@ namespace MediaBrowser.Controller.Entities
public virtual IEnumerable Children => LoadChildren();
///
- /// 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.
///
/// The recursive children.
[JsonIgnore]
@@ -232,7 +232,7 @@ namespace MediaBrowser.Controller.Entities
}
///
- /// Validates that the children of the folder still exist
+ /// Validates that the children of the folder still exist.
///
/// The progress.
/// The cancellation token.
@@ -574,7 +574,7 @@ namespace MediaBrowser.Controller.Entities
}
///
- /// Get the children of this folder from the actual file system
+ /// Get the children of this folder from the actual file system.
///
/// IEnumerable{BaseItem}.
protected virtual IEnumerable GetNonCachedChildren(IDirectoryService directoryService)
@@ -586,7 +586,7 @@ namespace MediaBrowser.Controller.Entities
}
///
- /// Get our children from the repo - stubbed for now
+ /// Get our children from the repo - stubbed for now.
///
/// IEnumerable{BaseItem}.
protected List GetCachedChildren()
@@ -1300,7 +1300,7 @@ namespace MediaBrowser.Controller.Entities
}
///
- /// Gets allowed recursive children of an item
+ /// Gets allowed recursive children of an item.
///
/// The user.
/// if set to true [include linked children].
diff --git a/MediaBrowser.Controller/Entities/Genre.cs b/MediaBrowser.Controller/Entities/Genre.cs
index 55634aa5e3..437def532e 100644
--- a/MediaBrowser.Controller/Entities/Genre.cs
+++ b/MediaBrowser.Controller/Entities/Genre.cs
@@ -8,7 +8,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Controller.Entities
{
///
- /// Class Genre
+ /// Class Genre.
///
public class Genre : BaseItem, IItemByName
{
@@ -32,7 +32,7 @@ namespace MediaBrowser.Controller.Entities
///
/// 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.
///
/// The containing folder path.
[JsonIgnore]
@@ -98,7 +98,7 @@ namespace MediaBrowser.Controller.Entities
}
///
- /// 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.
///
public override bool BeforeMetadataRefresh(bool replaceAllMetdata)
{
diff --git a/MediaBrowser.Controller/Entities/ICollectionFolder.cs b/MediaBrowser.Controller/Entities/ICollectionFolder.cs
index 4f0760746e..245b23ff0b 100644
--- a/MediaBrowser.Controller/Entities/ICollectionFolder.cs
+++ b/MediaBrowser.Controller/Entities/ICollectionFolder.cs
@@ -3,7 +3,7 @@ using System;
namespace MediaBrowser.Controller.Entities
{
///
- /// This is just a marker interface to denote top level folders
+ /// This is just a marker interface to denote top level folders.
///
public interface ICollectionFolder : IHasCollectionType
{
diff --git a/MediaBrowser.Controller/Entities/IHasAspectRatio.cs b/MediaBrowser.Controller/Entities/IHasAspectRatio.cs
index 149c1e5abb..d7d0076681 100644
--- a/MediaBrowser.Controller/Entities/IHasAspectRatio.cs
+++ b/MediaBrowser.Controller/Entities/IHasAspectRatio.cs
@@ -1,7 +1,7 @@
namespace MediaBrowser.Controller.Entities
{
///
- /// Interface IHasAspectRatio
+ /// Interface IHasAspectRatio.
///
public interface IHasAspectRatio
{
diff --git a/MediaBrowser.Controller/Entities/IHasDisplayOrder.cs b/MediaBrowser.Controller/Entities/IHasDisplayOrder.cs
index abee75a28d..13226b2346 100644
--- a/MediaBrowser.Controller/Entities/IHasDisplayOrder.cs
+++ b/MediaBrowser.Controller/Entities/IHasDisplayOrder.cs
@@ -1,7 +1,7 @@
namespace MediaBrowser.Controller.Entities
{
///
- /// Interface IHasDisplayOrder
+ /// Interface IHasDisplayOrder.
///
public interface IHasDisplayOrder
{
diff --git a/MediaBrowser.Controller/Entities/IHasScreenshots.cs b/MediaBrowser.Controller/Entities/IHasScreenshots.cs
index 0975242f5b..b027a0cb13 100644
--- a/MediaBrowser.Controller/Entities/IHasScreenshots.cs
+++ b/MediaBrowser.Controller/Entities/IHasScreenshots.cs
@@ -1,7 +1,7 @@
namespace MediaBrowser.Controller.Entities
{
///
- /// Interface IHasScreenshots
+ /// Interface IHasScreenshots.
///
public interface IHasScreenshots
{
diff --git a/MediaBrowser.Controller/Entities/LinkedChild.cs b/MediaBrowser.Controller/Entities/LinkedChild.cs
index cb698794bf..65753a26ec 100644
--- a/MediaBrowser.Controller/Entities/LinkedChild.cs
+++ b/MediaBrowser.Controller/Entities/LinkedChild.cs
@@ -18,7 +18,7 @@ namespace MediaBrowser.Controller.Entities
public string Id { get; set; }
///
- /// Serves as a cache
+ /// Serves as a cache.
///
public Guid? ItemId { get; set; }
diff --git a/MediaBrowser.Controller/Entities/Movies/BoxSet.cs b/MediaBrowser.Controller/Entities/Movies/BoxSet.cs
index be71bcc3c2..70c48b6f1a 100644
--- 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
{
///
- /// Class BoxSet
+ /// Class BoxSet.
///
public class BoxSet : Folder, IHasTrailers, IHasDisplayOrder, IHasLookupInfo
{
diff --git a/MediaBrowser.Controller/Entities/Movies/Movie.cs b/MediaBrowser.Controller/Entities/Movies/Movie.cs
index 26a1650252..53badac4db 100644
--- 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
{
///
- /// Class Movie
+ /// Class Movie.
///
public class Movie : Video, IHasSpecialFeatures, IHasTrailers, IHasLookupInfo, ISupportsBoxSetGrouping
{
diff --git a/MediaBrowser.Controller/Entities/Person.cs b/MediaBrowser.Controller/Entities/Person.cs
index 56106a266d..331d17fc80 100644
--- a/MediaBrowser.Controller/Entities/Person.cs
+++ b/MediaBrowser.Controller/Entities/Person.cs
@@ -47,7 +47,7 @@ namespace MediaBrowser.Controller.Entities
///
/// 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.
///
/// The containing folder path.
[JsonIgnore]
@@ -120,7 +120,7 @@ namespace MediaBrowser.Controller.Entities
}
///
- /// 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.
///
public override bool BeforeMetadataRefresh(bool replaceAllMetdata)
{
diff --git a/MediaBrowser.Controller/Entities/Studio.cs b/MediaBrowser.Controller/Entities/Studio.cs
index b5ee1e9527..1f64de6a41 100644
--- a/MediaBrowser.Controller/Entities/Studio.cs
+++ b/MediaBrowser.Controller/Entities/Studio.cs
@@ -7,7 +7,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Controller.Entities
{
///
- /// Class Studio
+ /// Class Studio.
///
public class Studio : BaseItem, IItemByName
{
@@ -26,7 +26,7 @@ namespace MediaBrowser.Controller.Entities
///
/// 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.
///
/// The containing folder path.
[JsonIgnore]
@@ -99,7 +99,7 @@ namespace MediaBrowser.Controller.Entities
}
///
- /// 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.
///
public override bool BeforeMetadataRefresh(bool replaceAllMetdata)
{
diff --git a/MediaBrowser.Controller/Entities/TV/Episode.cs b/MediaBrowser.Controller/Entities/TV/Episode.cs
index ec95c0e669..9a5f9097d7 100644
--- 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
{
///
- /// Class Episode
+ /// Class Episode.
///
public class Episode : Video, IHasTrailers, IHasLookupInfo, IHasSeries
{
@@ -104,7 +104,7 @@ namespace MediaBrowser.Controller.Entities.TV
}
///
- /// This Episode's Series Instance
+ /// This Episode's Series Instance.
///
/// The series.
[JsonIgnore]
diff --git a/MediaBrowser.Controller/Entities/TV/Season.cs b/MediaBrowser.Controller/Entities/TV/Season.cs
index c96acf9ca0..2aba1d03d8 100644
--- 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
{
///
- /// Class Season
+ /// Class Season.
///
public class Season : Folder, IHasSeries, IHasLookupInfo
{
@@ -68,7 +68,7 @@ namespace MediaBrowser.Controller.Entities.TV
}
///
- /// This Episode's Series Instance
+ /// This Episode's Series Instance.
///
/// The series.
[JsonIgnore]
@@ -226,7 +226,7 @@ namespace MediaBrowser.Controller.Entities.TV
}
///
- /// 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.
///
/// true if XXXX, false otherwise.
public override bool BeforeMetadataRefresh(bool replaceAllMetdata)
diff --git a/MediaBrowser.Controller/Entities/TV/Series.cs b/MediaBrowser.Controller/Entities/TV/Series.cs
index 315da7a3bf..45daa8a539 100644
--- 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
{
///
- /// Class Series
+ /// Class Series.
///
public class Series : Folder, IHasTrailers, IHasDisplayOrder, IHasLookupInfo, IMetadataContainer
{
@@ -55,7 +55,7 @@ namespace MediaBrowser.Controller.Entities.TV
public IReadOnlyList RemoteTrailerIds { get; set; }
///
- /// airdate, dvd or absolute
+ /// airdate, dvd or absolute.
///
public string DisplayOrder { get; set; }
diff --git a/MediaBrowser.Controller/Entities/Trailer.cs b/MediaBrowser.Controller/Entities/Trailer.cs
index c327d17c9f..6b544afc68 100644
--- a/MediaBrowser.Controller/Entities/Trailer.cs
+++ b/MediaBrowser.Controller/Entities/Trailer.cs
@@ -9,7 +9,7 @@ using MediaBrowser.Model.Providers;
namespace MediaBrowser.Controller.Entities
{
///
- /// Class Trailer
+ /// Class Trailer.
///
public class Trailer : Video, IHasLookupInfo
{
diff --git a/MediaBrowser.Controller/Entities/UserItemData.cs b/MediaBrowser.Controller/Entities/UserItemData.cs
index 4d8db99c49..3298fa2d33 100644
--- 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
{
///
- /// Class UserItemData
+ /// Class UserItemData.
///
public class UserItemData
{
@@ -21,11 +21,11 @@ namespace MediaBrowser.Controller.Entities
public string Key { get; set; }
///
- /// The _rating
+ /// The _rating.
///
private double? _rating;
///
- /// Gets or sets the users 0-10 rating
+ /// Gets or sets the users 0-10 rating.
///
/// The rating.
/// Rating;A 0 to 10 rating is required for UserItemData.
diff --git a/MediaBrowser.Controller/Entities/Video.cs b/MediaBrowser.Controller/Entities/Video.cs
index 8b534f05da..b7d7e8e1a3 100644
--- a/MediaBrowser.Controller/Entities/Video.cs
+++ b/MediaBrowser.Controller/Entities/Video.cs
@@ -17,7 +17,7 @@ using MediaBrowser.Model.MediaInfo;
namespace MediaBrowser.Controller.Entities
{
///
- /// Class Video
+ /// Class Video.
///
public class Video : BaseItem,
IHasAspectRatio,
diff --git a/MediaBrowser.Controller/Entities/Year.cs b/MediaBrowser.Controller/Entities/Year.cs
index d65b90c256..c88498640b 100644
--- a/MediaBrowser.Controller/Entities/Year.cs
+++ b/MediaBrowser.Controller/Entities/Year.cs
@@ -7,7 +7,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Controller.Entities
{
///
- /// Class Year
+ /// Class Year.
///
public class Year : BaseItem, IItemByName
{
@@ -21,7 +21,7 @@ namespace MediaBrowser.Controller.Entities
///
/// 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.
///
/// The containing folder path.
[JsonIgnore]
@@ -108,7 +108,7 @@ namespace MediaBrowser.Controller.Entities
}
///
- /// 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.
///
public override bool BeforeMetadataRefresh(bool replaceAllMetdata)
{
diff --git a/MediaBrowser.Controller/Extensions/StringExtensions.cs b/MediaBrowser.Controller/Extensions/StringExtensions.cs
index b1aaf6534e..e09543e145 100644
--- a/MediaBrowser.Controller/Extensions/StringExtensions.cs
+++ b/MediaBrowser.Controller/Extensions/StringExtensions.cs
@@ -7,7 +7,7 @@ using System.Text.RegularExpressions;
namespace MediaBrowser.Controller.Extensions
{
///
- /// Class BaseExtensions
+ /// Class BaseExtensions.
///
public static class StringExtensions
{
diff --git a/MediaBrowser.Controller/IServerApplicationHost.cs b/MediaBrowser.Controller/IServerApplicationHost.cs
index d1d6c74b86..abdb0f695d 100644
--- a/MediaBrowser.Controller/IServerApplicationHost.cs
+++ b/MediaBrowser.Controller/IServerApplicationHost.cs
@@ -10,7 +10,7 @@ using Microsoft.AspNetCore.Http;
namespace MediaBrowser.Controller
{
///
- /// Interface IServerApplicationHost
+ /// Interface IServerApplicationHost.
///
public interface IServerApplicationHost : IApplicationHost
{
diff --git a/MediaBrowser.Controller/IServerApplicationPaths.cs b/MediaBrowser.Controller/IServerApplicationPaths.cs
index c35a22ac70..155bf9177b 100644
--- a/MediaBrowser.Controller/IServerApplicationPaths.cs
+++ b/MediaBrowser.Controller/IServerApplicationPaths.cs
@@ -5,7 +5,7 @@ namespace MediaBrowser.Controller
public interface IServerApplicationPaths : IApplicationPaths
{
///
- /// Gets the path to the base root media directory
+ /// Gets the path to the base root media directory.
///
/// The root folder path.
string RootFolderPath { get; }
@@ -17,13 +17,13 @@ namespace MediaBrowser.Controller
string DefaultUserViewsPath { get; }
///
- /// Gets the path to the People directory
+ /// Gets the path to the People directory.
///
/// The people path.
string PeoplePath { get; }
///
- /// Gets the path to the Genre directory
+ /// Gets the path to the Genre directory.
///
/// The genre path.
string GenrePath { get; }
@@ -35,25 +35,25 @@ namespace MediaBrowser.Controller
string MusicGenrePath { get; }
///
- /// Gets the path to the Studio directory
+ /// Gets the path to the Studio directory.
///
/// The studio path.
string StudioPath { get; }
///
- /// Gets the path to the Year directory
+ /// Gets the path to the Year directory.
///
/// The year path.
string YearPath { get; }
///
- /// Gets the path to the General IBN directory
+ /// Gets the path to the General IBN directory.
///
/// The general path.
string GeneralPath { get; }
///
- /// Gets the path to the Ratings IBN directory
+ /// Gets the path to the Ratings IBN directory.
///
/// The ratings path.
string RatingsPath { get; }
@@ -65,7 +65,7 @@ namespace MediaBrowser.Controller
string MediaInfoImagesPath { get; }
///
- /// Gets the path to the user configuration directory
+ /// Gets the path to the user configuration directory.
///
/// The user configuration directory path.
string UserConfigurationDirectoryPath { get; }
diff --git a/MediaBrowser.Controller/Library/IIntroProvider.cs b/MediaBrowser.Controller/Library/IIntroProvider.cs
index aa70016112..d45493d404 100644
--- a/MediaBrowser.Controller/Library/IIntroProvider.cs
+++ b/MediaBrowser.Controller/Library/IIntroProvider.cs
@@ -5,7 +5,7 @@ using MediaBrowser.Controller.Entities;
namespace MediaBrowser.Controller.Library
{
///
- /// Class BaseIntroProvider
+ /// Class BaseIntroProvider.
///
public interface IIntroProvider
{
diff --git a/MediaBrowser.Controller/Library/ILibraryManager.cs b/MediaBrowser.Controller/Library/ILibraryManager.cs
index d7237039ef..47c080ebdc 100644
--- a/MediaBrowser.Controller/Library/ILibraryManager.cs
+++ b/MediaBrowser.Controller/Library/ILibraryManager.cs
@@ -21,7 +21,7 @@ using Person = MediaBrowser.Controller.Entities.Person;
namespace MediaBrowser.Controller.Library
{
///
- /// Interface ILibraryManager
+ /// Interface ILibraryManager.
///
public interface ILibraryManager
{
@@ -38,7 +38,7 @@ namespace MediaBrowser.Controller.Library
bool allowIgnorePath = true);
///
- /// Resolves a set of files into a list of BaseItem
+ /// Resolves a set of files into a list of BaseItem.
///
IEnumerable ResolvePaths(
IEnumerable files,
@@ -54,7 +54,7 @@ namespace MediaBrowser.Controller.Library
AggregateFolder RootFolder { get; }
///
- /// Gets a Person
+ /// Gets a Person.
///
/// The name.
/// Task{Person}.
@@ -75,14 +75,14 @@ namespace MediaBrowser.Controller.Library
MusicArtist GetArtist(string name);
MusicArtist GetArtist(string name, DtoOptions options);
///
- /// Gets a Studio
+ /// Gets a Studio.
///
/// The name.
/// Task{Studio}.
Studio GetStudio(string name);
///
- /// Gets a Genre
+ /// Gets a Genre.
///
/// The name.
/// Task{Genre}.
@@ -96,7 +96,7 @@ namespace MediaBrowser.Controller.Library
MusicGenre GetMusicGenre(string name);
///
- /// Gets a Year
+ /// Gets a Year.
///
/// The value.
/// Task{Year}.
@@ -113,7 +113,7 @@ namespace MediaBrowser.Controller.Library
Task ValidatePeople(CancellationToken cancellationToken, IProgress progress);
///
- /// Reloads the root media folder
+ /// Reloads the root media folder.
///
/// The progress.
/// The cancellation token.
diff --git a/MediaBrowser.Controller/Library/ILibraryPostScanTask.cs b/MediaBrowser.Controller/Library/ILibraryPostScanTask.cs
index cba5e8fd72..4032e9d83b 100644
--- a/MediaBrowser.Controller/Library/ILibraryPostScanTask.cs
+++ b/MediaBrowser.Controller/Library/ILibraryPostScanTask.cs
@@ -5,7 +5,7 @@ using System.Threading.Tasks;
namespace MediaBrowser.Controller.Library
{
///
- /// An interface for tasks that run after the media library scan
+ /// An interface for tasks that run after the media library scan.
///
public interface ILibraryPostScanTask
{
diff --git a/MediaBrowser.Controller/Library/IMetadataSaver.cs b/MediaBrowser.Controller/Library/IMetadataSaver.cs
index dd119984e6..027cc5b40e 100644
--- a/MediaBrowser.Controller/Library/IMetadataSaver.cs
+++ b/MediaBrowser.Controller/Library/IMetadataSaver.cs
@@ -4,7 +4,7 @@ using MediaBrowser.Controller.Entities;
namespace MediaBrowser.Controller.Library
{
///
- /// Interface IMetadataSaver
+ /// Interface IMetadataSaver.
///
public interface IMetadataSaver
{
diff --git a/MediaBrowser.Controller/Library/ISearchEngine.cs b/MediaBrowser.Controller/Library/ISearchEngine.cs
index 8498b92aec..31dcbba5bd 100644
--- a/MediaBrowser.Controller/Library/ISearchEngine.cs
+++ b/MediaBrowser.Controller/Library/ISearchEngine.cs
@@ -4,7 +4,7 @@ using MediaBrowser.Model.Search;
namespace MediaBrowser.Controller.Library
{
///
- /// Interface ILibrarySearchEngine
+ /// Interface ILibrarySearchEngine.
///
public interface ISearchEngine
{
diff --git a/MediaBrowser.Controller/Library/IUserDataManager.cs b/MediaBrowser.Controller/Library/IUserDataManager.cs
index f5ccad671b..d08ad4cac0 100644
--- a/MediaBrowser.Controller/Library/IUserDataManager.cs
+++ b/MediaBrowser.Controller/Library/IUserDataManager.cs
@@ -42,14 +42,14 @@ namespace MediaBrowser.Controller.Library
UserItemDataDto GetUserDataDto(BaseItem item, BaseItemDto itemDto, User user, DtoOptions dto_options);
///
- /// Get all user data for the given user
+ /// Get all user data for the given user.
///
///
///
List GetAllUserData(Guid userId);
///
- /// Save the all provided user data for the given user
+ /// Save the all provided user data for the given user.
///
///
///
@@ -58,7 +58,7 @@ namespace MediaBrowser.Controller.Library
void SaveAllUserData(Guid userId, UserItemData[] userData, CancellationToken cancellationToken);
///
- /// Updates playstate for an item and returns true or false indicating if it was played to completion
+ /// Updates playstate for an item and returns true or false indicating if it was played to completion.
///
bool UpdatePlayState(BaseItem item, UserItemData data, long? positionTicks);
}
diff --git a/MediaBrowser.Controller/Library/IUserManager.cs b/MediaBrowser.Controller/Library/IUserManager.cs
index b5b2e47297..fe3e4f9e68 100644
--- a/MediaBrowser.Controller/Library/IUserManager.cs
+++ b/MediaBrowser.Controller/Library/IUserManager.cs
@@ -11,7 +11,7 @@ using MediaBrowser.Model.Users;
namespace MediaBrowser.Controller.Library
{
///
- /// Interface IUserManager
+ /// Interface IUserManager.
///
public interface IUserManager
{
diff --git a/MediaBrowser.Controller/Library/ItemChangeEventArgs.cs b/MediaBrowser.Controller/Library/ItemChangeEventArgs.cs
index c9671de479..b5c48321ba 100644
--- a/MediaBrowser.Controller/Library/ItemChangeEventArgs.cs
+++ b/MediaBrowser.Controller/Library/ItemChangeEventArgs.cs
@@ -3,7 +3,7 @@ using MediaBrowser.Controller.Entities;
namespace MediaBrowser.Controller.Library
{
///
- /// Class ItemChangeEventArgs
+ /// Class ItemChangeEventArgs.
///
public class ItemChangeEventArgs
{
diff --git a/MediaBrowser.Controller/Library/ItemResolveArgs.cs b/MediaBrowser.Controller/Library/ItemResolveArgs.cs
index 096708ee3f..92473eaa18 100644
--- a/MediaBrowser.Controller/Library/ItemResolveArgs.cs
+++ b/MediaBrowser.Controller/Library/ItemResolveArgs.cs
@@ -15,7 +15,7 @@ namespace MediaBrowser.Controller.Library
public class ItemResolveArgs : EventArgs
{
///
- /// The _app paths
+ /// The _app paths.
///
private readonly IServerApplicationPaths _appPaths;
diff --git a/MediaBrowser.Controller/Library/PlaybackProgressEventArgs.cs b/MediaBrowser.Controller/Library/PlaybackProgressEventArgs.cs
index 1ed69975ca..08cfea3c31 100644
--- a/MediaBrowser.Controller/Library/PlaybackProgressEventArgs.cs
+++ b/MediaBrowser.Controller/Library/PlaybackProgressEventArgs.cs
@@ -8,7 +8,7 @@ using MediaBrowser.Model.Dto;
namespace MediaBrowser.Controller.Library
{
///
- /// Holds information about a playback progress event
+ /// Holds information about a playback progress event.
///
public class PlaybackProgressEventArgs : EventArgs
{
diff --git a/MediaBrowser.Controller/Library/Profiler.cs b/MediaBrowser.Controller/Library/Profiler.cs
index c4935868db..f9808a4f44 100644
--- a/MediaBrowser.Controller/Library/Profiler.cs
+++ b/MediaBrowser.Controller/Library/Profiler.cs
@@ -5,21 +5,21 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Controller.Library
{
///
- /// Class Profiler
+ /// Class Profiler.
///
public class Profiler : IDisposable
{
///
- /// The name
+ /// The name.
///
readonly string _name;
///
- /// The stopwatch
+ /// The stopwatch.
///
readonly Stopwatch _stopwatch;
///
- /// The _logger
+ /// The _logger.
///
private readonly ILogger _logger;
diff --git a/MediaBrowser.Controller/Library/SearchHintInfo.cs b/MediaBrowser.Controller/Library/SearchHintInfo.cs
index 692431e345..897c2b7f49 100644
--- a/MediaBrowser.Controller/Library/SearchHintInfo.cs
+++ b/MediaBrowser.Controller/Library/SearchHintInfo.cs
@@ -3,7 +3,7 @@ using MediaBrowser.Controller.Entities;
namespace MediaBrowser.Controller.Library
{
///
- /// Class SearchHintInfo
+ /// Class SearchHintInfo.
///
public class SearchHintInfo
{
diff --git a/MediaBrowser.Controller/Library/TVUtils.cs b/MediaBrowser.Controller/Library/TVUtils.cs
index 885488851f..fc9b3f1c6e 100644
--- a/MediaBrowser.Controller/Library/TVUtils.cs
+++ b/MediaBrowser.Controller/Library/TVUtils.cs
@@ -3,7 +3,7 @@ using System;
namespace MediaBrowser.Controller.Library
{
///
- /// Class TVUtils
+ /// Class TVUtils.
///
public static class TVUtils
{
diff --git a/MediaBrowser.Controller/Library/UserDataSaveEventArgs.cs b/MediaBrowser.Controller/Library/UserDataSaveEventArgs.cs
index 3e7351b8b9..fa01927843 100644
--- a/MediaBrowser.Controller/Library/UserDataSaveEventArgs.cs
+++ b/MediaBrowser.Controller/Library/UserDataSaveEventArgs.cs
@@ -6,7 +6,7 @@ using MediaBrowser.Model.Entities;
namespace MediaBrowser.Controller.Library
{
///
- /// Class UserDataSaveEventArgs
+ /// Class UserDataSaveEventArgs.
///
public class UserDataSaveEventArgs : EventArgs
{
diff --git a/MediaBrowser.Controller/LiveTv/ChannelInfo.cs b/MediaBrowser.Controller/LiveTv/ChannelInfo.cs
index 384ca62aaa..67d0df4fdc 100644
--- a/MediaBrowser.Controller/LiveTv/ChannelInfo.cs
+++ b/MediaBrowser.Controller/LiveTv/ChannelInfo.cs
@@ -3,7 +3,7 @@ using MediaBrowser.Model.LiveTv;
namespace MediaBrowser.Controller.LiveTv
{
///
- /// Class ChannelInfo
+ /// Class ChannelInfo.
///
public class ChannelInfo
{
@@ -44,13 +44,13 @@ namespace MediaBrowser.Controller.LiveTv
public ChannelType ChannelType { get; set; }
///
- /// Supply the image path if it can be accessed directly from the file system
+ /// Supply the image path if it can be accessed directly from the file system.
///
/// The image path.
public string ImagePath { get; set; }
///
- /// Supply the image url if it can be downloaded
+ /// Supply the image url if it can be downloaded.
///
/// The image URL.
public string ImageUrl { get; set; }
diff --git a/MediaBrowser.Controller/LiveTv/ILiveTvManager.cs b/MediaBrowser.Controller/LiveTv/ILiveTvManager.cs
index 4ac40fe88f..f619b011bf 100644
--- a/MediaBrowser.Controller/LiveTv/ILiveTvManager.cs
+++ b/MediaBrowser.Controller/LiveTv/ILiveTvManager.cs
@@ -14,7 +14,7 @@ using MediaBrowser.Model.Querying;
namespace MediaBrowser.Controller.LiveTv
{
///
- /// Manages all live tv services installed on the server
+ /// Manages all live tv services installed on the server.
///
public interface ILiveTvManager
{
diff --git a/MediaBrowser.Controller/LiveTv/LiveTvProgram.cs b/MediaBrowser.Controller/LiveTv/LiveTvProgram.cs
index e17db34c6b..472b061e6a 100644
--- a/MediaBrowser.Controller/LiveTv/LiveTvProgram.cs
+++ b/MediaBrowser.Controller/LiveTv/LiveTvProgram.cs
@@ -140,7 +140,7 @@ namespace MediaBrowser.Controller.LiveTv
///
/// 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.
///
/// The containing folder path.
[JsonIgnore]
diff --git a/MediaBrowser.Controller/LiveTv/ProgramInfo.cs b/MediaBrowser.Controller/LiveTv/ProgramInfo.cs
index aa7ad6ff7c..d06a15323a 100644
--- a/MediaBrowser.Controller/LiveTv/ProgramInfo.cs
+++ b/MediaBrowser.Controller/LiveTv/ProgramInfo.cs
@@ -18,7 +18,7 @@ namespace MediaBrowser.Controller.LiveTv
public string ChannelId { get; set; }
///
- /// Name of the program
+ /// Name of the program.
///
public string Name { get; set; }
@@ -95,13 +95,13 @@ namespace MediaBrowser.Controller.LiveTv
public string EpisodeTitle { get; set; }
///
- /// Supply the image path if it can be accessed directly from the file system
+ /// Supply the image path if it can be accessed directly from the file system.
///
/// The image path.
public string ImagePath { get; set; }
///
- /// Supply the image url if it can be downloaded
+ /// Supply the image url if it can be downloaded.
///
/// The image URL.
public string ImageUrl { get; set; }
diff --git a/MediaBrowser.Controller/LiveTv/RecordingInfo.cs b/MediaBrowser.Controller/LiveTv/RecordingInfo.cs
index 432388d6b6..b9e0218ab2 100644
--- a/MediaBrowser.Controller/LiveTv/RecordingInfo.cs
+++ b/MediaBrowser.Controller/LiveTv/RecordingInfo.cs
@@ -169,13 +169,13 @@ namespace MediaBrowser.Controller.LiveTv
public float? CommunityRating { get; set; }
///
- /// Supply the image path if it can be accessed directly from the file system
+ /// Supply the image path if it can be accessed directly from the file system.
///
/// The image path.
public string ImagePath { get; set; }
///
- /// Supply the image url if it can be downloaded
+ /// Supply the image url if it can be downloaded.
///
/// The image URL.
public string ImageUrl { get; set; }
diff --git a/MediaBrowser.Controller/MediaEncoding/EncodingHelper.cs b/MediaBrowser.Controller/MediaEncoding/EncodingHelper.cs
index 4fff46f4e0..8da714858a 100644
--- a/MediaBrowser.Controller/MediaEncoding/EncodingHelper.cs
+++ b/MediaBrowser.Controller/MediaEncoding/EncodingHelper.cs
@@ -110,7 +110,7 @@ namespace MediaBrowser.Controller.MediaEncoding
}
///
- /// Gets the name of the output video codec
+ /// Gets the name of the output video codec.
///
public string GetVideoEncoder(EncodingJobInfo state, EncodingOptions encodingOptions)
{
@@ -287,7 +287,7 @@ namespace MediaBrowser.Controller.MediaEncoding
}
///
- /// Infers the audio codec based on the url
+ /// Infers the audio codec based on the url.
///
public string InferAudioCodec(string container)
{
@@ -717,7 +717,7 @@ namespace MediaBrowser.Controller.MediaEncoding
}
///
- /// Gets the video bitrate to specify on the command line
+ /// Gets the video bitrate to specify on the command line.
///
public string GetVideoQualityParam(EncodingJobInfo state, string videoEncoder, EncodingOptions encodingOptions, string defaultPreset)
{
@@ -1314,7 +1314,7 @@ namespace MediaBrowser.Controller.MediaEncoding
}
///
- /// Gets the number of audio channels to specify on the command line
+ /// Gets the number of audio channels to specify on the command line.
///
/// The state.
/// The audio stream.
@@ -1500,7 +1500,7 @@ namespace MediaBrowser.Controller.MediaEncoding
}
///
- /// Determines which stream will be used for playback
+ /// Determines which stream will be used for playback.
///
/// All stream.
/// Index of the desired.
@@ -1977,7 +1977,7 @@ namespace MediaBrowser.Controller.MediaEncoding
}
///
- /// If we're going to put a fixed size on the command line, this will calculate it
+ /// If we're going to put a fixed size on the command line, this will calculate it.
///
public string GetOutputSizeParam(
EncodingJobInfo state,
@@ -2521,7 +2521,7 @@ namespace MediaBrowser.Controller.MediaEncoding
}
///
- /// Gets the name of the output video codec
+ /// Gets the name of the output video codec.
///
protected string GetHardwareAcceleratedVideoDecoder(EncodingJobInfo state, EncodingOptions encodingOptions)
{
diff --git a/MediaBrowser.Controller/MediaEncoding/EncodingJobInfo.cs b/MediaBrowser.Controller/MediaEncoding/EncodingJobInfo.cs
index 0d6654f851..b971b7c4bf 100644
--- a/MediaBrowser.Controller/MediaEncoding/EncodingJobInfo.cs
+++ b/MediaBrowser.Controller/MediaEncoding/EncodingJobInfo.cs
@@ -425,7 +425,7 @@ namespace MediaBrowser.Controller.MediaEncoding
}
///
- /// Predicts the audio sample rate that will be in the output stream
+ /// Predicts the audio sample rate that will be in the output stream.
///
public double? TargetVideoLevel
{
@@ -448,7 +448,7 @@ namespace MediaBrowser.Controller.MediaEncoding
}
///
- /// Predicts the audio sample rate that will be in the output stream
+ /// Predicts the audio sample rate that will be in the output stream.
///
public int? TargetVideoBitDepth
{
@@ -483,7 +483,7 @@ namespace MediaBrowser.Controller.MediaEncoding
}
///
- /// Predicts the audio sample rate that will be in the output stream
+ /// Predicts the audio sample rate that will be in the output stream.
///
public float? TargetFramerate
{
@@ -515,7 +515,7 @@ namespace MediaBrowser.Controller.MediaEncoding
}
///
- /// Predicts the audio sample rate that will be in the output stream
+ /// Predicts the audio sample rate that will be in the output stream.
///
public int? TargetPacketLength
{
@@ -531,7 +531,7 @@ namespace MediaBrowser.Controller.MediaEncoding
}
///
- /// Predicts the audio sample rate that will be in the output stream
+ /// Predicts the audio sample rate that will be in the output stream.
///
public string TargetVideoProfile
{
@@ -687,20 +687,20 @@ namespace MediaBrowser.Controller.MediaEncoding
}
///
- /// Enum TranscodingJobType
+ /// Enum TranscodingJobType.
///
public enum TranscodingJobType
{
///
- /// The progressive
+ /// The progressive.
///
Progressive,
///
- /// The HLS
+ /// The HLS.
///
Hls,
///
- /// The dash
+ /// The dash.
///
Dash
}
diff --git a/MediaBrowser.Controller/MediaEncoding/IMediaEncoder.cs b/MediaBrowser.Controller/MediaEncoding/IMediaEncoder.cs
index 393a411a15..f60e702393 100644
--- a/MediaBrowser.Controller/MediaEncoding/IMediaEncoder.cs
+++ b/MediaBrowser.Controller/MediaEncoding/IMediaEncoder.cs
@@ -11,7 +11,7 @@ using MediaBrowser.Model.System;
namespace MediaBrowser.Controller.MediaEncoding
{
///
- /// Interface IMediaEncoder
+ /// Interface IMediaEncoder.
///
public interface IMediaEncoder : ITranscoderSupport
{
diff --git a/MediaBrowser.Controller/MediaEncoding/MediaEncoderHelpers.cs b/MediaBrowser.Controller/MediaEncoding/MediaEncoderHelpers.cs
index 5cedc3d576..6c9bbb043e 100644
--- a/MediaBrowser.Controller/MediaEncoding/MediaEncoderHelpers.cs
+++ b/MediaBrowser.Controller/MediaEncoding/MediaEncoderHelpers.cs
@@ -7,7 +7,7 @@ using MediaBrowser.Model.IO;
namespace MediaBrowser.Controller.MediaEncoding
{
///
- /// Class MediaEncoderHelpers
+ /// Class MediaEncoderHelpers.
///
public static class MediaEncoderHelpers
{
diff --git a/MediaBrowser.Controller/Net/BasePeriodicWebSocketListener.cs b/MediaBrowser.Controller/Net/BasePeriodicWebSocketListener.cs
index 43016e1c9c..a54f6d57b5 100644
--- a/MediaBrowser.Controller/Net/BasePeriodicWebSocketListener.cs
+++ b/MediaBrowser.Controller/Net/BasePeriodicWebSocketListener.cs
@@ -11,7 +11,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Controller.Net
{
///
- /// Starts sending data over a web socket periodically when a message is received, and then stops when a corresponding stop message is received
+ /// Starts sending data over a web socket periodically when a message is received, and then stops when a corresponding stop message is received.
///
/// The type of the T return data type.
/// The type of the T state type.
@@ -20,7 +20,7 @@ namespace MediaBrowser.Controller.Net
where TReturnDataType : class
{
///
- /// The _active connections
+ /// The _active connections.
///
private readonly List> _activeConnections =
new List>();
@@ -38,7 +38,7 @@ namespace MediaBrowser.Controller.Net
protected abstract Task GetDataToSend();
///
- /// The logger
+ /// The logger.
///
protected ILogger> Logger;
@@ -78,7 +78,7 @@ namespace MediaBrowser.Controller.Net
}
///
- /// Starts sending messages over a web socket
+ /// Starts sending messages over a web socket.
///
/// The message.
private void Start(WebSocketMessageInfo message)
@@ -180,7 +180,7 @@ namespace MediaBrowser.Controller.Net
}
///
- /// Stops sending messages over a web socket
+ /// Stops sending messages over a web socket.
///
/// The message.
private void Stop(WebSocketMessageInfo message)
diff --git a/MediaBrowser.Controller/Net/IHttpResultFactory.cs b/MediaBrowser.Controller/Net/IHttpResultFactory.cs
index 25404fa78d..609bd5f596 100644
--- a/MediaBrowser.Controller/Net/IHttpResultFactory.cs
+++ b/MediaBrowser.Controller/Net/IHttpResultFactory.cs
@@ -7,7 +7,7 @@ using MediaBrowser.Model.Services;
namespace MediaBrowser.Controller.Net
{
///
- /// Interface IHttpResultFactory
+ /// Interface IHttpResultFactory.
///
public interface IHttpResultFactory
{
diff --git a/MediaBrowser.Controller/Net/IHttpServer.cs b/MediaBrowser.Controller/Net/IHttpServer.cs
index efb5f4ac3f..e6609fae38 100644
--- a/MediaBrowser.Controller/Net/IHttpServer.cs
+++ b/MediaBrowser.Controller/Net/IHttpServer.cs
@@ -29,19 +29,19 @@ namespace MediaBrowser.Controller.Net
void Init(IEnumerable serviceTypes, IEnumerable listener, IEnumerable urlPrefixes);
///
- /// If set, all requests will respond with this message
+ /// If set, all requests will respond with this message.
///
string GlobalResponse { get; set; }
///
- /// The HTTP request handler
+ /// The HTTP request handler.
///
///
///
Task RequestHandler(HttpContext context);
///
- /// Get the default CORS headers
+ /// Get the default CORS headers.
///
///
///
diff --git a/MediaBrowser.Controller/Net/IWebSocketListener.cs b/MediaBrowser.Controller/Net/IWebSocketListener.cs
index 0f472a2bc7..7250a57b0a 100644
--- a/MediaBrowser.Controller/Net/IWebSocketListener.cs
+++ b/MediaBrowser.Controller/Net/IWebSocketListener.cs
@@ -3,7 +3,7 @@ using System.Threading.Tasks;
namespace MediaBrowser.Controller.Net
{
///
- ///This is an interface for listening to messages coming through a web socket connection
+ ///This is an interface for listening to messages coming through a web socket connection.
///
public interface IWebSocketListener
{
diff --git a/MediaBrowser.Controller/Net/WebSocketMessageInfo.cs b/MediaBrowser.Controller/Net/WebSocketMessageInfo.cs
index 5bf39cae6d..be0b3ddc3f 100644
--- a/MediaBrowser.Controller/Net/WebSocketMessageInfo.cs
+++ b/MediaBrowser.Controller/Net/WebSocketMessageInfo.cs
@@ -3,7 +3,7 @@ using MediaBrowser.Model.Net;
namespace MediaBrowser.Controller.Net
{
///
- /// Class WebSocketMessageInfo
+ /// Class WebSocketMessageInfo.
///
public class WebSocketMessageInfo : WebSocketMessage
{
diff --git a/MediaBrowser.Controller/Persistence/IItemRepository.cs b/MediaBrowser.Controller/Persistence/IItemRepository.cs
index 75fc43a047..0ae1b8bbfa 100644
--- a/MediaBrowser.Controller/Persistence/IItemRepository.cs
+++ b/MediaBrowser.Controller/Persistence/IItemRepository.cs
@@ -9,12 +9,12 @@ using MediaBrowser.Model.Querying;
namespace MediaBrowser.Controller.Persistence
{
///
- /// Provides an interface to implement an Item repository
+ /// Provides an interface to implement an Item repository.
///
public interface IItemRepository : IRepository
{
///
- /// Saves an item
+ /// Saves an item.
///
/// The item.
/// The cancellation token.
@@ -43,14 +43,14 @@ namespace MediaBrowser.Controller.Persistence
BaseItem RetrieveItem(Guid id);
///
- /// Gets chapters for an item
+ /// Gets chapters for an item.
///
///
///
List GetChapters(BaseItem id);
///
- /// Gets a single chapter for an item
+ /// Gets a single chapter for an item.
///
///
///
diff --git a/MediaBrowser.Controller/Persistence/IRepository.cs b/MediaBrowser.Controller/Persistence/IRepository.cs
index 56bf1dd5a8..42f2850762 100644
--- a/MediaBrowser.Controller/Persistence/IRepository.cs
+++ b/MediaBrowser.Controller/Persistence/IRepository.cs
@@ -3,12 +3,12 @@ using System;
namespace MediaBrowser.Controller.Persistence
{
///
- /// Provides a base interface for all the repository interfaces
+ /// Provides a base interface for all the repository interfaces.
///
public interface IRepository : IDisposable
{
///
- /// Gets the name of the repository
+ /// Gets the name of the repository.
///
/// The name.
string Name { get; }
diff --git a/MediaBrowser.Controller/Persistence/IUserDataRepository.cs b/MediaBrowser.Controller/Persistence/IUserDataRepository.cs
index 4c327eeef9..ba7c9fd509 100644
--- a/MediaBrowser.Controller/Persistence/IUserDataRepository.cs
+++ b/MediaBrowser.Controller/Persistence/IUserDataRepository.cs
@@ -5,7 +5,7 @@ using MediaBrowser.Controller.Entities;
namespace MediaBrowser.Controller.Persistence
{
///
- /// Provides an interface to implement a UserData repository
+ /// Provides an interface to implement a UserData repository.
///
public interface IUserDataRepository : IRepository
{
@@ -30,14 +30,14 @@ namespace MediaBrowser.Controller.Persistence
UserItemData GetUserData(long userId, List keys);
///
- /// Return all user data associated with the given user
+ /// Return all user data associated with the given user.
///
///
///
List GetAllUserData(long userId);
///
- /// Save all user data associated with the given user
+ /// Save all user data associated with the given user.
///
///
///
diff --git a/MediaBrowser.Controller/Plugins/IPluginConfigurationPage.cs b/MediaBrowser.Controller/Plugins/IPluginConfigurationPage.cs
index c156da9246..077f5ab63e 100644
--- a/MediaBrowser.Controller/Plugins/IPluginConfigurationPage.cs
+++ b/MediaBrowser.Controller/Plugins/IPluginConfigurationPage.cs
@@ -4,7 +4,7 @@ using MediaBrowser.Common.Plugins;
namespace MediaBrowser.Controller.Plugins
{
///
- /// Interface IConfigurationPage
+ /// Interface IConfigurationPage.
///
public interface IPluginConfigurationPage
{
@@ -34,16 +34,16 @@ namespace MediaBrowser.Controller.Plugins
}
///
- /// Enum ConfigurationPageType
+ /// Enum ConfigurationPageType.
///
public enum ConfigurationPageType
{
///
- /// The plugin configuration
+ /// The plugin configuration.
///
PluginConfiguration,
///
- /// The none
+ /// The none.
///
None
}
diff --git a/MediaBrowser.Controller/Providers/IMetadataProvider.cs b/MediaBrowser.Controller/Providers/IMetadataProvider.cs
index 3e595ff934..62b16dadd7 100644
--- a/MediaBrowser.Controller/Providers/IMetadataProvider.cs
+++ b/MediaBrowser.Controller/Providers/IMetadataProvider.cs
@@ -3,7 +3,7 @@ using MediaBrowser.Controller.Entities;
namespace MediaBrowser.Controller.Providers
{
///
- /// Marker interface
+ /// Marker interface.
///
public interface IMetadataProvider
{
diff --git a/MediaBrowser.Controller/Providers/MetadataRefreshMode.cs b/MediaBrowser.Controller/Providers/MetadataRefreshMode.cs
index 02152ee332..6d49b55104 100644
--- a/MediaBrowser.Controller/Providers/MetadataRefreshMode.cs
+++ b/MediaBrowser.Controller/Providers/MetadataRefreshMode.cs
@@ -3,22 +3,22 @@ namespace MediaBrowser.Controller.Providers
public enum MetadataRefreshMode
{
///
- /// The none
+ /// The none.
///
None = 0,
///
- /// The validation only
+ /// The validation only.
///
ValidationOnly = 1,
///
- /// Providers will be executed based on default rules
+ /// Providers will be executed based on default rules.
///
Default = 2,
///
- /// All providers will be executed to search for new metadata
+ /// All providers will be executed to search for new metadata.
///
FullRefresh = 3
}
diff --git a/MediaBrowser.Controller/Providers/MetadataResult.cs b/MediaBrowser.Controller/Providers/MetadataResult.cs
index af955774f0..270ea24449 100644
--- a/MediaBrowser.Controller/Providers/MetadataResult.cs
+++ b/MediaBrowser.Controller/Providers/MetadataResult.cs
@@ -40,7 +40,7 @@ namespace MediaBrowser.Controller.Providers
}
///
- /// Not only does this clear, but initializes the list so that services can differentiate between a null list and zero people
+ /// Not only does this clear, but initializes the list so that services can differentiate between a null list and zero people.
///
public void ResetPeople()
{
diff --git a/MediaBrowser.Controller/Providers/VideoContentType.cs b/MediaBrowser.Controller/Providers/VideoContentType.cs
index c3b8964a37..49d587f6ce 100644
--- a/MediaBrowser.Controller/Providers/VideoContentType.cs
+++ b/MediaBrowser.Controller/Providers/VideoContentType.cs
@@ -1,17 +1,17 @@
namespace MediaBrowser.Controller.Providers
{
///
- /// Enum VideoContentType
+ /// Enum VideoContentType.
///
public enum VideoContentType
{
///
- /// The episode
+ /// The episode.
///
Episode = 0,
///
- /// The movie
+ /// The movie.
///
Movie = 1
}
diff --git a/MediaBrowser.Controller/Resolvers/BaseItemResolver.cs b/MediaBrowser.Controller/Resolvers/BaseItemResolver.cs
index 637a7e3f05..67acdd9a3c 100644
--- a/MediaBrowser.Controller/Resolvers/BaseItemResolver.cs
+++ b/MediaBrowser.Controller/Resolvers/BaseItemResolver.cs
@@ -4,7 +4,7 @@ using MediaBrowser.Controller.Library;
namespace MediaBrowser.Controller.Resolvers
{
///
- /// Class ItemResolver
+ /// Class ItemResolver.
///
///
public abstract class ItemResolver : IItemResolver
@@ -27,7 +27,7 @@ namespace MediaBrowser.Controller.Resolvers
public virtual ResolverPriority Priority => ResolverPriority.First;
///
- /// Sets initial values on the newly resolved item
+ /// Sets initial values on the newly resolved item.
///
/// The item.
/// The args.
diff --git a/MediaBrowser.Controller/Resolvers/IItemResolver.cs b/MediaBrowser.Controller/Resolvers/IItemResolver.cs
index 751ca8098c..a73937b3e3 100644
--- a/MediaBrowser.Controller/Resolvers/IItemResolver.cs
+++ b/MediaBrowser.Controller/Resolvers/IItemResolver.cs
@@ -7,7 +7,7 @@ using MediaBrowser.Model.IO;
namespace MediaBrowser.Controller.Resolvers
{
///
- /// Interface IItemResolver
+ /// Interface IItemResolver.
///
public interface IItemResolver
{
diff --git a/MediaBrowser.Controller/Resolvers/ResolverPriority.cs b/MediaBrowser.Controller/Resolvers/ResolverPriority.cs
index e393100952..1911e5c1dd 100644
--- a/MediaBrowser.Controller/Resolvers/ResolverPriority.cs
+++ b/MediaBrowser.Controller/Resolvers/ResolverPriority.cs
@@ -1,25 +1,25 @@
namespace MediaBrowser.Controller.Resolvers
{
///
- /// Enum ResolverPriority
+ /// Enum ResolverPriority.
///
public enum ResolverPriority
{
///
- /// The first
+ /// The first.
///
First = 1,
///
- /// The second
+ /// The second.
///
Second = 2,
///
- /// The third
+ /// The third.
///
Third = 3,
Fourth = 4,
///
- /// The last
+ /// The last.
///
Last = 5
}
diff --git a/MediaBrowser.Controller/Session/ISessionManager.cs b/MediaBrowser.Controller/Session/ISessionManager.cs
index 1fdb588ebf..e54f210506 100644
--- a/MediaBrowser.Controller/Session/ISessionManager.cs
+++ b/MediaBrowser.Controller/Session/ISessionManager.cs
@@ -13,7 +13,7 @@ using MediaBrowser.Model.SyncPlay;
namespace MediaBrowser.Controller.Session
{
///
- /// Interface ISessionManager
+ /// Interface ISessionManager.
///
public interface ISessionManager
{
@@ -79,14 +79,14 @@ namespace MediaBrowser.Controller.Session
void UpdateDeviceName(string sessionId, string reportedDeviceName);
///
- /// Used to report that playback has started for an item
+ /// Used to report that playback has started for an item.
///
/// The info.
/// Task.
Task OnPlaybackStart(PlaybackStartInfo info);
///
- /// Used to report playback progress for an item
+ /// Used to report playback progress for an item.
///
/// The info.
/// Task.
@@ -96,7 +96,7 @@ namespace MediaBrowser.Controller.Session
Task OnPlaybackProgress(PlaybackProgressInfo info, bool isAutomated);
///
- /// Used to report that playback has ended for an item
+ /// Used to report that playback has ended for an item.
///
/// The info.
/// Task.
diff --git a/MediaBrowser.Controller/Sorting/IBaseItemComparer.cs b/MediaBrowser.Controller/Sorting/IBaseItemComparer.cs
index 31087edec7..727cbe639c 100644
--- a/MediaBrowser.Controller/Sorting/IBaseItemComparer.cs
+++ b/MediaBrowser.Controller/Sorting/IBaseItemComparer.cs
@@ -4,7 +4,7 @@ using MediaBrowser.Controller.Entities;
namespace MediaBrowser.Controller.Sorting
{
///
- /// Interface IBaseItemComparer
+ /// Interface IBaseItemComparer.
///
public interface IBaseItemComparer : IComparer
{
diff --git a/MediaBrowser.Controller/Sorting/IUserBaseItemComparer.cs b/MediaBrowser.Controller/Sorting/IUserBaseItemComparer.cs
index 6f75d16de1..6d03d97ae3 100644
--- a/MediaBrowser.Controller/Sorting/IUserBaseItemComparer.cs
+++ b/MediaBrowser.Controller/Sorting/IUserBaseItemComparer.cs
@@ -3,7 +3,7 @@ using MediaBrowser.Controller.Library;
namespace MediaBrowser.Controller.Sorting
{
///
- /// Represents a BaseItem comparer that requires a User to perform it's comparison
+ /// Represents a BaseItem comparer that requires a User to perform it's comparison.
///
public interface IUserBaseItemComparer : IBaseItemComparer
{
diff --git a/MediaBrowser.Controller/Sync/IRemoteSyncProvider.cs b/MediaBrowser.Controller/Sync/IRemoteSyncProvider.cs
index c0b62b7530..b2c53365c4 100644
--- a/MediaBrowser.Controller/Sync/IRemoteSyncProvider.cs
+++ b/MediaBrowser.Controller/Sync/IRemoteSyncProvider.cs
@@ -1,7 +1,7 @@
namespace MediaBrowser.Controller.Sync
{
///
- /// A marker interface
+ /// A marker interface.
///
public interface IRemoteSyncProvider
{
diff --git a/MediaBrowser.LocalMetadata/Parsers/BaseItemXmlParser.cs b/MediaBrowser.LocalMetadata/Parsers/BaseItemXmlParser.cs
index f954d4192f..0b567af327 100644
--- a/MediaBrowser.LocalMetadata/Parsers/BaseItemXmlParser.cs
+++ b/MediaBrowser.LocalMetadata/Parsers/BaseItemXmlParser.cs
@@ -14,14 +14,14 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.LocalMetadata.Parsers
{
///
- /// Provides a base class for parsing metadata xml
+ /// Provides a base class for parsing metadata xml.
///
///
public class BaseItemXmlParser
where T : BaseItem
{
///
- /// The logger
+ /// The logger.
///
protected ILogger> Logger { get; private set; }
@@ -40,7 +40,7 @@ namespace MediaBrowser.LocalMetadata.Parsers
}
///
- /// Fetches metadata for an item from one xml file
+ /// Fetches metadata for an item from one xml file.
///
/// The item.
/// The metadata file.
@@ -125,7 +125,7 @@ namespace MediaBrowser.LocalMetadata.Parsers
private readonly CultureInfo _usCulture = new CultureInfo("en-US");
///
- /// Fetches metadata from one Xml Element
+ /// Fetches metadata from one Xml Element.
///
/// The reader.
/// The item result.
@@ -1278,7 +1278,7 @@ namespace MediaBrowser.LocalMetadata.Parsers
///
- /// Used to split names of comma or pipe delimeted genres and people
+ /// Used to split names of comma or pipe delimeted genres and people.
///
/// The value.
/// IEnumerable{System.String}.
diff --git a/MediaBrowser.MediaEncoding/BdInfo/BdInfoExaminer.cs b/MediaBrowser.MediaEncoding/BdInfo/BdInfoExaminer.cs
index 3260f3051e..e6359f4fbe 100644
--- a/MediaBrowser.MediaEncoding/BdInfo/BdInfoExaminer.cs
+++ b/MediaBrowser.MediaEncoding/BdInfo/BdInfoExaminer.cs
@@ -9,7 +9,7 @@ using MediaBrowser.Model.MediaInfo;
namespace MediaBrowser.MediaEncoding.BdInfo
{
///
- /// Class BdInfoExaminer
+ /// Class BdInfoExaminer.
///
public class BdInfoExaminer : IBlurayExaminer
{
diff --git a/MediaBrowser.MediaEncoding/Encoder/MediaEncoder.cs b/MediaBrowser.MediaEncoding/Encoder/MediaEncoder.cs
index a8df27d38b..1183e9fb2e 100644
--- a/MediaBrowser.MediaEncoding/Encoder/MediaEncoder.cs
+++ b/MediaBrowser.MediaEncoding/Encoder/MediaEncoder.cs
@@ -25,7 +25,7 @@ using System.Diagnostics;
namespace MediaBrowser.MediaEncoding.Encoder
{
///
- /// Class MediaEncoder
+ /// Class MediaEncoder.
///
public class MediaEncoder : IMediaEncoder, IDisposable
{
@@ -439,7 +439,7 @@ namespace MediaBrowser.MediaEncoding.Encoder
}
///
- /// The us culture
+ /// The us culture.
///
protected readonly CultureInfo UsCulture = new CultureInfo("en-US");
diff --git a/MediaBrowser.MediaEncoding/Probing/FFProbeHelpers.cs b/MediaBrowser.MediaEncoding/Probing/FFProbeHelpers.cs
index 78dc7b6078..3aa296f7f5 100644
--- a/MediaBrowser.MediaEncoding/Probing/FFProbeHelpers.cs
+++ b/MediaBrowser.MediaEncoding/Probing/FFProbeHelpers.cs
@@ -35,7 +35,7 @@ namespace MediaBrowser.MediaEncoding.Probing
}
///
- /// Gets a string from an FFProbeResult tags dictionary
+ /// Gets a string from an FFProbeResult tags dictionary.
///
/// The tags.
/// The key.
@@ -52,7 +52,7 @@ namespace MediaBrowser.MediaEncoding.Probing
}
///
- /// Gets an int from an FFProbeResult tags dictionary
+ /// Gets an int from an FFProbeResult tags dictionary.
///
/// The tags.
/// The key.
@@ -73,7 +73,7 @@ namespace MediaBrowser.MediaEncoding.Probing
}
///
- /// Gets a DateTime from an FFProbeResult tags dictionary
+ /// Gets a DateTime from an FFProbeResult tags dictionary.
///
/// The tags.
/// The key.
@@ -94,7 +94,7 @@ namespace MediaBrowser.MediaEncoding.Probing
}
///
- /// Converts a dictionary to case insensitive
+ /// Converts a dictionary to case insensitive.
///
/// The dict.
/// Dictionary{System.StringSystem.String}.
diff --git a/MediaBrowser.MediaEncoding/Probing/ProbeResultNormalizer.cs b/MediaBrowser.MediaEncoding/Probing/ProbeResultNormalizer.cs
index 918694e66e..ba807ab85b 100644
--- a/MediaBrowser.MediaEncoding/Probing/ProbeResultNormalizer.cs
+++ b/MediaBrowser.MediaEncoding/Probing/ProbeResultNormalizer.cs
@@ -524,7 +524,7 @@ namespace MediaBrowser.MediaEncoding.Probing
}
///
- /// Converts ffprobe stream info to our MediaAttachment class
+ /// Converts ffprobe stream info to our MediaAttachment class.
///
/// The stream info.
/// MediaAttachments.
@@ -557,7 +557,7 @@ namespace MediaBrowser.MediaEncoding.Probing
}
///
- /// Converts ffprobe stream info to our MediaStream class
+ /// Converts ffprobe stream info to our MediaStream class.
///
/// if set to true [is info].
/// The stream info.
@@ -776,7 +776,7 @@ namespace MediaBrowser.MediaEncoding.Probing
}
///
- /// Gets a string from an FFProbeResult tags dictionary
+ /// Gets a string from an FFProbeResult tags dictionary.
///
/// The tags.
/// The key.
@@ -1166,7 +1166,7 @@ namespace MediaBrowser.MediaEncoding.Probing
}
///
- /// Gets the studios from the tags collection
+ /// Gets the studios from the tags collection.
///
/// The info.
/// The tags.
@@ -1204,7 +1204,7 @@ namespace MediaBrowser.MediaEncoding.Probing
}
///
- /// Gets the genres from the tags collection
+ /// Gets the genres from the tags collection.
///
/// The information.
/// The tags.
diff --git a/MediaBrowser.MediaEncoding/Subtitles/SubtitleEncoder.cs b/MediaBrowser.MediaEncoding/Subtitles/SubtitleEncoder.cs
index b9d526a223..f1aa8ea5f8 100644
--- a/MediaBrowser.MediaEncoding/Subtitles/SubtitleEncoder.cs
+++ b/MediaBrowser.MediaEncoding/Subtitles/SubtitleEncoder.cs
@@ -353,7 +353,7 @@ namespace MediaBrowser.MediaEncoding.Subtitles
}
///
- /// The _semaphoreLocks
+ /// The _semaphoreLocks.
///
private readonly ConcurrentDictionary _semaphoreLocks =
new ConcurrentDictionary();
diff --git a/MediaBrowser.Model/Channels/ChannelFeatures.cs b/MediaBrowser.Model/Channels/ChannelFeatures.cs
index 496102d83b..a55754eddc 100644
--- a/MediaBrowser.Model/Channels/ChannelFeatures.cs
+++ b/MediaBrowser.Model/Channels/ChannelFeatures.cs
@@ -38,7 +38,7 @@ namespace MediaBrowser.Model.Channels
public ChannelMediaContentType[] ContentTypes { get; set; }
///
- /// Represents the maximum number of records the channel allows retrieving at a time
+ /// Represents the maximum number of records the channel allows retrieving at a time.
///
public int? MaxPageSize { get; set; }
diff --git a/MediaBrowser.Model/Channels/ChannelQuery.cs b/MediaBrowser.Model/Channels/ChannelQuery.cs
index d112600390..fd90e7f062 100644
--- a/MediaBrowser.Model/Channels/ChannelQuery.cs
+++ b/MediaBrowser.Model/Channels/ChannelQuery.cs
@@ -10,7 +10,7 @@ namespace MediaBrowser.Model.Channels
public class ChannelQuery
{
///
- /// Fields to return within the items, in addition to basic information
+ /// Fields to return within the items, in addition to basic information.
///
/// The fields.
public ItemFields[] Fields { get; set; }
@@ -34,7 +34,7 @@ namespace MediaBrowser.Model.Channels
public int? StartIndex { get; set; }
///
- /// The maximum number of items to return
+ /// The maximum number of items to return.
///
/// The limit.
public int? Limit { get; set; }
diff --git a/MediaBrowser.Model/Configuration/BaseApplicationConfiguration.cs b/MediaBrowser.Model/Configuration/BaseApplicationConfiguration.cs
index cdd322c948..54f4fb293c 100644
--- a/MediaBrowser.Model/Configuration/BaseApplicationConfiguration.cs
+++ b/MediaBrowser.Model/Configuration/BaseApplicationConfiguration.cs
@@ -12,7 +12,7 @@ namespace MediaBrowser.Model.Configuration
public class BaseApplicationConfiguration
{
///
- /// The number of days we should retain log files
+ /// The number of days we should retain log files.
///
/// The log file retention days.
public int LogFileRetentionDays { get; set; }
diff --git a/MediaBrowser.Model/Configuration/MetadataPluginType.cs b/MediaBrowser.Model/Configuration/MetadataPluginType.cs
index bff12799fa..4c5e952664 100644
--- a/MediaBrowser.Model/Configuration/MetadataPluginType.cs
+++ b/MediaBrowser.Model/Configuration/MetadataPluginType.cs
@@ -3,7 +3,7 @@
namespace MediaBrowser.Model.Configuration
{
///
- /// Enum MetadataPluginType
+ /// Enum MetadataPluginType.
///
public enum MetadataPluginType
{
diff --git a/MediaBrowser.Model/Configuration/ServerConfiguration.cs b/MediaBrowser.Model/Configuration/ServerConfiguration.cs
index afbe02dd36..7428876204 100644
--- a/MediaBrowser.Model/Configuration/ServerConfiguration.cs
+++ b/MediaBrowser.Model/Configuration/ServerConfiguration.cs
@@ -111,19 +111,19 @@ namespace MediaBrowser.Model.Configuration
public string MetadataCountryCode { get; set; }
///
- /// Characters to be replaced with a ' ' in strings to create a sort name
+ /// Characters to be replaced with a ' ' in strings to create a sort name.
///
/// The sort replace characters.
public string[] SortReplaceCharacters { get; set; }
///
- /// Characters to be removed from strings to create a sort name
+ /// Characters to be removed from strings to create a sort name.
///
/// The sort remove characters.
public string[] SortRemoveCharacters { get; set; }
///
- /// Words to be removed from strings to create a sort name
+ /// Words to be removed from strings to create a sort name.
///
/// The sort remove words.
public string[] SortRemoveWords { get; set; }
diff --git a/MediaBrowser.Model/Configuration/UserConfiguration.cs b/MediaBrowser.Model/Configuration/UserConfiguration.cs
index a5179f3ca3..cc0e0c4681 100644
--- a/MediaBrowser.Model/Configuration/UserConfiguration.cs
+++ b/MediaBrowser.Model/Configuration/UserConfiguration.cs
@@ -7,7 +7,7 @@ using Jellyfin.Data.Enums;
namespace MediaBrowser.Model.Configuration
{
///
- /// Class UserConfiguration
+ /// Class UserConfiguration.
///
public class UserConfiguration
{
diff --git a/MediaBrowser.Model/Dlna/AudioOptions.cs b/MediaBrowser.Model/Dlna/AudioOptions.cs
index 1468b0414f..67e4ffe03e 100644
--- a/MediaBrowser.Model/Dlna/AudioOptions.cs
+++ b/MediaBrowser.Model/Dlna/AudioOptions.cs
@@ -47,7 +47,7 @@ namespace MediaBrowser.Model.Dlna
public int? MaxAudioChannels { get; set; }
///
- /// The application's configured quality setting
+ /// The application's configured quality setting.
///
public long? MaxBitrate { get; set; }
diff --git a/MediaBrowser.Model/Dlna/StreamInfo.cs b/MediaBrowser.Model/Dlna/StreamInfo.cs
index 9e9d0b7e11..b89e9ce90a 100644
--- a/MediaBrowser.Model/Dlna/StreamInfo.cs
+++ b/MediaBrowser.Model/Dlna/StreamInfo.cs
@@ -483,7 +483,7 @@ namespace MediaBrowser.Model.Dlna
}
///
- /// Returns the audio stream that will be used
+ /// Returns the audio stream that will be used.
///
public MediaStream TargetAudioStream
{
@@ -499,7 +499,7 @@ namespace MediaBrowser.Model.Dlna
}
///
- /// Returns the video stream that will be used
+ /// Returns the video stream that will be used.
///
public MediaStream TargetVideoStream
{
@@ -515,7 +515,7 @@ namespace MediaBrowser.Model.Dlna
}
///
- /// Predicts the audio sample rate that will be in the output stream
+ /// Predicts the audio sample rate that will be in the output stream.
///
public int? TargetAudioSampleRate
{
@@ -527,7 +527,7 @@ namespace MediaBrowser.Model.Dlna
}
///
- /// Predicts the audio sample rate that will be in the output stream
+ /// Predicts the audio sample rate that will be in the output stream.
///
public int? TargetAudioBitDepth
{
@@ -550,7 +550,7 @@ namespace MediaBrowser.Model.Dlna
}
///
- /// Predicts the audio sample rate that will be in the output stream
+ /// Predicts the audio sample rate that will be in the output stream.
///
public int? TargetVideoBitDepth
{
@@ -597,7 +597,7 @@ namespace MediaBrowser.Model.Dlna
}
///
- /// Predicts the audio sample rate that will be in the output stream
+ /// Predicts the audio sample rate that will be in the output stream.
///
public float? TargetFramerate
{
@@ -611,7 +611,7 @@ namespace MediaBrowser.Model.Dlna
}
///
- /// Predicts the audio sample rate that will be in the output stream
+ /// Predicts the audio sample rate that will be in the output stream.
///
public double? TargetVideoLevel
{
@@ -698,7 +698,7 @@ namespace MediaBrowser.Model.Dlna
}
///
- /// Predicts the audio sample rate that will be in the output stream
+ /// Predicts the audio sample rate that will be in the output stream.
///
public int? TargetPacketLength
{
@@ -712,7 +712,7 @@ namespace MediaBrowser.Model.Dlna
}
///
- /// Predicts the audio sample rate that will be in the output stream
+ /// Predicts the audio sample rate that will be in the output stream.
///
public string TargetVideoProfile
{
@@ -750,7 +750,7 @@ namespace MediaBrowser.Model.Dlna
}
///
- /// Predicts the audio bitrate that will be in the output stream
+ /// Predicts the audio bitrate that will be in the output stream.
///
public int? TargetAudioBitrate
{
@@ -764,7 +764,7 @@ namespace MediaBrowser.Model.Dlna
}
///
- /// Predicts the audio channels that will be in the output stream
+ /// Predicts the audio channels that will be in the output stream.
///
public int? TargetAudioChannels
{
@@ -805,7 +805,7 @@ namespace MediaBrowser.Model.Dlna
}
///
- /// Predicts the audio codec that will be in the output stream
+ /// Predicts the audio codec that will be in the output stream.
///
public string[] TargetAudioCodec
{
@@ -858,7 +858,7 @@ namespace MediaBrowser.Model.Dlna
}
///
- /// Predicts the audio channels that will be in the output stream
+ /// Predicts the audio channels that will be in the output stream.
///
public long? TargetSize
{
diff --git a/MediaBrowser.Model/Dlna/SubtitleDeliveryMethod.cs b/MediaBrowser.Model/Dlna/SubtitleDeliveryMethod.cs
index 7b02045909..e7fe8d6af2 100644
--- a/MediaBrowser.Model/Dlna/SubtitleDeliveryMethod.cs
+++ b/MediaBrowser.Model/Dlna/SubtitleDeliveryMethod.cs
@@ -5,22 +5,22 @@ namespace MediaBrowser.Model.Dlna
public enum SubtitleDeliveryMethod
{
///
- /// The encode
+ /// The encode.
///
Encode = 0,
///
- /// The embed
+ /// The embed.
///
Embed = 1,
///
- /// The external
+ /// The external.
///
External = 2,
///
- /// The HLS
+ /// The HLS.
///
Hls = 3
}
diff --git a/MediaBrowser.Model/Dto/BaseItemDto.cs b/MediaBrowser.Model/Dto/BaseItemDto.cs
index 62005b901d..af3d83adec 100644
--- a/MediaBrowser.Model/Dto/BaseItemDto.cs
+++ b/MediaBrowser.Model/Dto/BaseItemDto.cs
@@ -317,7 +317,7 @@ namespace MediaBrowser.Model.Dto
public int? LocalTrailerCount { get; set; }
///
- /// User data for this item based on the user it's being requested for
+ /// User data for this item based on the user it's being requested for.
///
/// The user data.
public UserItemDataDto UserData { get; set; }
diff --git a/MediaBrowser.Model/Dto/ImageOptions.cs b/MediaBrowser.Model/Dto/ImageOptions.cs
index 158e622a85..3f4405f1e5 100644
--- a/MediaBrowser.Model/Dto/ImageOptions.cs
+++ b/MediaBrowser.Model/Dto/ImageOptions.cs
@@ -61,7 +61,7 @@ namespace MediaBrowser.Model.Dto
///
/// Gets or sets the image tag.
- /// If set this will result in strong, unconditional response caching
+ /// If set this will result in strong, unconditional response caching.
///
/// The hash.
public string Tag { get; set; }
diff --git a/MediaBrowser.Model/Dto/MediaSourceInfo.cs b/MediaBrowser.Model/Dto/MediaSourceInfo.cs
index 0c9e11f8f4..be682be23c 100644
--- a/MediaBrowser.Model/Dto/MediaSourceInfo.cs
+++ b/MediaBrowser.Model/Dto/MediaSourceInfo.cs
@@ -31,7 +31,7 @@ namespace MediaBrowser.Model.Dto
public string Name { get; set; }
///
- /// Differentiate internet url vs local network
+ /// Differentiate internet url vs local network.
///
public bool IsRemote { get; set; }
diff --git a/MediaBrowser.Model/Entities/DisplayPreferences.cs b/MediaBrowser.Model/Entities/DisplayPreferences.cs
index 0e5db01dd5..7e5c5be3b6 100644
--- a/MediaBrowser.Model/Entities/DisplayPreferences.cs
+++ b/MediaBrowser.Model/Entities/DisplayPreferences.cs
@@ -104,7 +104,7 @@ namespace MediaBrowser.Model.Entities
public bool ShowSidebar { get; set; }
///
- /// Gets or sets the client
+ /// Gets or sets the client.
///
public string Client { get; set; }
}
diff --git a/MediaBrowser.Model/Entities/MediaStream.cs b/MediaBrowser.Model/Entities/MediaStream.cs
index f0f7bf838c..d8ee79d0d0 100644
--- a/MediaBrowser.Model/Entities/MediaStream.cs
+++ b/MediaBrowser.Model/Entities/MediaStream.cs
@@ -13,7 +13,7 @@ using MediaBrowser.Model.MediaInfo;
namespace MediaBrowser.Model.Entities
{
///
- /// Class MediaStream
+ /// Class MediaStream.
///
public class MediaStream
{
diff --git a/MediaBrowser.Model/Entities/MetadataProvider.cs b/MediaBrowser.Model/Entities/MetadataProvider.cs
index bcc2b48e70..7fecf67b8e 100644
--- a/MediaBrowser.Model/Entities/MetadataProvider.cs
+++ b/MediaBrowser.Model/Entities/MetadataProvider.cs
@@ -3,28 +3,28 @@
namespace MediaBrowser.Model.Entities
{
///
- /// Enum MetadataProviders
+ /// Enum MetadataProviders.
///
public enum MetadataProvider
{
///
- /// The imdb
+ /// The imdb.
///
Imdb = 2,
///
- /// The TMDB
+ /// The TMDB.
///
Tmdb = 3,
///
- /// The TVDB
+ /// The TVDB.
///
Tvdb = 4,
///
- /// The tvcom
+ /// The tvcom.
///
Tvcom = 5,
///
- /// Tmdb Collection Id
+ /// Tmdb Collection Id.
///
TmdbCollection = 7,
MusicBrainzAlbum = 8,
diff --git a/MediaBrowser.Model/Entities/VirtualFolderInfo.cs b/MediaBrowser.Model/Entities/VirtualFolderInfo.cs
index f8df057618..f2bc6f25e0 100644
--- a/MediaBrowser.Model/Entities/VirtualFolderInfo.cs
+++ b/MediaBrowser.Model/Entities/VirtualFolderInfo.cs
@@ -7,7 +7,7 @@ using MediaBrowser.Model.Configuration;
namespace MediaBrowser.Model.Entities
{
///
- /// Used to hold information about a user's list of configured virtual folders
+ /// Used to hold information about a user's list of configured virtual folders.
///
public class VirtualFolderInfo
{
diff --git a/MediaBrowser.Model/IO/IZipClient.cs b/MediaBrowser.Model/IO/IZipClient.cs
index 83e8a018d6..2daa54f227 100644
--- a/MediaBrowser.Model/IO/IZipClient.cs
+++ b/MediaBrowser.Model/IO/IZipClient.cs
@@ -5,7 +5,7 @@ using System.IO;
namespace MediaBrowser.Model.IO
{
///
- /// Interface IZipClient
+ /// Interface IZipClient.
///
public interface IZipClient
{
diff --git a/MediaBrowser.Model/LiveTv/ChannelType.cs b/MediaBrowser.Model/LiveTv/ChannelType.cs
index b6974cb085..f4c55cb6d0 100644
--- a/MediaBrowser.Model/LiveTv/ChannelType.cs
+++ b/MediaBrowser.Model/LiveTv/ChannelType.cs
@@ -6,7 +6,7 @@ namespace MediaBrowser.Model.LiveTv
public enum ChannelType
{
///
- /// The TV
+ /// The TV.
///
TV,
diff --git a/MediaBrowser.Model/LiveTv/LiveTvChannelQuery.cs b/MediaBrowser.Model/LiveTv/LiveTvChannelQuery.cs
index fe23906898..2b2377fdaf 100644
--- a/MediaBrowser.Model/LiveTv/LiveTvChannelQuery.cs
+++ b/MediaBrowser.Model/LiveTv/LiveTvChannelQuery.cs
@@ -54,7 +54,7 @@ namespace MediaBrowser.Model.LiveTv
public int? StartIndex { get; set; }
///
- /// The maximum number of items to return
+ /// The maximum number of items to return.
///
/// The limit.
public int? Limit { get; set; }
@@ -68,13 +68,13 @@ namespace MediaBrowser.Model.LiveTv
public bool EnableUserData { get; set; }
///
- /// Used to specific whether to return news or not
+ /// Used to specific whether to return news or not.
///
/// If set to null, all programs will be returned
public bool? IsNews { get; set; }
///
- /// Used to specific whether to return movies or not
+ /// Used to specific whether to return movies or not.
///
/// If set to null, all programs will be returned
public bool? IsMovie { get; set; }
@@ -95,7 +95,7 @@ namespace MediaBrowser.Model.LiveTv
public string[] SortBy { get; set; }
///
- /// The sort order to return results with
+ /// The sort order to return results with.
///
/// The sort order.
public SortOrder? SortOrder { get; set; }
diff --git a/MediaBrowser.Model/LiveTv/RecordingQuery.cs b/MediaBrowser.Model/LiveTv/RecordingQuery.cs
index 25755483a7..69e7db4708 100644
--- a/MediaBrowser.Model/LiveTv/RecordingQuery.cs
+++ b/MediaBrowser.Model/LiveTv/RecordingQuery.cs
@@ -37,7 +37,7 @@ namespace MediaBrowser.Model.LiveTv
public int? StartIndex { get; set; }
///
- /// The maximum number of items to return
+ /// The maximum number of items to return.
///
/// The limit.
public int? Limit { get; set; }
@@ -61,7 +61,7 @@ namespace MediaBrowser.Model.LiveTv
public string SeriesTimerId { get; set; }
///
- /// Fields to return within the items, in addition to basic information
+ /// Fields to return within the items, in addition to basic information.
///
/// The fields.
public ItemFields[] Fields { get; set; }
diff --git a/MediaBrowser.Model/LiveTv/SeriesTimerQuery.cs b/MediaBrowser.Model/LiveTv/SeriesTimerQuery.cs
index bda46dd2bc..b899a464b4 100644
--- a/MediaBrowser.Model/LiveTv/SeriesTimerQuery.cs
+++ b/MediaBrowser.Model/LiveTv/SeriesTimerQuery.cs
@@ -7,7 +7,7 @@ namespace MediaBrowser.Model.LiveTv
public class SeriesTimerQuery
{
///
- /// Gets or sets the sort by - SortName, Priority
+ /// Gets or sets the sort by - SortName, Priority.
///
/// The sort by.
public string? SortBy { get; set; }
diff --git a/MediaBrowser.Model/Net/NetworkShare.cs b/MediaBrowser.Model/Net/NetworkShare.cs
index a40cf73e49..6344cbe21e 100644
--- a/MediaBrowser.Model/Net/NetworkShare.cs
+++ b/MediaBrowser.Model/Net/NetworkShare.cs
@@ -6,27 +6,27 @@ namespace MediaBrowser.Model.Net
public class NetworkShare
{
///
- /// The name of the computer that this share belongs to
+ /// The name of the computer that this share belongs to.
///
public string Server { get; set; }
///
- /// Share name
+ /// Share name.
///
public string Name { get; set; }
///
- /// Local path
+ /// Local path.
///
public string Path { get; set; }
///
- /// Share type
+ /// Share type.
///
public NetworkShareType ShareType { get; set; }
///
- /// Comment
+ /// Comment.
///
public string Remark { get; set; }
}
diff --git a/MediaBrowser.Model/Notifications/NotificationOption.cs b/MediaBrowser.Model/Notifications/NotificationOption.cs
index 144949a3b7..ea363d9b17 100644
--- a/MediaBrowser.Model/Notifications/NotificationOption.cs
+++ b/MediaBrowser.Model/Notifications/NotificationOption.cs
@@ -18,7 +18,7 @@ namespace MediaBrowser.Model.Notifications
public string Type { get; set; }
///
- /// User Ids to not monitor (it's opt out)
+ /// User Ids to not monitor (it's opt out).
///
public string[] DisabledMonitorUsers { get; set; }
diff --git a/MediaBrowser.Model/Querying/ItemFields.cs b/MediaBrowser.Model/Querying/ItemFields.cs
index d7cc5ebbea..731d22aaf8 100644
--- a/MediaBrowser.Model/Querying/ItemFields.cs
+++ b/MediaBrowser.Model/Querying/ItemFields.cs
@@ -8,198 +8,198 @@ namespace MediaBrowser.Model.Querying
public enum ItemFields
{
///
- /// The air time
+ /// The air time.
///
AirTime,
///
- /// The can delete
+ /// The can delete.
///
CanDelete,
///
- /// The can download
+ /// The can download.
///
CanDownload,
///
- /// The channel information
+ /// The channel information.
///
ChannelInfo,
///
- /// The chapters
+ /// The chapters.
///
Chapters,
ChildCount,
///
- /// The cumulative run time ticks
+ /// The cumulative run time ticks.
///
CumulativeRunTimeTicks,
///
- /// The custom rating
+ /// The custom rating.
///
CustomRating,
///
- /// The date created of the item
+ /// The date created of the item.
///
DateCreated,
///
- /// The date last media added
+ /// The date last media added.
///
DateLastMediaAdded,
///
- /// Item display preferences
+ /// Item display preferences.
///
DisplayPreferencesId,
///
- /// The etag
+ /// The etag.
///
Etag,
///
- /// The external urls
+ /// The external urls.
///
ExternalUrls,
///
- /// Genres
+ /// Genres.
///
Genres,
///
- /// The home page URL
+ /// The home page URL.
///
HomePageUrl,
///
- /// The item counts
+ /// The item counts.
///
ItemCounts,
///
- /// The media source count
+ /// The media source count.
///
MediaSourceCount,
///
- /// The media versions
+ /// The media versions.
///
MediaSources,
OriginalTitle,
///
- /// The item overview
+ /// The item overview.
///
Overview,
///
- /// The id of the item's parent
+ /// The id of the item's parent.
///
ParentId,
///
- /// The physical path of the item
+ /// The physical path of the item.
///
Path,
///
- /// The list of people for the item
+ /// The list of people for the item.
///
People,
PlayAccess,
///
- /// The production locations
+ /// The production locations.
///
ProductionLocations,
///
- /// Imdb, tmdb, etc
+ /// Imdb, tmdb, etc.
///
ProviderIds,
///
- /// The aspect ratio of the primary image
+ /// The aspect ratio of the primary image.
///
PrimaryImageAspectRatio,
RecursiveItemCount,
///
- /// The settings
+ /// The settings.
///
Settings,
///
- /// The screenshot image tags
+ /// The screenshot image tags.
///
ScreenshotImageTags,
SeriesPrimaryImage,
///
- /// The series studio
+ /// The series studio.
///
SeriesStudio,
///
- /// The sort name of the item
+ /// The sort name of the item.
///
SortName,
///
- /// The special episode numbers
+ /// The special episode numbers.
///
SpecialEpisodeNumbers,
///
- /// The studios of the item
+ /// The studios of the item.
///
Studios,
BasicSyncInfo,
///
- /// The synchronize information
+ /// The synchronize information.
///
SyncInfo,
///
- /// The taglines of the item
+ /// The taglines of the item.
///
Taglines,
///
- /// The tags
+ /// The tags.
///
Tags,
///
- /// The trailer url of the item
+ /// The trailer url of the item.
///
RemoteTrailers,
///
- /// The media streams
+ /// The media streams.
///
MediaStreams,
///
- /// The season user data
+ /// The season user data.
///
SeasonUserData,
///
- /// The service name
+ /// The service name.
///
ServiceName,
ThemeSongIds,
diff --git a/MediaBrowser.Model/Querying/ItemSortBy.cs b/MediaBrowser.Model/Querying/ItemSortBy.cs
index edf71c1a77..0b846bb96c 100644
--- a/MediaBrowser.Model/Querying/ItemSortBy.cs
+++ b/MediaBrowser.Model/Querying/ItemSortBy.cs
@@ -3,7 +3,7 @@
namespace MediaBrowser.Model.Querying
{
///
- /// These represent sort orders that are known by the core
+ /// These represent sort orders that are known by the core.
///
public static class ItemSortBy
{
diff --git a/MediaBrowser.Model/Querying/NextUpQuery.cs b/MediaBrowser.Model/Querying/NextUpQuery.cs
index 0df86cb22d..ee13ffc168 100644
--- a/MediaBrowser.Model/Querying/NextUpQuery.cs
+++ b/MediaBrowser.Model/Querying/NextUpQuery.cs
@@ -33,13 +33,13 @@ namespace MediaBrowser.Model.Querying
public int? StartIndex { get; set; }
///
- /// The maximum number of items to return
+ /// The maximum number of items to return.
///
/// The limit.
public int? Limit { get; set; }
///
- /// Fields to return within the items, in addition to basic information
+ /// Fields to return within the items, in addition to basic information.
///
/// The fields.
public ItemFields[] Fields { get; set; }
diff --git a/MediaBrowser.Model/Querying/QueryResult.cs b/MediaBrowser.Model/Querying/QueryResult.cs
index 42586243da..490f48b84b 100644
--- a/MediaBrowser.Model/Querying/QueryResult.cs
+++ b/MediaBrowser.Model/Querying/QueryResult.cs
@@ -15,7 +15,7 @@ namespace MediaBrowser.Model.Querying
public IReadOnlyList Items { get; set; }
///
- /// The total number of records available
+ /// The total number of records available.
///
/// The total record count.
public int TotalRecordCount { get; set; }
diff --git a/MediaBrowser.Model/Querying/UpcomingEpisodesQuery.cs b/MediaBrowser.Model/Querying/UpcomingEpisodesQuery.cs
index ed1aa7ac6d..12d537492a 100644
--- a/MediaBrowser.Model/Querying/UpcomingEpisodesQuery.cs
+++ b/MediaBrowser.Model/Querying/UpcomingEpisodesQuery.cs
@@ -26,13 +26,13 @@ namespace MediaBrowser.Model.Querying
public int? StartIndex { get; set; }
///
- /// The maximum number of items to return
+ /// The maximum number of items to return.
///
/// The limit.
public int? Limit { get; set; }
///
- /// Fields to return within the items, in addition to basic information
+ /// Fields to return within the items, in addition to basic information.
///
/// The fields.
public ItemFields[] Fields { get; set; }
diff --git a/MediaBrowser.Model/Search/SearchQuery.cs b/MediaBrowser.Model/Search/SearchQuery.cs
index 297199f61c..01ad319a43 100644
--- a/MediaBrowser.Model/Search/SearchQuery.cs
+++ b/MediaBrowser.Model/Search/SearchQuery.cs
@@ -8,7 +8,7 @@ namespace MediaBrowser.Model.Search
public class SearchQuery
{
///
- /// The user to localize search results for
+ /// The user to localize search results for.
///
/// The user id.
public Guid UserId { get; set; }
@@ -26,7 +26,7 @@ namespace MediaBrowser.Model.Search
public int? StartIndex { get; set; }
///
- /// The maximum number of items to return
+ /// The maximum number of items to return.
///
/// The limit.
public int? Limit { get; set; }
diff --git a/MediaBrowser.Model/Services/ApiMemberAttribute.cs b/MediaBrowser.Model/Services/ApiMemberAttribute.cs
index 7c23eee448..63f3ecd55d 100644
--- a/MediaBrowser.Model/Services/ApiMemberAttribute.cs
+++ b/MediaBrowser.Model/Services/ApiMemberAttribute.cs
@@ -58,7 +58,7 @@ namespace MediaBrowser.Model.Services
public string Route { get; set; }
///
- /// Whether to exclude this property from being included in the ModelSchema
+ /// Whether to exclude this property from being included in the ModelSchema.
///
public bool ExcludeInSchema { get; set; }
}
diff --git a/MediaBrowser.Model/Services/IRequest.cs b/MediaBrowser.Model/Services/IRequest.cs
index 89622f3110..8bc1d36681 100644
--- a/MediaBrowser.Model/Services/IRequest.cs
+++ b/MediaBrowser.Model/Services/IRequest.cs
@@ -23,7 +23,7 @@ namespace MediaBrowser.Model.Services
string Verb { get; }
///
- /// The request ContentType
+ /// The request ContentType.
///
string ContentType { get; }
@@ -32,7 +32,7 @@ namespace MediaBrowser.Model.Services
string UserAgent { get; }
///
- /// The expected Response ContentType for this request
+ /// The expected Response ContentType for this request.
///
string ResponseContentType { get; set; }
@@ -55,7 +55,7 @@ namespace MediaBrowser.Model.Services
string RemoteIp { get; }
///
- /// The value of the Authorization Header used to send the Api Key, null if not available
+ /// The value of the Authorization Header used to send the Api Key, null if not available.
///
string Authorization { get; }
@@ -68,7 +68,7 @@ namespace MediaBrowser.Model.Services
long ContentLength { get; }
///
- /// The value of the Referrer, null if not available
+ /// The value of the Referrer, null if not available.
///
Uri UrlReferrer { get; }
}
diff --git a/MediaBrowser.Model/Services/IRequiresRequestStream.cs b/MediaBrowser.Model/Services/IRequiresRequestStream.cs
index 622626edcc..3e5f2da42e 100644
--- a/MediaBrowser.Model/Services/IRequiresRequestStream.cs
+++ b/MediaBrowser.Model/Services/IRequiresRequestStream.cs
@@ -7,7 +7,7 @@ namespace MediaBrowser.Model.Services
public interface IRequiresRequestStream
{
///
- /// The raw Http Request Input Stream
+ /// The raw Http Request Input Stream.
///
Stream RequestStream { get; set; }
}
diff --git a/MediaBrowser.Model/Session/PlayRequest.cs b/MediaBrowser.Model/Session/PlayRequest.cs
index 1a51e23c99..d57bed171a 100644
--- a/MediaBrowser.Model/Session/PlayRequest.cs
+++ b/MediaBrowser.Model/Session/PlayRequest.cs
@@ -7,7 +7,7 @@ using MediaBrowser.Model.Services;
namespace MediaBrowser.Model.Session
{
///
- /// Class PlayRequest
+ /// Class PlayRequest.
///
public class PlayRequest
{
@@ -19,7 +19,7 @@ namespace MediaBrowser.Model.Session
public Guid[] ItemIds { get; set; }
///
- /// Gets or sets the start position ticks that the first item should be played at
+ /// Gets or sets the start position ticks that the first item should be played at.
///
/// The start position ticks.
[ApiMember(Name = "StartPositionTicks", Description = "The starting position of the first item.", IsRequired = false, DataType = "string", ParameterType = "query", Verb = "POST")]
diff --git a/MediaBrowser.Model/Sync/SyncCategory.cs b/MediaBrowser.Model/Sync/SyncCategory.cs
index 215ac301e0..80ad5f56ec 100644
--- a/MediaBrowser.Model/Sync/SyncCategory.cs
+++ b/MediaBrowser.Model/Sync/SyncCategory.cs
@@ -5,15 +5,15 @@ namespace MediaBrowser.Model.Sync
public enum SyncCategory
{
///
- /// The latest
+ /// The latest.
///
Latest = 0,
///
- /// The next up
+ /// The next up.
///
NextUp = 1,
///
- /// The resume
+ /// The resume.
///
Resume = 2
}
diff --git a/MediaBrowser.Model/System/SystemInfo.cs b/MediaBrowser.Model/System/SystemInfo.cs
index a67c38c3ac..18ca74ee30 100644
--- a/MediaBrowser.Model/System/SystemInfo.cs
+++ b/MediaBrowser.Model/System/SystemInfo.cs
@@ -23,7 +23,7 @@ namespace MediaBrowser.Model.System
};
///
- /// Class SystemInfo
+ /// Class SystemInfo.
///
public class SystemInfo : PublicSystemInfo
{
diff --git a/MediaBrowser.Model/Tasks/IScheduledTaskWorker.cs b/MediaBrowser.Model/Tasks/IScheduledTaskWorker.cs
index c79d7fe75d..b08acba2c6 100644
--- a/MediaBrowser.Model/Tasks/IScheduledTaskWorker.cs
+++ b/MediaBrowser.Model/Tasks/IScheduledTaskWorker.cs
@@ -57,7 +57,7 @@ namespace MediaBrowser.Model.Tasks
double? CurrentProgress { get; }
///
- /// Gets the triggers that define when the task will run
+ /// Gets the triggers that define when the task will run.
///
/// The triggers.
/// value
diff --git a/MediaBrowser.Model/Tasks/ITaskManager.cs b/MediaBrowser.Model/Tasks/ITaskManager.cs
index 4a7f579ec5..363773ff74 100644
--- a/MediaBrowser.Model/Tasks/ITaskManager.cs
+++ b/MediaBrowser.Model/Tasks/ITaskManager.cs
@@ -10,7 +10,7 @@ namespace MediaBrowser.Model.Tasks
public interface ITaskManager : IDisposable
{
///
- /// Gets the list of Scheduled Tasks
+ /// Gets the list of Scheduled Tasks.
///
/// The scheduled tasks.
IScheduledTaskWorker[] ScheduledTasks { get; }
diff --git a/MediaBrowser.Providers/Manager/ImageSaver.cs b/MediaBrowser.Providers/Manager/ImageSaver.cs
index 2f5aa18195..29749060c8 100644
--- a/MediaBrowser.Providers/Manager/ImageSaver.cs
+++ b/MediaBrowser.Providers/Manager/ImageSaver.cs
@@ -24,19 +24,19 @@ using Season = MediaBrowser.Controller.Entities.TV.Season;
namespace MediaBrowser.Providers.Manager
{
///
- /// Class ImageSaver
+ /// Class ImageSaver.
///
public class ImageSaver
{
private static readonly CultureInfo UsCulture = new CultureInfo("en-US");
///
- /// The _config
+ /// The _config.
///
private readonly IServerConfigurationManager _config;
///
- /// The _directory watchers
+ /// The _directory watchers.
///
private readonly ILibraryMonitor _libraryMonitor;
private readonly IFileSystem _fileSystem;
diff --git a/MediaBrowser.Providers/Manager/ItemImageProvider.cs b/MediaBrowser.Providers/Manager/ItemImageProvider.cs
index 3d60979f3e..cf55466023 100644
--- a/MediaBrowser.Providers/Manager/ItemImageProvider.cs
+++ b/MediaBrowser.Providers/Manager/ItemImageProvider.cs
@@ -169,7 +169,7 @@ namespace MediaBrowser.Providers.Manager
}
///
- /// Image types that are only one per item
+ /// Image types that are only one per item.
///
private readonly ImageType[] _singularImages =
{
@@ -190,7 +190,7 @@ namespace MediaBrowser.Providers.Manager
}
///
- /// Determines if an item already contains the given images
+ /// Determines if an item already contains the given images.
///
/// The item.
/// The images.
diff --git a/MediaBrowser.Providers/Manager/ProviderManager.cs b/MediaBrowser.Providers/Manager/ProviderManager.cs
index 5b1192c305..a51007a0e3 100644
--- a/MediaBrowser.Providers/Manager/ProviderManager.cs
+++ b/MediaBrowser.Providers/Manager/ProviderManager.cs
@@ -38,7 +38,7 @@ using Series = MediaBrowser.Controller.Entities.TV.Series;
namespace MediaBrowser.Providers.Manager
{
///
- /// Class ProviderManager
+ /// Class ProviderManager.
///
public class ProviderManager : IProviderManager, IDisposable
{
diff --git a/MediaBrowser.Providers/MediaInfo/AudioImageProvider.cs b/MediaBrowser.Providers/MediaInfo/AudioImageProvider.cs
index ef4e1dde9b..9c8d2d6ca4 100644
--- a/MediaBrowser.Providers/MediaInfo/AudioImageProvider.cs
+++ b/MediaBrowser.Providers/MediaInfo/AudioImageProvider.cs
@@ -17,7 +17,7 @@ using MediaBrowser.Model.IO;
namespace MediaBrowser.Providers.MediaInfo
{
///
- /// Uses ffmpeg to create video images
+ /// Uses ffmpeg to create video images.
///
public class AudioImageProvider : IDynamicImageProvider
{
diff --git a/MediaBrowser.Providers/MediaInfo/FFProbeAudioInfo.cs b/MediaBrowser.Providers/MediaInfo/FFProbeAudioInfo.cs
index 73c89e8153..de377086a3 100644
--- a/MediaBrowser.Providers/MediaInfo/FFProbeAudioInfo.cs
+++ b/MediaBrowser.Providers/MediaInfo/FFProbeAudioInfo.cs
@@ -99,7 +99,7 @@ namespace MediaBrowser.Providers.MediaInfo
}
///
- /// Fetches data from the tags dictionary
+ /// Fetches data from the tags dictionary.
///
/// The audio.
/// The data.
diff --git a/MediaBrowser.Providers/MediaInfo/FFProbeVideoInfo.cs b/MediaBrowser.Providers/MediaInfo/FFProbeVideoInfo.cs
index 54847c8a9c..f373a8093c 100644
--- a/MediaBrowser.Providers/MediaInfo/FFProbeVideoInfo.cs
+++ b/MediaBrowser.Providers/MediaInfo/FFProbeVideoInfo.cs
@@ -342,7 +342,7 @@ namespace MediaBrowser.Providers.MediaInfo
}
///
- /// Gets information about the longest playlist on a bdrom
+ /// Gets information about the longest playlist on a bdrom.
///
/// The path.
/// VideoStream.
diff --git a/MediaBrowser.Providers/Plugins/Tmdb/Models/Search/MovieResult.cs b/MediaBrowser.Providers/Plugins/Tmdb/Models/Search/MovieResult.cs
index 51c26a61c5..c0a880bc9f 100644
--- a/MediaBrowser.Providers/Plugins/Tmdb/Models/Search/MovieResult.cs
+++ b/MediaBrowser.Providers/Plugins/Tmdb/Models/Search/MovieResult.cs
@@ -53,7 +53,7 @@ namespace MediaBrowser.Providers.Plugins.Tmdb.Models.Search
/// The vote_average.
public double Vote_Average { get; set; }
///
- /// For collection search results
+ /// For collection search results.
///
public string Name { get; set; }
///
diff --git a/MediaBrowser.Providers/Plugins/Tmdb/Movies/TmdbMovieProvider.cs b/MediaBrowser.Providers/Plugins/Tmdb/Movies/TmdbMovieProvider.cs
index faeb48b12e..3c0922f39b 100644
--- a/MediaBrowser.Providers/Plugins/Tmdb/Movies/TmdbMovieProvider.cs
+++ b/MediaBrowser.Providers/Plugins/Tmdb/Movies/TmdbMovieProvider.cs
@@ -25,7 +25,7 @@ using Microsoft.Extensions.Logging;
namespace MediaBrowser.Providers.Plugins.Tmdb.Movies
{
///
- /// Class MovieDbProvider
+ /// Class MovieDbProvider.
///
public class TmdbMovieProvider : IRemoteMetadataProvider, IHasOrder
{
@@ -129,7 +129,7 @@ namespace MediaBrowser.Providers.Plugins.Tmdb.Movies
public string Name => TmdbUtils.ProviderName;
///
- /// The _TMDB settings task
+ /// The _TMDB settings task.
///
private TmdbSettingsResult _tmdbSettings;
diff --git a/MediaBrowser.Providers/TV/MissingEpisodeProvider.cs b/MediaBrowser.Providers/TV/MissingEpisodeProvider.cs
index aabad3ada8..26259f1aa9 100644
--- a/MediaBrowser.Providers/TV/MissingEpisodeProvider.cs
+++ b/MediaBrowser.Providers/TV/MissingEpisodeProvider.cs
@@ -108,7 +108,7 @@ namespace MediaBrowser.Providers.TV
///
/// Returns true if a series has any seasons or episodes without season or episode numbers
- /// If this data is missing no virtual items will be added in order to prevent possible duplicates
+ /// If this data is missing no virtual items will be added in order to prevent possible duplicates.
///
private bool HasInvalidContent(IList allItems)
{
@@ -171,7 +171,7 @@ namespace MediaBrowser.Providers.TV
}
///
- /// Removes the virtual entry after a corresponding physical version has been added
+ /// Removes the virtual entry after a corresponding physical version has been added.
///
private bool RemoveObsoleteOrMissingEpisodes(
IEnumerable allRecursiveChildren,
diff --git a/RSSDP/DiscoveredSsdpDevice.cs b/RSSDP/DiscoveredSsdpDevice.cs
index 9093199dd6..fb323c1fb3 100644
--- a/RSSDP/DiscoveredSsdpDevice.cs
+++ b/RSSDP/DiscoveredSsdpDevice.cs
@@ -56,7 +56,7 @@ namespace Rssdp
}
///
- /// Returns the headers from the SSDP device response message
+ /// Returns the headers from the SSDP device response message.
///
public HttpHeaders ResponseHeaders { get; set; }