File: Assertion.xml

package info (click to toggle)
monodoc 1.1.18-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 58,432 kB
  • ctags: 4,991
  • sloc: xml: 718,392; cs: 38,337; sh: 3,172; perl: 554; makefile: 303
file content (366 lines) | stat: -rw-r--r-- 14,174 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
<Type Name="Assertion" FullName="NUnit.Framework.Assertion">
  <TypeSignature Language="C#" Value="public class Assertion" Maintainer="auto" />
  <AssemblyInfo>
    <AssemblyName>NUnit.Framework</AssemblyName>
    <AssemblyPublicKey>
    </AssemblyPublicKey>
    <AssemblyVersion>2.1.4.0</AssemblyVersion>
    <AssemblyCulture>neutral</AssemblyCulture>
    <Attributes>
      <Attribute>
        <AttributeName>System.CLSCompliantAttribute</AttributeName>
      </Attribute>
    </Attributes>
  </AssemblyInfo>
  <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>
  <Docs>
    <summary>
    The class Assertion is used to make assertions in methods flaged as a Test in a class flages as a TestFixture.
    </summary>
    <remarks>
      <para>
    Note: It is not mandatory to inherit from Assertion, 
    but if you do, the code becomes a little more clear and you will save some typing.
    Assertion.AssertionEquals (...) vs AssertionEquals (...)
    </para>
      <para>
    A good idea is to tag your Test with the name of the test and a number. 
    That information can be used when generating bug reports.
    </para>
      <example>
        <code lang="C#">
    using NUnit.Framework;

    [TestFixture]
    public class MyUnitTest : Assertion {

	string foo;

	[SetUp]
	public void GetReady()
	{
		foo = "Foobar";
	}

	[Test]
	public void TestLength()
	{
		AssertEquals ("(1) Length", 6, foo.Length);
	}
    }
    </code>
      </example>
    </remarks>
  </Docs>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes />
  <Members>
    <Member MemberName="Fail">
      <MemberSignature Language="C#" Value="public static void Fail (string message);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="message" Type="System.String" />
      </Parameters>
      <Docs>
        <summary>Fails a Test with a message</summary>
        <param name="message">The message</param>
      </Docs>
    </Member>
    <Member MemberName="Fail">
      <MemberSignature Language="C#" Value="public static void Fail ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Fails a Test</summary>
      </Docs>
    </Member>
    <Member MemberName="AssertSame">
      <MemberSignature Language="C#" Value="public static void AssertSame (string message, object expected, object actual);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="expected" Type="System.Object" />
        <Parameter Name="actual" Type="System.Object" />
      </Parameters>
      <Docs>
        <summary>Assert that two references refers to the same object</summary>
        <param name="message">A message</param>
        <param name="expected">The expected object</param>
        <param name="actual">The actual object</param>
      </Docs>
    </Member>
    <Member MemberName="AssertSame">
      <MemberSignature Language="C#" Value="public static void AssertSame (object expected, object actual);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="expected" Type="System.Object" />
        <Parameter Name="actual" Type="System.Object" />
      </Parameters>
      <Docs>
        <summary>Assert that two references refers to the same object</summary>
        <param name="expected">The expected object</param>
        <param name="actual">The actual object</param>
      </Docs>
    </Member>
    <Member MemberName="AssertNull">
      <MemberSignature Language="C#" Value="public static void AssertNull (string message, object anObject);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="anObject" Type="System.Object" />
      </Parameters>
      <Docs>
        <summary>Asserts that an object references null</summary>
        <param name="message">A message</param>
        <param name="anObject">The object</param>
      </Docs>
    </Member>
    <Member MemberName="AssertNull">
      <MemberSignature Language="C#" Value="public static void AssertNull (object anObject);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="anObject" Type="System.Object" />
      </Parameters>
      <Docs>
        <summary>Asserts that an object references null</summary>
        <param name="anObject">The object</param>
      </Docs>
    </Member>
    <Member MemberName="AssertNotNull">
      <MemberSignature Language="C#" Value="public static void AssertNotNull (string message, object anObject);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="anObject" Type="System.Object" />
      </Parameters>
      <Docs>
        <summary>Asserts that an object do not reference null</summary>
        <param name="message">A message</param>
        <param name="anObject">The object</param>
      </Docs>
    </Member>
    <Member MemberName="AssertNotNull">
      <MemberSignature Language="C#" Value="public static void AssertNotNull (object anObject);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="anObject" Type="System.Object" />
      </Parameters>
      <Docs>
        <summary>Asserts that an object do not reference null</summary>
        <param name="anObject">The object</param>
      </Docs>
    </Member>
    <Member MemberName="AssertEquals">
      <MemberSignature Language="C#" Value="public static void AssertEquals (string message, object expected, object actual);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="expected" Type="System.Object" />
        <Parameter Name="actual" Type="System.Object" />
      </Parameters>
      <Docs>
        <summary>Asserts that two objects are Equal</summary>
        <param name="message">A message</param>
        <param name="expected">The expected object</param>
        <param name="actual">The actual object</param>
      </Docs>
    </Member>
    <Member MemberName="AssertEquals">
      <MemberSignature Language="C#" Value="public static void AssertEquals (string message, float expected, float actual, float delta);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="expected" Type="System.Single" />
        <Parameter Name="actual" Type="System.Single" />
        <Parameter Name="delta" Type="System.Single" />
      </Parameters>
      <Docs>
        <summary>Asserts that two floats are equal, accepting some difference expresed by the delta</summary>
        <param name="message">A message</param>
        <param name="expected">The expected</param>
        <param name="actual">The actual</param>
        <param name="delta">The delta difference allowed</param>
      </Docs>
    </Member>
    <Member MemberName="AssertEquals">
      <MemberSignature Language="C#" Value="public static void AssertEquals (string message, double expected, double actual, double delta);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="expected" Type="System.Double" />
        <Parameter Name="actual" Type="System.Double" />
        <Parameter Name="delta" Type="System.Double" />
      </Parameters>
      <Docs>
        <summary>Asserts that two doubles are equal, accepting some difference expresed by the delta</summary>
        <param name="message">A message</param>
        <param name="expected">The expected</param>
        <param name="actual">The actual</param>
        <param name="delta">The delta difference allowed</param>
      </Docs>
    </Member>
    <Member MemberName="AssertEquals">
      <MemberSignature Language="C#" Value="public static void AssertEquals (string message, int expected, int actual);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="expected" Type="System.Int32" />
        <Parameter Name="actual" Type="System.Int32" />
      </Parameters>
      <Docs>
        <summary>Asserts that two ints are equal</summary>
        <param name="message">A message</param>
        <param name="expected">The expected</param>
        <param name="actual">The actual</param>
      </Docs>
    </Member>
    <Member MemberName="AssertEquals">
      <MemberSignature Language="C#" Value="public static void AssertEquals (int expected, int actual);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="expected" Type="System.Int32" />
        <Parameter Name="actual" Type="System.Int32" />
      </Parameters>
      <Docs>
        <summary>Asserts that two ints are equal</summary>
        <param name="expected">The expected</param>
        <param name="actual">The actual</param>
      </Docs>
    </Member>
    <Member MemberName="AssertEquals">
      <MemberSignature Language="C#" Value="public static void AssertEquals (object expected, object actual);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="expected" Type="System.Object" />
        <Parameter Name="actual" Type="System.Object" />
      </Parameters>
      <Docs>
        <summary>Asserts that two objects are Equal</summary>
        <param name="expected">The expected object</param>
        <param name="actual">The actual object</param>
      </Docs>
    </Member>
    <Member MemberName="AssertEquals">
      <MemberSignature Language="C#" Value="public static void AssertEquals (float expected, float actual, float delta);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="expected" Type="System.Single" />
        <Parameter Name="actual" Type="System.Single" />
        <Parameter Name="delta" Type="System.Single" />
      </Parameters>
      <Docs>
        <summary>Asserts that two floats are equal, accepting some difference expresed by the delta</summary>
        <param name="expected">The expected</param>
        <param name="actual">The actual</param>
        <param name="delta">The delta difference allowed</param>
      </Docs>
    </Member>
    <Member MemberName="AssertEquals">
      <MemberSignature Language="C#" Value="public static void AssertEquals (double expected, double actual, double delta);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="expected" Type="System.Double" />
        <Parameter Name="actual" Type="System.Double" />
        <Parameter Name="delta" Type="System.Double" />
      </Parameters>
      <Docs>
        <summary>Asserts that two doubles are equal, accepting some difference expresed by the delta</summary>
        <param name="expected">The expected</param>
        <param name="actual">The actual</param>
        <param name="delta">The delta difference allowed</param>
      </Docs>
    </Member>
    <Member MemberName="Assert">
      <MemberSignature Language="C#" Value="public static void Assert (bool condition);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="condition" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <summary>Asserts that a condition is true</summary>
        <param name="condition">The condition</param>
      </Docs>
    </Member>
    <Member MemberName="Assert">
      <MemberSignature Language="C#" Value="public static void Assert (string message, bool condition);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="condition" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <summary>Asserts that a condition is true</summary>
        <param name="message">A message</param>
        <param name="condition">The condition</param>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Assertion ();" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters />
      <Docs>
        <summary>Creates an Assertion object</summary>
        <remarks>Should not be used, all methods are static</remarks>
      </Docs>
    </Member>
  </Members>
</Type>