mcs/nunit20/framework/Documentation/en/NUnit.Framework/SetUpAttribute.xml

   1 <Type Name="SetUpAttribute" FullName="NUnit.Framework.SetUpAttribute">
   2   <TypeSignature Language="C#" Maintainer="auto" Value="public sealed class SetUpAttribute : Attribute" />
   3   <AssemblyInfo>
   4     <AssemblyName>nunit.framework</AssemblyName>
   5     <AssemblyPublicKey>
   6     </AssemblyPublicKey>
   7     <AssemblyVersion>2.1.4.0</AssemblyVersion>
   8     <AssemblyVersion>2.2.0.0</AssemblyVersion>
   9   </AssemblyInfo>
  10   <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
  11   <Base>
  12     <BaseTypeName>System.Attribute</BaseTypeName>
  13   </Base>
  14   <Interfaces />
  15   <Attributes>
  16     <Attribute>
  17       <AttributeName>System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false)</AttributeName>
  18     </Attribute>
  19   </Attributes>
  20   <Docs>
  21     <summary>
  22     SetUp this attribute are used inside a TestFixture to provide a function that are performed prior a test method is called.
  23     </summary>
  24     <remarks>
  25       <para>
  26     A TestFixture can have only one SetUp method. If more than one is defined the TestFixture will not be run.
  27     It will compile however.
  28     </para>
  29       <example>
  30         <code lang="C#">
  31     using System;
  32     using NUnit.Framework;
  33
  34     [TestFixture]
  35     public class SuccessTests
  36     {
  37             [SetUp]
  38             public void GetReady()
  39             {
  40                     /* ... */
  41             }
  42
  43             [TearDown]
  44             public void Clear()
  45             {
  46                     /* ... */
  47             }
  48
  49             [Test]
  50             public void Foobar()
  51             {
  52                     /* ... */
  53             }
  54     }
  55     </code>
  56       </example>
  57     </remarks>
  58   </Docs>
  59   <Members>
  60     <Member MemberName=".ctor">
  61       <MemberSignature Language="C#" Value="public SetUpAttribute ();" />
  62       <MemberType>Constructor</MemberType>
  63       <ReturnValue />
  64       <Parameters />
  65       <Docs>
  66         <summary>Flags a method as a Setup method</summary>
  67         <remarks>To be added.</remarks>
  68       </Docs>
  69       <AssemblyInfo>
  70         <AssemblyVersion>2.2.0.0</AssemblyVersion>
  71       </AssemblyInfo>
  72     </Member>
  73   </Members>
  74 </Type>