CodingStyle: Adding empty lines between elements

This commit is contained in:
Zoe Roux 2021-09-05 09:46:30 +02:00
parent ef63acced2
commit 2d3659d0b9
22 changed files with 66 additions and 0 deletions

View File

@ -143,6 +143,7 @@ namespace Kyoo.Abstractions.Controllers
/// <returns>The resource found</returns>
[ItemNotNull]
Task<T> Get(string slug);
/// <summary>
/// Get the first resource that match the predicate.
/// </summary>
@ -159,6 +160,7 @@ namespace Kyoo.Abstractions.Controllers
/// <returns>The resource found</returns>
[ItemCanBeNull]
Task<T> GetOrDefault(int id);
/// <summary>
/// Get a resource from it's slug or null if it is not found.
/// </summary>
@ -166,6 +168,7 @@ namespace Kyoo.Abstractions.Controllers
/// <returns>The resource found</returns>
[ItemCanBeNull]
Task<T> GetOrDefault(string slug);
/// <summary>
/// Get the first resource that match the predicate or null if it is not found.
/// </summary>
@ -193,6 +196,7 @@ namespace Kyoo.Abstractions.Controllers
Task<ICollection<T>> GetAll(Expression<Func<T, bool>> where = null,
Sort<T> sort = default,
Pagination limit = default);
/// <summary>
/// Get every resources that match all filters
/// </summary>
@ -246,12 +250,14 @@ namespace Kyoo.Abstractions.Controllers
/// <param name="id">The ID of the resource</param>
/// <exception cref="ItemNotFoundException">If the item is not found</exception>
Task Delete(int id);
/// <summary>
/// Delete a resource by it's slug
/// </summary>
/// <param name="slug">The slug of the resource</param>
/// <exception cref="ItemNotFoundException">If the item is not found</exception>
Task Delete(string slug);
/// <summary>
/// Delete a resource
/// </summary>
@ -344,6 +350,7 @@ namespace Kyoo.Abstractions.Controllers
/// <exception cref="ItemNotFoundException">If the item is not found</exception>
/// <returns>The episode found</returns>
Task<Episode> Get(int showID, int seasonNumber, int episodeNumber);
/// <summary>
/// Get a episode from it's show slug, it's seasonNumber and it's episode number.
/// </summary>
@ -362,6 +369,7 @@ namespace Kyoo.Abstractions.Controllers
/// <param name="episodeNumber">The episode's number</param>
/// <returns>The episode found</returns>
Task<Episode> GetOrDefault(int showID, int seasonNumber, int episodeNumber);
/// <summary>
/// Get a episode from it's show slug, it's seasonNumber and it's episode number or null if it is not found.
/// </summary>
@ -379,6 +387,7 @@ namespace Kyoo.Abstractions.Controllers
/// <exception cref="ItemNotFoundException">If the item is not found</exception>
/// <returns>The episode found</returns>
Task<Episode> GetAbsolute(int showID, int absoluteNumber);
/// <summary>
/// Get a episode from it's showID and it's absolute number.
/// </summary>
@ -416,6 +425,7 @@ namespace Kyoo.Abstractions.Controllers
Expression<Func<LibraryItem, bool>> where = null,
Sort<LibraryItem> sort = default,
Pagination limit = default);
/// <summary>
/// Get items (A wrapper around shows or collections) from a library.
/// </summary>
@ -442,6 +452,7 @@ namespace Kyoo.Abstractions.Controllers
Expression<Func<LibraryItem, bool>> where = null,
Sort<LibraryItem> sort = default,
Pagination limit = default);
/// <summary>
/// Get items (A wrapper around shows or collections) from a library.
/// </summary>
@ -489,6 +500,7 @@ namespace Kyoo.Abstractions.Controllers
Expression<Func<PeopleRole, bool>> where = null,
Sort<PeopleRole> sort = default,
Pagination limit = default);
/// <summary>
/// Get people's roles from a show.
/// </summary>
@ -515,6 +527,7 @@ namespace Kyoo.Abstractions.Controllers
Expression<Func<PeopleRole, bool>> where = null,
Sort<PeopleRole> sort = default,
Pagination limit = default);
/// <summary>
/// Get people's roles from a show.
/// </summary>
@ -541,6 +554,7 @@ namespace Kyoo.Abstractions.Controllers
Expression<Func<PeopleRole, bool>> where = null,
Sort<PeopleRole> sort = default,
Pagination limit = default);
/// <summary>
/// Get people's roles from a person.
/// </summary>
@ -567,6 +581,7 @@ namespace Kyoo.Abstractions.Controllers
Expression<Func<PeopleRole, bool>> where = null,
Sort<PeopleRole> sort = default,
Pagination limit = default);
/// <summary>
/// Get people's roles from a person.
/// </summary>

