From 526e47c3624aca76234006b031b74e595f295cc8 Mon Sep 17 00:00:00 2001
From: Mark Monteiro <marknr.monteiro@protonmail.com>
Date: Sun, 17 May 2020 14:22:36 -0400
Subject: [PATCH] Clean up documentation

---
 .../Providers/ExternalIdMediaType.cs          | 60 ++++++++++++++-----
 .../Providers/IExternalId.cs                  | 21 +++++--
 .../Providers/ExternalIdInfo.cs               |  2 +-
 3 files changed, 63 insertions(+), 20 deletions(-)

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
 {
-    /// <summary>The specific media type of an <see cref="IExternalId"/>.</summary>
+    /// <summary>
+    /// The specific media type of an <see cref="IExternalId"/>.
+    /// </summary>
+    /// <remarks>
+    /// This is used as a translation key for clients.
+    /// </remarks>
     public enum ExternalIdMediaType
     {
-        /// <summary>There is no specific media type</summary>
+        /// <summary>
+        /// 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.
+        /// </summary>
         None,
 
-        /// <summary>A music album</summary>
+        /// <summary>
+        /// A music album.
+        /// </summary>
         Album,
 
-        /// <summary>The artist of a music album</summary>
+        /// <summary>
+        /// The artist of a music album.
+        /// </summary>
         AlbumArtist,
 
-        /// <summary>The artist of a media item</summary>
+        /// <summary>
+        /// The artist of a media item.
+        /// </summary>
         Artist,
 
-        /// <summary>A boxed set of media</summary>
+        /// <summary>
+        /// A boxed set of media.
+        /// </summary>
         BoxSet,
 
-        /// <summary>A series episode</summary>
+        /// <summary>
+        /// A series episode.
+        /// </summary>
         Episode,
 
-        /// <summary>A movie</summary>
+        /// <summary>
+        /// A movie.
+        /// </summary>
         Movie,
 
-        /// <summary>An alternative artist apart from the main artist</summary>
+        /// <summary>
+        /// An alternative artist apart from the main artist.
+        /// </summary>
         OtherArtist,
 
-        /// <summary>A person</summary>
+        /// <summary>
+        /// A person.
+        /// </summary>
         Person,
 
-        /// <summary>A release group</summary>
+        /// <summary>
+        /// A release group.
+        /// </summary>
         ReleaseGroup,
 
-        /// <summary>A single season of a series</summary>
+        /// <summary>
+        /// A single season of a series.
+        /// </summary>
         Season,
 
-        /// <summary>A series</summary>
+        /// <summary>
+        /// A series.
+        /// </summary>
         Series,
 
-        /// <summary>A music track</summary>
+        /// <summary>
+        /// A music track.
+        /// </summary>
         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
     /// <summary>Represents and identifier for an external provider.</summary>
     public interface IExternalId
     {
-        /// <summary>Gets the name used to identify this provider</summary>
+        /// <summary>
+        /// Gets the display name of the provider associated with this ID type.
+        /// </summary>
         string Name { get; }
 
-        /// <summary>Gets the unique key to distinguish this provider/type pair. This should be unique across providers.</summary>
+        /// <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.
         string Key { get; }
 
-        /// <summary>Gets the specific media type for this id.</summary>
+        /// <summary>
+        /// Gets the specific media type for this id.
+        /// </summary>
         ExternalIdMediaType Type { get; }
 
-        /// <summary>Gets the url format string for this id.</summary>
+        /// <summary>
+        /// Gets the URL format string for this id.
+        /// </summary>
         string UrlFormatString { get; }
 
-        /// <summary>Determines whether this id supports a given item type.</summary>
+        /// <summary>
+        /// Determines whether this id supports a given item type.
+        /// </summary>
         /// <param name="item">The item.</param>
         /// <returns>True if this item is supported, otherwise false.</returns>
         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
     {
         /// <summary>
-        /// 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).
         /// </summary>
         public string Name { get; set; }