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.

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 .NET 7.0 Preview1 documentation #7807

Merged
merged 38 commits into from
Mar 12, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
fd43d29
Microsoft.Extensions.Caching.Memory
carlossanlop Mar 8, 2022
6a92b36
Microsoft.Extensions.Configuration
carlossanlop Mar 8, 2022
075a2b3
Microsoft.Extensions.DependencyModel
carlossanlop Mar 8, 2022
10a14dc
Microsoft.Extensions.Primitives
carlossanlop Mar 8, 2022
4f7f6d6
System.Buffers
carlossanlop Mar 8, 2022
5239499
System.Collections.Concurrent
carlossanlop Mar 8, 2022
5a5f7ad
System.Collections.Generic
carlossanlop Mar 8, 2022
584a2af
System.Diagnostics
carlossanlop Mar 8, 2022
6c7f489
System.Diagnostics.CodeAnalysis
carlossanlop Mar 8, 2022
13e3e0c
System.Drawing
carlossanlop Mar 8, 2022
245ecfe
System.IO
carlossanlop Mar 8, 2022
7971258
System.Net.Http.Json
carlossanlop Mar 8, 2022
86325ec
System.Net.Sockets
carlossanlop Mar 8, 2022
335ae1e
System.Numerics
carlossanlop Mar 8, 2022
eb08f02
System.Reflection.Metadata.Ecma335
carlossanlop Mar 8, 2022
2a6e974
System.Reflection.PortableExecutable
carlossanlop Mar 8, 2022
eb0343a
System.Runtime.CompilerServices
carlossanlop Mar 8, 2022
75d5db3
System.Runtime.InteropServices
carlossanlop Mar 8, 2022
30330be
System.Runtime.Intrinsics
carlossanlop Mar 8, 2022
67498d1
System.Runtime.Intrinsics.Arm
carlossanlop Mar 8, 2022
24f094a
System.Runtime.Intrinsics.X86
carlossanlop Mar 8, 2022
21bab26
System.Security.Cryptography
carlossanlop Mar 8, 2022
f1de8f6
System.Security.Cryptography.Pkcs
carlossanlop Mar 8, 2022
491d247
System.Security.Cryptography.X509Certificates
carlossanlop Mar 8, 2022
d99e46c
System.Text.Json
carlossanlop Mar 8, 2022
1bbc6f3
System.Text.Json.Nodes
carlossanlop Mar 8, 2022
dcdfae3
System.Text.RegularExpressions
carlossanlop Mar 8, 2022
2e7df81
System.Text.Unicode
carlossanlop Mar 8, 2022
a91f537
System.Threading
carlossanlop Mar 8, 2022
cb052e6
System.Threading.Tasks
carlossanlop Mar 8, 2022
f211159
System.Web.DynamicData
carlossanlop Mar 8, 2022
2da1fef
System.Windows.Forms
carlossanlop Mar 8, 2022
2199c09
System
carlossanlop Mar 8, 2022
73c4320
Update xml/System.Diagnostics/Activity.xml
tarekgh Mar 9, 2022
c62b156
Update xml/System.Diagnostics/ActivityContext.xml
tarekgh Mar 9, 2022
bbec271
Update xml/System.Diagnostics/ActivityContext.xml
tarekgh Mar 9, 2022
5aab5b6
suggestions by gewarren
carlossanlop Mar 9, 2022
7aa55da
Remove OperationCanceledException from BlockingCollection`1.Take()
carlossanlop Mar 9, 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
2 changes: 1 addition & 1 deletion xml/Microsoft.Extensions.Caching.Memory/MemoryCache.xml
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Removes all keys and values from the cache.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
15 changes: 12 additions & 3 deletions xml/Microsoft.Extensions.Caching.Memory/MemoryCacheOptions.xml
Original file line number Diff line number Diff line change
Expand Up @@ -253,9 +253,18 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets or sets a value that indicates whether to track linked entries.</summary>
<value>
<see langword="true" /> if linked entries are tracked; otherwise, <see langword="false" />. The default is <see langword="false" /> in .NET 7 and later versions.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

Prior to .NET 7 this feature was always enabled.

]]></format>
</remarks>
</Docs>
</Member>
</Members>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Provides data about the current item of the configuration.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down Expand Up @@ -67,7 +67,7 @@
<ReturnType>Microsoft.Extensions.Configuration.IConfigurationProvider</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" /> that was used to get the value of the current item.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -88,7 +88,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the key of the current item.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -109,7 +109,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the path of the current item.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -130,7 +130,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the value of the current item.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,10 @@
<Parameter Name="processValue" Type="System.Func&lt;Microsoft.Extensions.Configuration.ConfigurationDebugViewContext,System.String&gt;" Index="1" FrameworkAlternate="dotnet-plat-ext-7.0" />
</Parameters>
<Docs>
<param name="root">To be added.</param>
<param name="processValue">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="root">The configuration root.</param>
<param name="processValue">A function for processing the value, for example, to hide secrets, where the <see cref="T:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext"/> represents the context of the current configuration item, and the string is assigned as the value of the configuration section.</param>
<summary>Generates a human-readable view of the configuration showing where each value came from.</summary>
<returns>The debug view.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
7 changes: 4 additions & 3 deletions xml/Microsoft.Extensions.DependencyModel/Dependency.xml
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,10 @@
<Parameter Name="other" Type="Microsoft.Extensions.DependencyModel.Dependency" />
</Parameters>
<Docs>
<param name="other">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="other">An object to compare with this object.</param>
<summary>Indicates whether the current object is equal to another object of the same type.</summary>
<returns>
<see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
1 change: 1 addition & 0 deletions xml/Microsoft.Extensions.Primitives/StringSegment.xml
Original file line number Diff line number Diff line change
Expand Up @@ -436,6 +436,7 @@
</Parameters>
<Docs>
<inheritdoc />
<summary>Indicates whether the current object is equal to another object of the same type.</summary>
</Docs>
</Member>
<Member MemberName="Equals">
Expand Down
9 changes: 5 additions & 4 deletions xml/System.Buffers/SequenceReader`1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -956,10 +956,11 @@ This method copies a fixed amount of data out of the sequence if possible. It do
<Parameter Name="sequence" Type="System.Buffers.ReadOnlySequence&lt;T&gt;" RefType="out" Index="1" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="count">To be added.</param>
<param name="sequence">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="count">The number of values to read.</param>
<param name="sequence">When this method returns, contains the read data, if <paramref name="count" /> items were successfully read.</param>
<summary>Attempts to read exactly <paramref name="count" /> values from the current sequence.</summary>
<returns>
<see langword="true" /> if there are <paramref name="count" /> or more remaining items in the current sequence.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
22 changes: 13 additions & 9 deletions xml/System.Collections.Generic/CollectionExtensions.xml
Original file line number Diff line number Diff line change
Expand Up @@ -63,11 +63,13 @@
<Parameter Name="list" Type="System.Collections.Generic.IList&lt;T&gt;" Index="0" FrameworkAlternate="net-7.0" RefType="this" />
</Parameters>
<Docs>
<typeparam name="T">To be added.</typeparam>
<param name="list">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="T">The type of elements in the collection.</typeparam>
<param name="list">The list to wrap.</param>
<summary>Returns a read-only <see cref="T:System.Collections.ObjectModel.ReadOnlyCollection`1" /> wrapper for the specified list.</summary>
<returns>An object that acts as a read-only wrapper around the current <see cref="T:System.Collections.Generic.IList`1" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="list" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="AsReadOnly&lt;TKey,TValue&gt;">
Expand Down Expand Up @@ -96,12 +98,14 @@
<Parameter Name="dictionary" Type="System.Collections.Generic.IDictionary&lt;TKey,TValue&gt;" Index="0" FrameworkAlternate="net-7.0" RefType="this" />
</Parameters>
<Docs>
<typeparam name="TKey">To be added.</typeparam>
<typeparam name="TValue">To be added.</typeparam>
<param name="dictionary">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<typeparam name="TKey">The type of keys in the dictionary.</typeparam>
<typeparam name="TValue">The type of values in the dictionary.</typeparam>
<param name="dictionary">The dictionary to wrap.</param>
<summary>Returns a read-only <see cref="T:System.Collections.ObjectModel.ReadOnlyDictionary`2" /> wrapper for the current dictionary.</summary>
<returns>An object that acts as a read-only wrapper around the current <see cref="T:System.Collections.Generic.IDictionary`2" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="dictionary" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="GetDefaultAssets">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,16 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Indicates that the specified method parameter expects a constant.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This attribute can be used to inform tooling that a constant should be used as an argument for the annotated parameter.

]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand Down Expand Up @@ -57,7 +65,7 @@
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets the maximum bound of the expected constant, inclusive.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -78,7 +86,7 @@
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets the minimum bound of the expected constant, inclusive.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,16 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Indicates that the specified method requires the ability to generate new code at runtime, for example through <see cref="N:System.Reflection" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This attribute allows tools to understand which methods are unsafe to call when compiling ahead of time.

]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
Expand All @@ -40,8 +48,8 @@
<Parameter Name="message" Type="System.String" />
</Parameters>
<Docs>
<param name="message">To be added.</param>
<summary>To be added.</summary>
<param name="message">A message that contains information about the usage of dynamic code.</param>
<summary>Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute" /> class with the specified message.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -61,7 +69,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets a message that contains information about the usage of dynamic code.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -82,7 +90,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets an optional URL that contains more information about the method, why it requires dynamic code, and what options a consumer has to deal with it.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
22 changes: 11 additions & 11 deletions xml/System.Diagnostics.CodeAnalysis/StringSyntaxAttribute.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Specifies the syntax used in a string.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -40,8 +40,8 @@
<Parameter Name="syntax" Type="System.String" />
</Parameters>
<Docs>
<param name="syntax">To be added.</param>
<summary>To be added.</summary>
<param name="syntax">The syntax identifier.</param>
<summary>Initializes the <see cref="T:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute" /> with the identifier of the syntax used.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -69,9 +69,9 @@
</Parameter>
</Parameters>
<Docs>
<param name="syntax">To be added.</param>
<param name="arguments">To be added.</param>
<summary>To be added.</summary>
<param name="syntax">The syntax identifier.</param>
<param name="arguments">Optional arguments associated with the specific syntax employed.</param>
<summary>Initializes the <see cref="T:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute" /> with the identifier of the syntax used.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -91,7 +91,7 @@
<ReturnType>System.Object[]</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the optional arguments associated with the specific syntax employed.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -112,7 +112,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The syntax identifier for strings containing date and time format specifiers.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -132,7 +132,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The syntax identifier for strings containing JavaScript Object Notation (JSON).</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -152,7 +152,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The syntax identifier for strings containing regular expressions.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -172,7 +172,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the identifier of the syntax used.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
12 changes: 10 additions & 2 deletions xml/System.Diagnostics/Activity.xml
Original file line number Diff line number Diff line change
Expand Up @@ -761,9 +761,17 @@ The best practice for the library authors is not try to set this property. This
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets a value that indicates whether this <see cref="T:System.Diagnostics.Activity" /> object is stopped or not.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

