aboutsummaryrefslogtreecommitdiff
path: root/Emby.Server.Implementations/Channels/ChannelPostScanTask.cs
diff options
context:
space:
mode:
authorJoshua M. Boniface <joshua@boniface.me>2020-06-13 16:28:37 -0400
committerGitHub <noreply@github.com>2020-06-13 16:28:37 -0400
commit0011e8df47380936742302ef40639a4626a780ed (patch)
treeb286c590e9d1dbc00cf1acbf8e50f90713e8faf8 /Emby.Server.Implementations/Channels/ChannelPostScanTask.cs
parentd975ad155e7857bcbfcf55246fd78dd87ed594ca (diff)
parentec3e15db5789b6218482beb488433f41f9a0d8ba (diff)
Merge pull request #3332 from crobibero/api-migration
Merge master into api-migration
Diffstat (limited to 'Emby.Server.Implementations/Channels/ChannelPostScanTask.cs')
-rw-r--r--Emby.Server.Implementations/Channels/ChannelPostScanTask.cs17
1 files changed, 15 insertions, 2 deletions
diff --git a/Emby.Server.Implementations/Channels/ChannelPostScanTask.cs b/Emby.Server.Implementations/Channels/ChannelPostScanTask.cs
index 250e9da64..eeb49b8fe 100644
--- a/Emby.Server.Implementations/Channels/ChannelPostScanTask.cs
+++ b/Emby.Server.Implementations/Channels/ChannelPostScanTask.cs
@@ -1,5 +1,3 @@
-#pragma warning disable CS1591
-
using System;
using System.Linq;
using System.Threading;
@@ -11,12 +9,21 @@ using Microsoft.Extensions.Logging;
namespace Emby.Server.Implementations.Channels
{
+ /// <summary>
+ /// A task to remove all non-installed channels from the database.
+ /// </summary>
public class ChannelPostScanTask
{
private readonly IChannelManager _channelManager;
private readonly ILogger _logger;
private readonly ILibraryManager _libraryManager;
+ /// <summary>
+ /// Initializes a new instance of the <see cref="ChannelPostScanTask"/> class.
+ /// </summary>
+ /// <param name="channelManager">The channel manager.</param>
+ /// <param name="logger">The logger.</param>
+ /// <param name="libraryManager">The library manager.</param>
public ChannelPostScanTask(IChannelManager channelManager, ILogger logger, ILibraryManager libraryManager)
{
_channelManager = channelManager;
@@ -24,6 +31,12 @@ namespace Emby.Server.Implementations.Channels
_libraryManager = libraryManager;
}
+ /// <summary>
+ /// Runs this task.
+ /// </summary>
+ /// <param name="progress">The progress.</param>
+ /// <param name="cancellationToken">The cancellation token.</param>
+ /// <returns>The completed task.</returns>
public Task Run(IProgress<double> progress, CancellationToken cancellationToken)
{
CleanDatabase(cancellationToken);