View File

@ -26,6 +26,7 @@ namespace Kyoo.Abstractions.Models
/// The ID of the People playing the role.
/// </summary>
public int PeopleID { get; set; }
/// <summary>
/// The people that played this role.
/// </summary>
@ -35,6 +36,7 @@ namespace Kyoo.Abstractions.Models
/// The ID of the Show where the People playing in.
/// </summary>
public int ShowID { get; set; }
/// <summary>
/// The show where the People played in.
/// </summary>

View File

@ -44,6 +44,7 @@ namespace Kyoo.Abstractions.Models
/// The ID of the Show containing this season.
/// </summary>
[SerializeIgnore] public int ShowID { get; set; }
/// <summary>
/// The show that contains this season.
/// This must be explicitly loaded via a call to <see cref="ILibraryManager.Load"/>.

View File

@ -14,10 +14,12 @@ namespace Kyoo.Authentication.Models
/// The path of the certificate file.
/// </summary>
public string File { get; set; }
/// <summary>
/// The path of the old certificate file.
/// </summary>
public string OldFile { get; set; }
/// <summary>
/// The password of the certificates.
/// </summary>

View File

@ -33,10 +33,12 @@ namespace Kyoo.Authentication.Views
/// The repository to handle users.
/// </summary>
private readonly IUserRepository _users;
/// <summary>
/// A file manager to send profile pictures
/// </summary>
private readonly IFileSystem _files;
/// <summary>
/// Options about authentication. Those options are monitored and reloads are supported.
/// </summary>

View File

@ -105,10 +105,12 @@ namespace Kyoo.Core.Controllers
/// The path of the request to forward.
/// </summary>
private readonly Uri _path;
/// <summary>
/// Should the proxied result support ranges requests?
/// </summary>
private readonly bool _rangeSupport;
/// <summary>
/// If not null, override the content type of the resulting request.
/// </summary>

View File

@ -19,26 +19,37 @@ namespace Kyoo.Core.Controllers
/// <inheritdoc />
public ILibraryRepository LibraryRepository { get; }
/// <inheritdoc />
public ILibraryItemRepository LibraryItemRepository { get; }
/// <inheritdoc />
public ICollectionRepository CollectionRepository { get; }
/// <inheritdoc />
public IShowRepository ShowRepository { get; }
/// <inheritdoc />
public ISeasonRepository SeasonRepository { get; }
/// <inheritdoc />
public IEpisodeRepository EpisodeRepository { get; }
/// <inheritdoc />
public ITrackRepository TrackRepository { get; }
/// <inheritdoc />
public IPeopleRepository PeopleRepository { get; }
/// <inheritdoc />
public IStudioRepository StudioRepository { get; }
/// <inheritdoc />
public IGenreRepository GenreRepository { get; }
/// <inheritdoc />
public IProviderRepository ProviderRepository { get; }
/// <inheritdoc />
public IUserRepository UserRepository { get; }

View File

@ -22,10 +22,12 @@ namespace Kyoo.Core.Controllers
/// The service provider. It allow plugin's activation.
/// </summary>
private readonly IServiceProvider _provider;
/// <summary>
/// The configuration to get the plugin's directory.
/// </summary>
private readonly IOptions<BasicOptions> _options;
/// <summary>
/// The logger used by this class.
/// </summary>

View File

@ -23,6 +23,7 @@ namespace Kyoo.Core.Controllers
/// The configuration of kyoo to retrieve the identifier regex.
/// </summary>
private readonly IOptionsMonitor<MediaOptions> _configuration;
/// <summary>
/// The library manager used to retrieve libraries paths.
/// </summary>

View File

@ -21,10 +21,12 @@ namespace Kyoo.Core.Controllers
/// The database handle
/// </summary>
private readonly DatabaseContext _database;
/// <summary>
/// A provider repository to handle externalID creation and deletion
/// </summary>
private readonly IProviderRepository _providers;
/// <summary>
/// A track repository to handle creation and deletion of tracks related to the current episode.
/// </summary>

View File

@ -20,6 +20,7 @@ namespace Kyoo.Core.Controllers
/// The database handle
/// </summary>
private readonly DatabaseContext _database;
/// <summary>
/// A lazy loaded library repository to validate queries (check if a library does exist)
/// </summary>

View File

@ -20,6 +20,7 @@ namespace Kyoo.Core.Controllers
/// The database handle
/// </summary>
private readonly DatabaseContext _database;
/// <summary>
/// A provider repository to handle externalID creation and deletion
/// </summary>

View File

