/tools/nant/NAnt.NUnit.xml

  1<?xml version="1.0"?>
  2<doc>
  3    <assembly>
  4        <name>NAnt.NUnit</name>
  5    </assembly>
  6    <members>
  7        <member name="T:NAnt.NUnit.Types.FormatterData">
  8            <summary>
  9            Carries data specified through the formatter element.
 10            </summary>
 11        </member>
 12        <member name="P:NAnt.NUnit.Types.FormatterData.Type">
 13            <summary>
 14            Gets or sets the type of the formatter.
 15            </summary>
 16            <value>The type of the formatter.</value>
 17        </member>
 18        <member name="P:NAnt.NUnit.Types.FormatterData.UseFile">
 19            <summary>
 20            Gets or sets a value indicating whether output should be persisted 
 21            to a file. 
 22            </summary>
 23            <value>
 24            <see langword="true" /> if output should be written to a file; otherwise, 
 25            <see langword="false" />. The default is <see langword="false" />.
 26            </value>
 27        </member>
 28        <member name="P:NAnt.NUnit.Types.FormatterData.Extension">
 29            <summary>
 30            Gets or sets the extension to append to the output filename.
 31            </summary>
 32            <value>The extension to append to the output filename.</value>
 33        </member>
 34        <member name="P:NAnt.NUnit.Types.FormatterData.OutputDirectory">
 35            <summary>
 36            Gets or sets the directory where the output file should be written 
 37            to, if <see cref="P:NAnt.NUnit.Types.FormatterData.UseFile"/> is <see langword="true"/>.
 38            </summary> 
 39            <value>
 40            The directory where the output file should be written to.
 41            </value>
 42        </member>
 43        <member name="T:NAnt.NUnit.Types.FormatterDataCollection">
 44            <summary>
 45            Contains a strongly typed collection of <see cref="T:NAnt.NUnit.Types.FormatterData"/> objects.
 46            </summary>
 47        </member>
 48        <member name="M:NAnt.NUnit.Types.FormatterDataCollection.#ctor">
 49            <summary>
 50            Initializes a new instance of the <see cref="T:NAnt.NUnit.Types.FormatterDataCollection"/> class.
 51            </summary>
 52        </member>
 53        <member name="M:NAnt.NUnit.Types.FormatterDataCollection.#ctor(NAnt.NUnit.Types.FormatterDataCollection)">
 54            <summary>
 55            Initializes a new instance of the <see cref="T:NAnt.NUnit.Types.FormatterDataCollection"/> class
 56            with the specified <see cref="T:NAnt.NUnit.Types.FormatterDataCollection"/> instance.
 57            </summary>
 58        </member>
 59        <member name="M:NAnt.NUnit.Types.FormatterDataCollection.#ctor(NAnt.NUnit.Types.FormatterData[])">
 60            <summary>
 61            Initializes a new instance of the <see cref="T:NAnt.NUnit.Types.FormatterDataCollection"/> class
 62            with the specified array of <see cref="T:NAnt.NUnit.Types.FormatterData"/> instances.
 63            </summary>
 64        </member>
 65        <member name="M:NAnt.NUnit.Types.FormatterDataCollection.Add(NAnt.NUnit.Types.FormatterData)">
 66            <summary>
 67            Adds a <see cref="T:NAnt.NUnit.Types.FormatterData"/> to the end of the collection.
 68            </summary>
 69            <param name="item">The <see cref="T:NAnt.NUnit.Types.FormatterData"/> to be added to the end of the collection.</param> 
 70            <returns>The position into which the new element was inserted.</returns>
 71        </member>
 72        <member name="M:NAnt.NUnit.Types.FormatterDataCollection.AddRange(NAnt.NUnit.Types.FormatterData[])">
 73            <summary>
 74            Adds the elements of a <see cref="T:NAnt.NUnit.Types.FormatterData"/> array to the end of the collection.
 75            </summary>
 76            <param name="items">The array of <see cref="T:NAnt.NUnit.Types.FormatterData"/> elements to be added to the end of the collection.</param> 
 77        </member>
 78        <member name="M:NAnt.NUnit.Types.FormatterDataCollection.AddRange(NAnt.NUnit.Types.FormatterDataCollection)">
 79            <summary>
 80            Adds the elements of a <see cref="T:NAnt.NUnit.Types.FormatterDataCollection"/> to the end of the collection.
 81            </summary>
 82            <param name="items">The <see cref="T:NAnt.NUnit.Types.FormatterDataCollection"/> to be added to the end of the collection.</param> 
 83        </member>
 84        <member name="M:NAnt.NUnit.Types.FormatterDataCollection.Contains(NAnt.NUnit.Types.FormatterData)">
 85            <summary>
 86            Determines whether a <see cref="T:NAnt.NUnit.Types.FormatterData"/> is in the collection.
 87            </summary>
 88            <param name="item">The <see cref="T:NAnt.NUnit.Types.FormatterData"/> to locate in the collection.</param> 
 89            <returns>
 90            <see langword="true"/> if <paramref name="item"/> is found in the 
 91            collection; otherwise, <see langword="false"/>.
 92            </returns>
 93        </member>
 94        <member name="M:NAnt.NUnit.Types.FormatterDataCollection.CopyTo(NAnt.NUnit.Types.FormatterData[],System.Int32)">
 95            <summary>
 96            Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.        
 97            </summary>
 98            <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param> 
 99            <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
