diff options
| author | Bond-009 <bond.009@outlook.com> | 2022-11-19 15:11:56 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-19 15:11:56 +0100 |
| commit | 32fc46eb6af76d92246974ab2c87c8f58ac8ccff (patch) | |
| tree | 5aae11c6a5831c5a4de4379e9aae9a4ed40fb68e /MediaBrowser.Providers/Plugins/StudioImages/Plugin.cs | |
| parent | f3ac9ba4659d58f7bfe1bd006fbea1f68f86b73b (diff) | |
| parent | 2e639c77c73439901abf64fa3439191f181b0b60 (diff) | |
Merge pull request #7602 from Shadowghost/provider-xmldoc
Diffstat (limited to 'MediaBrowser.Providers/Plugins/StudioImages/Plugin.cs')
| -rw-r--r-- | MediaBrowser.Providers/Plugins/StudioImages/Plugin.cs | 21 |
1 files changed, 20 insertions, 1 deletions
diff --git a/MediaBrowser.Providers/Plugins/StudioImages/Plugin.cs b/MediaBrowser.Providers/Plugins/StudioImages/Plugin.cs index 5e653d039..78150153a 100644 --- a/MediaBrowser.Providers/Plugins/StudioImages/Plugin.cs +++ b/MediaBrowser.Providers/Plugins/StudioImages/Plugin.cs @@ -1,5 +1,4 @@ #nullable disable -#pragma warning disable CS1591 using System; using System.Collections.Generic; @@ -11,27 +10,47 @@ using MediaBrowser.Providers.Plugins.StudioImages.Configuration; namespace MediaBrowser.Providers.Plugins.StudioImages { + /// <summary> + /// Artwork Plugin class. + /// </summary> public class Plugin : BasePlugin<PluginConfiguration>, IHasWebPages { + /// <summary> + /// Artwork repository URL. + /// </summary> public const string DefaultServer = "https://raw.github.com/jellyfin/emby-artwork/master/studios"; + /// <summary> + /// Initializes a new instance of the <see cref="Plugin"/> class. + /// </summary> + /// <param name="applicationPaths">application paths.</param> + /// <param name="xmlSerializer">xml serializer.</param> public Plugin(IApplicationPaths applicationPaths, IXmlSerializer xmlSerializer) : base(applicationPaths, xmlSerializer) { Instance = this; } + /// <summary> + /// Gets the instance of Artwork plugin. + /// </summary> public static Plugin Instance { get; private set; } + /// <inheritdoc/> public override Guid Id => new Guid("872a7849-1171-458d-a6fb-3de3d442ad30"); + /// <inheritdoc/> public override string Name => "Studio Images"; + /// <inheritdoc/> public override string Description => "Get artwork for studios from any Jellyfin-compatible repository."; // TODO remove when plugin removed from server. + + /// <inheritdoc/> public override string ConfigurationFileName => "Jellyfin.Plugin.StudioImages.xml"; + /// <inheritdoc/> public IEnumerable<PluginPageInfo> GetPages() { yield return new PluginPageInfo |
