|
19 | 19 | </Base>
|
20 | 20 | <Interfaces />
|
21 | 21 | <Docs>
|
22 |
| - <summary> |
23 |
| - |
24 |
| - Provides methods for creating an array that is immutable; meaning it cannot be changed once it is created. |
| 22 | + <summary>Provides methods for creating an array that is immutable; meaning it cannot be changed once it is created. |
25 | 23 |
|
26 | 24 | **NuGet package**: <see href="https://www.nuget.org/packages/System.Collections.Immutable/">System.Collections.Immutable</see> (<see href="https://docs.microsoft.com/dotnet/api/system.collections.immutable?#remarks">about immutable collections and how to install</see>)</summary>
|
27 | 25 | <remarks>To be added.</remarks>
|
|
59 | 57 | <typeparam name="T">The type of element stored in the array.</typeparam>
|
60 | 58 | <param name="array">The sorted array to search.</param>
|
61 | 59 | <param name="value">The object to search for.</param>
|
62 |
| - <summary> |
63 |
| - |
64 |
| - Searches the sorted immutable array for a specified element using the default comparer and returns the zero-based index of the element, if it's found.</summary> |
| 60 | + <summary>Searches the sorted immutable array for a specified element using the default comparer and returns the zero-based index of the element, if it's found.</summary> |
65 | 61 | <returns>The zero-based index of the item in the array, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than <paramref name="value" /> or, if there is no larger element, the bitwise complement of <see cref="P:System.Collections.Generic.ICollection`1.Count" />.</returns>
|
66 | 62 | <remarks>To be added.</remarks>
|
67 | 63 | <exception cref="T:System.InvalidOperationException">
|
|
101 | 97 | <param name="array">The sorted array to search.</param>
|
102 | 98 | <param name="value">The object to search for.</param>
|
103 | 99 | <param name="comparer">The comparer implementation to use when comparing elements, or null to use the default comparer.</param>
|
104 |
| - <summary> |
105 |
| - |
106 |
| - Searches a sorted immutable array for a specified element and returns the zero-based index of the element, if it's found.</summary> |
| 100 | + <summary>Searches a sorted immutable array for a specified element and returns the zero-based index of the element, if it's found.</summary> |
107 | 101 | <returns>The zero-based index of the item in the array, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than <paramref name="value" /> or, if there is no larger element, the bitwise complement of <see cref="P:System.Collections.Generic.ICollection`1.Count" />.</returns>
|
108 | 102 | <remarks>To be added.</remarks>
|
109 | 103 | <exception cref="T:System.InvalidOperationException">
|
|
145 | 139 | <param name="index">The starting index of the range to search.</param>
|
146 | 140 | <param name="length">The length of the range to search.</param>
|
147 | 141 | <param name="value">The object to search for.</param>
|
148 |
| - <summary> |
149 |
| - |
150 |
| - Searches a sorted immutable array for a specified element and returns the zero-based index of the element, if it's found.</summary> |
| 142 | + <summary>Searches a sorted immutable array for a specified element and returns the zero-based index of the element, if it's found.</summary> |
151 | 143 | <returns>The zero-based index of the item in the array, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than <paramref name="value" /> or, if there is no larger element, the bitwise complement of <see cref="P:System.Collections.Generic.ICollection`1.Count" />.</returns>
|
152 | 144 | <remarks>To be added.</remarks>
|
153 | 145 | <exception cref="T:System.InvalidOperationException">
|
|
199 | 191 | <param name="length">The length of the range to search.</param>
|
200 | 192 | <param name="value">The object to search for.</param>
|
201 | 193 | <param name="comparer">The comparer to use when comparing elements for equality or <see langword="null" /> to use the default comparer.</param>
|
202 |
| - <summary> |
203 |
| - |
204 |
| - Searches a sorted immutable array for a specified element and returns the zero-based index of the element.</summary> |
| 194 | + <summary>Searches a sorted immutable array for a specified element and returns the zero-based index of the element.</summary> |
205 | 195 | <returns>The zero-based index of the item in the array, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than <paramref name="value" /> or, if there is no larger element, the bitwise complement of <see cref="P:System.Collections.Generic.ICollection`1.Count" />.</returns>
|
206 | 196 | <remarks>To be added.</remarks>
|
207 | 197 | <exception cref="T:System.InvalidOperationException">
|
|
246 | 236 | <Parameters />
|
247 | 237 | <Docs>
|
248 | 238 | <typeparam name="T">The type of elements stored in the array.</typeparam>
|
249 |
| - <summary> |
250 |
| - |
251 |
| - Creates an empty immutable array.</summary> |
| 239 | + <summary>Creates an empty immutable array.</summary> |
252 | 240 | <returns>An empty immutable array.</returns>
|
253 | 241 | <remarks>To be added.</remarks>
|
254 | 242 | </Docs>
|
|
282 | 270 | <Docs>
|
283 | 271 | <typeparam name="T">The type of elements stored in the array.</typeparam>
|
284 | 272 | <param name="item">The object to store in the array.</param>
|
285 |
| - <summary> |
286 |
| - |
287 |
| - Creates an immutable array that contains the specified object.</summary> |
| 273 | + <summary>Creates an immutable array that contains the specified object.</summary> |
288 | 274 | <returns>An immutable array that contains the specified object.</returns>
|
289 | 275 | <remarks>To be added.</remarks>
|
290 | 276 | </Docs>
|
|
324 | 310 | <Docs>
|
325 | 311 | <typeparam name="T">The type of elements stored in the array.</typeparam>
|
326 | 312 | <param name="items">The array of objects to populate the array with.</param>
|
327 |
| - <summary> |
328 |
| - |
329 |
| - Creates an immutable array from the specified array of objects.</summary> |
| 313 | + <summary>Creates an immutable array from the specified array of objects.</summary> |
330 | 314 | <returns>An immutable array that contains the array of items.</returns>
|
331 | 315 | <remarks>To be added.</remarks>
|
332 | 316 | </Docs>
|
|
362 | 346 | <typeparam name="T">The type of elements stored in the array.</typeparam>
|
363 | 347 | <param name="item1">The first object to store in the array.</param>
|
364 | 348 | <param name="item2">The second object to store in the array.</param>
|
365 |
| - <summary> |
366 |
| - |
367 |
| - Creates an immutable array that contains the specified objects.</summary> |
| 349 | + <summary>Creates an immutable array that contains the specified objects.</summary> |
368 | 350 | <returns>An immutable array that contains the specified objects.</returns>
|
369 | 351 | <remarks>To be added.</remarks>
|
370 | 352 | </Docs>
|
|
402 | 384 | <param name="items">The source array of objects.</param>
|
403 | 385 | <param name="start">The index of the first element to copy from <paramref name="items" />.</param>
|
404 | 386 | <param name="length">The number of elements from <paramref name="items" /> to include in this immutable array.</param>
|
405 |
| - <summary> |
406 |
| - |
407 |
| - Creates an immutable array with the specified objects from another immutable array.</summary> |
| 387 | + <summary>Creates an immutable array with the specified objects from another immutable array.</summary> |
408 | 388 | <returns>An immutable array that contains the specified objects from the source array.</returns>
|
409 | 389 | <remarks>
|
410 | 390 | <format type="text/markdown"><![CDATA[
|
@@ -448,9 +428,7 @@ This overload allows helper methods or custom builder classes to efficiently avo
|
448 | 428 | <param name="item1">The first object to store in the array.</param>
|
449 | 429 | <param name="item2">The second object to store in the array.</param>
|
450 | 430 | <param name="item3">The third object to store in the array.</param>
|
451 |
| - <summary> |
452 |
| - |
453 |
| - Creates an immutable array that contains the specified objects.</summary> |
| 431 | + <summary>Creates an immutable array that contains the specified objects.</summary> |
454 | 432 | <returns>An immutable array that contains the specified objects.</returns>
|
455 | 433 | <remarks>To be added.</remarks>
|
456 | 434 | </Docs>
|
@@ -488,9 +466,7 @@ This overload allows helper methods or custom builder classes to efficiently avo
|
488 | 466 | <param name="items">The source array of objects.</param>
|
489 | 467 | <param name="start">The index of the first element to copy from <paramref name="items" />.</param>
|
490 | 468 | <param name="length">The number of elements from <paramref name="items" /> to include in this immutable array.</param>
|
491 |
| - <summary> |
492 |
| - |
493 |
| - Creates an immutable array with specified objects from another array.</summary> |
| 469 | + <summary>Creates an immutable array with specified objects from another array.</summary> |
494 | 470 | <returns>An immutable array that contains the specified objects from the source array.</returns>
|
495 | 471 | <remarks>
|
496 | 472 | <format type="text/markdown"><![CDATA[
|
@@ -536,9 +512,7 @@ This overload allows helper methods or custom builder classes to efficiently avo
|
536 | 512 | <param name="item2">The second object to store in the array.</param>
|
537 | 513 | <param name="item3">The third object to store in the array.</param>
|
538 | 514 | <param name="item4">The fourth object to store in the array.</param>
|
539 |
| - <summary> |
540 |
| - |
541 |
| - Creates an immutable array that contains the specified objects.</summary> |
| 515 | + <summary>Creates an immutable array that contains the specified objects.</summary> |
542 | 516 | <returns>An immutable array that contains the specified objects.</returns>
|
543 | 517 | <remarks>To be added.</remarks>
|
544 | 518 | </Docs>
|
@@ -569,9 +543,7 @@ This overload allows helper methods or custom builder classes to efficiently avo
|
569 | 543 | <Parameters />
|
570 | 544 | <Docs>
|
571 | 545 | <typeparam name="T">The type of elements stored in the builder.</typeparam>
|
572 |
| - <summary> |
573 |
| - |
574 |
| - Creates a mutable array that can be converted to an <see cref="T:System.Collections.Immutable.ImmutableArray" /> without allocating new memory.</summary> |
| 546 | + <summary>Creates a mutable array that can be converted to an <see cref="T:System.Collections.Immutable.ImmutableArray" /> without allocating new memory.</summary> |
575 | 547 | <returns>A mutable array of the specified type that can be efficiently converted to an immutable array.</returns>
|
576 | 548 | <remarks>To be added.</remarks>
|
577 | 549 | </Docs>
|
@@ -605,9 +577,7 @@ This overload allows helper methods or custom builder classes to efficiently avo
|
605 | 577 | <Docs>
|
606 | 578 | <typeparam name="T">The type of elements stored in the builder.</typeparam>
|
607 | 579 | <param name="initialCapacity">The initial capacity of the builder.</param>
|
608 |
| - <summary> |
609 |
| - |
610 |
| - Creates a mutable array that can be converted to an <see cref="T:System.Collections.Immutable.ImmutableArray" /> without allocating new memory.</summary> |
| 580 | + <summary>Creates a mutable array that can be converted to an <see cref="T:System.Collections.Immutable.ImmutableArray" /> without allocating new memory.</summary> |
611 | 581 | <returns>A mutable array of the specified type that can be efficiently converted to an immutable array.</returns>
|
612 | 582 | <remarks>To be added.</remarks>
|
613 | 583 | </Docs>
|
@@ -641,9 +611,7 @@ This overload allows helper methods or custom builder classes to efficiently avo
|
641 | 611 | <Docs>
|
642 | 612 | <typeparam name="T">The type of element stored in the array.</typeparam>
|
643 | 613 | <param name="items">The elements to add to the array.</param>
|
644 |
| - <summary> |
645 |
| - |
646 |
| - Creates a new <see cref="T:System.Collections.Immutable.ImmutableArray`1" /> populated with the specified items.</summary> |
| 614 | + <summary>Creates a new <see cref="T:System.Collections.Immutable.ImmutableArray`1" /> populated with the specified items.</summary> |
647 | 615 | <returns>An immutable array that contains the specified items.</returns>
|
648 | 616 | <remarks>To be added.</remarks>
|
649 | 617 | </Docs>
|
@@ -873,9 +841,7 @@ This overload allows helper methods or custom builder classes to efficiently avo
|
873 | 841 | <Docs>
|
874 | 842 | <typeparam name="TSource">The type of elements contained in <paramref name="items" />.</typeparam>
|
875 | 843 | <param name="items">The collection of objects to copy to the immutable array.</param>
|
876 |
| - <summary> |
877 |
| - |
878 |
| - Creates an immutable array from the specified collection.</summary> |
| 844 | + <summary>Creates an immutable array from the specified collection.</summary> |
879 | 845 | <returns>An immutable array that contains the specified collection of objects.</returns>
|
880 | 846 | <remarks>To be added.</remarks>
|
881 | 847 | </Docs>
|
|
0 commit comments