Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Port documentation for .NET 7.0 Preview5 #8185

Merged
merged 24 commits into from
Jul 6, 2022
Merged

Port documentation for .NET 7.0 Preview5 #8185

Show file tree
Hide file tree
Changes from 22 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
f8e6345
Microsoft.Extensions.Logging
carlossanlop Jun 30, 2022
ba90dbf
System
carlossanlop Jun 30, 2022
84bb6c9
System.Collections
carlossanlop Jun 30, 2022
795c3cf
System.Diagnostics.Activity
carlossanlop Jun 30, 2022
d10feb6
System.IO
carlossanlop Jun 30, 2022
be6ab80
System.Numerics
carlossanlop Jun 30, 2022
e578b7c
System.Reflection
carlossanlop Jun 30, 2022
a740ece
System.Runtime.CompilerServices
carlossanlop Jun 30, 2022
766adfd
System.Runtime.InteropServices
carlossanlop Jun 30, 2022
7c81d49
System.Runtime.Intrinsics
carlossanlop Jun 30, 2022
9191450
System.Security
carlossanlop Jun 30, 2022
2f26e61
System.Text.Json
carlossanlop Jun 30, 2022
907563f
System.Threading
carlossanlop Jun 30, 2022
ab34e14
System.Windows.Forms
carlossanlop Jun 30, 2022
0423cf4
mass fixes to numeric type remarks
gewarren Jun 30, 2022
1d5dbb5
some more fixes
gewarren Jun 30, 2022
14e3a23
some more fixes
gewarren Jun 30, 2022
5d97bb1
Apply suggestions from code review
carlossanlop Jul 5, 2022
4122893
Update xml/System.Collections.Immutable/ImmutableList`1+Builder.xml
carlossanlop Jul 5, 2022
9be0f51
Apply suggestions from code review
carlossanlop Jul 5, 2022
f84d9b6
Apply suggestions from code review
carlossanlop Jul 5, 2022
0b6d8d9
Apply suggestions from code review
carlossanlop Jul 5, 2022
847ccf6
Fix build warning
carlossanlop Jul 5, 2022
372f07e
the specified -> a supplied
carlossanlop Jul 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions xml/Microsoft.Extensions.Logging/LoggerFactory.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,11 +195,11 @@
<Parameter Name="scopeProvider" Type="Microsoft.Extensions.Logging.IExternalScopeProvider" Index="3" FrameworkAlternate="dotnet-plat-ext-7.0" />
</Parameters>
<Docs>
<param name="providers">To be added.</param>
<param name="filterOption">To be added.</param>
<param name="options">To be added.</param>
<param name="scopeProvider">To be added.</param>
<summary>To be added.</summary>
<param name="providers">The providers to use in producing <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instances.</param>
<param name="filterOption">The filter option to use.</param>
<param name="options">The <see cref="T:Microsoft.Extensions.Logging.LoggerFactoryOptions" />.</param>
<param name="scopeProvider">The <see cref="T:Microsoft.Extensions.Logging.IExternalScopeProvider" />.</param>
<summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.LoggerFactory" /> instance.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
2 changes: 1 addition & 1 deletion xml/Microsoft.Extensions.Logging/LoggerFactoryExtensions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
<param name="factory">The factory.</param>
<param name="type">The type.</param>
<summary>Creates a new <see cref="T:Microsoft.Extensions.Logging.ILogger" /> instance using the full name of the given <paramref name="type" />.</summary>
<returns>To be added.</returns>
<returns>The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> that was created.</returns>
<remarks>To be added.</remarks>
<return>The <see cref="T:Microsoft.Extensions.Logging.ILogger" /> that was created.</return>
</Docs>
Expand Down
83 changes: 44 additions & 39 deletions xml/System.Collections.Immutable/ImmutableArray`1+Builder.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -630,8 +630,8 @@
<Parameter Name="destination" Type="T[]" Index="0" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="destination">To be added.</param>
<summary>To be added.</summary>
<param name="destination">The array to copy to.</param>
<summary>Copies the contents of this array to the specified array.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -695,11 +695,11 @@
<Parameter Name="length" Type="System.Int32" Index="3" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="sourceIndex">To be added.</param>
<param name="destination">To be added.</param>
<param name="destinationIndex">To be added.</param>
<param name="length">To be added.</param>
<summary>To be added.</summary>
<param name="sourceIndex">The index into this collection of the first element to copy.</param>
<param name="destination">The array to copy to.</param>
<param name="destinationIndex">The index into the destination array to which the first copied element is written.</param>
<param name="length">The number of elements to copy.</param>
<summary>Copies the contents of this array to the specified array.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -881,11 +881,12 @@
<Parameter Name="equalityComparer" Type="System.Collections.Generic.IEqualityComparer&lt;T&gt;" Index="2" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="item">To be added.</param>
<param name="startIndex">To be added.</param>
<param name="equalityComparer">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="item">The item to search for.</param>
<param name="startIndex">The index at which to begin the search.</param>
<param name="equalityComparer">The equality comparer to use in the search.
If <see langword="null" />, <see cref="P:System.Collections.Generic.EqualityComparer`1.Default" /> is used.</param>
<summary>Searches the array for the specified item.</summary>
<returns>The 0-based index into the array where the item was found; or -1 if it could not be found.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1026,9 +1027,9 @@
<Parameter Name="items" Type="System.Collections.Generic.IEnumerable&lt;T&gt;" Index="1" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="index">To be added.</param>
<param name="items">To be added.</param>
<summary>To be added.</summary>
<param name="index">The index at which to insert the value.</param>
<param name="items">The elements to insert.</param>
<summary>Inserts the specified values at the specified index.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -1052,9 +1053,9 @@
<Parameter Name="items" Type="System.Collections.Immutable.ImmutableArray&lt;T&gt;" Index="1" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="index">To be added.</param>
<param name="items">To be added.</param>
<summary>To be added.</summary>
<param name="index">The index at which to insert the value.</param>
<param name="items">The elements to insert.</param>
<summary>Inserts the specified values at the specified index.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1373,10 +1374,12 @@
<Parameter Name="equalityComparer" Type="System.Collections.Generic.IEqualityComparer&lt;T&gt;" Index="1" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="element">To be added.</param>
<param name="equalityComparer">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="element">The element to remove.</param>
<param name="equalityComparer">The equality comparer to use in the search.
If <see langword="null" />, <see cref="P:System.Collections.Generic.EqualityComparer`1.Default" /> is used.</param>
<summary>Removes the first occurrence of the specified element from the builder.
If no match is found, the builder remains unchanged.</summary>
<returns>A value indicating whether the specified element was found and removed from the collection.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -1399,8 +1402,8 @@
<Parameter Name="match" Type="System.Predicate&lt;T&gt;" Index="0" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="match">To be added.</param>
<summary>To be added.</summary>
<param name="match">The <see cref="T:System.Predicate`1" /> delegate that defines the conditions of the elements to remove.</param>
<summary>Removes all the elements that match the conditions defined by the specified predicate.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -1459,8 +1462,8 @@
<Parameter Name="items" Type="System.Collections.Generic.IEnumerable&lt;T&gt;" Index="0" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="items">To be added.</param>
<summary>To be added.</summary>
<param name="items">The items to remove if matches are found in this list.</param>
<summary>Removes the specified values from this list.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -1484,9 +1487,10 @@
<Parameter Name="equalityComparer" Type="System.Collections.Generic.IEqualityComparer&lt;T&gt;" Index="1" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="items">To be added.</param>
<param name="equalityComparer">To be added.</param>
<summary>To be added.</summary>
<param name="items">The items to remove if matches are found in this list.</param>
<param name="equalityComparer">The equality comparer to use in the search.
If <see langword="null" />, <see cref="P:System.Collections.Generic.EqualityComparer`1.Default" /> is used.</param>
<summary>Removes the specified values from this list.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -1510,9 +1514,9 @@
<Parameter Name="length" Type="System.Int32" Index="1" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="index">To be added.</param>
<param name="length">To be added.</param>
<summary>To be added.</summary>
<param name="index">The 0-based index into the array for the element to omit from the returned array.</param>
<param name="length">The number of elements to remove.</param>
<summary>Removes the specified values from this list.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -1536,9 +1540,9 @@
<Parameter Name="newValue" Type="T" Index="1" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="oldValue">To be added.</param>
<param name="newValue">To be added.</param>
<summary>To be added.</summary>
<param name="oldValue">The element to replace.</param>
<param name="newValue">The element to replace the old element with.</param>
<summary>Replaces the first equal element in the list with the specified element.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -1563,10 +1567,11 @@
<Parameter Name="equalityComparer" Type="System.Collections.Generic.IEqualityComparer&lt;T&gt;" Index="2" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="oldValue">To be added.</param>
<param name="newValue">To be added.</param>
<param name="equalityComparer">To be added.</param>
<summary>To be added.</summary>
<param name="oldValue">The element to replace.</param>
<param name="newValue">The element to replace the old element with.</param>
<param name="equalityComparer">The equality comparer to use in the search.
If <see langword="null" />, <see cref="P:System.Collections.Generic.EqualityComparer`1.Default" /> is used.</param>
<summary>Replaces the first equal element in the list with the specified element.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
28 changes: 14 additions & 14 deletions xml/System.Collections.Immutable/ImmutableArray`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,10 +291,10 @@
<Parameter Name="length" Type="System.Int32" Index="1" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="items">To be added.</param>
<param name="length">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="items">The values to add.</param>
<param name="length">The number of elements from the source array to add.</param>
<summary>Adds the specified items to the end of the array.</summary>
<returns>A new list with the elements added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -318,10 +318,10 @@
<Parameter Name="length" Type="System.Int32" Index="1" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="items">To be added.</param>
<param name="length">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="items">The values to add.</param>
<param name="length">The number of elements from the source array to add.</param>
<summary>Adds the specified items to the end of the array.</summary>
<returns>A new list with the elements added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -352,9 +352,9 @@
</Parameters>
<Docs>
<typeparam name="TDerived">To be added.</typeparam>
<param name="items">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="items">The values to add.</param>
<summary>Adds the specified items to the end of the array.</summary>
<returns>A new list with the elements added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -385,9 +385,9 @@
</Parameters>
<Docs>
<typeparam name="TDerived">To be added.</typeparam>
<param name="items">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="items">The values to add.</param>
<summary>Adds the specified items to the end of the array.</summary>
<returns>A new list with the elements added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
41 changes: 23 additions & 18 deletions xml/System.Collections.Immutable/ImmutableList`1+Builder.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1558,9 +1558,10 @@
<Parameter Name="equalityComparer" Type="System.Collections.Generic.IEqualityComparer&lt;T&gt;" Index="1" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="item">To be added.</param>
<param name="equalityComparer">To be added.</param>
<summary>To be added.</summary>
<param name="item">The item to remove.</param>
<param name="equalityComparer">The equality comparer to use in the search.
If <see langword="null" />, <see cref="P:System.Collections.Generic.EqualityComparer`1.Default" /> is used.</param>
<summary>Removes the first occurrence matching the specified value from this list.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -1655,8 +1656,8 @@
<Parameter Name="items" Type="System.Collections.Generic.IEnumerable&lt;T&gt;" Index="0" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="items">To be added.</param>
<summary>To be added.</summary>
<param name="items">The items to remove if matches are found in this list.</param>
<summary>Removes any first occurrences of the specified values from this list.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -1680,9 +1681,10 @@
<Parameter Name="equalityComparer" Type="System.Collections.Generic.IEqualityComparer&lt;T&gt;" Index="1" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="items">To be added.</param>
<param name="equalityComparer">To be added.</param>
<summary>To be added.</summary>
<param name="items">The items to remove if matches are found in this list.</param>
<param name="equalityComparer">The equality comparer to use in the search.
If <see langword="null" />, <see cref="P:System.Collections.Generic.EqualityComparer`1.Default" /> is used.</param>
<summary>Removes any first occurrences of the specified values from this list.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -1706,9 +1708,9 @@
<Parameter Name="count" Type="System.Int32" Index="1" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="index">To be added.</param>
<param name="count">To be added.</param>
<summary>To be added.</summary>
<param name="index">The starting index to begin removal.</param>
<param name="count">The number of elements to remove.</param>
<summary>Removes the specified range of values from this list.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -1732,10 +1734,11 @@
<Parameter Name="newValue" Type="T" Index="1" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="oldValue">To be added.</param>
<param name="newValue">To be added.</param>
<summary>To be added.</summary>
<param name="oldValue">The element to replace.</param>
<param name="newValue">The element to replace the old element with.</param>
<summary>Replaces the first equal element in the list with the specified element.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">The old value does not exist in the list.</exception>
</Docs>
</Member>
<Member MemberName="Replace">
Expand All @@ -1759,11 +1762,13 @@
<Parameter Name="equalityComparer" Type="System.Collections.Generic.IEqualityComparer&lt;T&gt;" Index="2" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="oldValue">To be added.</param>
<param name="newValue">To be added.</param>
<param name="equalityComparer">To be added.</param>
<summary>To be added.</summary>
<param name="oldValue">The element to replace.</param>
<param name="newValue">The element to replace the old element with.</param>
<param name="equalityComparer">The equality comparer to use in the search.
If <see langword="null" />, <see cref="P:System.Collections.Generic.EqualityComparer`1.Default" /> is used.</param>
<summary>Replaces the first equal element in the list with the specified element.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">The old value does not exist in the list.</exception>
</Docs>
</Member>
<Member MemberName="Reverse">
Expand Down
6 changes: 3 additions & 3 deletions xml/System.Collections.Immutable/ImmutableSortedSet`1+Builder.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,9 +299,9 @@
<Parameter Name="item" Type="T" Index="0" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="item">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="item">The value to locate within the set.</param>
<summary>Searches for the first index within this set that the specified value is contained.</summary>
<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>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
5 changes: 3 additions & 2 deletions xml/System.Diagnostics/ActivityEvent.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Enumerate the tags attached to this <see cref="T:System.Diagnostics.ActivityEvent" /> object.</summary>
<returns>
<see cref="T:System.Diagnostics.Activity.Enumerator`1" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
5 changes: 3 additions & 2 deletions xml/System.Diagnostics/ActivityLink.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,9 @@ Activity links can be used to represent batched operations where an activity was
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Enumerate the tags attached to this <see cref="T:System.Diagnostics.ActivityLink" /> object.</summary>
<returns>
<see cref="T:System.Diagnostics.Activity.Enumerator`1" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
Loading