Skip to content

Port documentation for .NET 7.0 Preview6 #8242

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

Merged
carlossanlop merged 26 commits into from
Jul 21, 2022
Merged

Port documentation for .NET 7.0 Preview6 #8242

Show file tree
Hide file tree
Changes from 22 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
bf085ea
Microsoft.Extensions.Hosting
carlossanlop Jul 20, 2022
b47c1f0
Microsoft.Extensions.Logging.Console
carlossanlop Jul 20, 2022
b0af321
System.ComponentModel
carlossanlop Jul 20, 2022
4d2bfb4
System.Data.Common
carlossanlop Jul 20, 2022
33035c3
System.Formats.Tar
carlossanlop Jul 20, 2022
6b71e74
System.IO
carlossanlop Jul 20, 2022
139400c
System.IO.Compression
carlossanlop Jul 20, 2022
aef1cb4
System.Net.Security
carlossanlop Jul 20, 2022
807b21d
System.Numerics (and "System's Numerics")
carlossanlop Jul 20, 2022
ed48d6d
System.GC
carlossanlop Jul 20, 2022
4e30bff
System.Runtime
carlossanlop Jul 20, 2022
befa28d
System.Runtime.CompilerServices
carlossanlop Jul 20, 2022
112b9fe
System.Runtime.InteropServices
carlossanlop Jul 20, 2022
07e3a06
System.Security.Cryptography
carlossanlop Jul 20, 2022
623b264
System.Text.Json
carlossanlop Jul 20, 2022
e7f8151
Apply suggestions from code review
carlossanlop Jul 20, 2022
e896eb3
Add summary and remarks
gewarren Jul 20, 2022
30edd15
(Date|Time)OnlyConverter onstructor summaries provided by tarekgh.
carlossanlop Jul 21, 2022
d7954d4
Merge branch 'PortPrev6' of github.com:carlossanlop/dotnet-api-docs i…
carlossanlop Jul 21, 2022
d671207
suggestions by tarekgh
carlossanlop Jul 21, 2022
2c33066
Tar and IO suggestions by gewarren
carlossanlop Jul 21, 2022
4395bd5
Networking suggestions by gewarren
carlossanlop Jul 21, 2022
d8ab648
json suggestions by gewarren
carlossanlop Jul 21, 2022
d717c7c
component model suggestions by tarekgh
carlossanlop Jul 21, 2022
03de271
more json suggestions from gewarren
carlossanlop Jul 21, 2022
43ec01e
Apply suggestions from code review
carlossanlop Jul 21, 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
38 changes: 29 additions & 9 deletions xml/Microsoft.Extensions.Hosting/HostAbortedException.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>The exception that is thrown upon <see cref="T:Microsoft.Extensions.Hosting.IHost" /> abortion.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -37,7 +37,7 @@
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.Hosting.HostAbortedException" /> class with a system-supplied error message.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -57,9 +57,19 @@
<Parameter Name="message" Type="System.String" />
</Parameters>
<Docs>
<param name="message">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="message">The error message that explains the reason for the exception.</param>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.Hosting.HostAbortedException" /> class with a specified error message.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

The content of `message` is intended to be understood by humans.
The caller of this constructor is required to ensure that this string has been localized for the
current system culture.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
Expand All @@ -79,10 +89,20 @@
<Parameter Name="innerException" Type="System.Exception" />
</Parameters>
<Docs>
<param name="message">To be added.</param>
<param name="innerException">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.Hosting.HostAbortedException" /> class with a specified error message and a reference to the inner exception that is the cause of this exception.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