100        </member>
101        <member name="M:NAnt.NUnit.Types.FormatterDataCollection.IndexOf(NAnt.NUnit.Types.FormatterData)">
102            <summary>
103            Retrieves the index of a specified <see cref="T:NAnt.NUnit.Types.FormatterData"/> object in the collection.
104            </summary>
105            <param name="item">The <see cref="T:NAnt.NUnit.Types.FormatterData"/> object for which the index is returned.</param> 
106            <returns>
107            The index of the specified <see cref="T:NAnt.NUnit.Types.FormatterData"/>. If the <see cref="T:NAnt.NUnit.Types.FormatterData"/> is not currently a member of the collection, it returns -1.
108            </returns>
109        </member>
110        <member name="M:NAnt.NUnit.Types.FormatterDataCollection.Insert(System.Int32,NAnt.NUnit.Types.FormatterData)">
111            <summary>
112            Inserts a <see cref="T:NAnt.NUnit.Types.FormatterData"/> into the collection at the specified index.
113            </summary>
114            <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
115            <param name="item">The <see cref="T:NAnt.NUnit.Types.FormatterData"/> to insert.</param>
116        </member>
117        <member name="M:NAnt.NUnit.Types.FormatterDataCollection.GetEnumerator">
118            <summary>
119            Returns an enumerator that can iterate through the collection.
120            </summary>
121            <returns>
122            A <see cref="T:NAnt.NUnit.Types.FormatterDataEnumerator"/> for the entire collection.
123            </returns>
124        </member>
125        <member name="M:NAnt.NUnit.Types.FormatterDataCollection.Remove(NAnt.NUnit.Types.FormatterData)">
126            <summary>
127            Removes a member from the collection.
128            </summary>
129            <param name="item">The <see cref="T:NAnt.NUnit.Types.FormatterData"/> to remove from the collection.</param>
130        </member>
131        <member name="P:NAnt.NUnit.Types.FormatterDataCollection.Item(System.Int32)">
132            <summary>
133            Gets or sets the element at the specified index.
134            </summary>
135            <param name="index">The zero-based index of the element to get or set.</param>
136        </member>
137        <member name="T:NAnt.NUnit.Types.FormatterDataEnumerator">
138            <summary>
139            Enumerates the <see cref="T:NAnt.NUnit.Types.FormatterData"/> elements of a <see cref="T:NAnt.NUnit.Types.FormatterDataCollection"/>.
140            </summary>
141        </member>
142        <member name="M:NAnt.NUnit.Types.FormatterDataEnumerator.#ctor(NAnt.NUnit.Types.FormatterDataCollection)">
143            <summary>
144            Initializes a new instance of the <see cref="T:NAnt.NUnit.Types.FormatterDataEnumerator"/> class
145            with the specified <see cref="T:NAnt.NUnit.Types.FormatterDataCollection"/>.
146            </summary>
147            <param name="arguments">The collection that should be enumerated.</param>
148        </member>
149        <member name="M:NAnt.NUnit.Types.FormatterDataEnumerator.MoveNext">
150            <summary>
151            Advances the enumerator to the next element of the collection.
152            </summary>
153            <returns>
154            <see langword="true" /> if the enumerator was successfully advanced 
155            to the next element; <see langword="false" /> if the enumerator has 
156            passed the end of the collection.
157            </returns>
158        </member>
159        <member name="M:NAnt.NUnit.Types.FormatterDataEnumerator.Reset">
160            <summary>
161            Sets the enumerator to its initial position, which is before the 
162            first element in the collection.
163            </summary>
164        </member>
165        <member name="P:NAnt.NUnit.Types.FormatterDataEnumerator.Current">
166            <summary>
167            Gets the current element in the collection.
168            </summary>
169            <returns>
170            The current element in the collection.
171            </returns>
172        </member>
173        <member name="T:NAnt.NUnit.Types.FormatterType">
174            <summary>
175            The built-in formatter types.
176            </summary>
177        </member>
178        <member name="F:NAnt.NUnit.Types.FormatterType.Plain">
179            <summary>
180            A plaintext formatter.
181            </summary>
182        </member>
183        <member name="F:NAnt.NUnit.Types.FormatterType.Xml">
184            <summary>
185            An XML formatter.
186            </summary>
187        </member>
188        <member name="T:NAnt.NUnit.Types.FormatterElement">
189            <summary>
190            Represents the FormatterElement of the NUnit task.
191            </summary>
192        </member>
193        <member name="P:NAnt.NUnit.Types.FormatterElement.Type">
194            <summary>
195            Type of formatter.
196            </summary>
197        </member>
198        <member name="P:NAnt.NUnit.Types.FormatterElement.Extension">
199            <summary>
200            Extension to append to the output filename.
201            </summary> 
202        </member>
203        <member name="P:NAnt.NUnit.Types.FormatterElement.UseFile">
204            <summary>
205            Determines whether output should be persisted to a file. The default 
206            is <see langword="false" />.
207            </summary> 
208        </member>
209        <member name="P:NAnt.NUnit.Types.FormatterElement.OutputDirectory">
210            <summary>
211            Specifies the directory where the output file should be written to,
212            if <see cref="P:NAnt.NUnit.Types.FormatterElement.UseFile"/> is <see langword="true"/>.  If not 
213            specified, the output file will be written to the directory where
214            the test module is located.
215            </summary> 
216        </member>
217        <member name="P:NAnt.NUnit.Types.FormatterElement.Data">
218            <summary>
219            Gets the underlying <see cref="T:NAnt.NUnit.Types.FormatterData"/> for the element.
220            </summary>
221        </member>
222        <member name="T:NAnt.NUnit.Types.FormatterElementCollection">
223            <summary>
224            Contains a strongly typed collection of <see cref="T:NAnt.NUnit.Types.FormatterElement"/> objects.
225            </summary>
226        </member>
227        <member name="M:NAnt.NUnit.Types.FormatterElementCollection.#ctor">
228            <summary>
229            Initializes a new instance of the <see cref="T:NAnt.NUnit.Types.FormatterElementCollection"/> class.
230            </summary>
231        </member>
232        <member name="M:NAnt.NUnit.Types.FormatterElementCollection.#ctor(NAnt.NUnit.Types.FormatterElementCollection)">
233            <summary>
234            Initializes a new instance of the <see cref="T:NAnt.NUnit.Types.FormatterElementCollection"/> class
235            with the specified <see cref="T:NAnt.NUnit.Types.FormatterElementCollection"/> instance.
236            </summary>
237        </member>
238        <member name="M:NAnt.NUnit.Types.FormatterElementCollection.#ctor(NAnt.NUnit.Types.FormatterElement[])">
239            <summary>
240            Initializes a new instance of the <see cref="T:NAnt.NUnit.Types.FormatterElementCollection"/> class
241            with the specified array of <see cref="T:NAnt.NUnit.Types.FormatterElement"/> instances.
242            </summary>
243        </member>
244        <member name="M:NAnt.NUnit.Types.FormatterElementCollection.Add(NAnt.NUnit.Types.FormatterElement)">
245            <summary>
246            Adds a <see cref="T:NAnt.NUnit.Types.FormatterElement"/> to the end of the collection.
247            </summary>
248            <param name="item">The <see cref="T:NAnt.NUnit.Types.FormatterElement"/> to be added to the end of the collection.</param> 
249            <returns>The position into which the new element was inserted.</returns>
250        </member>
251        <member name="M:NAnt.NUnit.Types.FormatterElementCollection.AddRange(NAnt.NUnit.Types.FormatterElement[])">
252            <summary>
253            Adds the elements of a <see cref="T:NAnt.NUnit.Types.FormatterElement"/> array to the end of the collection.
254            </summary>
255            <param name="items">The array of <see cref="T:NAnt.NUnit.Types.FormatterElement"/> elements to be added to the end of the collection.</param> 
256        </member>
257        <member name="M:NAnt.NUnit.Types.FormatterElementCollection.AddRange(NAnt.NUnit.Types.FormatterElementCollection)">
258            <summary>
259            Adds the elements of a <see cref="T:NAnt.NUnit.Types.FormatterElementCollection"/> to the end of the collection.
260            </summary>
261            <param name="items">The <see cref="T:NAnt.NUnit.Types.FormatterElementCollection"/> to be added to the end of the collection.</param> 
262        </member>
263        <member name="M:NAnt.NUnit.Types.FormatterElementCollection.Contains(NAnt.NUnit.Types.FormatterElement)">
264            <summary>
265            Determines whether a <see cref="T:NAnt.NUnit.Types.FormatterElement"/> is in the collection.
266            </summary>
267            <param name="item">The <see cref="T:NAnt.NUnit.Types.FormatterElement"/> to locate in the collection.</param> 
268            <returns>
269            <see langword="true"/> if <paramref name="item"/> is found in the 
270            collection; otherwise, <see langword="false"/>.
271            </returns>
272        </member>
273        <member name="M:NAnt.NUnit.Types.FormatterElementCollection.CopyTo(NAnt.NUnit.Types.FormatterElement[],System.Int32)">
274            <summary>
275            Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.        
276            </summary>
277            <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param> 
278            <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
279        </member>
280        <member name="M:NAnt.NUnit.Types.FormatterElementCollection.IndexOf(NAnt.NUnit.Types.FormatterElement)">
281            <summary>
282            Retrieves the index of a specified <see cref="T:NAnt.NUnit.Types.FormatterElement"/> object in the collection.
283            </summary>
284            <param name="item">The <see cref="T:NAnt.NUnit.Types.FormatterElement"/> object for which the index is returned.</param> 
285            <returns>
286            The index of the specified <see cref="T:NAnt.NUnit.Types.FormatterElement"/>. If the <see cref="T:NAnt.NUnit.Types.FormatterElement"/> is not currently a member of the collection, it returns -1.
287            </returns>
288        </member>
289        <member name="M:NAnt.NUnit.Types.FormatterElementCollection.Insert(System.Int32,NAnt.NUnit.Types.FormatterElement)">
290            <summary>
291            Inserts a <see cref="T:NAnt.NUnit.Types.FormatterElement"/> into the collection at the specified index.
292            </summary>
293            <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
294            <param name="item">The <see cref="T:NAnt.NUnit.Types.FormatterElement"/> to insert.</param>
295        </member>
296        <member name="M:NAnt.NUnit.Types.FormatterElementCollection.GetEnumerator">
297            <summary>
298            Returns an enumerator that can iterate through the collection.
299            </summary>
300            <returns>
301            A <see cref="T:NAnt.NUnit.Types.FormatterElementEnumerator"/> for the entire collection.
302            </returns>
303        </member>
304        <member name="M:NAnt.NUnit.Types.FormatterElementCollection.Remove(NAnt.NUnit.Types.FormatterElement)">
305            <summary>
306            Removes a member from the collection.
307            </summary>
308            <param name="item">The <see cref="T:NAnt.NUnit.Types.FormatterElement"/> to remove from the collection.</param>
309        </member>
310        <member name="P:NAnt.NUnit.Types.FormatterElementCollection.Item(System.Int32)">
311            <summary>
312            Gets or sets the element at the specified index.
313            </summary>
314            <param name="index">The zero-based index of the element to get or set.</param>
315        </member>
316        <member name="T:NAnt.NUnit.Types.FormatterElementEnumerator">
317            <summary>
318            Enumerates the <see cref="T:NAnt.NUnit.Types.FormatterElement"/> elements of a <see cref="T:NAnt.NUnit.Types.FormatterElementCollection"/>.
319            </summary>
320        </member>
321        <member name="M:NAnt.NUnit.Types.FormatterElementEnumerator.#ctor(NAnt.NUnit.Types.FormatterElementCollection)">
322            <summary>
323            Initializes a new instance of the <see cref="T:NAnt.NUnit.Types.FormatterElementEnumerator"/> class
324            with the specified <see cref="T:NAnt.NUnit.Types.FormatterElementCollection"/>.
325            </summary>
326            <param name="arguments">The collection that should be enumerated.</param>
327        </member>
328        <member name="M:NAnt.NUnit.Types.FormatterElementEnumerator.MoveNext">
329            <summary>
330            Advances the enumerator to the next element of the collection.
331            </summary>
332            <returns>
333            <see langword="true" /> if the enumerator was successfully advanced 
334            to the next element; <see langword="false" /> if the enumerator has 
335            passed the end of the collection.
336            </returns>
337        </member>
338        <member name="M:NAnt.NUnit.Types.FormatterElementEnumerator.Reset">
339            <summary>
340            Sets the enumerator to its initial position, which is before the 
341            first element in the collection.
342            </summary>
343        </member>
344        <member name="P:NAnt.NUnit.Types.FormatterElementEnumerator.Current">
345            <summary>
346            Gets the current element in the collection.
347            </summary>
348            <returns>
349            The current element in the collection.
350            </returns>
351        </member>
352    </members>
353</doc>