dotnet / aspnetcore Public
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
Fix nearly all CS1591 #40106
base: main
Are you sure you want to change the base?
Fix nearly all CS1591 #40106
Conversation
Bonus |
Tcp, | ||
|
||
/// <summary> | ||
/// Carries water when not burst. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
:/
Co-authored-by: Brennan <[email protected]>
Http3 = 0x4, | ||
|
||
/// <summary> | ||
/// The <see cref="Http1"/>, <see cref="Http2"/> and <see cref="Http3"/> protocol versions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/// The <see cref="Http1"/>, <see cref="Http2"/> and <see cref="Http3"/> protocol versions. | |
/// The <see cref="Http1"/>, <see cref="Http2"/>, and <see cref="Http3"/> protocol versions. |
/// <summary> | ||
/// A binary transport format. | ||
/// </summary> | ||
Binary = 0x01, | ||
|
||
/// <summary> | ||
/// A text output format. | ||
/// </summary> | ||
Text = 0x02 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/// <summary> | ||
/// This API supports framework infrastructure and is not intended to be used | ||
/// directly from application code. | ||
/// </summary> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
<inheritdoc />
for this
/// <summary> | |
/// This API supports framework infrastructure and is not intended to be used | |
/// directly from application code. | |
/// </summary> | |
/// <inheritdoc cref="HttpMethod" /> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can also create a type specifically for this purpose, and then link all documentation to it for elements to have consistent wording.
/// <summary> | ||
/// Specify Quic as the transport to be used by Kestrel. | ||
/// </summary> | ||
/// <param name="hostBuilder">The <see cref="IWebHostBuilder"/>. to configure.</param> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/// <param name="hostBuilder">The <see cref="IWebHostBuilder"/>. to configure.</param> | |
/// <param name="hostBuilder">The <see cref="IWebHostBuilder"/> to configure.</param> |
/// Specify Quic as the transport to be used by Kestrel. | ||
/// </summary> | ||
/// <param name="hostBuilder">The <see cref="IWebHostBuilder"/>. to configure.</param> | ||
/// <returns>The <see cref="IWebHostBuilder"/>.</returns> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/// <returns>The <see cref="IWebHostBuilder"/>.</returns> | |
/// <returns>Returns <paramref name="hostBuilder"/>.</returns> |
/// <summary> | ||
/// Specify Quic as the transport to be used by Kestrel. | ||
/// </summary> | ||
/// <param name="hostBuilder">The <see cref="IWebHostBuilder"/>. to configure.</param> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/// <param name="hostBuilder">The <see cref="IWebHostBuilder"/>. to configure.</param> | |
/// <param name="hostBuilder">The <see cref="IWebHostBuilder"/> to configure.</param> |
@@ -16,6 +16,11 @@ public sealed class SocketTransportFactory : IConnectionListenerFactory | |||
private readonly SocketTransportOptions _options; | |||
private readonly ILoggerFactory _logger; | |||
|
|||
/// <summary> | |||
/// Initializes a new instance of <see cref="SocketTransportFactory"/>. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/// Initializes a new instance of <see cref="SocketTransportFactory"/>. | |
/// Initializes a new instance of the <see cref="SocketTransportFactory"/> class. |
/// <summary> | ||
/// Not a manual. | ||
/// </summary> | ||
Auto, | ||
|
||
/// <summary> | ||
/// Better than UDP. | ||
/// </summary> | ||
Tcp, | ||
|
||
/// <summary> | ||
/// Carries water when not burst. | ||
/// </summary> | ||
Pipe |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe want to revisit these
/// <summary> | ||
/// Better than UDP. | ||
/// </summary> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Take that QUIC
@@ -9,10 +9,33 @@ namespace Microsoft.AspNetCore.Server.Kestrel.Core; | |||
[Flags] | |||
public enum HttpProtocols | |||
{ | |||
/// <summary> | |||
/// A missing HTTP protocol version. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/// A missing HTTP protocol version. | |
/// No HTTP protocol version was specified. |
Fixes #27538
The text was updated successfully, but these errors were encountered: