Skip to content

Port System.Net documentation for .NET 8.0 APIs #88569

New issue
New issue
Closed
Closed
Port System.Net documentation for .NET 8.0 APIs#88569
Assignees
antonfirsovliveans
Labels
area-System.Netblocking-releasedocumentationDocumentation bug or enhancement, does not impact product or test code
Milestone
8.0.0

Description

@carlossanlop
carlossanlop
opened on Jul 9, 2023

Below is the list of APIs that still show up as undocumented in dotnet-api-docs and were introduced in .NET 8.0.

Full porting instructions can be found in the main issue.

This task needs to be finished before the RC2 snap (September 18th).

Summary Parameters TypeParameters ReturnValue API
Missing NA NA NA F:System.Net.HttpStatusCode.UnprocessableContent
Missing Missing NA Missing M:System.Net.IPAddress.System#IFormattable#ToString(System.String,System.IFormatProvider)
Missing Missing NA Missing M:System.Net.IPAddress.System#IParsable<System#Net#IPAddress>#Parse(System.String,System.IFormatProvider)
Missing Missing NA Missing M:System.Net.IPAddress.System#IParsable<System#Net#IPAddress>#TryParse(System.String,System.IFormatProvider,System.Net.IPAddress@)
Missing Missing NA Missing M:System.Net.IPAddress.System#ISpanFormattable#TryFormat(System.Span{System.Char},System.Int32@,System.ReadOnlySpan{System.Char},System.IFormatProvider)
Missing Missing NA Missing M:System.Net.IPAddress.System#ISpanParsable<System#Net#IPAddress>#Parse(System.ReadOnlySpan{System.Char},System.IFormatProvider)
Missing Missing NA Missing M:System.Net.IPAddress.System#ISpanParsable<System#Net#IPAddress>#TryParse(System.ReadOnlySpan{System.Char},System.IFormatProvider,System.Net.IPAddress@)
Missing Missing NA Missing M:System.Net.IPAddress.System#IUtf8SpanFormattable#TryFormat(System.Span{System.Byte},System.Int32@,System.ReadOnlySpan{System.Char},System.IFormatProvider)
Missing Missing NA Missing M:System.Net.IPAddress.TryFormat(System.Span{System.Byte},System.Int32@)
Missing Missing NA NA M:System.Net.IPNetwork.#ctor(System.Net.IPAddress,System.Int32)
Missing NA NA NA P:System.Net.IPNetwork.BaseAddress
Missing Missing NA Missing M:System.Net.IPNetwork.Contains(System.Net.IPAddress)
Missing Missing NA Missing M:System.Net.IPNetwork.Equals(System.Net.IPNetwork)
Missing Missing NA Missing M:System.Net.IPNetwork.Equals(System.Object)
Missing NA NA Missing M:System.Net.IPNetwork.GetHashCode
Missing NA NA NA T:System.Net.IPNetwork
Missing Missing NA Missing M:System.Net.IPNetwork.op_Equality(System.Net.IPNetwork,System.Net.IPNetwork)
Missing Missing NA Missing M:System.Net.IPNetwork.op_Inequality(System.Net.IPNetwork,System.Net.IPNetwork)
Missing Missing NA Missing M:System.Net.IPNetwork.Parse(System.ReadOnlySpan{System.Char})
Missing Missing NA Missing M:System.Net.IPNetwork.Parse(System.String)
Missing NA NA NA P:System.Net.IPNetwork.PrefixLength
Missing Missing NA Missing M:System.Net.IPNetwork.System#IFormattable#ToString(System.String,System.IFormatProvider)
Missing Missing NA Missing M:System.Net.IPNetwork.System#IParsable<System#Net#IPNetwork>#Parse(System.String,System.IFormatProvider)
Missing Missing NA Missing M:System.Net.IPNetwork.System#IParsable<System#Net#IPNetwork>#TryParse(System.String,System.IFormatProvider,System.Net.IPNetwork@)
Missing Missing NA Missing M:System.Net.IPNetwork.System#ISpanFormattable#TryFormat(System.Span{System.Char},System.Int32@,System.ReadOnlySpan{System.Char},System.IFormatProvider)
Missing Missing NA Missing M:System.Net.IPNetwork.System#ISpanParsable<System#Net#IPNetwork>#Parse(System.ReadOnlySpan{System.Char},System.IFormatProvider)
Missing Missing NA Missing M:System.Net.IPNetwork.System#ISpanParsable<System#Net#IPNetwork>#TryParse(System.ReadOnlySpan{System.Char},System.IFormatProvider,System.Net.IPNetwork@)
Missing Missing NA Missing M:System.Net.IPNetwork.System#IUtf8SpanFormattable#TryFormat(System.Span{System.Byte},System.Int32@,System.ReadOnlySpan{System.Char},System.IFormatProvider)
Missing NA NA Missing M:System.Net.IPNetwork.ToString
Missing Missing NA Missing M:System.Net.IPNetwork.TryFormat(System.Span{System.Char},System.Int32@)
Missing Missing NA Missing M:System.Net.IPNetwork.TryFormat(System.Span{System.Byte},System.Int32@)
Missing Missing NA Missing M:System.Net.IPNetwork.TryParse(System.String,System.Net.IPNetwork@)
Missing Missing NA Missing M:System.Net.IPNetwork.TryParse(System.ReadOnlySpan{System.Char},System.Net.IPNetwork@)
Missing Missing NA Missing M:System.Net.Http.Json.HttpContentJsonExtensions.ReadFromJsonAsync(System.Net.Http.HttpContent,System.Type,System.Threading.CancellationToken)
Missing Missing Missing Missing M:System.Net.Http.Json.HttpContentJsonExtensions.ReadFromJsonAsync1(System.Net.Http.HttpContent,System.Threading.CancellationToken)
Missing Missing NA Missing M:System.Net.NetworkInformation.Ping.SendPingAsync(System.Net.IPAddress,System.TimeSpan,System.Byte[],System.Net.NetworkInformation.PingOptions,System.Threading.CancellationToken)
Missing Missing NA Missing M:System.Net.NetworkInformation.Ping.SendPingAsync(System.String,System.TimeSpan,System.Byte[],System.Net.NetworkInformation.PingOptions,System.Threading.CancellationToken)
Missing NA NA NA P:System.Net.Quic.QuicConnection.TargetHostName
Missing NA NA NA F:System.Net.Quic.QuicError.AlpnInUse
Missing NA NA Missing M:System.Net.Quic.QuicStream.ToString
Missing NA NA NA P:System.Net.Security.SslClientAuthenticationOptions.ClientCertificateContext
Missing Missing NA NA M:System.Net.Security.SslClientHelloInfo.#ctor(System.String,System.Security.Authentication.SslProtocols)
Missing NA NA NA P:System.Net.Security.SslStreamCertificateContext.IntermediateCertificates
Missing NA NA NA P:System.Net.Security.SslStreamCertificateContext.TargetCertificate
Missing Missing NA NA M:System.Net.Sockets.SocketException.#ctor(System.Int32,System.String)
Missing Missing NA Missing M:System.Net.WebSockets.ClientWebSocket.SendAsync(System.ReadOnlyMemory{System.Byte},System.Net.WebSockets.WebSocketMessageType,System.Net.WebSockets.WebSocketMessageFlags,System.Threading.CancellationToken)

