Skip to content

Commit dd42f68

Browse files
carlossanloptarekghgewarren
authored
Port .NET 7.0 Preview1 documentation (#7807)
* Microsoft.Extensions.Caching.Memory * Microsoft.Extensions.Configuration * Microsoft.Extensions.DependencyModel * Microsoft.Extensions.Primitives * System.Buffers * System.Collections.Concurrent * System.Collections.Generic * System.Diagnostics * System.Diagnostics.CodeAnalysis * System.Drawing * System.IO * System.Net.Http.Json * System.Net.Sockets * System.Numerics * System.Reflection.Metadata.Ecma335 * System.Reflection.PortableExecutable * System.Runtime.CompilerServices * System.Runtime.InteropServices * System.Runtime.Intrinsics * System.Runtime.Intrinsics.Arm * System.Runtime.Intrinsics.X86 * System.Security.Cryptography * System.Security.Cryptography.Pkcs * System.Security.Cryptography.X509Certificates * System.Text.Json * System.Text.Json.Nodes * System.Text.RegularExpressions * System.Text.Unicode * System.Threading * System.Threading.Tasks * System.Web.DynamicData * System.Windows.Forms * System * Update xml/System.Diagnostics/Activity.xml Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * Update xml/System.Diagnostics/ActivityContext.xml Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * Update xml/System.Diagnostics/ActivityContext.xml Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * suggestions by gewarren Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com> * Remove OperationCanceledException from BlockingCollection`1.Take() Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> Co-authored-by: Tarek Mahmoud Sayed <tarekms@microsoft.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
1 parent 45bf39b commit dd42f68

File tree

88 files changed

+3782
-2683
lines changed

Some content is hidden

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

88 files changed

+3782
-2683
lines changed

‎xml/Microsoft.Extensions.Caching.Memory/MemoryCache.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@
109109
</ReturnValue>
110110
<Parameters />
111111
<Docs>
112-
<summary>To be added.</summary>
112+
<summary>Removes all keys and values from the cache.</summary>
113113
<remarks>To be added.</remarks>
114114
</Docs>
115115
</Member>

‎xml/Microsoft.Extensions.Caching.Memory/MemoryCacheOptions.xml

+12-3
Original file line numberDiff line numberDiff line change
@@ -253,9 +253,18 @@
253253
<ReturnType>System.Boolean</ReturnType>
254254
</ReturnValue>
255255
<Docs>
256-
<summary>To be added.</summary>
257-
<value>To be added.</value>
258-
<remarks>To be added.</remarks>
256+
<summary>Gets or sets a value that indicates whether to track linked entries.</summary>
257+
<value>
258+
<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>
259+
<remarks>
260+
<format type="text/markdown"><![CDATA[
261+
262+
## Remarks
263+
264+
Prior to .NET 7 this feature was always enabled.
265+
266+
]]></format>
267+
</remarks>
259268
</Docs>
260269
</Member>
261270
</Members>

‎xml/Microsoft.Extensions.Configuration/ConfigurationDebugViewContext.xml

+5-5
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
</Attribute>
2121
</Attributes>
2222
<Docs>
23-
<summary>To be added.</summary>
23+
<summary>Provides data about the current item of the configuration.</summary>
2424
<remarks>To be added.</remarks>
2525
</Docs>
2626
<Members>
@@ -67,7 +67,7 @@
6767
<ReturnType>Microsoft.Extensions.Configuration.IConfigurationProvider</ReturnType>
6868
</ReturnValue>
6969
<Docs>
70-
<summary>To be added.</summary>
70+
<summary>Gets the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" /> that was used to get the value of the current item.</summary>
7171
<value>To be added.</value>
7272
<remarks>To be added.</remarks>
7373
</Docs>
@@ -88,7 +88,7 @@
8888
<ReturnType>System.String</ReturnType>
8989
</ReturnValue>
9090
<Docs>
91-
<summary>To be added.</summary>
91+
<summary>Gets the key of the current item.</summary>
9292
<value>To be added.</value>
9393
<remarks>To be added.</remarks>
9494
</Docs>
@@ -109,7 +109,7 @@
109109
<ReturnType>System.String</ReturnType>
110110
</ReturnValue>
111111
<Docs>
112-
<summary>To be added.</summary>
112+
<summary>Gets the path of the current item.</summary>
113113
<value>To be added.</value>
114114
<remarks>To be added.</remarks>
115115
</Docs>
@@ -130,7 +130,7 @@
130130
<ReturnType>System.String</ReturnType>
131131
</ReturnValue>
132132
<Docs>
133-
<summary>To be added.</summary>
133+
<summary>Gets the value of the current item.</summary>
134134
<value>To be added.</value>
135135
<remarks>To be added.</remarks>
136136
</Docs>

‎xml/Microsoft.Extensions.Configuration/ConfigurationRootExtensions.xml

+4-4
Original file line numberDiff line numberDiff line change
@@ -71,10 +71,10 @@
7171
<Parameter Name="processValue" Type="System.Func&lt;Microsoft.Extensions.Configuration.ConfigurationDebugViewContext,System.String&gt;" Index="1" FrameworkAlternate="dotnet-plat-ext-7.0" />
7272
</Parameters>
7373
<Docs>
74-
<param name="root">To be added.</param>
75-
<param name="processValue">To be added.</param>
76-
<summary>To be added.</summary>
77-
<returns>To be added.</returns>
74+
<param name="root">The configuration root.</param>
75+
<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>
76+
<summary>Generates a human-readable view of the configuration showing where each value came from.</summary>
77+
<returns>The debug view.</returns>
7878
<remarks>To be added.</remarks>
7979
</Docs>
8080
</Member>

‎xml/Microsoft.Extensions.DependencyModel/Dependency.xml

+4-3
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,10 @@
8585
<Parameter Name="other" Type="Microsoft.Extensions.DependencyModel.Dependency" />
8686
</Parameters>
8787
<Docs>
88-
<param name="other">To be added.</param>
89-
<summary>To be added.</summary>
90-
<returns>To be added.</returns>
88+
<param name="other">An object to compare with this object.</param>
89+
<summary>Indicates whether the current object is equal to another object of the same type.</summary>
90+
<returns>
91+
<see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
9192
<remarks>To be added.</remarks>
9293
</Docs>
9394
</Member>

‎xml/Microsoft.Extensions.Primitives/StringSegment.xml

+1
Original file line numberDiff line numberDiff line change
@@ -436,6 +436,7 @@
436436
</Parameters>
437437
<Docs>
438438
<inheritdoc />
439+
<summary>Indicates whether the current object is equal to another object of the same type.</summary>
439440
</Docs>
440441
</Member>
441442
<Member MemberName="Equals">

‎xml/System.Buffers/SequenceReader`1.xml

+5-4
Original file line numberDiff line numberDiff line change
@@ -956,10 +956,11 @@ This method copies a fixed amount of data out of the sequence if possible. It do
956956
<Parameter Name="sequence" Type="System.Buffers.ReadOnlySequence&lt;T&gt;" RefType="out" Index="1" FrameworkAlternate="net-7.0" />
957957
</Parameters>
958958
<Docs>
959-
<param name="count">To be added.</param>
960-
<param name="sequence">To be added.</param>
961-
<summary>To be added.</summary>
962-
<returns>To be added.</returns>
959+
<param name="count">The number of values to read.</param>
960+
<param name="sequence">When this method returns, contains the read data, if <paramref name="count" /> items were successfully read.</param>
961+
<summary>Attempts to read exactly <paramref name="count" /> values from the current sequence.</summary>
962+
<returns>
963+
<see langword="true" /> if there are <paramref name="count" /> or more remaining items in the current sequence.</returns>
963964
<remarks>To be added.</remarks>
964965
</Docs>
965966
</Member>

‎xml/System.Collections.Generic/CollectionExtensions.xml

+13-9
Original file line numberDiff line numberDiff line change
@@ -63,11 +63,13 @@
6363
<Parameter Name="list" Type="System.Collections.Generic.IList&lt;T&gt;" Index="0" FrameworkAlternate="net-7.0" RefType="this" />
6464
</Parameters>
6565
<Docs>
66-
<typeparam name="T">To be added.</typeparam>
67-
<param name="list">To be added.</param>
68-
<summary>To be added.</summary>
69-
<returns>To be added.</returns>
66+
<typeparam name="T">The type of elements in the collection.</typeparam>
67+
<param name="list">The list to wrap.</param>
68+
<summary>Returns a read-only <see cref="T:System.Collections.ObjectModel.ReadOnlyCollection`1" /> wrapper for the specified list.</summary>
69+
<returns>An object that acts as a read-only wrapper around the current <see cref="T:System.Collections.Generic.IList`1" />.</returns>
7070
<remarks>To be added.</remarks>
71+
<exception cref="T:System.ArgumentNullException">
72+
<paramref name="list" /> is <see langword="null" />.</exception>
7173
</Docs>
7274
</Member>
7375
<Member MemberName="AsReadOnly&lt;TKey,TValue&gt;">
@@ -96,12 +98,14 @@
9698
<Parameter Name="dictionary" Type="System.Collections.Generic.IDictionary&lt;TKey,TValue&gt;" Index="0" FrameworkAlternate="net-7.0" RefType="this" />
9799
</Parameters>
98100
<Docs>
99-
<typeparam name="TKey">To be added.</typeparam>
100-
<typeparam name="TValue">To be added.</typeparam>
101-
<param name="dictionary">To be added.</param>
102-
<summary>To be added.</summary>
103-
<returns>To be added.</returns>
101+
<typeparam name="TKey">The type of keys in the dictionary.</typeparam>
102+
<typeparam name="TValue">The type of values in the dictionary.</typeparam>
103+
<param name="dictionary">The dictionary to wrap.</param>
104+
<summary>Returns a read-only <see cref="T:System.Collections.ObjectModel.ReadOnlyDictionary`2" /> wrapper for the current dictionary.</summary>
105+
<returns>An object that acts as a read-only wrapper around the current <see cref="T:System.Collections.Generic.IDictionary`2" />.</returns>
104106
<remarks>To be added.</remarks>
107+
<exception cref="T:System.ArgumentNullException">
108+
<paramref name="dictionary" /> is <see langword="null" />.</exception>
105109
</Docs>
106110
</Member>
107111
<Member MemberName="GetDefaultAssets">

‎xml/System.Diagnostics.CodeAnalysis/ConstantExpectedAttribute.xml

+12-4
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,16 @@
2020
</Attribute>
2121
</Attributes>
2222
<Docs>
23-
<summary>To be added.</summary>
24-
<remarks>To be added.</remarks>
23+
<summary>Indicates that the specified method parameter expects a constant.</summary>
24+
<remarks>
25+
<format type="text/markdown"><![CDATA[
26+
27+
## Remarks
28+
29+
This attribute can be used to inform tooling that a constant should be used as an argument for the annotated parameter.
30+
31+
]]></format>
32+
</remarks>
2533
</Docs>
2634
<Members>
2735
<Member MemberName=".ctor">
@@ -57,7 +65,7 @@
5765
<ReturnType>System.Object</ReturnType>
5866
</ReturnValue>
5967
<Docs>
60-
<summary>To be added.</summary>
68+
<summary>Gets or sets the maximum bound of the expected constant, inclusive.</summary>
6169
<value>To be added.</value>
6270
<remarks>To be added.</remarks>
6371
</Docs>
@@ -78,7 +86,7 @@
7886
<ReturnType>System.Object</ReturnType>
7987
</ReturnValue>
8088
<Docs>
81-
<summary>To be added.</summary>
89+
<summary>Gets or sets the minimum bound of the expected constant, inclusive.</summary>
8290
<value>To be added.</value>
8391
<remarks>To be added.</remarks>
8492
</Docs>

‎xml/System.Diagnostics.CodeAnalysis/RequiresDynamicCodeAttribute.xml

+14-6
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,16 @@
2020
</Attribute>
2121
</Attributes>
2222
<Docs>
23-
<summary>To be added.</summary>
24-
<remarks>To be added.</remarks>
23+
<summary>Indicates that the specified method requires the ability to generate new code at runtime, for example through <see cref="N:System.Reflection" />.</summary>
24+
<remarks>
25+
<format type="text/markdown"><![CDATA[
26+
27+
## Remarks
28+
29+
This attribute allows tools to understand which methods are unsafe to call when compiling ahead of time.
30+
31+
]]></format>
32+
</remarks>
2533
</Docs>
2634
<Members>
2735
<Member MemberName=".ctor">
@@ -40,8 +48,8 @@
4048
<Parameter Name="message" Type="System.String" />
4149
</Parameters>
4250
<Docs>
43-
<param name="message">To be added.</param>
44-
<summary>To be added.</summary>
51+
<param name="message">A message that contains information about the usage of dynamic code.</param>
52+
<summary>Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute" /> class with the specified message.</summary>
4553
<remarks>To be added.</remarks>
4654
</Docs>
4755
</Member>
@@ -61,7 +69,7 @@
6169
<ReturnType>System.String</ReturnType>
6270
</ReturnValue>
6371
<Docs>
64-
<summary>To be added.</summary>
72+
<summary>Gets a message that contains information about the usage of dynamic code.</summary>
6573
<value>To be added.</value>
6674
<remarks>To be added.</remarks>
6775
</Docs>
@@ -82,7 +90,7 @@
8290
<ReturnType>System.String</ReturnType>
8391
</ReturnValue>
8492
<Docs>
85-
<summary>To be added.</summary>
93+
<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>
8694
<value>To be added.</value>
8795
<remarks>To be added.</remarks>
8896
</Docs>

‎xml/System.Diagnostics.CodeAnalysis/StringSyntaxAttribute.xml

+11-11
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
</Attribute>
2121
</Attributes>
2222
<Docs>
23-
<summary>To be added.</summary>
23+
<summary>Specifies the syntax used in a string.</summary>
2424
<remarks>To be added.</remarks>
2525
</Docs>
2626
<Members>
@@ -40,8 +40,8 @@
4040
<Parameter Name="syntax" Type="System.String" />
4141
</Parameters>
4242
<Docs>
43-
<param name="syntax">To be added.</param>
44-
<summary>To be added.</summary>
43+
<param name="syntax">The syntax identifier.</param>
44+
<summary>Initializes the <see cref="T:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute" /> with the identifier of the syntax used.</summary>
4545
<remarks>To be added.</remarks>
4646
</Docs>
4747
</Member>
@@ -69,9 +69,9 @@
6969
</Parameter>
7070
</Parameters>
7171
<Docs>
72-
<param name="syntax">To be added.</param>
73-
<param name="arguments">To be added.</param>
74-
<summary>To be added.</summary>
72+
<param name="syntax">The syntax identifier.</param>
73+
<param name="arguments">Optional arguments associated with the specific syntax employed.</param>
74+
<summary>Initializes the <see cref="T:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute" /> with the identifier of the syntax used.</summary>
7575
<remarks>To be added.</remarks>
7676
</Docs>
7777
</Member>
@@ -91,7 +91,7 @@
9191
<ReturnType>System.Object[]</ReturnType>
9292
</ReturnValue>
9393
<Docs>
94-
<summary>To be added.</summary>
94+
<summary>Gets the optional arguments associated with the specific syntax employed.</summary>
9595
<value>To be added.</value>
9696
<remarks>To be added.</remarks>
9797
</Docs>
@@ -112,7 +112,7 @@
112112
<ReturnType>System.String</ReturnType>
113113
</ReturnValue>
114114
<Docs>
115-
<summary>To be added.</summary>
115+
<summary>The syntax identifier for strings containing date and time format specifiers.</summary>
116116
<remarks>To be added.</remarks>
117117
</Docs>
118118
</Member>
@@ -132,7 +132,7 @@
132132
<ReturnType>System.String</ReturnType>
133133
</ReturnValue>
134134
<Docs>
135-
<summary>To be added.</summary>
135+
<summary>The syntax identifier for strings containing JavaScript Object Notation (JSON).</summary>
136136
<remarks>To be added.</remarks>
137137
</Docs>
138138
</Member>
@@ -152,7 +152,7 @@
152152
<ReturnType>System.String</ReturnType>
153153
</ReturnValue>
154154
<Docs>
155-
<summary>To be added.</summary>
155+
<summary>The syntax identifier for strings containing regular expressions.</summary>
156156
<remarks>To be added.</remarks>
157157
</Docs>
158158
</Member>
@@ -172,7 +172,7 @@
172172
<ReturnType>System.String</ReturnType>
173173
</ReturnValue>
174174
<Docs>
175-
<summary>To be added.</summary>
175+
<summary>Gets the identifier of the syntax used.</summary>
176176
<value>To be added.</value>
177177
<remarks>To be added.</remarks>
178178
</Docs>

‎xml/System.Diagnostics/Activity.xml

+10-2
Original file line numberDiff line numberDiff line change
@@ -761,9 +761,17 @@ The best practice for the library authors is not try to set this property. This
761761
<ReturnType>System.Boolean</ReturnType>
762762
</ReturnValue>
763763
<Docs>
764-
<summary>To be added.</summary>
764+
<summary>Gets a value that indicates whether this <see cref="T:System.Diagnostics.Activity" /> object is stopped or not.</summary>
765765
<value>To be added.</value>
766-
<remarks>To be added.</remarks>
766+
<remarks>
767+
<format type="text/markdown"><![CDATA[
768+
769+
## Remarks
770+
771+
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`.
772+
773+
]]></format>
774+
</remarks>
767775
</Docs>
768776
</Member>
769777
<Member MemberName="Kind">

‎xml/System.Diagnostics/ActivityContext.xml

+7-6
Original file line numberDiff line numberDiff line change
@@ -428,12 +428,13 @@ ActivityContext contains the property `IsRemote`, which is not part of W3C. `IsR
428428
<Parameter Name="context" Type="System.Diagnostics.ActivityContext" RefType="out" Index="3" FrameworkAlternate="net-7.0" />
429429
</Parameters>
430430
<Docs>
431-
<param name="traceParent">To be added.</param>
432-
<param name="traceState">To be added.</param>
433-
<param name="isRemote">To be added.</param>
434-
<param name="context">To be added.</param>
435-
<summary>To be added.</summary>
436-
<returns>To be added.</returns>
431+
<param name="traceParent">The W3C trace parent header.</param>
432+
<param name="traceState">The W3C trace state.</param>
433+
<param name="isRemote">
434+
<see langword="true" /> to propagate the context from the remote parent; otherwise, <see langword="false" />.</param>
435+
<param name="context">When this method returns, contains the <see cref="T:System.Diagnostics.ActivityContext"/> object created from the parsing operation.</param>
436+
<summary>Tries to parse the W3C trace context headers to the <see cref="T:System.Diagnostics.ActivityContext"/> object.</summary>
437+
<returns><see langword="true"/> if the operation succeeds; <see langword="false"/> otherwise.</returns>
437438
<remarks>To be added.</remarks>
438439
</Docs>
439440
</Member>

‎xml/System.Drawing/Graphics.xml

+8-8
Original file line numberDiff line numberDiff line change
@@ -6972,9 +6972,9 @@ The number of points in the array should be a multiple of 3 plus 1 because the f
69726972
<Parameter Name="rect" Type="System.Drawing.RectangleF" Index="1" FrameworkAlternate="dotnet-plat-ext-7.0;windowsdesktop-7.0" />
69736973
</Parameters>
69746974
<Docs>
6975-
<param name="pen">To be added.</param>
6976-
<param name="rect">To be added.</param>
6977-
<summary>To be added.</summary>
6975+
<param name="pen">A pen that determines the color, width, and style of the rectangle.</param>
6976+
<param name="rect">The rectangle to draw.</param>
6977+
<summary>Draws the outline of the specified rectangle.</summary>
69786978
<remarks>To be added.</remarks>
69796979
</Docs>
69806980
</Member>
@@ -11284,11 +11284,11 @@ The number of points in the array should be a multiple of 3 plus 1 because the f
1128411284
<Parameter Name="sweepAngle" Type="System.Single" Index="3" FrameworkAlternate="dotnet-plat-ext-7.0;windowsdesktop-7.0" />
1128511285
</Parameters>
1128611286
<Docs>
11287-
<param name="brush">To be added.</param>
11288-
<param name="rect">To be added.</param>
11289-
<param name="startAngle">To be added.</param>
11290-
<param name="sweepAngle">To be added.</param>
11291-
<summary>To be added.</summary>
11287+
<param name="brush">A brush that determines the characteristics of the fill.</param>
11288+
<param name="rect">The bounding rectangle that defines the ellipse from which the pie section comes.</param>
11289+
<param name="startAngle">Angle in degrees measured clockwise from the x-axis to the first side of the pie section.</param>
11290+
<param name="sweepAngle">Angle in degrees measured clockwise from the <paramref name="startAngle" /> parameter to the second side of the pie section.</param>
11291+
<summary>Fills the interior of a pie section defined by an ellipse and two radial lines.</summary>
1129211292
<remarks>To be added.</remarks>
1129311293
</Docs>
1129411294
</Member>

0 commit comments

Comments
 (0)