diff --git a/Emby.Server.Implementations/Library/Resolvers/Movies/MovieResolver.cs b/Emby.Server.Implementations/Library/Resolvers/Movies/MovieResolver.cs index d6ae8aba85..84d4688aff 100644 --- a/Emby.Server.Implementations/Library/Resolvers/Movies/MovieResolver.cs +++ b/Emby.Server.Implementations/Library/Resolvers/Movies/MovieResolver.cs @@ -387,7 +387,7 @@ namespace Emby.Server.Implementations.Library.Resolvers.Movies if (!string.IsNullOrEmpty(item.Path)) { - // Check for IMDb id - we use full media path, as we can assume that this will match in any use case (wither id in parent dir or in file name) + // Check for IMDb id - we use full media path, as we can assume that this will match in any use case (whether id in parent dir or in file name) var imdbid = item.Path.AsSpan().GetAttributeValue("imdbid"); if (!string.IsNullOrWhiteSpace(imdbid)) diff --git a/MediaBrowser.Controller/Providers/IRemoteMetadataProvider.cs b/MediaBrowser.Controller/Providers/IRemoteMetadataProvider.cs index 2c943d9e77..888ca6c72c 100644 --- a/MediaBrowser.Controller/Providers/IRemoteMetadataProvider.cs +++ b/MediaBrowser.Controller/Providers/IRemoteMetadataProvider.cs @@ -25,7 +25,7 @@ namespace MediaBrowser.Controller.Providers /// /// The LookupInfoType to get metadata for. /// The . - /// Task{MetadataResult{TItemType}}. + /// A task returning a MetadataResult for the specific LookupInfoType. Task> GetMetadata(TLookupInfoType info, CancellationToken cancellationToken); } @@ -40,7 +40,7 @@ namespace MediaBrowser.Controller.Providers /// /// The LookupInfoType to search for. /// The . - /// Task{IEnumerable{RemoteSearchResult}}. + /// A task returning RemoteSearchResults for the searchInfo. Task> GetSearchResults(TLookupInfoType searchInfo, CancellationToken cancellationToken); } } diff --git a/MediaBrowser.Model/Entities/MetadataProvider.cs b/MediaBrowser.Model/Entities/MetadataProvider.cs index a34bbd3c8f..bd8db99416 100644 --- a/MediaBrowser.Model/Entities/MetadataProvider.cs +++ b/MediaBrowser.Model/Entities/MetadataProvider.cs @@ -12,77 +12,77 @@ namespace MediaBrowser.Model.Entities Custom = 0, /// - /// The IMDb id. + /// The IMDb provider. /// Imdb = 2, /// - /// The TMDb id. + /// The TMDb provider. /// Tmdb = 3, /// - /// The TVDb id. + /// The TVDb provider. /// Tvdb = 4, /// - /// The tvcom id. + /// The tvcom providerd. /// Tvcom = 5, /// - /// TMDb collection id. + /// TMDb collection provider. /// TmdbCollection = 7, /// - /// The MusicBrainz album id. + /// The MusicBrainz album provider. /// MusicBrainzAlbum = 8, /// - /// The MusicBrainz album artist id. + /// The MusicBrainz album artist provider. /// MusicBrainzAlbumArtist = 9, /// - /// The MusicBrainz artist id. + /// The MusicBrainz artist provider. /// MusicBrainzArtist = 10, /// - /// The MusicBrainz release group id. + /// The MusicBrainz release group provider. /// MusicBrainzReleaseGroup = 11, /// - /// The Zap2It id. + /// The Zap2It provider. /// Zap2It = 12, /// - /// The TvRage id. + /// The TvRage provider. /// TvRage = 15, /// - /// The AudioDb artist id. + /// The AudioDb artist provider. /// AudioDbArtist = 16, /// - /// The AudioDb collection id. + /// The AudioDb collection provider. /// AudioDbAlbum = 17, /// - /// The MusicBrainz track id. + /// The MusicBrainz track provider. /// MusicBrainzTrack = 18, /// - /// The TvMaze id. + /// The TvMaze provider. /// TvMaze = 19 } diff --git a/MediaBrowser.Providers/Plugins/StudioImages/Plugin.cs b/MediaBrowser.Providers/Plugins/StudioImages/Plugin.cs index f5ea6d103d..78150153ad 100644 --- a/MediaBrowser.Providers/Plugins/StudioImages/Plugin.cs +++ b/MediaBrowser.Providers/Plugins/StudioImages/Plugin.cs @@ -50,10 +50,7 @@ namespace MediaBrowser.Providers.Plugins.StudioImages /// public override string ConfigurationFileName => "Jellyfin.Plugin.StudioImages.xml"; - /// - /// Return the plugin configuration page. - /// - /// PluginPageInfo. + /// public IEnumerable GetPages() { yield return new PluginPageInfo diff --git a/MediaBrowser.Providers/Plugins/StudioImages/StudiosImageProvider.cs b/MediaBrowser.Providers/Plugins/StudioImages/StudiosImageProvider.cs index 88bbdadb46..ffbb338e84 100644 --- a/MediaBrowser.Providers/Plugins/StudioImages/StudiosImageProvider.cs +++ b/MediaBrowser.Providers/Plugins/StudioImages/StudiosImageProvider.cs @@ -122,13 +122,13 @@ namespace MediaBrowser.Providers.Plugins.StudioImages } /// - /// Ensures the list. + /// Ensures the existence of a file listing. /// /// The URL. /// The file. /// The file system. /// The cancellation token. - /// Task. + /// A Task to ensure existence of a file listing. public async Task EnsureList(string url, string file, IFileSystem fileSystem, CancellationToken cancellationToken) { var fileInfo = fileSystem.GetFileInfo(file); @@ -151,7 +151,7 @@ namespace MediaBrowser.Providers.Plugins.StudioImages /// /// The . /// The enumerable of image strings. - /// String. + /// The matching image string. public string FindMatch(BaseItem item, IEnumerable images) { var name = GetComparableName(item.Name); @@ -170,10 +170,10 @@ namespace MediaBrowser.Providers.Plugins.StudioImages } /// - /// Get available images for a file. + /// Get available image strings for a file. /// /// The file. - /// IEnumerable{string}. + /// All images strings of a file. public IEnumerable GetAvailableImages(string file) { using var fileStream = File.OpenRead(file); diff --git a/MediaBrowser.Providers/Plugins/Tmdb/TV/TmdbEpisodeImageProvider.cs b/MediaBrowser.Providers/Plugins/Tmdb/TV/TmdbEpisodeImageProvider.cs index e568bc4d3d..943a3a75b2 100644 --- a/MediaBrowser.Providers/Plugins/Tmdb/TV/TmdbEpisodeImageProvider.cs +++ b/MediaBrowser.Providers/Plugins/Tmdb/TV/TmdbEpisodeImageProvider.cs @@ -16,7 +16,7 @@ using MediaBrowser.Model.Providers; namespace MediaBrowser.Providers.Plugins.Tmdb.TV { /// - /// TV episode iage provider powered by TheMovieDb. + /// TV episode image provider powered by TheMovieDb. /// public class TmdbEpisodeImageProvider : IRemoteImageProvider, IHasOrder { diff --git a/MediaBrowser.Providers/Plugins/Tmdb/TV/TmdbSeasonImageProvider.cs b/MediaBrowser.Providers/Plugins/Tmdb/TV/TmdbSeasonImageProvider.cs index dea89f1d2c..da32ea4081 100644 --- a/MediaBrowser.Providers/Plugins/Tmdb/TV/TmdbSeasonImageProvider.cs +++ b/MediaBrowser.Providers/Plugins/Tmdb/TV/TmdbSeasonImageProvider.cs @@ -27,21 +27,16 @@ namespace MediaBrowser.Providers.Plugins.Tmdb.TV /// /// The . /// The . - public TmdbSeasonImageProvider(IHttpClientFactory httpClientFactory, TmdbClientManager tmdbClientManager) { _httpClientFactory = httpClientFactory; _tmdbClientManager = tmdbClientManager; } - /// - /// The order. - /// + /// public int Order => 1; - /// - /// The name. - /// + /// public string Name => TmdbUtils.ProviderName; /// diff --git a/MediaBrowser.XbmcMetadata/Parsers/BaseNfoParser.cs b/MediaBrowser.XbmcMetadata/Parsers/BaseNfoParser.cs index 0d03876f24..9e197e737b 100644 --- a/MediaBrowser.XbmcMetadata/Parsers/BaseNfoParser.cs +++ b/MediaBrowser.XbmcMetadata/Parsers/BaseNfoParser.cs @@ -1,5 +1,3 @@ -#pragma warning disable CS1591 - using System; using System.Collections.Generic; using System.Globalization; @@ -23,6 +21,10 @@ using Microsoft.Extensions.Logging; namespace MediaBrowser.XbmcMetadata.Parsers { + /// + /// The BaseNfoParser class. + /// + /// The type. public class BaseNfoParser where T : BaseItem { @@ -63,16 +65,22 @@ namespace MediaBrowser.XbmcMetadata.Parsers /// protected ILogger Logger { get; } + /// + /// Gets the provider manager. + /// protected IProviderManager ProviderManager { get; } + /// + /// Gets a value indicating whether URLs after a closing XML tag are supporrted. + /// protected virtual bool SupportsUrlAfterClosingXmlTag => false; /// /// Fetches metadata for an item from one xml file. /// - /// The item. + /// The . /// The metadata file. - /// The cancellation token. + /// The . /// item is null. /// metadataFile is null or empty. public void Fetch(MetadataResult item, string metadataFile, CancellationToken cancellationToken) @@ -111,10 +119,10 @@ namespace MediaBrowser.XbmcMetadata.Parsers /// /// Fetches the specified item. /// - /// The item. + /// The . /// The metadata file. - /// The settings. - /// The cancellation token. + /// The . + /// The . protected virtual void Fetch(MetadataResult item, string metadataFile, XmlReaderSettings settings, CancellationToken cancellationToken) { if (!SupportsUrlAfterClosingXmlTag) @@ -216,6 +224,11 @@ namespace MediaBrowser.XbmcMetadata.Parsers } } + /// + /// Parses a XML tag to a provider id. + /// + /// The item. + /// The xml tag. protected void ParseProviderLinks(T item, ReadOnlySpan xml) { if (ProviderIdParsers.TryFindImdbId(xml, out var imdbId)) @@ -245,6 +258,11 @@ namespace MediaBrowser.XbmcMetadata.Parsers } } + /// + /// Fetches metadata from an XML node. + /// + /// The . + /// The . protected virtual void FetchDataFromXmlNode(XmlReader reader, MetadataResult itemResult) { var item = itemResult.Item; @@ -1100,17 +1118,14 @@ namespace MediaBrowser.XbmcMetadata.Parsers switch (reader.Name) { case "language": + _ = reader.ReadElementContentAsString(); + if (item is Video video) { - _ = reader.ReadElementContentAsString(); - - if (item is Video video) - { - video.HasSubtitles = true; - } - - break; + video.HasSubtitles = true; } + break; + default: reader.Skip(); break; @@ -1210,9 +1225,9 @@ namespace MediaBrowser.XbmcMetadata.Parsers } /// - /// Gets the persons from XML node. + /// Gets the persons from a XML node. /// - /// The reader. + /// The . /// IEnumerable{PersonInfo}. private PersonInfo GetPersonFromXmlNode(XmlReader reader) { @@ -1348,10 +1363,10 @@ namespace MediaBrowser.XbmcMetadata.Parsers } /// - /// Parses the ImageType from the nfo aspect property. + /// Parses the from the NFO aspect property. /// - /// The nfo aspect property. - /// The image type. + /// The NFO aspect property. + /// The . private static ImageType GetImageType(string aspect) { return aspect switch