Activity

  1. carlossanlop
    added
    documentationDocumentation bug or enhancement, does not impact product or test code
    area-System.Net
    blocking-release
    on Jul 9, 2023
  2. carlossanlop
    added this to the 8.0.0 milestone on Jul 9, 2023
  4. karelz
    assigned
    antonfirsov
    on Aug 29, 2023
  5. karelz
    assigned
    liveans
    on Sep 7, 2023

  6. antonfirsov commented on Sep 11, 2023

    @antonfirsov
    antonfirsov
    on Sep 11, 2023
    Contributor

    This has been completed with the PRs listed above. @carlossanlop if I missed something, let me know.

  7. antonfirsov
    closed this as completedon Sep 11, 2023

  8. carlossanlop commented on Sep 15, 2023

    @carlossanlop
    carlossanlop
    on Sep 15, 2023
    ContributorAuthor

    Last push. Here's the updated list, @antonfirsov @karelz. Please let me know if you need help, I can assist with documenting a bunch of them:

    API Summary Parameters TypeParameters ReturnValue
    P:System.Net.SocketAddress.Buffer Missing NA NA NA
    M:System.Net.SocketAddress.GetMaximumAddressSize(System.Net.Sockets.AddressFamily) Missing Missing NA Missing
    P:System.Net.Http.HttpClientHandler.MeterFactory Missing NA NA NA
    M:System.Net.Http.HttpIOException.#ctor(System.Net.Http.HttpRequestError,System.String,System.Exception) Missing Missing NA NA
    T:System.Net.Http.HttpIOException Missing NA NA NA
    P:System.Net.Http.HttpIOException.HttpRequestError Missing NA NA NA
    M:System.Net.Http.HttpMethod.Parse(System.ReadOnlySpan{System.Char}) Missing Missing NA Missing
    F:System.Net.Http.HttpRequestError.ConfigurationLimitExceeded Missing NA NA NA
    F:System.Net.Http.HttpRequestError.ConnectionError Missing NA NA NA
    F:System.Net.Http.HttpRequestError.ExtendedConnectNotSupported Missing NA NA NA
    F:System.Net.Http.HttpRequestError.HttpProtocolError Missing NA NA NA
    T:System.Net.Http.HttpRequestError Missing NA NA NA
    F:System.Net.Http.HttpRequestError.InvalidResponse Missing NA NA NA
    F:System.Net.Http.HttpRequestError.NameResolutionError Missing NA NA NA
    F:System.Net.Http.HttpRequestError.ProxyTunnelError Missing NA NA NA
    F:System.Net.Http.HttpRequestError.ResponseEnded Missing NA NA NA
    F:System.Net.Http.HttpRequestError.SecureConnectionError Missing NA NA NA
    F:System.Net.Http.HttpRequestError.Unknown Missing NA NA NA
    F:System.Net.Http.HttpRequestError.UserAuthenticationError Missing NA NA NA
    F:System.Net.Http.HttpRequestError.VersionNegotiationError Missing NA NA NA
    M:System.Net.Http.HttpRequestException.#ctor(System.Net.Http.HttpRequestError,System.String,System.Exception,System.Nullable{System.Net.HttpStatusCode}) Missing Missing NA NA
    P:System.Net.Http.HttpRequestException.HttpRequestError Missing NA NA NA
    M:System.Net.Http.HttpRequestOptions.System#Collections#Generic#IReadOnlyDictionary<System#String,System#Object>#TryGetValue(System.String,System.Object@) Missing Missing NA Missing
    P:System.Net.Http.SocketsHttpHandler.MeterFactory Missing NA NA NA
    M:System.Net.Http.Json.HttpClientJsonExtensions.GetFromJsonAsAsyncEnumerable1(System.Net.Http.HttpClient,System.String,System.Threading.CancellationToken) Missing Missing Missing Missing
    M:System.Net.Http.Json.HttpClientJsonExtensions.GetFromJsonAsAsyncEnumerable1(System.Net.Http.HttpClient,System.Uri,System.Threading.CancellationToken) Missing Missing Missing Missing
    M:System.Net.Http.Json.HttpClientJsonExtensions.GetFromJsonAsAsyncEnumerable1(System.Net.Http.HttpClient,System.String,System.Text.Json.JsonSerializerOptions,System.Threading.CancellationToken) Missing Missing Missing Missing
    M:System.Net.Http.Json.HttpClientJsonExtensions.GetFromJsonAsAsyncEnumerable1(System.Net.Http.HttpClient,System.String,System.Text.Json.Serialization.Metadata.JsonTypeInfo{0},System.Threading.CancellationToken) Missing Missing Missing Missing
    M:System.Net.Http.Json.HttpClientJsonExtensions.GetFromJsonAsAsyncEnumerable1(System.Net.Http.HttpClient,System.Uri,System.Text.Json.JsonSerializerOptions,System.Threading.CancellationToken) Missing Missing Missing Missing
    M:System.Net.Http.Json.HttpClientJsonExtensions.GetFromJsonAsAsyncEnumerable1(System.Net.Http.HttpClient,System.Uri,System.Text.Json.Serialization.Metadata.JsonTypeInfo{0},System.Threading.CancellationToken) Missing Missing Missing Missing
    M:System.Net.Http.Json.HttpContentJsonExtensions.ReadFromJsonAsAsyncEnumerable1(System.Net.Http.HttpContent,System.Threading.CancellationToken) Missing Missing Missing Missing
    M:System.Net.Http.Json.HttpContentJsonExtensions.ReadFromJsonAsAsyncEnumerable1(System.Net.Http.HttpContent,System.Text.Json.JsonSerializerOptions,System.Threading.CancellationToken) Missing Missing Missing Missing
    M:System.Net.Http.Json.HttpContentJsonExtensions.ReadFromJsonAsAsyncEnumerable1(System.Net.Http.HttpContent,System.Text.Json.Serialization.Metadata.JsonTypeInfo{0},System.Threading.CancellationToken) Missing Missing Missing Missing
    M:System.Net.Http.Json.JsonContent.Create(System.Object,System.Text.Json.Serialization.Metadata.JsonTypeInfo,System.Net.Http.Headers.MediaTypeHeaderValue) Missing Missing NA Missing
    M:System.Net.Http.Json.JsonContent.Create1(0,System.Text.Json.Serialization.Metadata.JsonTypeInfo{0},System.Net.Http.Headers.MediaTypeHeaderValue) Missing Missing Missing Missing
    N:System.Net.Http.Metrics Missing NA NA NA
    M:System.Net.Http.Metrics.HttpMetricsEnrichmentContext.AddCallback(System.Net.Http.HttpRequestMessage,System.Action{System.Net.Http.Metrics.HttpMetricsEnrichmentContext}) Missing Missing NA NA
    M:System.Net.Http.Metrics.HttpMetricsEnrichmentContext.AddCustomTag(System.String,System.Object) Missing Missing NA NA
    P:System.Net.Http.Metrics.HttpMetricsEnrichmentContext.Exception Missing NA NA NA
    T:System.Net.Http.Metrics.HttpMetricsEnrichmentContext Missing NA NA NA
    P:System.Net.Http.Metrics.HttpMetricsEnrichmentContext.Request Missing NA NA NA
    P:System.Net.Http.Metrics.HttpMetricsEnrichmentContext.Response Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Application.FormUrlEncoded Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Application.JsonPatch Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Application.JsonSequence Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Application.Manifest Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Application.ProblemJson Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Application.ProblemXml Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Application.Wasm Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Application.XmlDtd Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Application.XmlPatch Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Font.Collection Missing NA NA NA
    T:System.Net.Mime.MediaTypeNames.Font Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Font.Otf Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Font.Sfnt Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Font.Ttf Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Font.Woff Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Font.Woff2 Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Image.Avif Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Image.Bmp Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Image.Icon Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Image.Png Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Image.Svg Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Image.Webp Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Multipart.ByteRanges Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Multipart.FormData Missing NA NA NA
    T:System.Net.Mime.MediaTypeNames.Multipart Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Text.Css Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Text.Csv Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Text.JavaScript Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Text.Markdown Missing NA NA NA
    F:System.Net.Mime.MediaTypeNames.Text.Rtf Missing NA NA NA
    F:System.Net.Quic.QuicError.CallbackError Missing NA NA NA
    F:System.Net.Quic.QuicError.TransportError Missing NA NA NA
    P:System.Net.Quic.QuicException.TransportErrorCode Missing NA NA NA
    M:System.Net.Sockets.LingerOption.Equals(System.Object) Missing Missing NA Missing
    M:System.Net.Sockets.LingerOption.GetHashCode Missing NA NA Missing
    M:System.Net.Sockets.Socket.ReceiveFrom(System.Span{System.Byte},System.Net.Sockets.SocketFlags,System.Net.SocketAddress) Missing Missing NA Missing
    M:System.Net.Sockets.Socket.ReceiveFromAsync(System.Memory{System.Byte},System.Net.Sockets.SocketFlags,System.Net.SocketAddress,System.Threading.CancellationToken) Missing Missing NA Missing
    M:System.Net.Sockets.Socket.SendTo(System.ReadOnlySpan{System.Byte},System.Net.Sockets.SocketFlags,System.Net.SocketAddress) Missing Missing NA Missing
    M:System.Net.Sockets.Socket.SendToAsync(System.ReadOnlyMemory{System.Byte},System.Net.Sockets.SocketFlags,System.Net.SocketAddress,System.Threading.CancellationToken) Missing Missing NA Missing
    M:System.Net.Sockets.TcpListener.Dispose Missing NA NA NA
    M:System.Net.Sockets.UnixDomainSocketEndPoint.Equals(System.Object) Missing Missing NA Missing
    M:System.Net.Sockets.UnixDomainSocketEndPoint.GetHashCode Missing NA NA Missing
  9. carlossanlop
    reopened this on Sep 15, 2023

  10. antonfirsov commented on Sep 15, 2023

    @antonfirsov
    antonfirsov
    on Sep 15, 2023
    Contributor

    @carlossanlop it's Friday evening here so if you can roll forward some of the work, it would be really appreciated. (Especially System.Net.Json which is not our area.)

    I will do the rest on Monday.

  11. karelz commented on Sep 18, 2023

    @karelz
    karelz
    on Sep 18, 2023
    Member

    @carlossanlop we made a push in EU timezone and everything should be documented - now we just need code reviews, and merging of the PRs :)

  12. karelz commented on Sep 19, 2023

    @karelz
    karelz
    on Sep 19, 2023
    Member

    All docs made it into 8.0 dotnet-api-docs.

  13. karelz
    closed this as completedon Sep 19, 2023
  14. ghost locked as resolved and limited conversation to collaborators on Oct 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

area-System.Netblocking-releasedocumentationDocumentation bug or enhancement, does not impact product or test code

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions