diff --git a/MediaBrowser.Controller/Providers/ExternalIdMediaType.cs b/MediaBrowser.Controller/Providers/ExternalIdMediaType.cs
index 470f1e24c0..dc87aefc83 100644
--- a/MediaBrowser.Controller/Providers/ExternalIdMediaType.cs
+++ b/MediaBrowser.Controller/Providers/ExternalIdMediaType.cs
@@ -1,45 +1,77 @@
namespace MediaBrowser.Controller.Providers
{
- /// The specific media type of an .
+ ///
+ /// The specific media type of an .
+ ///
+ ///
+ /// This is used as a translation key for clients.
+ ///
public enum ExternalIdMediaType
{
- /// There is no specific media type
+ ///
+ /// There is no specific media type associated with the external id, or the external provider only has one
+ /// id type so there is no need to be specific.
+ ///
None,
- /// A music album
+ ///
+ /// A music album.
+ ///
Album,
- /// The artist of a music album
+ ///
+ /// The artist of a music album.
+ ///
AlbumArtist,
- /// The artist of a media item
+ ///
+ /// The artist of a media item.
+ ///
Artist,
- /// A boxed set of media
+ ///
+ /// A boxed set of media.
+ ///
BoxSet,
- /// A series episode
+ ///
+ /// A series episode.
+ ///
Episode,
- /// A movie
+ ///
+ /// A movie.
+ ///
Movie,
- /// An alternative artist apart from the main artist
+ ///
+ /// An alternative artist apart from the main artist.
+ ///
OtherArtist,
- /// A person
+ ///
+ /// A person.
+ ///
Person,
- /// A release group
+ ///
+ /// A release group.
+ ///
ReleaseGroup,
- /// A single season of a series
+ ///
+ /// A single season of a series.
+ ///
Season,
- /// A series
+ ///
+ /// A series.
+ ///
Series,
- /// A music track
+ ///
+ /// A music track.
+ ///
Track
}
}
diff --git a/MediaBrowser.Controller/Providers/IExternalId.cs b/MediaBrowser.Controller/Providers/IExternalId.cs
index c877ffe1fe..f362c42eb1 100644
--- a/MediaBrowser.Controller/Providers/IExternalId.cs
+++ b/MediaBrowser.Controller/Providers/IExternalId.cs
@@ -5,19 +5,30 @@ namespace MediaBrowser.Controller.Providers
/// Represents and identifier for an external provider.
public interface IExternalId
{
- /// Gets the name used to identify this provider
+ ///
+ /// Gets the display name of the provider associated with this ID type.
+ ///
string Name { get; }
- /// Gets the unique key to distinguish this provider/type pair. This should be unique across providers.
+ ///
+ /// Gets the unique key to distinguish this provider/type pair. This should be unique across providers.
+ ///
+ // TODO: This property is not actually unique at the moment. It should be updated to be unique.
string Key { get; }
- /// Gets the specific media type for this id.
+ ///
+ /// Gets the specific media type for this id.
+ ///
ExternalIdMediaType Type { get; }
- /// Gets the url format string for this id.
+ ///
+ /// Gets the URL format string for this id.
+ ///
string UrlFormatString { get; }
- /// Determines whether this id supports a given item type.
+ ///
+ /// Determines whether this id supports a given item type.
+ ///
/// The item.
/// True if this item is supported, otherwise false.
bool Supports(IHasProviderIds item);
diff --git a/MediaBrowser.Model/Providers/ExternalIdInfo.cs b/MediaBrowser.Model/Providers/ExternalIdInfo.cs
index befcc309bf..ca0c857c41 100644
--- a/MediaBrowser.Model/Providers/ExternalIdInfo.cs
+++ b/MediaBrowser.Model/Providers/ExternalIdInfo.cs
@@ -6,7 +6,7 @@ namespace MediaBrowser.Model.Providers
public class ExternalIdInfo
{
///
- /// Gets or sets the name of the external id provider (IE: IMDB, MusicBrainz, etc).
+ /// Gets or sets the display name of the external id provider (IE: IMDB, MusicBrainz, etc).
///
public string Name { get; set; }