The content of `message` is intended to be understood by humans.
The caller of this constructor is required to ensure that this string has been localized for the
current system culture.

]]></format>
</remarks>
</Docs>
</Member>
</Members>
Expand Down
2 changes: 1 addition & 1 deletion xml/Microsoft.Extensions.Hosting/SystemdHostBuilderExtensions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
<summary>Sets the host lifetime to <see cref="T:Microsoft.Extensions.Hosting.Systemd.SystemdLifetime" />,
provides notification messages for application started and stopping,
and configures console logging to the systemd format.</summary>
<returns />
<returns>The <paramref name="hostBuilder" /> instance for chaining.</returns>
<remarks>
<para>This is context aware and will only activate if it detects the process is running
as a systemd Service.</para>
Expand Down
4 changes: 2 additions & 2 deletions xml/Microsoft.Extensions.Logging.Console/ConsoleLoggerOptions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets the maximum number of enqueued messages. Defaults to 2500.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -245,7 +245,7 @@
<ReturnType>Microsoft.Extensions.Logging.Console.ConsoleLoggerQueueFullMode</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets or sets the desired console logger behavior when the queue becomes full. Defaults to <c>Wait</c>.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
6 changes: 3 additions & 3 deletions xml/Microsoft.Extensions.Logging.Console/ConsoleLoggerQueueFullMode.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>To be added.</summary>
<summary>Determines the console logger behavior when the queue becomes full.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -34,7 +34,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Drops new log messages when the queue is full.</summary>
</Docs>
</Member>
<Member MemberName="Wait">
Expand All @@ -54,7 +54,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Blocks the logging threads once the queue limit is reached.</summary>
</Docs>
</Member>
</Members>
Expand Down
30 changes: 15 additions & 15 deletions xml/System.ComponentModel/DateOnlyConverter.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>Provides a type converter to convert <see cref="T:System.DateOnly" /> objects to and from various other representations.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -31,7 +31,7 @@
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Initializes a new instance of the <see cref="T:System.ComponentModel.DateOnlyConverter" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -55,10 +55,10 @@
<Parameter Name="sourceType" Type="System.Type" />
</Parameters>
<Docs>
<param name="context">To be added.</param>
<param name="sourceType">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context.</param>
<param name="sourceType">The type to convert from.</param>
<summary>Gets a value indicating whether this converter can convert an object in the given source type to a <see cref="T:System.DateOnly" /> object using the specified context.</summary>
<returns><see langword="true" /> if this object can perform the conversion; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -89,9 +89,9 @@
</Parameter>
</Parameters>
<Docs>
<param name="context">To be added.</param>
<param name="destinationType">To be added.</param>
<summary>To be added.</summary>
<param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context.</param>
<param name="destinationType">The type to convert to.</param>
<summary>Gets a value indicating whether this converter can convert an object to the given destination type using the context.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand All @@ -117,11 +117,11 @@
<Parameter Name="value" Type="System.Object" />
</Parameters>
<Docs>
<param name="context">To be added.</param>
<param name="culture">To be added.</param>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context.</param>
<param name="culture">An optional <see cref="T:System.Globalization.CultureInfo" />. If not supplied, the current culture is assumed.</param>
<param name="value">The <see cref="T:System.Object" /> to convert.</param>
<summary>Converts the given value object to a <see cref="T:System.DateOnly" /> object.</summary>
<returns>An <see cref="T:System.Object" /> that represents the converted <paramref name="value" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -151,7 +151,7 @@
<param name="culture">To be added.</param>
<param name="value">To be added.</param>
<param name="destinationType">To be added.</param>
<summary>To be added.</summary>
<summary>Converts the given value object from a <see cref="T:System.DateOnly" /> object using the arguments.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.ComponentModel/HalfConverter.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>Provides a type converter to convert half-precision, floating point number objects to and from various other representations.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.ComponentModel/Int128Converter.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>Provides a type converter to convert 128-bit signed integer objects to and from various other representations.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down
12 changes: 6 additions & 6 deletions xml/System.ComponentModel/TimeOnlyConverter.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>Provides a type converter to convert <see cref="T:System.TimeOnly" /> objects to and from various other representations.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -31,7 +31,7 @@
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Initializes a new instance of the <see cref="T:System.ComponentModel.TimeOnlyConverter" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -57,7 +57,7 @@
<Docs>
<param name="context">To be added.</param>
<param name="sourceType">To be added.</param>
<summary>To be added.</summary>
<summary>Gets a value indicating whether this converter can convert an object in the given source type to a <see cref="T:System.TimeOnly" /> object using the specified context.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -91,7 +91,7 @@
<Docs>
<param name="context">To be added.</param>
<param name="destinationType">To be added.</param>
<summary>To be added.</summary>
<summary>Gets a value indicating whether this converter can convert an object to the given destination type using the context.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -120,7 +120,7 @@
<param name="context">To be added.</param>
<param name="culture">To be added.</param>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<summary>Converts the given value object to a <see cref="T:System.TimeOnly" /> object.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -151,7 +151,7 @@
<param name="culture">To be added.</param>
<param name="value">To be added.</param>
<param name="destinationType">To be added.</param>
<summary>To be added.</summary>
<summary>Converts the given value object from a <see cref="T:System.TimeOnly" /> object using the arguments.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.ComponentModel/UInt128Converter.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>Provides a type converter to convert 128-bit unsigned integer objects to and from various other representations.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down
6 changes: 3 additions & 3 deletions xml/System.Data.Common/DbDataSource.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -267,8 +267,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.</summary>
<returns>A task that represents the asynchronous dispose operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Formats.Tar/GnuTarEntry.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Even though the <xref:System.Formats.Tar.TarEntryFormat.Gnu> format is not POSIX
</Parameters>
<Docs>
<param name="other">To be added.</param>
<summary>To be added.</summary>
<summary>Initializes a new <see cref="T:System.Formats.Tar.GnuTarEntry" /> instance by converting the specified <paramref name="other" /> entry into the GNU format.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
10 changes: 6 additions & 4 deletions xml/System.Formats.Tar/PaxGlobalExtendedAttributesTarEntry.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>Represents a global extended attributes TAR entry from an archive of the PAX format.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -34,9 +34,11 @@
<Parameter Name="globalExtendedAttributes" Type="System.Collections.Generic.IEnumerable&lt;System.Collections.Generic.KeyValuePair&lt;System.String,System.String&gt;&gt;" />
</Parameters>
<Docs>
<param name="globalExtendedAttributes">To be added.</param>
<summary>To be added.</summary>
<param name="globalExtendedAttributes">An enumeration of string key-value pairs that represents the metadata to include as global extended attributes.</param>
<summary>Initializes a new <see cref="T:System.Formats.Tar.PaxGlobalExtendedAttributesTarEntry" /> instance with the specified global extended attributes enumeration.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="globalExtendedAttributes" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="GlobalExtendedAttributes">
Expand All @@ -55,7 +57,7 @@
<ReturnType>System.Collections.Generic.IReadOnlyDictionary&lt;System.String,System.String&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Returns the global extended attributes stored in this entry.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Formats.Tar/PaxTarEntry.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
</Parameters>
<Docs>
<param name="other">To be added.</param>
<summary>To be added.</summary>
<summary>Initializes a new <see cref="T:System.Formats.Tar.PaxTarEntry" /> instance by converting the specified <paramref name="other" /> entry into the PAX format.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Formats.Tar/TarEntry.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ An I/O problem occurred.</exception>
<ReturnType>System.Formats.Tar.TarEntryFormat</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>The format of the entry.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
Expand Down
Loading