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 Preview4 #8127

Merged
merged 32 commits into from
Jun 8, 2022
Merged

Port documentation for .NET 7.0 Preview4 #8127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
56542b7
Microsoft.Extensions.Caching.Memory
carlossanlop Jun 2, 2022
3a8ded4
Microsoft.Extensions.Configuration
carlossanlop Jun 2, 2022
c882f16
Microsoft.Extensions.DependencyInjection
carlossanlop Jun 2, 2022
a2adb34
System.ComponentModel.DataAnnotations
carlossanlop Jun 2, 2022
c41d949
System.Diagnostics.Activity
carlossanlop Jun 2, 2022
3ccfcbc
System.Diagnostics
carlossanlop Jun 2, 2022
70ccbca
System.Diagnostics.CodeAnalysis
carlossanlop Jun 2, 2022
b727586
System.Formats.Tar
carlossanlop Jun 2, 2022
e4e14dc
System.IO.Hashing
carlossanlop Jun 2, 2022
7c194d2
System.Numerics
carlossanlop Jun 2, 2022
786f501
System.Runtime.CompilerServices
carlossanlop Jun 2, 2022
3502b92
System.Runtime.InteropServices
carlossanlop Jun 2, 2022
657ade7
System.ServiceProcess
carlossanlop Jun 2, 2022
e959333
System.Text.Json
carlossanlop Jun 2, 2022
d78dc24
System.Text.RegularExpressions
carlossanlop Jun 2, 2022
0ba4553
System.Threading.Tasks
carlossanlop Jun 2, 2022
6ea85e6
System.Timers
carlossanlop Jun 2, 2022
0b2ad89
System (Globalization)
carlossanlop Jun 2, 2022
df8aab2
System (Memory)
carlossanlop Jun 2, 2022
8b31c61
System (GC)
carlossanlop Jun 2, 2022
28c2dc4
System (Built-in types and everything else)
carlossanlop Jun 2, 2022
d8bb886
Apply batch of suggestions from gewarren
carlossanlop Jun 3, 2022
6eab650
Apply another batch of suggestions from gewarren
carlossanlop Jun 3, 2022
388c0f2
Yet another batch of suggestions
carlossanlop Jun 3, 2022
69ee501
Fix malformed xrefs in markdown
carlossanlop Jun 4, 2022
8e657bf
Apply suggestions from code review
carlossanlop Jun 4, 2022
6948225
Apply suggestions from code review
carlossanlop Jun 4, 2022
1d72de2
Apply suggestions from code review
carlossanlop Jun 4, 2022
7f4dfcf
Remove wrong inheritdoc remarks from TimeOnly, UIntPtr, IntPtr and Ha…
carlossanlop Jun 7, 2022
1a0d01b
Apply suggestions from code review
carlossanlop Jun 7, 2022
d35ff29
Fix warnings
carlossanlop Jun 8, 2022
b140e3d
Missed #ctor in PaxTarEntry
carlossanlop Jun 8, 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
4 changes: 2 additions & 2 deletions xml/Microsoft.Extensions.Caching.Memory/IMemoryCache.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Gets a snapshot of the cache statistics if available.</summary>
<returns>An instance of <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheStatistics" /> containing a snapshot of the cache statistics.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
4 changes: 2 additions & 2 deletions xml/Microsoft.Extensions.Caching.Memory/MemoryCache.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -329,8 +329,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Gets a snapshot of the current statistics for the memory cache.</summary>
<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>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
2 changes: 1 addition & 1 deletion xml/Microsoft.Extensions.Caching.Memory/MemoryCacheOptions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ Prior to .NET 7 this feature was always enabled.
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets whether to track memory cache statistics. Disabled by default.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
14 changes: 7 additions & 7 deletions xml/Microsoft.Extensions.Caching.Memory/MemoryCacheStatistics.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<summary>Holds a snapshot of statistics for a memory cache.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -31,7 +31,7 @@
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Initializes an instance of the <see cref="T:Microsoft.Extensions.Caching.Memory.MemoryCacheStatistics"/> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -51,7 +51,7 @@
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the number of <see cref="T:Microsoft.Extensions.Caching.Memory.ICacheEntry" /> instances currently in the memory cache.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -72,8 +72,8 @@
<ReturnType>System.Nullable&lt;System.Int64&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets an estimated sum of all the <see cref="P:Microsoft.Extensions.Caching.Memory.ICacheEntry.Size" /> values currently in the memory cache.</summary>
<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>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -93,7 +93,7 @@
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the total number of cache hits.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -114,7 +114,7 @@
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the total number of cache misses.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
2 changes: 1 addition & 1 deletion xml/Microsoft.Extensions.Configuration/ChainedConfigurationProvider.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
<ReturnType>Microsoft.Extensions.Configuration.IConfiguration</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the chained configuration.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
12 changes: 10 additions & 2 deletions xml/Microsoft.Extensions.DependencyInjection/ServiceCollection.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -465,8 +465,16 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Makes this collection read-only.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

