Skip to content

Commit 9f32d39

Browse files
carlossanlopgewarren
carlossanlop
and
gewarren
authored
Port documentation for .NET 7.0 Preview5 (#8185)
* Microsoft.Extensions.Logging * System * System.Collections * System.Diagnostics.Activity * System.IO * System.Numerics * System.Reflection * System.Runtime.CompilerServices * System.Runtime.InteropServices * System.Runtime.Intrinsics * System.Security * System.Text.Json * System.Threading * System.Windows.Forms * mass fixes to numeric type remarks * some more fixes * some more fixes * Apply suggestions from code review Co-authored-by: Genevieve Warren <[email protected]> * Update xml/System.Collections.Immutable/ImmutableList`1+Builder.xml Co-authored-by: Genevieve Warren <[email protected]> * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review * Fix build warning * the specified -> a supplied Co-authored-by: Genevieve Warren <[email protected]>
1 parent 12bdd60 commit 9f32d39

File tree

77 files changed

+4136
-2001
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+4136
-2001
lines changed

‎xml/Microsoft.Extensions.Logging/LoggerFactory.xml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -195,11 +195,11 @@
195195
<Parameter Name="scopeProvider" Type="Microsoft.Extensions.Logging.IExternalScopeProvider" Index="3" FrameworkAlternate="dotnet-plat-ext-7.0" />
196196
</Parameters>
197197
<Docs>
198-
<param name="providers">To be added.</param>
199-
<param name="filterOption">To be added.</param>
200-
<param name="options">To be added.</param>
201-
<param name="scopeProvider">To be added.</param>
202-
<summary>To be added.</summary>
198+
<param name="providers">The providers to use in producing <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instances.</param>
199+
<param name="filterOption">The filter option to use.</param>
200+
<param name="options">The <see cref="T:Microsoft.Extensions.Logging.LoggerFactoryOptions" />.</param>
201+
<param name="scopeProvider">The <see cref="T:Microsoft.Extensions.Logging.IExternalScopeProvider" />.</param>
202+
<summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFactory" /> instance.</summary>
203203
<remarks>To be added.</remarks>
204204
</Docs>
205205
</Member>

‎xml/Microsoft.Extensions.Logging/LoggerFactoryExtensions.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
<param name="factory">The factory.</param>
6060
<param name="type">The type.</param>
6161
<summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instance using the full name of the given <paramref name="type" />.</summary>
62-
<returns>To be added.</returns>
62+
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> that was created.</returns>
6363
<remarks>To be added.</remarks>
6464
<return>The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> that was created.</return>
6565
</Docs>

‎xml/System.Collections.Immutable/ImmutableArray`1+Builder.xml‎

Lines changed: 44 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -630,8 +630,8 @@
630630
<Parameter Name="destination" Type="T[]" Index="0" FrameworkAlternate="net-7.0" />
631631
</Parameters>
632632
<Docs>
633-
<param name="destination">To be added.</param>
634-
<summary>To be added.</summary>
633+
<param name="destination">The array to copy to.</param>
634+
<summary>Copies the contents of this array to the specified array.</summary>
635635
<remarks>To be added.</remarks>
636636
</Docs>
637637
</Member>
@@ -695,11 +695,11 @@
695695
<Parameter Name="length" Type="System.Int32" Index="3" FrameworkAlternate="net-7.0" />
696696
</Parameters>
697697
<Docs>
698-
<param name="sourceIndex">To be added.</param>
699-
<param name="destination">To be added.</param>
700-
<param name="destinationIndex">To be added.</param>
701-
<param name="length">To be added.</param>
702-
<summary>To be added.</summary>
698+
<param name="sourceIndex">The index into this collection of the first element to copy.</param>
699+
<param name="destination">The array to copy to.</param>
700+
<param name="destinationIndex">The index into the destination array to which the first copied element is written.</param>
701+
<param name="length">The number of elements to copy.</param>
702+
<summary>Copies the contents of this array to the specified array.</summary>
703703
<remarks>To be added.</remarks>
704704
</Docs>
705705
</Member>
@@ -881,11 +881,12 @@
881881
<Parameter Name="equalityComparer" Type="System.Collections.Generic.IEqualityComparer&lt;T&gt;" Index="2" FrameworkAlternate="net-7.0" />
882882
</Parameters>
883883
<Docs>
884-
<param name="item">To be added.</param>
885-
<param name="startIndex">To be added.</param>
886-
<param name="equalityComparer">To be added.</param>
887-
<summary>To be added.</summary>
888-
<returns>To be added.</returns>
884+
<param name="item">The item to search for.</param>
885+
<param name="startIndex">The index at which to begin the search.</param>
886+
<param name="equalityComparer">The equality comparer to use in the search.
887+
If <see langword="null" />, <see cref="P:System.Collections.Generic.EqualityComparer`1.Default" /> is used.</param>
888+
<summary>Searches the array for the specified item.</summary>
889+
<returns>The 0-based index into the array where the item was found; or -1 if it could not be found.</returns>
889890
<remarks>To be added.</remarks>
890891
</Docs>
891892
</Member>
@@ -1026,9 +1027,9 @@
10261027
<Parameter Name="items" Type="System.Collections.Generic.IEnumerable&lt;T&gt;" Index="1" FrameworkAlternate="net-7.0" />
10271028
</Parameters>
10281029
<Docs>
1029-
<param name="index">To be added.</param>
1030-
<param name="items">To be added.</param>
1031-
<summary>To be added.</summary>
1030+
<param name="index">The index at which to insert the value.</param>
1031+
<param name="items">The elements to insert.</param>
1032+
<summary>Inserts the specified values at the specified index.</summary>
10321033
<remarks>To be added.</remarks>
10331034
</Docs>
10341035
</Member>
@@ -1052,9 +1053,9 @@
10521053
<Parameter Name="items" Type="System.Collections.Immutable.ImmutableArray&lt;T&gt;" Index="1" FrameworkAlternate="net-7.0" />
10531054
</Parameters>
10541055
<Docs>
1055-
<param name="index">To be added.</param>
1056-
<param name="items">To be added.</param>
1057-
<summary>To be added.</summary>
1056+
<param name="index">The index at which to insert the value.</param>
1057+
<param name="items">The elements to insert.</param>
1058+
<summary>Inserts the specified values at the specified index.</summary>
10581059
<remarks>To be added.</remarks>
10591060
</Docs>
10601061
</Member>
@@ -1373,10 +1374,12 @@
13731374
<Parameter Name="equalityComparer" Type="System.Collections.Generic.IEqualityComparer&lt;T&gt;" Index="1" FrameworkAlternate="net-7.0" />
13741375
</Parameters>
13751376
<Docs>
1376-
<param name="element">To be added.</param>
1377-
<param name="equalityComparer">To be added.</param>
1378-
<summary>To be added.</summary>
1379-
<returns>To be added.</returns>
1377+
<param name="element">The element to remove.</param>
1378+
<param name="equalityComparer">The equality comparer to use in the search.
1379+
If <see langword="null" />, <see cref="P:System.Collections.Generic.EqualityComparer`1.Default" /> is used.</param>
1380+
<summary>Removes the first occurrence of the specified element from the builder.
1381+
If no match is found, the builder remains unchanged.</summary>
1382+
<returns>A value indicating whether the specified element was found and removed from the collection.</returns>
13801383
<remarks>To be added.</remarks>
13811384
</Docs>
13821385
</Member>
@@ -1399,8 +1402,8 @@
13991402
<Parameter Name="match" Type="System.Predicate&lt;T&gt;" Index="0" FrameworkAlternate="net-7.0" />
14001403
</Parameters>
14011404
<Docs>
1402-
<param name="match">To be added.</param>
1403-
<summary>To be added.</summary>
1405+
<param name="match">The <see cref="T:System.Predicate`1" /> delegate that defines the conditions of the elements to remove.</param>
1406+
<summary>Removes all the elements that match the conditions defined by the specified predicate.</summary>
14041407
<remarks>To be added.</remarks>
14051408
</Docs>
14061409
</Member>
@@ -1459,8 +1462,8 @@
14591462
<Parameter Name="items" Type="System.Collections.Generic.IEnumerable&lt;T&gt;" Index="0" FrameworkAlternate="net-7.0" />
14601463
</Parameters>
14611464
<Docs>
1462-
<param name="items">To be added.</param>
1463-
<summary>To be added.</summary>
1465+
<param name="items">The items to remove if matches are found in this list.</param>
1466+
<summary>Removes the specified values from this list.</summary>
14641467
<remarks>To be added.</remarks>
14651468
</Docs>
14661469
</Member>
@@ -1484,9 +1487,10 @@
14841487
<Parameter Name="equalityComparer" Type="System.Collections.Generic.IEqualityComparer&lt;T&gt;" Index="1" FrameworkAlternate="net-7.0" />
14851488
</Parameters>
14861489
<Docs>
1487-
<param name="items">To be added.</param>
1488-
<param name="equalityComparer">To be added.</param>
1489-
<summary>To be added.</summary>
1490+
<param name="items">The items to remove if matches are found in this list.</param>
1491+
<param name="equalityComparer">The equality comparer to use in the search.
1492+
If <see langword="null" />, <see cref="P:System.Collections.Generic.EqualityComparer`1.Default" /> is used.</param>
1493+
<summary>Removes the specified values from this list.</summary>
14901494
<remarks>To be added.</remarks>
14911495
</Docs>
14921496
</Member>
@@ -1510,9 +1514,9 @@
15101514
<Parameter Name="length" Type="System.Int32" Index="1" FrameworkAlternate="net-7.0" />
15111515
</Parameters>
15121516
<Docs>
1513-
<param name="index">To be added.</param>
1514-
<param name="length">To be added.</param>
1515-
<summary>To be added.</summary>
1517+
<param name="index">The 0-based index into the array for the element to omit from the returned array.</param>
1518+
<param name="length">The number of elements to remove.</param>
1519+
<summary>Removes the specified values from this list.</summary>
15161520
<remarks>To be added.</remarks>
15171521
</Docs>
15181522
</Member>
@@ -1536,9 +1540,9 @@
15361540
<Parameter Name="newValue" Type="T" Index="1" FrameworkAlternate="net-7.0" />
15371541
</Parameters>
15381542
<Docs>
1539-
<param name="oldValue">To be added.</param>
1540-
<param name="newValue">To be added.</param>
1541-
<summary>To be added.</summary>
1543+
<param name="oldValue">The element to replace.</param>
1544+
<param name="newValue">The element to replace the old element with.</param>
1545+
<summary>Replaces the first equal element in the list with the specified element.</summary>
15421546
<remarks>To be added.</remarks>
15431547
</Docs>
15441548
</Member>
@@ -1563,10 +1567,11 @@
15631567
<Parameter Name="equalityComparer" Type="System.Collections.Generic.IEqualityComparer&lt;T&gt;" Index="2" FrameworkAlternate="net-7.0" />
15641568
</Parameters>
15651569
<Docs>
1566-
<param name="oldValue">To be added.</param>
1567-
<param name="newValue">To be added.</param>
1568-
<param name="equalityComparer">To be added.</param>
1569-
<summary>To be added.</summary>
1570+
<param name="oldValue">The element to replace.</param>
1571+
<param name="newValue">The element to replace the old element with.</param>
1572+
<param name="equalityComparer">The equality comparer to use in the search.
1573+
If <see langword="null" />, <see cref="P:System.Collections.Generic.EqualityComparer`1.Default" /> is used.</param>
1574+
<summary>Replaces the first equal element in the list with the specified element.</summary>
15701575
<remarks>To be added.</remarks>
15711576
</Docs>
15721577
</Member>

‎xml/System.Collections.Immutable/ImmutableArray`1.xml‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -291,10 +291,10 @@
291291
<Parameter Name="length" Type="System.Int32" Index="1" FrameworkAlternate="net-7.0" />
292292
</Parameters>
293293
<Docs>
294-
<param name="items">To be added.</param>
295-
<param name="length">To be added.</param>
296-
<summary>To be added.</summary>
297-
<returns>To be added.</returns>
294+
<param name="items">The values to add.</param>
295+
<param name="length">The number of elements from the source array to add.</param>
296+
<summary>Adds the specified items to the end of the array.</summary>
297+
<returns>A new list with the elements added.</returns>
298298
<remarks>To be added.</remarks>
299299
</Docs>
300300
</Member>
@@ -318,10 +318,10 @@
318318
<Parameter Name="length" Type="System.Int32" Index="1" FrameworkAlternate="net-7.0" />
319319
</Parameters>
320320
<Docs>
321-
<param name="items">To be added.</param>
322-
<param name="length">To be added.</param>
323-
<summary>To be added.</summary>
324-
<returns>To be added.</returns>
321+
<param name="items">The values to add.</param>
322+
<param name="length">The number of elements from the source array to add.</param>
323+
<summary>Adds the specified items to the end of the array.</summary>
324+
<returns>A new list with the elements added.</returns>
325325
<remarks>To be added.</remarks>
326326
</Docs>
327327
</Member>
@@ -352,9 +352,9 @@
352352
</Parameters>
353353
<Docs>
354354
<typeparam name="TDerived">To be added.</typeparam>
355-
<param name="items">To be added.</param>
356-
<summary>To be added.</summary>
357-
<returns>To be added.</returns>
355+
<param name="items">The values to add.</param>
356+
<summary>Adds the specified items to the end of the array.</summary>
357+
<returns>A new list with the elements added.</returns>
358358
<remarks>To be added.</remarks>
359359
</Docs>
360360
</Member>
@@ -385,9 +385,9 @@
385385
</Parameters>
386386
<Docs>
387387
<typeparam name="TDerived">To be added.</typeparam>
388-
<param name="items">To be added.</param>
389-
<summary>To be added.</summary>
390-
<returns>To be added.</returns>
388+
<param name="items">The values to add.</param>
389+
<summary>Adds the specified items to the end of the array.</summary>
390+
<returns>A new list with the elements added.</returns>
391391
<remarks>To be added.</remarks>
392392
</Docs>
393393
</Member>

‎xml/System.Collections.Immutable/ImmutableList`1+Builder.xml‎

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1558,9 +1558,10 @@
15581558
<Parameter Name="equalityComparer" Type="System.Collections.Generic.IEqualityComparer&lt;T&gt;" Index="1" FrameworkAlternate="net-7.0" />
15591559
</Parameters>
15601560
<Docs>
1561-
<param name="item">To be added.</param>
1562-
<param name="equalityComparer">To be added.</param>
1563-
<summary>To be added.</summary>
1561+
<param name="item">The item to remove.</param>
1562+
<param name="equalityComparer">The equality comparer to use in the search.
1563+
If <see langword="null" />, <see cref="P:System.Collections.Generic.EqualityComparer`1.Default" /> is used.</param>
1564+
<summary>Removes the first occurrence matching the specified value from this list.</summary>
15641565
<returns>To be added.</returns>
15651566
<remarks>To be added.</remarks>
15661567
</Docs>
@@ -1655,8 +1656,8 @@
16551656
<Parameter Name="items" Type="System.Collections.Generic.IEnumerable&lt;T&gt;" Index="0" FrameworkAlternate="net-7.0" />
16561657
</Parameters>
16571658
<Docs>
1658-
<param name="items">To be added.</param>
1659-
<summary>To be added.</summary>
1659+
<param name="items">The items to remove if matches are found in this list.</param>
1660+
<summary>Removes any first occurrences of the specified values from this list.</summary>
16601661
<remarks>To be added.</remarks>
16611662
</Docs>
16621663
</Member>
@@ -1680,9 +1681,10 @@
16801681
<Parameter Name="equalityComparer" Type="System.Collections.Generic.IEqualityComparer&lt;T&gt;" Index="1" FrameworkAlternate="net-7.0" />
16811682
</Parameters>
16821683
<Docs>
1683-
<param name="items">To be added.</param>
1684-
<param name="equalityComparer">To be added.</param>
1685-
<summary>To be added.</summary>
1684+
<param name="items">The items to remove if matches are found in this list.</param>
1685+
<param name="equalityComparer">The equality comparer to use in the search.
1686+
If <see langword="null" />, <see cref="P:System.Collections.Generic.EqualityComparer`1.Default" /> is used.</param>
1687+
<summary>Removes any first occurrences of the specified values from this list.</summary>
16861688
<remarks>To be added.</remarks>
16871689
</Docs>
16881690
</Member>
@@ -1706,9 +1708,9 @@
17061708
<Parameter Name="count" Type="System.Int32" Index="1" FrameworkAlternate="net-7.0" />
17071709
</Parameters>
17081710
<Docs>
1709-
<param name="index">To be added.</param>
1710-
<param name="count">To be added.</param>
1711-
<summary>To be added.</summary>
1711+
<param name="index">The starting index to begin removal.</param>
1712+
<param name="count">The number of elements to remove.</param>
1713+
<summary>Removes the specified range of values from this list.</summary>
17121714
<remarks>To be added.</remarks>
17131715
</Docs>
17141716
</Member>
@@ -1732,10 +1734,11 @@
17321734
<Parameter Name="newValue" Type="T" Index="1" FrameworkAlternate="net-7.0" />
17331735
</Parameters>
17341736
<Docs>
1735-
<param name="oldValue">To be added.</param>
1736-
<param name="newValue">To be added.</param>
1737-
<summary>To be added.</summary>
1737+
<param name="oldValue">The element to replace.</param>
1738+
<param name="newValue">The element to replace the old element with.</param>
1739+
<summary>Replaces the first equal element in the list with the specified element.</summary>
17381740
<remarks>To be added.</remarks>
1741+
<exception cref="T:System.ArgumentException">The old value does not exist in the list.</exception>
17391742
</Docs>
17401743
</Member>
17411744
<Member MemberName="Replace">
@@ -1759,11 +1762,13 @@
17591762
<Parameter Name="equalityComparer" Type="System.Collections.Generic.IEqualityComparer&lt;T&gt;" Index="2" FrameworkAlternate="net-7.0" />
17601763
</Parameters>
17611764
<Docs>
1762-
<param name="oldValue">To be added.</param>
1763-
<param name="newValue">To be added.</param>
1764-
<param name="equalityComparer">To be added.</param>
1765-
<summary>To be added.</summary>
1765+
<param name="oldValue">The element to replace.</param>
1766+
<param name="newValue">The element to replace the old element with.</param>
1767+
<param name="equalityComparer">The equality comparer to use in the search.
1768+
If <see langword="null" />, <see cref="P:System.Collections.Generic.EqualityComparer`1.Default" /> is used.</param>
1769+
<summary>Replaces the first equal element in the list with the specified element.</summary>
17661770
<remarks>To be added.</remarks>
1771+
<exception cref="T:System.ArgumentException">The old value does not exist in the list.</exception>
17671772
</Docs>
17681773
</Member>
17691774
<Member MemberName="Reverse">

‎xml/System.Collections.Immutable/ImmutableSortedSet`1+Builder.xml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -299,9 +299,9 @@
299299
<Parameter Name="item" Type="T" Index="0" FrameworkAlternate="net-7.0" />
300300
</Parameters>
301301
<Docs>
302-
<param name="item">To be added.</param>
303-
<summary>To be added.</summary>
304-
<returns>To be added.</returns>
302+
<param name="item">The value to locate within the set.</param>
303+
<summary>Searches for the first index within this set that the specified value is contained.</summary>
304+
<returns>The index of the specified <paramref name="item" /> in the sorted set, if <paramref name="item" /> is found. If <paramref name="item" /> is not found and <paramref name="item" /> is less than one or more elements in this set, returns a negative number that is the bitwise complement of the index of the first element that's larger than <paramref name="item" />. If <paramref name="item" /> is not found and <paramref name="item" /> is greater than any of the elements in the set, returns a negative number that is the bitwise complement of (the index of the last element plus 1).</returns>
305305
<remarks>To be added.</remarks>
306306
</Docs>
307307
</Member>

‎xml/System.Diagnostics/ActivityEvent.xml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,9 @@
9292
</ReturnValue>
9393
<Parameters />
9494
<Docs>
95-
<summary>To be added.</summary>
96-
<returns>To be added.</returns>
95+
<summary>Enumerate the tags attached to this <see cref="T:System.Diagnostics.ActivityEvent" /> object.</summary>
96+
<returns>
97+
<see cref="T:System.Diagnostics.Activity.Enumerator`1" />.</returns>
9798
<remarks>To be added.</remarks>
9899
</Docs>
99100
</Member>

‎xml/System.Diagnostics/ActivityLink.xml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,9 @@ Activity links can be used to represent batched operations where an activity was
9898
</ReturnValue>
9999
<Parameters />
100100
<Docs>
101-
<summary>To be added.</summary>
102-
<returns>To be added.</returns>
101+
<summary>Enumerate the tags attached to this <see cref="T:System.Diagnostics.ActivityLink" /> object.</summary>
102+
<returns>
103+
<see cref="T:System.Diagnostics.Activity.Enumerator`1" />.</returns>
103104
<remarks>To be added.</remarks>
104105
</Docs>
105106
</Member>

0 commit comments

Comments
 (0)