mcs/nunit20/framework/TestAttribute.cs

   1 #region Copyright (c) 2002-2003, James W. Newkirk, Michael C. Two, Alexei A. Vorontsov, Charlie Poole
   2 /************************************************************************************
   3 '
   4 ' Copyright © 2002-2003 James W. Newkirk, Michael C. Two, Alexei A. Vorontsov, Charlie Poole
   5 ' Copyright © 2000-2003 Philip A. Craig
   6 '
   7 ' This software is provided 'as-is', without any express or implied warranty. In no
   8 ' event will the authors be held liable for any damages arising from the use of this
   9 ' software.
  10 '
  11 ' Permission is granted to anyone to use this software for any purpose, including
  12 ' commercial applications, and to alter it and redistribute it freely, subject to the
  13 ' following restrictions:
  14 '
  15 ' 1. The origin of this software must not be misrepresented; you must not claim that
  16 ' you wrote the original software. If you use this software in a product, an
  17 ' acknowledgment (see the following) in the product documentation is required.
  18 '
  19 ' Portions Copyright © 2002-2003 James W. Newkirk, Michael C. Two, Alexei A. Vorontsov,
  20 ' Charlie Poole or Copyright © 2000-2003 Philip A. Craig
  21 '
  22 ' 2. Altered source versions must be plainly marked as such, and must not be
  23 ' misrepresented as being the original software.
  24 '
  25 ' 3. This notice may not be removed or altered from any source distribution.
  26 '
  27 '***********************************************************************************/
  28 #endregion
  29
  30 namespace NUnit.Framework
  31 {
  32         using System;
  33
  34         /// <summary>
  35         /// Adding this attribute to a method within a <seealso cref="TestFixtureAttribute"/>
  36         /// class makes the method callable from the NUnit test runner. There is a property
  37         /// called Description which is optional which you can provide a more detailed test
  38         /// description. This class cannot be inherited.
  39         /// </summary>
  40         ///
  41         /// <example>
  42         /// [TestFixture]
  43         /// public class Fixture
  44         /// {
  45         ///   [Test]
  46         ///   public void MethodToTest()
  47         ///   {}
  48         ///
  49         ///   [Test(Description = "more detailed description")]
  50         ///   publc void TestDescriptionMethod()
  51         ///   {}
  52         /// }
  53         /// </example>
  54         ///
  55         [AttributeUsage(AttributeTargets.Method, AllowMultiple=false)]
  56         public sealed class TestAttribute : Attribute
  57         {
  58                 private string description;
  59
  60                 /// <summary>
  61                 /// Descriptive text for this test
  62                 /// </summary>
  63                 public string Description
  64                 {
  65                         get { return description; }
  66                         set { description = value; }
  67                 }
  68         }
  69 }