@ -21,10 +21,12 @@ namespace Kyoo.Core.Controllers
/// The database handle
/// </summary>
private readonly DatabaseContext _database;
/// <summary>
/// A provider repository to handle externalID creation and deletion
/// </summary>
private readonly IProviderRepository _providers;
/// <summary>
/// A lazy loaded show repository to validate requests from shows.
/// </summary>

View File

@ -20,6 +20,7 @@ namespace Kyoo.Core.Controllers
/// The database handle
/// </summary>
private readonly DatabaseContext _database;
/// <summary>
/// A provider repository to handle externalID creation and deletion
/// </summary>

View File

@ -20,18 +20,22 @@ namespace Kyoo.Core.Controllers
/// The database handle
/// </summary>
private readonly DatabaseContext _database;
/// <summary>
/// A studio repository to handle creation/validation of related studios.
/// </summary>
private readonly IStudioRepository _studios;
/// <summary>
/// A people repository to handle creation/validation of related people.
/// </summary>
private readonly IPeopleRepository _people;
/// <summary>
/// A genres repository to handle creation/validation of related genres.
/// </summary>
private readonly IGenreRepository _genres;
/// <summary>
/// A provider repository to handle externalID creation and deletion
/// </summary>

View File

@ -74,6 +74,7 @@ namespace Kyoo.Core.Controllers
/// The configuration instance used to get schedule information
/// </summary>
private readonly IOptionsMonitor<TaskOptions> _options;
/// <summary>
/// The logger instance.
/// </summary>
@ -83,14 +84,17 @@ namespace Kyoo.Core.Controllers
/// The list of tasks and their next scheduled run.
/// </summary>
private readonly List<ManagedTask> _tasks;
/// <summary>
/// The queue of tasks that should be run as soon as possible.
/// </summary>
private readonly Queue<QueuedTask> _queuedTasks = new();
/// <summary>
/// The currently running task.
/// </summary>
private (TaskMetadataAttribute, ITask)? _runningTask;
/// <summary>
/// The cancellation token used to cancel the running task when the runner should shutdown.
/// </summary>

View File

@ -22,14 +22,17 @@ namespace Kyoo.Core.Tasks
/// The library manager used to get libraries and providers to use.
/// </summary>
private readonly ILibraryManager _libraryManager;
/// <summary>
/// The file manager used walk inside directories and check they existences.
/// </summary>
private readonly IFileSystem _fileSystem;
/// <summary>
/// A task manager used to create sub tasks for each episode to add to the database.
/// </summary>
private readonly ITaskManager _taskManager;
/// <summary>
/// The logger used to inform the current status to the console.
/// </summary>

View File

@ -18,10 +18,12 @@ namespace Kyoo.Core.Tasks
/// The library manager used to get libraries or remove deleted episodes.
/// </summary>
private readonly ILibraryManager _libraryManager;
/// <summary>
/// The file manager used walk inside directories and check they existences.
/// </summary>
private readonly IFileSystem _fileSystem;
/// <summary>
/// The logger used to inform the user that episodes has been removed.
/// </summary>

View File

@ -19,10 +19,12 @@ namespace Kyoo.Core.Tasks
/// The provider repository used to create in-db providers from metadata providers.
/// </summary>
private readonly IProviderRepository _providers;
/// <summary>
/// The thumbnail manager used to download providers logo.
/// </summary>
private readonly IThumbnailsManager _thumbnails;
/// <summary>
/// The list of metadata providers to register.
/// </summary>

View File

@ -18,6 +18,7 @@ namespace Kyoo.Core.Tasks
/// The plugin manager used to retrieve plugins to initialize them.
/// </summary>
private readonly IPluginManager _pluginManager;
/// <summary>
/// The service provider given to each <see cref="IPlugin.Initialize"/> method.
/// </summary>

View File

@ -19,18 +19,22 @@ namespace Kyoo.Core.Tasks
/// An identifier to extract metadata from paths.
/// </summary>
private readonly IIdentifier _identifier;
/// <summary>
/// The library manager used to register the episode.
/// </summary>
private readonly ILibraryManager _libraryManager;
/// <summary>
/// A metadata provider to retrieve the metadata of the new episode (and related items if they do not exist).
/// </summary>
private readonly AProviderComposite _metadataProvider;
/// <summary>
/// The thumbnail manager used to download images.
/// </summary>
private readonly IThumbnailsManager _thumbnailsManager;
/// <summary>
/// The transcoder used to extract subtitles and metadata.
/// </summary>

View File

@ -18,6 +18,7 @@ namespace Kyoo.Core.Tasks
/// An identifier to extract metadata from paths.
/// </summary>
private readonly IIdentifier _identifier;
/// <summary>
/// The library manager used to register the episode.
/// </summary>