After the collection is marked as read-only, any further attempt to modify it throws an <xref:System.InvalidOperationException>.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Remove">
Expand Down
2 changes: 1 addition & 1 deletion xml/System.ComponentModel.DataAnnotations/RegularExpressionAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ This override performs the specific regular expression matching of `value` field
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the timeout to use when matching the regular expression pattern</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
18 changes: 9 additions & 9 deletions xml/System.Diagnostics.CodeAnalysis/StringSyntaxAttribute.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The syntax identifier for strings containing composite formats for string formatting.</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 date format specifiers.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -172,7 +172,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The syntax identifier for strings containing <see cref="T:System.Enum" /> format specifiers.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -192,7 +192,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The syntax identifier for strings containing <see cref="T:System.Guid" /> format specifiers.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -232,7 +232,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The syntax identifier for strings containing numeric format specifiers.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -293,7 +293,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The syntax identifier for strings containing time format specifiers.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -313,7 +313,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The syntax identifier for strings containing <see cref="T:System.TimeSpan" /> format specifiers.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -333,7 +333,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The syntax identifier for strings containing URIs.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -353,7 +353,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The syntax identifier for strings containing XML.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
16 changes: 9 additions & 7 deletions xml/System.Diagnostics/Activity+Enumerator`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
</Base>
<Interfaces />
<Docs>
<typeparam name="T">To be added.</typeparam>
<summary>To be added.</summary>
<typeparam name="T">Type being enumerated.</typeparam>
<summary>Enumerates the data stored on an <see cref="T:System.Diagnostics.Activity"/> object.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -44,7 +44,7 @@
<ReturnType>T</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the element at the current position of the enumerator.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -76,8 +76,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Returns an enumerator that iterates through the data stored on an Activity object.</summary>
<returns>
<see cref="T:System.Diagnostics.Activity.Enumerator`1" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -98,8 +99,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Advances the enumerator to the next element of the data.</summary>
<returns>
<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>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
17 changes: 10 additions & 7 deletions xml/System.Diagnostics/Activity.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -381,7 +381,7 @@ This key/value pair is included in the collection returned by the <xref:System.D
<ReturnType>System.EventHandler&lt;System.Diagnostics.ActivityChangedEventArgs&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Occurs when the <see cref="P:System.Diagnostics.Activity.Current" /> value changes.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -548,8 +548,9 @@ If the `DisplayName` property is not set, it will return the same value as `Oper
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Enumerates the <see cref="T:System.Diagnostics.ActivityEvent" /> objects attached to this Activity object.</summary>
<returns>
<see cref="T:System.Diagnostics.Activity.Enumerator`1" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -570,8 +571,9 @@ If the `DisplayName` property is not set, it will return the same value as `Oper
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Enumerates the <see cref="T:System.Diagnostics.ActivityLink" /> objects attached to this Activity object.</summary>
<returns>
<see cref="T:System.Diagnostics.Activity.Enumerator`1" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -592,8 +594,9 @@ If the `DisplayName` property is not set, it will return the same value as `Oper
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Enumerates the tags attached to this Activity object.</summary>
<returns>
<see cref="T:System.Diagnostics.Activity.Enumerator`1" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
6 changes: 3 additions & 3 deletions xml/System.Diagnostics/ActivityChangedEventArgs.xml
View file
Open in desktop
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 for the <see cref="E:System.Diagnostics.Activity.CurrentChanged" /> event.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -40,7 +40,7 @@
<ReturnType>System.Diagnostics.Activity</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the <see cref="T:System.Diagnostics.Activity" /> object after the event.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -61,7 +61,7 @@
<ReturnType>System.Diagnostics.Activity</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the <see cref="T:System.Diagnostics.Activity" /> object before the event.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
Loading