aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Model/Providers/ExternalIdInfo.cs
diff options
context:
space:
mode:
Diffstat (limited to 'MediaBrowser.Model/Providers/ExternalIdInfo.cs')
-rw-r--r--MediaBrowser.Model/Providers/ExternalIdInfo.cs17
1 files changed, 8 insertions, 9 deletions
diff --git a/MediaBrowser.Model/Providers/ExternalIdInfo.cs b/MediaBrowser.Model/Providers/ExternalIdInfo.cs
index 8d6d91143..befcc309b 100644
--- a/MediaBrowser.Model/Providers/ExternalIdInfo.cs
+++ b/MediaBrowser.Model/Providers/ExternalIdInfo.cs
@@ -1,31 +1,30 @@
-#pragma warning disable CS1591
-
namespace MediaBrowser.Model.Providers
{
+ /// <summary>
+ /// Represents the external id information for serialization to the client.
+ /// </summary>
public class ExternalIdInfo
{
/// <summary>
- /// Gets or sets the name.
+ /// Gets or sets the name of the external id provider (IE: IMDB, MusicBrainz, etc).
/// </summary>
- /// <value>The name.</value>
public string Name { get; set; }
/// <summary>
- /// Gets or sets the key.
+ /// Gets or sets the unique key for this id. This key should be unique across all providers.
/// </summary>
- /// <value>The key.</value>
public string Key { get; set; }
/// <summary>
- /// Gets or sets the type.
+ /// Gets or sets the media type (Album, Artist, etc).
+ /// This can be null if there is no specific type.
+ /// This string is also used to localize the media type on the client.
/// </summary>
- /// <value>The type.</value>
public string Type { get; set; }
/// <summary>
/// Gets or sets the URL format string.
/// </summary>
- /// <value>The URL format string.</value>
public string UrlFormatString { get; set; }
}
}