mcs/nunit24/NUnitFramework/framework/IgnoreAttribute.cs

   1 // ****************************************************************\r
   2 // This is free software licensed under the NUnit license. You\r
   3 // may obtain a copy of the license as well as information regarding\r
   4 // copyright ownership at http://nunit.org/?p=license&r=2.4.\r
   5 // ****************************************************************\r
   6 \r
   7 namespace NUnit.Framework\r
   8 {\r
   9         using System;\r
  10 \r
  11         /// <summary>\r
  12         /// Attribute used to mark a test that is to be ignored.\r
  13         /// Ignored tests result in a warning message when the\r
  14         /// tests are run.\r
  15         /// </summary>\r
  16         [AttributeUsage(AttributeTargets.Method|AttributeTargets.Class|AttributeTargets.Assembly, AllowMultiple=false)]\r
  17         public class IgnoreAttribute : Attribute\r
  18         {\r
  19                 private string reason;\r
  20 \r
  21                 /// <summary>\r
  22                 /// Constructs the attribute without giving a reason \r
  23                 /// for ignoring the test.\r
  24                 /// </summary>\r
  25                 public IgnoreAttribute()\r
  26                 {\r
  27                         this.reason = "";\r
  28                 }\r
  29 \r
  30                 /// <summary>\r
  31                 /// Constructs the attribute giving a reason for ignoring the test\r
  32                 /// </summary>\r
  33                 /// <param name="reason">The reason for ignoring the test</param>\r
  34                 public IgnoreAttribute(string reason)\r
  35                 {\r
  36                         this.reason = reason;\r
  37                 }\r
  38 \r
  39                 /// <summary>\r
  40                 /// The reason for ignoring a test\r
  41                 /// </summary>\r
  42                 public string Reason\r
  43                 {\r
  44                         get { return reason; }\r
  45                 }\r
  46         }\r
  47 }\r