michael.heier/jellyfin
1
0
Fork 0
Code Issues Pull Requests Actions 3 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
Show Stats 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.

4
MediaBrowser.Model/Providers/ExternalIdInfo.cs
View File

@ -13,10 +13,12 @@ namespace MediaBrowser.Model.Providers
/// <summary>
/// Gets or sets the unique key for this id. This key should be unique across all providers.
/// </summary>
// TODO: This property is not actually unique across the concrete types at the moment. It should be updated to be unique.
public string Key { get; set; }
/// <summary>
/// Gets or sets the specific media type for this id.
/// Gets or sets 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.

8
MediaBrowser.Model/Providers/ExternalIdMediaType.cs
View File

@ -1,16 +1,16 @@
namespace MediaBrowser.Model.Providers
{
/// <summary>
/// The specific media type of an <see cref="IExternalId"/>.
/// The specific media type of an <see cref="ExternalIdInfo"/>.
/// </summary>
/// <remarks>
/// This is used as a translation key for clients.
/// Client applications may use this as a translation key.
/// </remarks>
public enum ExternalIdMediaType
{
/// <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.
/// There is no specific media type associated with the external id, or this is the default id for the external
/// provider so there is no need to specify a type.
/// </summary>
General,