alteropen/jellyfin
1
0
Fork 0
mirror of https://github.com/jellyfin/jellyfin.git synced 2026-05-28 03:18:27 +01:00
Code Issues Actions 9 Packages Projects Releases Wiki Activity

Clean up some doc comments

Browse Source
This commit is contained in:
Mark Monteiro
2020-05-17 16:24:28 -04:00
parent 67edf1b7f5
commit c82f7eeca1
3 changed files with 13 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
MediaBrowser.Controller/Providers/IExternalId.cs
View File

@@ -3,7 +3,9 @@ using MediaBrowser.Model.Providers;
namespace MediaBrowser.Controller.Providers
{
/// <summary>Represents and identifier for an external provider.</summary>
/// <summary>
/// Represents an identifier for an external provider.
/// </summary>
public interface IExternalId
{
/// <summary>
@@ -14,11 +16,12 @@ namespace MediaBrowser.Controller.Providers
/// <summary>
/// Gets the unique key to distinguish this provider/type pair. This should be unique across providers.
/// </summary>
// TODO: This property is not actually unique at the moment. It should be updated to be unique.
// TODO: This property is not actually unique across the concrete types at the moment. It should be updated to be unique.
string Key { get; }
/// <summary>
/// Gets the specific media type for this id.
/// Gets the specific media type for this id. This is used to distinguish between the different
/// external id types for providers with multiple ids.
/// </summary>
/// <remarks>
/// This can be used along with the <see cref="Name"/> to localize the external id on the client.