2009-06-12 Bill Holmes <billholmes54@gmail.com>
[mono.git] / mcs / nunit20 / core / Documentation / en / NUnit.Core / Test.xml
1 <Type Name="Test" FullName="NUnit.Core.Test">
2   <TypeSignature Language="C#" Value="public abstract class Test : NUnit.Core.LongLivingMarshalByRefObject, IComparable, NUnit.Core.ITest" />
3   <AssemblyInfo>
4     <AssemblyName>nunit.core</AssemblyName>
5     <AssemblyVersion>2.2.0.0</AssemblyVersion>
6   </AssemblyInfo>
7   <Base>
8     <BaseTypeName>NUnit.Core.LongLivingMarshalByRefObject</BaseTypeName>
9   </Base>
10   <Interfaces>
11     <Interface>
12       <InterfaceName>NUnit.Core.ITest</InterfaceName>
13     </Interface>
14     <Interface>
15       <InterfaceName>System.IComparable</InterfaceName>
16     </Interface>
17   </Interfaces>
18   <Docs>
19     <summary>To be added.</summary>
20     <remarks>To be added.</remarks>
21   </Docs>
22   <Members>
23     <Member MemberName=".ctor">
24       <MemberSignature Language="C#" Value="protected Test (object fixture);" />
25       <MemberType>Constructor</MemberType>
26       <AssemblyInfo>
27         <AssemblyVersion>2.2.0.0</AssemblyVersion>
28       </AssemblyInfo>
29       <Parameters>
30         <Parameter Name="fixture" Type="System.Object" />
31       </Parameters>
32       <Docs>
33         <param name="fixture">To be added.</param>
34         <summary>To be added.</summary>
35         <remarks>To be added.</remarks>
36       </Docs>
37     </Member>
38     <Member MemberName=".ctor">
39       <MemberSignature Language="C#" Value="public Test (string name);" />
40       <MemberType>Constructor</MemberType>
41       <AssemblyInfo>
42         <AssemblyVersion>2.2.0.0</AssemblyVersion>
43       </AssemblyInfo>
44       <Parameters>
45         <Parameter Name="name" Type="System.String" />
46       </Parameters>
47       <Docs>
48         <param name="name">To be added.</param>
49         <summary>To be added.</summary>
50         <remarks>To be added.</remarks>
51       </Docs>
52     </Member>
53     <Member MemberName=".ctor">
54       <MemberSignature Language="C#" Value="protected Test (Type fixtureType);" />
55       <MemberType>Constructor</MemberType>
56       <AssemblyInfo>
57         <AssemblyVersion>2.2.0.0</AssemblyVersion>
58       </AssemblyInfo>
59       <Parameters>
60         <Parameter Name="fixtureType" Type="System.Type" />
61       </Parameters>
62       <Docs>
63         <param name="fixtureType">To be added.</param>
64         <summary>To be added.</summary>
65         <remarks>To be added.</remarks>
66       </Docs>
67     </Member>
68     <Member MemberName=".ctor">
69       <MemberSignature Language="C#" Value="protected Test (object fixture, int assemblyKey);" />
70       <MemberType>Constructor</MemberType>
71       <AssemblyInfo>
72         <AssemblyVersion>2.2.0.0</AssemblyVersion>
73       </AssemblyInfo>
74       <Parameters>
75         <Parameter Name="fixture" Type="System.Object" />
76         <Parameter Name="assemblyKey" Type="System.Int32" />
77       </Parameters>
78       <Docs>
79         <param name="fixture">To be added.</param>
80         <param name="assemblyKey">To be added.</param>
81         <summary>To be added.</summary>
82         <remarks>To be added.</remarks>
83       </Docs>
84     </Member>
85     <Member MemberName=".ctor">
86       <MemberSignature Language="C#" Value="public Test (string name, int assemblyKey);" />
87       <MemberType>Constructor</MemberType>
88       <AssemblyInfo>
89         <AssemblyVersion>2.2.0.0</AssemblyVersion>
90       </AssemblyInfo>
91       <Parameters>
92         <Parameter Name="name" Type="System.String" />
93         <Parameter Name="assemblyKey" Type="System.Int32" />
94       </Parameters>
95       <Docs>
96         <param name="name">To be added.</param>
97         <param name="assemblyKey">To be added.</param>
98         <summary>To be added.</summary>
99         <remarks>To be added.</remarks>
100       </Docs>
101     </Member>
102     <Member MemberName=".ctor">
103       <MemberSignature Language="C#" Value="protected Test (string pathName, string testName);" />
104       <MemberType>Constructor</MemberType>
105       <AssemblyInfo>
106         <AssemblyVersion>2.2.0.0</AssemblyVersion>
107       </AssemblyInfo>
108       <Parameters>
109         <Parameter Name="pathName" Type="System.String" />
110         <Parameter Name="testName" Type="System.String" />
111       </Parameters>
112       <Docs>
113         <param name="pathName">To be added.</param>
114         <param name="testName">To be added.</param>
115         <summary>To be added.</summary>
116         <remarks>To be added.</remarks>
117       </Docs>
118     </Member>
119     <Member MemberName=".ctor">
120       <MemberSignature Language="C#" Value="protected Test (Type fixtureType, int assemblyKey);" />
121       <MemberType>Constructor</MemberType>
122       <AssemblyInfo>
123         <AssemblyVersion>2.2.0.0</AssemblyVersion>
124       </AssemblyInfo>
125       <Parameters>
126         <Parameter Name="fixtureType" Type="System.Type" />
127         <Parameter Name="assemblyKey" Type="System.Int32" />
128       </Parameters>
129       <Docs>
130         <param name="fixtureType">To be added.</param>
131         <param name="assemblyKey">To be added.</param>
132         <summary>To be added.</summary>
133         <remarks>To be added.</remarks>
134       </Docs>
135     </Member>
136     <Member MemberName=".ctor">
137       <MemberSignature Language="C#" Value="protected Test (string pathName, string testName, int assemblyKey);" />
138       <MemberType>Constructor</MemberType>
139       <AssemblyInfo>
140         <AssemblyVersion>2.2.0.0</AssemblyVersion>
141       </AssemblyInfo>
142       <Parameters>
143         <Parameter Name="pathName" Type="System.String" />
144         <Parameter Name="testName" Type="System.String" />
145         <Parameter Name="assemblyKey" Type="System.Int32" />
146       </Parameters>
147       <Docs>
148         <param name="pathName">To be added.</param>
149         <param name="testName">To be added.</param>
150         <param name="assemblyKey">To be added.</param>
151         <summary>To be added.</summary>
152         <remarks>To be added.</remarks>
153       </Docs>
154     </Member>
155     <Member MemberName="AssemblyKey">
156       <MemberSignature Language="C#" Value="public int AssemblyKey { set; get; }" />
157       <MemberType>Property</MemberType>
158       <AssemblyInfo>
159         <AssemblyVersion>2.2.0.0</AssemblyVersion>
160       </AssemblyInfo>
161       <ReturnValue>
162         <ReturnType>System.Int32</ReturnType>
163       </ReturnValue>
164       <Docs>
165         <summary>To be added.</summary>
166         <value>To be added.</value>
167         <remarks>To be added.</remarks>
168       </Docs>
169     </Member>
170     <Member MemberName="Categories">
171       <MemberSignature Language="C#" Value="public System.Collections.IList Categories { set; get; }" />
172       <MemberType>Property</MemberType>
173       <AssemblyInfo>
174         <AssemblyVersion>2.2.0.0</AssemblyVersion>
175       </AssemblyInfo>
176       <ReturnValue>
177         <ReturnType>System.Collections.IList</ReturnType>
178       </ReturnValue>
179       <Docs>
180         <summary>To be added.</summary>
181         <value>To be added.</value>
182         <remarks>To be added.</remarks>
183       </Docs>
184     </Member>
185     <Member MemberName="CompareTo">
186       <MemberSignature Language="C#" Value="public int CompareTo (object obj);" />
187       <MemberType>Method</MemberType>
188       <AssemblyInfo>
189         <AssemblyVersion>2.2.0.0</AssemblyVersion>
190       </AssemblyInfo>
191       <ReturnValue>
192         <ReturnType>System.Int32</ReturnType>
193       </ReturnValue>
194       <Parameters>
195         <Parameter Name="obj" Type="System.Object" />
196       </Parameters>
197       <Docs>
198         <param name="obj">To be added.</param>
199         <summary>To be added.</summary>
200         <returns>To be added.</returns>
201         <remarks>To be added.</remarks>
202       </Docs>
203     </Member>
204     <Member MemberName="CountTestCases">
205       <MemberSignature Language="C#" Value="public abstract int CountTestCases ();" />
206       <MemberType>Method</MemberType>
207       <AssemblyInfo>
208         <AssemblyVersion>2.2.0.0</AssemblyVersion>
209       </AssemblyInfo>
210       <ReturnValue>
211         <ReturnType>System.Int32</ReturnType>
212       </ReturnValue>
213       <Parameters />
214       <Docs>
215         <summary>To be added.</summary>
216         <returns>To be added.</returns>
217         <remarks>To be added.</remarks>
218       </Docs>
219     </Member>
220     <Member MemberName="CountTestCases">
221       <MemberSignature Language="C#" Value="public abstract int CountTestCases (NUnit.Core.IFilter filter);" />
222       <MemberType>Method</MemberType>
223       <AssemblyInfo>
224         <AssemblyVersion>2.2.0.0</AssemblyVersion>
225       </AssemblyInfo>
226       <ReturnValue>
227         <ReturnType>System.Int32</ReturnType>
228       </ReturnValue>
229       <Parameters>
230         <Parameter Name="filter" Type="NUnit.Core.IFilter" />
231       </Parameters>
232       <Docs>
233         <param name="filter">To be added.</param>
234         <summary>To be added.</summary>
235         <returns>To be added.</returns>
236         <remarks>To be added.</remarks>
237       </Docs>
238     </Member>
239     <Member MemberName="Description">
240       <MemberSignature Language="C#" Value="public string Description { set; get; }" />
241       <MemberType>Property</MemberType>
242       <AssemblyInfo>
243         <AssemblyVersion>2.2.0.0</AssemblyVersion>
244       </AssemblyInfo>
245       <ReturnValue>
246         <ReturnType>System.String</ReturnType>
247       </ReturnValue>
248       <Docs>
249         <summary>To be added.</summary>
250         <value>To be added.</value>
251         <remarks>To be added.</remarks>
252       </Docs>
253     </Member>
254     <Member MemberName="Filter">
255       <MemberSignature Language="C#" Value="public abstract bool Filter (NUnit.Core.IFilter filter);" />
256       <MemberType>Method</MemberType>
257       <AssemblyInfo>
258         <AssemblyVersion>2.2.0.0</AssemblyVersion>
259       </AssemblyInfo>
260       <ReturnValue>
261         <ReturnType>System.Boolean</ReturnType>
262       </ReturnValue>
263       <Parameters>
264         <Parameter Name="filter" Type="NUnit.Core.IFilter" />
265       </Parameters>
266       <Docs>
267         <param name="filter">To be added.</param>
268         <summary>To be added.</summary>
269         <returns>To be added.</returns>
270         <remarks>To be added.</remarks>
271       </Docs>
272     </Member>
273     <Member MemberName="Fixture">
274       <MemberSignature Language="C#" Value="public object Fixture { set; get; }" />
275       <MemberType>Property</MemberType>
276       <AssemblyInfo>
277         <AssemblyVersion>2.2.0.0</AssemblyVersion>
278       </AssemblyInfo>
279       <ReturnValue>
280         <ReturnType>System.Object</ReturnType>
281       </ReturnValue>
282       <Docs>
283         <summary>To be added.</summary>
284         <value>To be added.</value>
285         <remarks>To be added.</remarks>
286       </Docs>
287     </Member>
288     <Member MemberName="fixtureType">
289       <MemberSignature Language="C#" Value="protected Type fixtureType;" />
290       <MemberType>Field</MemberType>
291       <AssemblyInfo>
292         <AssemblyVersion>2.2.0.0</AssemblyVersion>
293       </AssemblyInfo>
294       <ReturnValue>
295         <ReturnType>System.Type</ReturnType>
296       </ReturnValue>
297       <Docs>
298         <summary>To be added.</summary>
299         <remarks>To be added.</remarks>
300       </Docs>
301     </Member>
302     <Member MemberName="FullName">
303       <MemberSignature Language="C#" Value="public string FullName { get; }" />
304       <MemberType>Property</MemberType>
305       <AssemblyInfo>
306         <AssemblyVersion>2.2.0.0</AssemblyVersion>
307       </AssemblyInfo>
308       <ReturnValue>
309         <ReturnType>System.String</ReturnType>
310       </ReturnValue>
311       <Docs>
312         <summary>To be added.</summary>
313         <value>To be added.</value>
314         <remarks>To be added.</remarks>
315       </Docs>
316     </Member>
317     <Member MemberName="HasCategory">
318       <MemberSignature Language="C#" Value="public bool HasCategory (System.Collections.IList names);" />
319       <MemberType>Method</MemberType>
320       <AssemblyInfo>
321         <AssemblyVersion>2.2.0.0</AssemblyVersion>
322       </AssemblyInfo>
323       <ReturnValue>
324         <ReturnType>System.Boolean</ReturnType>
325       </ReturnValue>
326       <Parameters>
327         <Parameter Name="names" Type="System.Collections.IList" />
328       </Parameters>
329       <Docs>
330         <param name="names">To be added.</param>
331         <summary>To be added.</summary>
332         <returns>To be added.</returns>
333         <remarks>To be added.</remarks>
334       </Docs>
335     </Member>
336     <Member MemberName="HasCategory">
337       <MemberSignature Language="C#" Value="public bool HasCategory (string name);" />
338       <MemberType>Method</MemberType>
339       <AssemblyInfo>
340         <AssemblyVersion>2.2.0.0</AssemblyVersion>
341       </AssemblyInfo>
342       <ReturnValue>
343         <ReturnType>System.Boolean</ReturnType>
344       </ReturnValue>
345       <Parameters>
346         <Parameter Name="name" Type="System.String" />
347       </Parameters>
348       <Docs>
349         <param name="name">To be added.</param>
350         <summary>To be added.</summary>
351         <returns>To be added.</returns>
352         <remarks>To be added.</remarks>
353       </Docs>
354     </Member>
355     <Member MemberName="IgnoreReason">
356       <MemberSignature Language="C#" Value="public string IgnoreReason { set; get; }" />
357       <MemberType>Property</MemberType>
358       <AssemblyInfo>
359         <AssemblyVersion>2.2.0.0</AssemblyVersion>
360       </AssemblyInfo>
361       <ReturnValue>
362         <ReturnType>System.String</ReturnType>
363       </ReturnValue>
364       <Docs>
365         <summary>To be added.</summary>
366         <value>To be added.</value>
367         <remarks>To be added.</remarks>
368       </Docs>
369     </Member>
370     <Member MemberName="IsDescendant">
371       <MemberSignature Language="C#" Value="public bool IsDescendant (NUnit.Core.Test test);" />
372       <MemberType>Method</MemberType>
373       <AssemblyInfo>
374         <AssemblyVersion>2.2.0.0</AssemblyVersion>
375       </AssemblyInfo>
376       <ReturnValue>
377         <ReturnType>System.Boolean</ReturnType>
378       </ReturnValue>
379       <Parameters>
380         <Parameter Name="test" Type="NUnit.Core.Test" />
381       </Parameters>
382       <Docs>
383         <param name="test">To be added.</param>
384         <summary>To be added.</summary>
385         <returns>To be added.</returns>
386         <remarks>To be added.</remarks>
387       </Docs>
388     </Member>
389     <Member MemberName="IsExplicit">
390       <MemberSignature Language="C#" Value="public bool IsExplicit { set; get; }" />
391       <MemberType>Property</MemberType>
392       <AssemblyInfo>
393         <AssemblyVersion>2.2.0.0</AssemblyVersion>
394       </AssemblyInfo>
395       <ReturnValue>
396         <ReturnType>System.Boolean</ReturnType>
397       </ReturnValue>
398       <Docs>
399         <summary>To be added.</summary>
400         <value>To be added.</value>
401         <remarks>To be added.</remarks>
402       </Docs>
403     </Member>
404     <Member MemberName="IsFixture">
405       <MemberSignature Language="C#" Value="public abstract bool IsFixture { get; }" />
406       <MemberType>Property</MemberType>
407       <AssemblyInfo>
408         <AssemblyVersion>2.2.0.0</AssemblyVersion>
409       </AssemblyInfo>
410       <ReturnValue>
411         <ReturnType>System.Boolean</ReturnType>
412       </ReturnValue>
413       <Docs>
414         <summary>To be added.</summary>
415         <value>To be added.</value>
416         <remarks>To be added.</remarks>
417       </Docs>
418     </Member>
419     <Member MemberName="IsSuite">
420       <MemberSignature Language="C#" Value="public abstract bool IsSuite { get; }" />
421       <MemberType>Property</MemberType>
422       <AssemblyInfo>
423         <AssemblyVersion>2.2.0.0</AssemblyVersion>
424       </AssemblyInfo>
425       <ReturnValue>
426         <ReturnType>System.Boolean</ReturnType>
427       </ReturnValue>
428       <Docs>
429         <summary>To be added.</summary>
430         <value>To be added.</value>
431         <remarks>To be added.</remarks>
432       </Docs>
433     </Member>
434     <Member MemberName="IsTestCase">
435       <MemberSignature Language="C#" Value="public abstract bool IsTestCase { get; }" />
436       <MemberType>Property</MemberType>
437       <AssemblyInfo>
438         <AssemblyVersion>2.2.0.0</AssemblyVersion>
439       </AssemblyInfo>
440       <ReturnValue>
441         <ReturnType>System.Boolean</ReturnType>
442       </ReturnValue>
443       <Docs>
444         <summary>To be added.</summary>
445         <value>To be added.</value>
446         <remarks>To be added.</remarks>
447       </Docs>
448     </Member>
449     <Member MemberName="Name">
450       <MemberSignature Language="C#" Value="public string Name { get; }" />
451       <MemberType>Property</MemberType>
452       <AssemblyInfo>
453         <AssemblyVersion>2.2.0.0</AssemblyVersion>
454       </AssemblyInfo>
455       <ReturnValue>
456         <ReturnType>System.String</ReturnType>
457       </ReturnValue>
458       <Docs>
459         <summary>To be added.</summary>
460         <value>To be added.</value>
461         <remarks>To be added.</remarks>
462       </Docs>
463     </Member>
464     <Member MemberName="Parent">
465       <MemberSignature Language="C#" Value="public NUnit.Core.TestSuite Parent { set; get; }" />
466       <MemberType>Property</MemberType>
467       <AssemblyInfo>
468         <AssemblyVersion>2.2.0.0</AssemblyVersion>
469       </AssemblyInfo>
470       <ReturnValue>
471         <ReturnType>NUnit.Core.TestSuite</ReturnType>
472       </ReturnValue>
473       <Docs>
474         <summary>To be added.</summary>
475         <value>To be added.</value>
476         <remarks>To be added.</remarks>
477       </Docs>
478     </Member>
479     <Member MemberName="Run">
480       <MemberSignature Language="C#" Value="public abstract NUnit.Core.TestResult Run (NUnit.Core.EventListener listener);" />
481       <MemberType>Method</MemberType>
482       <AssemblyInfo>
483         <AssemblyVersion>2.2.0.0</AssemblyVersion>
484       </AssemblyInfo>
485       <ReturnValue>
486         <ReturnType>NUnit.Core.TestResult</ReturnType>
487       </ReturnValue>
488       <Parameters>
489         <Parameter Name="listener" Type="NUnit.Core.EventListener" />
490       </Parameters>
491       <Docs>
492         <param name="listener">To be added.</param>
493         <summary>To be added.</summary>
494         <returns>To be added.</returns>
495         <remarks>To be added.</remarks>
496       </Docs>
497     </Member>
498     <Member MemberName="Run">
499       <MemberSignature Language="C#" Value="public abstract NUnit.Core.TestResult Run (NUnit.Core.EventListener listener, NUnit.Core.IFilter filter);" />
500       <MemberType>Method</MemberType>
501       <AssemblyInfo>
502         <AssemblyVersion>2.2.0.0</AssemblyVersion>
503       </AssemblyInfo>
504       <ReturnValue>
505         <ReturnType>NUnit.Core.TestResult</ReturnType>
506       </ReturnValue>
507       <Parameters>
508         <Parameter Name="listener" Type="NUnit.Core.EventListener" />
509         <Parameter Name="filter" Type="NUnit.Core.IFilter" />
510       </Parameters>
511       <Docs>
512         <param name="listener">To be added.</param>
513         <param name="filter">To be added.</param>
514         <summary>To be added.</summary>
515         <returns>To be added.</returns>
516         <remarks>To be added.</remarks>
517       </Docs>
518     </Member>
519     <Member MemberName="ShortName">
520       <MemberSignature Language="C#" Value="public string ShortName { get; }" />
521       <MemberType>Property</MemberType>
522       <AssemblyInfo>
523         <AssemblyVersion>2.2.0.0</AssemblyVersion>
524       </AssemblyInfo>
525       <ReturnValue>
526         <ReturnType>System.String</ReturnType>
527       </ReturnValue>
528       <Docs>
529         <summary>To be added.</summary>
530         <value>To be added.</value>
531         <remarks>To be added.</remarks>
532       </Docs>
533     </Member>
534     <Member MemberName="ShouldRun">
535       <MemberSignature Language="C#" Value="public virtual bool ShouldRun { set; get; }" />
536       <MemberType>Property</MemberType>
537       <AssemblyInfo>
538         <AssemblyVersion>2.2.0.0</AssemblyVersion>
539       </AssemblyInfo>
540       <ReturnValue>
541         <ReturnType>System.Boolean</ReturnType>
542       </ReturnValue>
543       <Docs>
544         <summary>To be added.</summary>
545         <value>To be added.</value>
546         <remarks>To be added.</remarks>
547       </Docs>
548     </Member>
549     <Member MemberName="TestPath">
550       <MemberSignature Language="C#" Value="public string TestPath { get; }" />
551       <MemberType>Property</MemberType>
552       <AssemblyInfo>
553         <AssemblyVersion>2.2.0.0</AssemblyVersion>
554       </AssemblyInfo>
555       <ReturnValue>
556         <ReturnType>System.String</ReturnType>
557       </ReturnValue>
558       <Docs>
559         <summary>To be added.</summary>
560         <value>To be added.</value>
561         <remarks>To be added.</remarks>
562       </Docs>
563     </Member>
564     <Member MemberName="Tests">
565       <MemberSignature Language="C#" Value="public abstract System.Collections.ArrayList Tests { get; }" />
566       <MemberType>Property</MemberType>
567       <AssemblyInfo>
568         <AssemblyVersion>2.2.0.0</AssemblyVersion>
569       </AssemblyInfo>
570       <ReturnValue>
571         <ReturnType>System.Collections.ArrayList</ReturnType>
572       </ReturnValue>
573       <Docs>
574         <summary>To be added.</summary>
575         <value>To be added.</value>
576         <remarks>To be added.</remarks>
577       </Docs>
578     </Member>
579     <Member MemberName="UniqueName">
580       <MemberSignature Language="C#" Value="public string UniqueName { get; }" />
581       <MemberType>Property</MemberType>
582       <AssemblyInfo>
583         <AssemblyVersion>2.2.0.0</AssemblyVersion>
584       </AssemblyInfo>
585       <ReturnValue>
586         <ReturnType>System.String</ReturnType>
587       </ReturnValue>
588       <Docs>
589         <summary>To be added.</summary>
590         <value>To be added.</value>
591         <remarks>To be added.</remarks>
592       </Docs>
593     </Member>
594   </Members>
595 </Type>