When subscribing to <xref:System.Diagnostics.Activity> stop event using <xref:System.Diagnostics.ActivityListener.ActivityStopped>, the received <xref:System.Diagnostics.Activity> object in the event callback will have <xref:System.Diagnostics.Activity.IsStopped> as `true`.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Kind">
Expand Down
13 changes: 7 additions & 6 deletions xml/System.Diagnostics/ActivityContext.xml
Original file line number Diff line number Diff line change
Expand Up @@ -428,12 +428,13 @@ ActivityContext contains the property `IsRemote`, which is not part of W3C. `IsR
<Parameter Name="context" Type="System.Diagnostics.ActivityContext" RefType="out" Index="3" FrameworkAlternate="net-7.0" />
</Parameters>
<Docs>
<param name="traceParent">To be added.</param>
<param name="traceState">To be added.</param>
<param name="isRemote">To be added.</param>
<param name="context">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="traceParent">The W3C trace parent header.</param>
<param name="traceState">The W3C trace state.</param>
<param name="isRemote">
<see langword="true" /> to propagate the context from the remote parent; otherwise, <see langword="false" />.</param>
<param name="context">When this method returns, contains the <see cref="T:System.Diagnostics.ActivityContext"/> object created from the parsing operation.</param>
<summary>Tries to parse the W3C trace context headers to the <see cref="T:System.Diagnostics.ActivityContext"/> object.</summary>
<returns><see langword="true"/> if the operation succeeds; <see langword="false"/> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
16 changes: 8 additions & 8 deletions xml/System.Drawing/Graphics.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6972,9 +6972,9 @@ The number of points in the array should be a multiple of 3 plus 1 because the f
<Parameter Name="rect" Type="System.Drawing.RectangleF" Index="1" FrameworkAlternate="dotnet-plat-ext-7.0;windowsdesktop-7.0" />
</Parameters>
<Docs>
<param name="pen">To be added.</param>
<param name="rect">To be added.</param>
<summary>To be added.</summary>
<param name="pen">A pen that determines the color, width, and style of the rectangle.</param>
<param name="rect">The rectangle to draw.</param>
<summary>Draws the outline of the specified rectangle.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -11284,11 +11284,11 @@ The number of points in the array should be a multiple of 3 plus 1 because the f
<Parameter Name="sweepAngle" Type="System.Single" Index="3" FrameworkAlternate="dotnet-plat-ext-7.0;windowsdesktop-7.0" />
</Parameters>
<Docs>
<param name="brush">To be added.</param>
<param name="rect">To be added.</param>
<param name="startAngle">To be added.</param>
<param name="sweepAngle">To be added.</param>
<summary>To be added.</summary>
<param name="brush">A brush that determines the characteristics of the fill.</param>
<param name="rect">The bounding rectangle that defines the ellipse from which the pie section comes.</param>
<param name="startAngle">Angle in degrees measured clockwise from the x-axis to the first side of the pie section.</param>
<param name="sweepAngle">Angle in degrees measured clockwise from the <paramref name="startAngle" /> parameter to the second side of the pie section.</param>
<summary>Fills the interior of a pie section defined by an ellipse and two radial lines.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
Loading