Document ExtraRule properly

This commit is contained in:
Mark Monteiro 2020-04-01 18:54:06 +02:00
parent 34204046dd
commit 4ff8d30e41

View File

@ -5,30 +5,29 @@ using MediaType = Emby.Naming.Common.MediaType;
namespace Emby.Naming.Video
{
/// <summary>
/// A rule used to match a file path with an <see cref="MediaBrowser.Model.Entities.ExtraType"/>.
/// </summary>
public class ExtraRule
{
/// <summary>
/// Gets or sets the token.
/// Gets or sets the token to use for matching against the file path.
/// </summary>
/// <value>The token.</value>
public string Token { get; set; }
/// <summary>
/// Gets or sets the type of the extra.
/// Gets or sets the type of the extra to return when matched.
/// </summary>
/// <value>The type of the extra.</value>
public ExtraType ExtraType { get; set; }
/// <summary>
/// Gets or sets the type of the rule.
/// </summary>
/// <value>The type of the rule.</value>
public ExtraRuleType RuleType { get; set; }
/// <summary>
/// Gets or sets the type of the media.
/// Gets or sets the type of the media to return when matched.
/// </summary>
/// <value>The type of the media.</value>
public MediaType MediaType { get; set; }
}
}