Skip to content

Commit 665fe9c

Browse files
Port documentation for .NET 7.0 Preview4 (#8127)
* Microsoft.Extensions.Caching.Memory * Microsoft.Extensions.Configuration * Microsoft.Extensions.DependencyInjection * System.ComponentModel.DataAnnotations * System.Diagnostics.Activity * System.Diagnostics * System.Diagnostics.CodeAnalysis * System.Formats.Tar * System.IO.Hashing * System.Numerics * System.Runtime.CompilerServices * System.Runtime.InteropServices * System.ServiceProcess * System.Text.Json * System.Text.RegularExpressions * System.Threading.Tasks * System.Timers * System (Globalization) * System (Memory) * System (GC) * System (Built-in types and everything else) Co-authored-by: Genevieve Warren <[email protected]> Co-authored-by: carlossanlop <[email protected]>
1 parent 7662b6a commit 665fe9c

File tree

117 files changed

+11475
-9345
lines changed

Some content is hidden

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

117 files changed

+11475
-9345
lines changed

xml/Microsoft.Extensions.Caching.Memory/IMemoryCache.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,8 @@
7979
</ReturnValue>
8080
<Parameters />
8181
<Docs>
82-
<summary>To be added.</summary>
83-
<returns>To be added.</returns>
82+
<summary>Gets a snapshot of the cache statistics if available.</summary>
83+
<returns>An instance of <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheStatistics" /> containing a snapshot of the cache statistics.</returns>
8484
<remarks>To be added.</remarks>
8585
</Docs>
8686
</Member>

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -329,8 +329,8 @@
329329
</ReturnValue>
330330
<Parameters />
331331
<Docs>
332-
<summary>To be added.</summary>
333-
<returns>To be added.</returns>
332+
<summary>Gets a snapshot of the current statistics for the memory cache.</summary>
333+
<returns>Returns <see langword="null" /> if statistics are not being tracked because <see cref="P:Microsoft.Extensions.Caching.Memory.MemoryCacheOptions.TrackStatistics" /> is <see langword="false" />.</returns>
334334
<remarks>To be added.</remarks>
335335
</Docs>
336336
</Member>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ Prior to .NET 7 this feature was always enabled.
284284
<ReturnType>System.Boolean</ReturnType>
285285
</ReturnValue>
286286
<Docs>
287-
<summary>To be added.</summary>
287+
<summary>Gets or sets whether to track memory cache statistics. Disabled by default.</summary>
288288
<value>To be added.</value>
289289
<remarks>To be added.</remarks>
290290
</Docs>

xml/Microsoft.Extensions.Caching.Memory/MemoryCacheStatistics.xml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>To be added.</summary>
17+
<summary>Holds a snapshot of statistics for a memory cache.</summary>
1818
<remarks>To be added.</remarks>
1919
</Docs>
2020
<Members>
@@ -31,7 +31,7 @@
3131
</AssemblyInfo>
3232
<Parameters />
3333
<Docs>
34-
<summary>To be added.</summary>
34+
<summary>Initializes an instance of the <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheStatistics"/> class.</summary>
3535
<remarks>To be added.</remarks>
3636
</Docs>
3737
</Member>
@@ -51,7 +51,7 @@
5151
<ReturnType>System.Int64</ReturnType>
5252
</ReturnValue>
5353
<Docs>
54-
<summary>To be added.</summary>
54+
<summary>Gets the number of <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry" /> instances currently in the memory cache.</summary>
5555
<value>To be added.</value>
5656
<remarks>To be added.</remarks>
5757
</Docs>
@@ -72,8 +72,8 @@
7272
<ReturnType>System.Nullable&lt;System.Int64&gt;</ReturnType>
7373
</ReturnValue>
7474
<Docs>
75-
<summary>To be added.</summary>
76-
<value>To be added.</value>
75+
<summary>Gets an estimated sum of all the <see cref="P:Microsoft.Extensions.Caching.Memory.ICacheEntry.Size" /> values currently in the memory cache.</summary>
76+
<value>Returns <see langword="null" /> if size isn't being tracked. The common MemoryCache implementation tracks size whenever a SizeLimit is set on the cache.</value>
7777
<remarks>To be added.</remarks>
7878
</Docs>
7979
</Member>
@@ -93,7 +93,7 @@
9393
<ReturnType>System.Int64</ReturnType>
9494
</ReturnValue>
9595
<Docs>
96-
<summary>To be added.</summary>
96+
<summary>Gets the total number of cache hits.</summary>
9797
<value>To be added.</value>
9898
<remarks>To be added.</remarks>
9999
</Docs>
@@ -114,7 +114,7 @@
114114
<ReturnType>System.Int64</ReturnType>
115115
</ReturnValue>
116116
<Docs>
117-
<summary>To be added.</summary>
117+
<summary>Gets the total number of cache misses.</summary>
118118
<value>To be added.</value>
119119
<remarks>To be added.</remarks>
120120
</Docs>

xml/Microsoft.Extensions.Configuration/ChainedConfigurationProvider.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@
7979
<ReturnType>Microsoft.Extensions.Configuration.IConfiguration</ReturnType>
8080
</ReturnValue>
8181
<Docs>
82-
<summary>To be added.</summary>
82+
<summary>Gets the chained configuration.</summary>
8383
<value>To be added.</value>
8484
<remarks>To be added.</remarks>
8585
</Docs>

xml/Microsoft.Extensions.DependencyInjection/ServiceCollection.xml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -465,8 +465,16 @@
465465
</ReturnValue>
466466
<Parameters />
467467
<Docs>
468-
<summary>To be added.</summary>
469-
<remarks>To be added.</remarks>
468+
<summary>Makes this collection read-only.</summary>
469+
<remarks>
470+
<format type="text/markdown"><![CDATA[
471+
472+
## Remarks
473+
474+
After the collection is marked as read-only, any further attempt to modify it throws an <xref:System.InvalidOperationException>.
475+
476+
]]></format>
477+
</remarks>
470478
</Docs>
471479
</Member>
472480
<Member MemberName="Remove">

xml/System.ComponentModel.DataAnnotations/RegularExpressionAttribute.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ This override performs the specific regular expression matching of `value` field
232232
<ReturnType>System.TimeSpan</ReturnType>
233233
</ReturnValue>
234234
<Docs>
235-
<summary>To be added.</summary>
235+
<summary>Gets the timeout to use when matching the regular expression pattern</summary>
236236
<value>To be added.</value>
237237
<remarks>To be added.</remarks>
238238
</Docs>

xml/System.Diagnostics.CodeAnalysis/StringSyntaxAttribute.xml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -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 composite formats for string formatting.</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 date format specifiers.</summary>
136136
<remarks>To be added.</remarks>
137137
</Docs>
138138
</Member>
@@ -172,7 +172,7 @@
172172
<ReturnType>System.String</ReturnType>
173173
</ReturnValue>
174174
<Docs>
175-
<summary>To be added.</summary>
175+
<summary>The syntax identifier for strings containing <see cref="T:System.Enum" /> format specifiers.</summary>
176176
<remarks>To be added.</remarks>
177177
</Docs>
178178
</Member>
@@ -192,7 +192,7 @@
192192
<ReturnType>System.String</ReturnType>
193193
</ReturnValue>
194194
<Docs>
195-
<summary>To be added.</summary>
195+
<summary>The syntax identifier for strings containing <see cref="T:System.Guid" /> format specifiers.</summary>
196196
<remarks>To be added.</remarks>
197197
</Docs>
198198
</Member>
@@ -232,7 +232,7 @@
232232
<ReturnType>System.String</ReturnType>
233233
</ReturnValue>
234234
<Docs>
235-
<summary>To be added.</summary>
235+
<summary>The syntax identifier for strings containing numeric format specifiers.</summary>
236236
<remarks>To be added.</remarks>
237237
</Docs>
238238
</Member>
@@ -293,7 +293,7 @@
293293
<ReturnType>System.String</ReturnType>
294294
</ReturnValue>
295295
<Docs>
296-
<summary>To be added.</summary>
296+
<summary>The syntax identifier for strings containing time format specifiers.</summary>
297297
<remarks>To be added.</remarks>
298298
</Docs>
299299
</Member>
@@ -313,7 +313,7 @@
313313
<ReturnType>System.String</ReturnType>
314314
</ReturnValue>
315315
<Docs>
316-
<summary>To be added.</summary>
316+
<summary>The syntax identifier for strings containing <see cref="T:System.TimeSpan" /> format specifiers.</summary>
317317
<remarks>To be added.</remarks>
318318
</Docs>
319319
</Member>
@@ -333,7 +333,7 @@
333333
<ReturnType>System.String</ReturnType>
334334
</ReturnValue>
335335
<Docs>
336-
<summary>To be added.</summary>
336+
<summary>The syntax identifier for strings containing URIs.</summary>
337337
<remarks>To be added.</remarks>
338338
</Docs>
339339
</Member>
@@ -353,7 +353,7 @@
353353
<ReturnType>System.String</ReturnType>
354354
</ReturnValue>
355355
<Docs>
356-
<summary>To be added.</summary>
356+
<summary>The syntax identifier for strings containing XML.</summary>
357357
<remarks>To be added.</remarks>
358358
</Docs>
359359
</Member>

xml/System.Diagnostics/Activity+Enumerator`1.xml

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717
</Base>
1818
<Interfaces />
1919
<Docs>
20-
<typeparam name="T">To be added.</typeparam>
21-
<summary>To be added.</summary>
20+
<typeparam name="T">Type being enumerated.</typeparam>
21+
<summary>Enumerates the data stored on an <see cref="T:System.Diagnostics.Activity"/> object.</summary>
2222
<remarks>To be added.</remarks>
2323
</Docs>
2424
<Members>
@@ -44,7 +44,7 @@
4444
<ReturnType>T</ReturnType>
4545
</ReturnValue>
4646
<Docs>
47-
<summary>To be added.</summary>
47+
<summary>Gets the element at the current position of the enumerator.</summary>
4848
<value>To be added.</value>
4949
<remarks>To be added.</remarks>
5050
</Docs>
@@ -76,8 +76,9 @@
7676
</ReturnValue>
7777
<Parameters />
7878
<Docs>
79-
<summary>To be added.</summary>
80-
<returns>To be added.</returns>
79+
<summary>Returns an enumerator that iterates through the data stored on an Activity object.</summary>
80+
<returns>
81+
<see cref="T:System.Diagnostics.Activity.Enumerator`1" />.</returns>
8182
<remarks>To be added.</remarks>
8283
</Docs>
8384
</Member>
@@ -98,8 +99,9 @@
9899
</ReturnValue>
99100
<Parameters />
100101
<Docs>
101-
<summary>To be added.</summary>
102-
<returns>To be added.</returns>
102+
<summary>Advances the enumerator to the next element of the data.</summary>
103+
<returns>
104+
<see langword="true" /> if the enumerator was successfully advanced to the next element; <see langword="false" /> if the enumerator has passed the end of the collection.</returns>
103105
<remarks>To be added.</remarks>
104106
</Docs>
105107
</Member>

xml/System.Diagnostics/Activity.xml

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,7 @@ This key/value pair is included in the collection returned by the <xref:System.D
381381
<ReturnType>System.EventHandler&lt;System.Diagnostics.ActivityChangedEventArgs&gt;</ReturnType>
382382
</ReturnValue>
383383
<Docs>
384-
<summary>To be added.</summary>
384+
<summary>Occurs when the <see cref="P:System.Diagnostics.Activity.Current" /> value changes.</summary>
385385
<remarks>To be added.</remarks>
386386
</Docs>
387387
</Member>
@@ -548,8 +548,9 @@ If the `DisplayName` property is not set, it will return the same value as `Oper
548548
</ReturnValue>
549549
<Parameters />
550550
<Docs>
551-
<summary>To be added.</summary>
552-
<returns>To be added.</returns>
551+
<summary>Enumerates the <see cref="T:System.Diagnostics.ActivityEvent" /> objects attached to this Activity object.</summary>
552+
<returns>
553+
<see cref="T:System.Diagnostics.Activity.Enumerator`1" />.</returns>
553554
<remarks>To be added.</remarks>
554555
</Docs>
555556
</Member>
@@ -570,8 +571,9 @@ If the `DisplayName` property is not set, it will return the same value as `Oper
570571
</ReturnValue>
571572
<Parameters />
572573
<Docs>
573-
<summary>To be added.</summary>
574-
<returns>To be added.</returns>
574+
<summary>Enumerates the <see cref="T:System.Diagnostics.ActivityLink" /> objects attached to this Activity object.</summary>
575+
<returns>
576+
<see cref="T:System.Diagnostics.Activity.Enumerator`1" />.</returns>
575577
<remarks>To be added.</remarks>
576578
</Docs>
577579
</Member>
@@ -592,8 +594,9 @@ If the `DisplayName` property is not set, it will return the same value as `Oper
592594
</ReturnValue>
593595
<Parameters />
594596
<Docs>
595-
<summary>To be added.</summary>
596-
<returns>To be added.</returns>
597+
<summary>Enumerates the tags attached to this Activity object.</summary>
598+
<returns>
599+
<see cref="T:System.Diagnostics.Activity.Enumerator`1" />.</returns>
597600
<remarks>To be added.</remarks>
598601
</Docs>
599602
</Member>

xml/System.Diagnostics/ActivityChangedEventArgs.xml

Lines changed: 3 additions & 3 deletions
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 for the <see cref="E:System.Diagnostics.Activity.CurrentChanged" /> event.</summary>
2424
<remarks>To be added.</remarks>
2525
</Docs>
2626
<Members>
@@ -40,7 +40,7 @@
4040
<ReturnType>System.Diagnostics.Activity</ReturnType>
4141
</ReturnValue>
4242
<Docs>
43-
<summary>To be added.</summary>
43+
<summary>Gets the <see cref="T:System.Diagnostics.Activity" /> object after the event.</summary>
4444
<value>To be added.</value>
4545
<remarks>To be added.</remarks>
4646
</Docs>
@@ -61,7 +61,7 @@
6161
<ReturnType>System.Diagnostics.Activity</ReturnType>
6262
</ReturnValue>
6363
<Docs>
64-
<summary>To be added.</summary>
64+
<summary>Gets the <see cref="T:System.Diagnostics.Activity" /> object before the event.</summary>
6565
<value>To be added.</value>
6666
<remarks>To be added.</remarks>
6767
</Docs>

0 commit comments

Comments
 (0)