diff --git a/Kyoo.Abstractions/Controllers/IRepository.cs b/Kyoo.Abstractions/Controllers/IRepository.cs index f25eb6bb..1fa8af25 100644 --- a/Kyoo.Abstractions/Controllers/IRepository.cs +++ b/Kyoo.Abstractions/Controllers/IRepository.cs @@ -143,6 +143,7 @@ namespace Kyoo.Abstractions.Controllers /// The resource found [ItemNotNull] Task Get(string slug); + /// /// Get the first resource that match the predicate. /// @@ -159,6 +160,7 @@ namespace Kyoo.Abstractions.Controllers /// The resource found [ItemCanBeNull] Task GetOrDefault(int id); + /// /// Get a resource from it's slug or null if it is not found. /// @@ -166,6 +168,7 @@ namespace Kyoo.Abstractions.Controllers /// The resource found [ItemCanBeNull] Task GetOrDefault(string slug); + /// /// Get the first resource that match the predicate or null if it is not found. /// @@ -193,6 +196,7 @@ namespace Kyoo.Abstractions.Controllers Task> GetAll(Expression> where = null, Sort sort = default, Pagination limit = default); + /// /// Get every resources that match all filters /// @@ -246,12 +250,14 @@ namespace Kyoo.Abstractions.Controllers /// The ID of the resource /// If the item is not found Task Delete(int id); + /// /// Delete a resource by it's slug /// /// The slug of the resource /// If the item is not found Task Delete(string slug); + /// /// Delete a resource /// @@ -344,6 +350,7 @@ namespace Kyoo.Abstractions.Controllers /// If the item is not found /// The episode found Task Get(int showID, int seasonNumber, int episodeNumber); + /// /// Get a episode from it's show slug, it's seasonNumber and it's episode number. /// @@ -362,6 +369,7 @@ namespace Kyoo.Abstractions.Controllers /// The episode's number /// The episode found Task GetOrDefault(int showID, int seasonNumber, int episodeNumber); + /// /// Get a episode from it's show slug, it's seasonNumber and it's episode number or null if it is not found. /// @@ -379,6 +387,7 @@ namespace Kyoo.Abstractions.Controllers /// If the item is not found /// The episode found Task GetAbsolute(int showID, int absoluteNumber); + /// /// Get a episode from it's showID and it's absolute number. /// @@ -416,6 +425,7 @@ namespace Kyoo.Abstractions.Controllers Expression> where = null, Sort sort = default, Pagination limit = default); + /// /// Get items (A wrapper around shows or collections) from a library. /// @@ -442,6 +452,7 @@ namespace Kyoo.Abstractions.Controllers Expression> where = null, Sort sort = default, Pagination limit = default); + /// /// Get items (A wrapper around shows or collections) from a library. /// @@ -489,6 +500,7 @@ namespace Kyoo.Abstractions.Controllers Expression> where = null, Sort sort = default, Pagination limit = default); + /// /// Get people's roles from a show. /// @@ -515,6 +527,7 @@ namespace Kyoo.Abstractions.Controllers Expression> where = null, Sort sort = default, Pagination limit = default); + /// /// Get people's roles from a show. /// @@ -541,6 +554,7 @@ namespace Kyoo.Abstractions.Controllers Expression> where = null, Sort sort = default, Pagination limit = default); + /// /// Get people's roles from a person. /// @@ -567,6 +581,7 @@ namespace Kyoo.Abstractions.Controllers Expression> where = null, Sort sort = default, Pagination limit = default); + /// /// Get people's roles from a person. /// diff --git a/Kyoo.Abstractions/Models/PeopleRole.cs b/Kyoo.Abstractions/Models/PeopleRole.cs index 0baf681e..b552a622 100644 --- a/Kyoo.Abstractions/Models/PeopleRole.cs +++ b/Kyoo.Abstractions/Models/PeopleRole.cs @@ -26,6 +26,7 @@ namespace Kyoo.Abstractions.Models /// The ID of the People playing the role. /// public int PeopleID { get; set; } + /// /// The people that played this role. /// @@ -35,6 +36,7 @@ namespace Kyoo.Abstractions.Models /// The ID of the Show where the People playing in. /// public int ShowID { get; set; } + /// /// The show where the People played in. /// diff --git a/Kyoo.Abstractions/Models/Resources/Season.cs b/Kyoo.Abstractions/Models/Resources/Season.cs index ed9f415c..965e1f44 100644 --- a/Kyoo.Abstractions/Models/Resources/Season.cs +++ b/Kyoo.Abstractions/Models/Resources/Season.cs @@ -44,6 +44,7 @@ namespace Kyoo.Abstractions.Models /// The ID of the Show containing this season. /// [SerializeIgnore] public int ShowID { get; set; } + /// /// The show that contains this season. /// This must be explicitly loaded via a call to . diff --git a/Kyoo.Authentication/Models/Options/CertificateOption.cs b/Kyoo.Authentication/Models/Options/CertificateOption.cs index 41eba09a..6ffec41c 100644 --- a/Kyoo.Authentication/Models/Options/CertificateOption.cs +++ b/Kyoo.Authentication/Models/Options/CertificateOption.cs @@ -14,10 +14,12 @@ namespace Kyoo.Authentication.Models /// The path of the certificate file. /// public string File { get; set; } + /// /// The path of the old certificate file. /// public string OldFile { get; set; } + /// /// The password of the certificates. /// diff --git a/Kyoo.Authentication/Views/AccountApi.cs b/Kyoo.Authentication/Views/AccountApi.cs index 4c496632..de2a06a5 100644 --- a/Kyoo.Authentication/Views/AccountApi.cs +++ b/Kyoo.Authentication/Views/AccountApi.cs @@ -33,10 +33,12 @@ namespace Kyoo.Authentication.Views /// The repository to handle users. /// private readonly IUserRepository _users; + /// /// A file manager to send profile pictures /// private readonly IFileSystem _files; + /// /// Options about authentication. Those options are monitored and reloads are supported. /// diff --git a/Kyoo.Core/Controllers/FileSystems/HttpFileSystem.cs b/Kyoo.Core/Controllers/FileSystems/HttpFileSystem.cs index fb09db8e..4b27686b 100644 --- a/Kyoo.Core/Controllers/FileSystems/HttpFileSystem.cs +++ b/Kyoo.Core/Controllers/FileSystems/HttpFileSystem.cs @@ -105,10 +105,12 @@ namespace Kyoo.Core.Controllers /// The path of the request to forward. /// private readonly Uri _path; + /// /// Should the proxied result support ranges requests? /// private readonly bool _rangeSupport; + /// /// If not null, override the content type of the resulting request. /// diff --git a/Kyoo.Core/Controllers/LibraryManager.cs b/Kyoo.Core/Controllers/LibraryManager.cs index dadacd1d..21801c9b 100644 --- a/Kyoo.Core/Controllers/LibraryManager.cs +++ b/Kyoo.Core/Controllers/LibraryManager.cs @@ -19,26 +19,37 @@ namespace Kyoo.Core.Controllers /// public ILibraryRepository LibraryRepository { get; } + /// public ILibraryItemRepository LibraryItemRepository { get; } + /// public ICollectionRepository CollectionRepository { get; } + /// public IShowRepository ShowRepository { get; } + /// public ISeasonRepository SeasonRepository { get; } + /// public IEpisodeRepository EpisodeRepository { get; } + /// public ITrackRepository TrackRepository { get; } + /// public IPeopleRepository PeopleRepository { get; } + /// public IStudioRepository StudioRepository { get; } + /// public IGenreRepository GenreRepository { get; } + /// public IProviderRepository ProviderRepository { get; } + /// public IUserRepository UserRepository { get; } diff --git a/Kyoo.Core/Controllers/PluginManager.cs b/Kyoo.Core/Controllers/PluginManager.cs index 77c00924..649bdffa 100644 --- a/Kyoo.Core/Controllers/PluginManager.cs +++ b/Kyoo.Core/Controllers/PluginManager.cs @@ -22,10 +22,12 @@ namespace Kyoo.Core.Controllers /// The service provider. It allow plugin's activation. /// private readonly IServiceProvider _provider; + /// /// The configuration to get the plugin's directory. /// private readonly IOptions _options; + /// /// The logger used by this class. /// diff --git a/Kyoo.Core/Controllers/RegexIdentifier.cs b/Kyoo.Core/Controllers/RegexIdentifier.cs index c3da511a..44bdd4f8 100644 --- a/Kyoo.Core/Controllers/RegexIdentifier.cs +++ b/Kyoo.Core/Controllers/RegexIdentifier.cs @@ -23,6 +23,7 @@ namespace Kyoo.Core.Controllers /// The configuration of kyoo to retrieve the identifier regex. /// private readonly IOptionsMonitor _configuration; + /// /// The library manager used to retrieve libraries paths. /// diff --git a/Kyoo.Core/Controllers/Repositories/EpisodeRepository.cs b/Kyoo.Core/Controllers/Repositories/EpisodeRepository.cs index 05f6b86d..6946c747 100644 --- a/Kyoo.Core/Controllers/Repositories/EpisodeRepository.cs +++ b/Kyoo.Core/Controllers/Repositories/EpisodeRepository.cs @@ -21,10 +21,12 @@ namespace Kyoo.Core.Controllers /// The database handle /// private readonly DatabaseContext _database; + /// /// A provider repository to handle externalID creation and deletion /// private readonly IProviderRepository _providers; + /// /// A track repository to handle creation and deletion of tracks related to the current episode. /// diff --git a/Kyoo.Core/Controllers/Repositories/LibraryItemRepository.cs b/Kyoo.Core/Controllers/Repositories/LibraryItemRepository.cs index ad6d3958..79b36f9a 100644 --- a/Kyoo.Core/Controllers/Repositories/LibraryItemRepository.cs +++ b/Kyoo.Core/Controllers/Repositories/LibraryItemRepository.cs @@ -20,6 +20,7 @@ namespace Kyoo.Core.Controllers /// The database handle /// private readonly DatabaseContext _database; + /// /// A lazy loaded library repository to validate queries (check if a library does exist) /// diff --git a/Kyoo.Core/Controllers/Repositories/LibraryRepository.cs b/Kyoo.Core/Controllers/Repositories/LibraryRepository.cs index 933a2c07..8339505d 100644 --- a/Kyoo.Core/Controllers/Repositories/LibraryRepository.cs +++ b/Kyoo.Core/Controllers/Repositories/LibraryRepository.cs @@ -20,6 +20,7 @@ namespace Kyoo.Core.Controllers /// The database handle /// private readonly DatabaseContext _database; + /// /// A provider repository to handle externalID creation and deletion /// diff --git a/Kyoo.Core/Controllers/Repositories/PeopleRepository.cs b/Kyoo.Core/Controllers/Repositories/PeopleRepository.cs index ca615782..6be87e9f 100644 --- a/Kyoo.Core/Controllers/Repositories/PeopleRepository.cs +++ b/Kyoo.Core/Controllers/Repositories/PeopleRepository.cs @@ -21,10 +21,12 @@ namespace Kyoo.Core.Controllers /// The database handle /// private readonly DatabaseContext _database; + /// /// A provider repository to handle externalID creation and deletion /// private readonly IProviderRepository _providers; + /// /// A lazy loaded show repository to validate requests from shows. /// diff --git a/Kyoo.Core/Controllers/Repositories/SeasonRepository.cs b/Kyoo.Core/Controllers/Repositories/SeasonRepository.cs index 7075e1ad..7f26c4b3 100644 --- a/Kyoo.Core/Controllers/Repositories/SeasonRepository.cs +++ b/Kyoo.Core/Controllers/Repositories/SeasonRepository.cs @@ -20,6 +20,7 @@ namespace Kyoo.Core.Controllers /// The database handle /// private readonly DatabaseContext _database; + /// /// A provider repository to handle externalID creation and deletion /// diff --git a/Kyoo.Core/Controllers/Repositories/ShowRepository.cs b/Kyoo.Core/Controllers/Repositories/ShowRepository.cs index 740ea06f..4d06daf1 100644 --- a/Kyoo.Core/Controllers/Repositories/ShowRepository.cs +++ b/Kyoo.Core/Controllers/Repositories/ShowRepository.cs @@ -20,18 +20,22 @@ namespace Kyoo.Core.Controllers /// The database handle /// private readonly DatabaseContext _database; + /// /// A studio repository to handle creation/validation of related studios. /// private readonly IStudioRepository _studios; + /// /// A people repository to handle creation/validation of related people. /// private readonly IPeopleRepository _people; + /// /// A genres repository to handle creation/validation of related genres. /// private readonly IGenreRepository _genres; + /// /// A provider repository to handle externalID creation and deletion /// diff --git a/Kyoo.Core/Controllers/TaskManager.cs b/Kyoo.Core/Controllers/TaskManager.cs index ba713e81..63ae2f3f 100644 --- a/Kyoo.Core/Controllers/TaskManager.cs +++ b/Kyoo.Core/Controllers/TaskManager.cs @@ -74,6 +74,7 @@ namespace Kyoo.Core.Controllers /// The configuration instance used to get schedule information /// private readonly IOptionsMonitor _options; + /// /// The logger instance. /// @@ -83,14 +84,17 @@ namespace Kyoo.Core.Controllers /// The list of tasks and their next scheduled run. /// private readonly List _tasks; + /// /// The queue of tasks that should be run as soon as possible. /// private readonly Queue _queuedTasks = new(); + /// /// The currently running task. /// private (TaskMetadataAttribute, ITask)? _runningTask; + /// /// The cancellation token used to cancel the running task when the runner should shutdown. /// diff --git a/Kyoo.Core/Tasks/Crawler.cs b/Kyoo.Core/Tasks/Crawler.cs index 96f8576a..78625dea 100644 --- a/Kyoo.Core/Tasks/Crawler.cs +++ b/Kyoo.Core/Tasks/Crawler.cs @@ -22,14 +22,17 @@ namespace Kyoo.Core.Tasks /// The library manager used to get libraries and providers to use. /// private readonly ILibraryManager _libraryManager; + /// /// The file manager used walk inside directories and check they existences. /// private readonly IFileSystem _fileSystem; + /// /// A task manager used to create sub tasks for each episode to add to the database. /// private readonly ITaskManager _taskManager; + /// /// The logger used to inform the current status to the console. /// diff --git a/Kyoo.Core/Tasks/Housekeeping.cs b/Kyoo.Core/Tasks/Housekeeping.cs index f27a05c4..43d6a585 100644 --- a/Kyoo.Core/Tasks/Housekeeping.cs +++ b/Kyoo.Core/Tasks/Housekeeping.cs @@ -18,10 +18,12 @@ namespace Kyoo.Core.Tasks /// The library manager used to get libraries or remove deleted episodes. /// private readonly ILibraryManager _libraryManager; + /// /// The file manager used walk inside directories and check they existences. /// private readonly IFileSystem _fileSystem; + /// /// The logger used to inform the user that episodes has been removed. /// diff --git a/Kyoo.Core/Tasks/MetadataProviderLoader.cs b/Kyoo.Core/Tasks/MetadataProviderLoader.cs index 6a3270f3..36ed7f14 100644 --- a/Kyoo.Core/Tasks/MetadataProviderLoader.cs +++ b/Kyoo.Core/Tasks/MetadataProviderLoader.cs @@ -19,10 +19,12 @@ namespace Kyoo.Core.Tasks /// The provider repository used to create in-db providers from metadata providers. /// private readonly IProviderRepository _providers; + /// /// The thumbnail manager used to download providers logo. /// private readonly IThumbnailsManager _thumbnails; + /// /// The list of metadata providers to register. /// diff --git a/Kyoo.Core/Tasks/PluginInitializer.cs b/Kyoo.Core/Tasks/PluginInitializer.cs index ece55603..e51219bf 100644 --- a/Kyoo.Core/Tasks/PluginInitializer.cs +++ b/Kyoo.Core/Tasks/PluginInitializer.cs @@ -18,6 +18,7 @@ namespace Kyoo.Core.Tasks /// The plugin manager used to retrieve plugins to initialize them. /// private readonly IPluginManager _pluginManager; + /// /// The service provider given to each method. /// diff --git a/Kyoo.Core/Tasks/RegisterEpisode.cs b/Kyoo.Core/Tasks/RegisterEpisode.cs index 88913b3d..21b62321 100644 --- a/Kyoo.Core/Tasks/RegisterEpisode.cs +++ b/Kyoo.Core/Tasks/RegisterEpisode.cs @@ -19,18 +19,22 @@ namespace Kyoo.Core.Tasks /// An identifier to extract metadata from paths. /// private readonly IIdentifier _identifier; + /// /// The library manager used to register the episode. /// private readonly ILibraryManager _libraryManager; + /// /// A metadata provider to retrieve the metadata of the new episode (and related items if they do not exist). /// private readonly AProviderComposite _metadataProvider; + /// /// The thumbnail manager used to download images. /// private readonly IThumbnailsManager _thumbnailsManager; + /// /// The transcoder used to extract subtitles and metadata. /// diff --git a/Kyoo.Core/Tasks/RegisterSubtitle.cs b/Kyoo.Core/Tasks/RegisterSubtitle.cs index dffd5cdc..1b598d46 100644 --- a/Kyoo.Core/Tasks/RegisterSubtitle.cs +++ b/Kyoo.Core/Tasks/RegisterSubtitle.cs @@ -18,6 +18,7 @@ namespace Kyoo.Core.Tasks /// An identifier to extract metadata from paths. /// private readonly IIdentifier _identifier; + /// /// The library manager used to register the episode. ///