diff options
| author | Mark Monteiro <marknr.monteiro@protonmail.com> | 2020-05-17 16:24:28 -0400 |
|---|---|---|
| committer | Mark Monteiro <marknr.monteiro@protonmail.com> | 2020-05-17 17:26:40 -0400 |
| commit | c82f7eeca14839cd21e1904f79007c0d24c85f8f (patch) | |
| tree | 3bb5a4e579276e486a40533de09ce93d6a0b9cbb /MediaBrowser.Controller | |
| parent | 67edf1b7f5f423ab5fa53644bacdba6974b430db (diff) | |
Clean up some doc comments
Diffstat (limited to 'MediaBrowser.Controller')
| -rw-r--r-- | MediaBrowser.Controller/Providers/IExternalId.cs | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/MediaBrowser.Controller/Providers/IExternalId.cs b/MediaBrowser.Controller/Providers/IExternalId.cs index 149c58847..ae87aab9e 100644 --- a/MediaBrowser.Controller/Providers/IExternalId.cs +++ b/MediaBrowser.Controller/Providers/IExternalId.cs @@ -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. |