using System;

namespace Framework.Input.States {

  /// <summary>Provides a human-readable description for an input action</summary>
  [AttributeUsage(AttributeTargets.Field | AttributeTargets.Property)]
  public class DescriptionAttribute : Attribute {

    /// <summary>Initializes a new input action description</summary>
    /// <param name="description">
    ///   Description that will be assigned to the input action
    /// </param>
    public DescriptionAttribute(string description) {
      this.description = description;
    }

    /// <summary>Description that can be displayed for the input action</summary>
    public string Description {
      get { return this.description; }
    }

    /// <summary>Description to be displayed for the input action</summary>
    private string description;

  }

} // namespace Framework.Input.States