Add MemberGroup descriptions (System.N*)#12818
Draft
gewarren wants to merge 2 commits into
Draft
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR contributes to dotnet/dotnet-api-docs issue #12626 by adding (or improving) MemberGroup <summary> descriptions for overload groups across several System.N* namespaces, making the rendered API reference less reliant on “To be added” placeholders and improving discoverability of overloaded members.
Changes:
- Add
MemberGroup<summary>blocks for many overload groups inSystem.Numerics*andSystem.Net*API XML. - Update
IPEndPointParse/TryParsegroup summaries from placeholders to descriptive text. - Add
MemberGroupsummaries for additional networking, HTTP, and JSON extension APIs.
Reviewed changes
Copilot reviewed 69 out of 70 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| xml/System.Numerics/Vector4.xml | Add MemberGroup summaries for overload groups (e.g., Create, Lerp). |
| xml/System.Numerics/Vector3.xml | Add MemberGroup summaries for overload groups (e.g., Create, Lerp). |
| xml/System.Numerics/Vector2.xml | Add MemberGroup summaries for overload groups (e.g., Create, Lerp). |
| xml/System.Numerics/Vector`1.xml | Add MemberGroup summaries for several overload groups (e.g., CopyTo, operators, ToString). |
| xml/System.Numerics/Vector.xml | Add many MemberGroup summaries for vector helper/operation overload groups. |
| xml/System.Numerics/TotalOrderIeee754Comparer`1.xml | Add MemberGroup summaries for Equals/GetHashCode. |
| xml/System.Numerics/Quaternion.xml | Add MemberGroup summary for Create overload group. |
| xml/System.Numerics/Plane.xml | Add MemberGroup summary for Create overload group. |
| xml/System.Numerics/Matrix4x4.xml | Add MemberGroup summary for Create overload group. |
| xml/System.Numerics/Matrix3x2.xml | Add MemberGroup summary for Create overload group. |
| xml/System.Numerics/INumberBase`1.xml | Add MemberGroup summaries for Parse/TryParse overload groups. |
| xml/System.Numerics/ILogarithmicFunctions`1.xml | Add MemberGroup summary for Log overload group. |
| xml/System.Numerics/IFloatingPoint`1.xml | Add MemberGroup summaries for Round / exponent/significand writers. |
| xml/System.Numerics/IBinaryInteger`1.xml | Add MemberGroup summaries for DivRem and endian read/write methods. |
| xml/System.Numerics/Complex.xml | Add MemberGroup summaries for Parse/TryParse/TryFormat overload groups. |
| xml/System.Numerics/BitOperations.xml | Add MemberGroup summaries for various bit-operation overload groups. |
| xml/System.Numerics/BigInteger.xml | Add MemberGroup summaries for DivRem/ToByteArray/TryFormat. |
| xml/System.Numerics.Tensors/TensorSpan`1.xml | Add MemberGroup summaries for ctor/operator/slice/ToString groups. |
| xml/System.Numerics.Tensors/TensorPrimitives.xml | Add MemberGroup summaries for many tensor primitive operation overload groups. |
| xml/System.Numerics.Tensors/Tensor+<G>$EE370FE0DCC484E8A0E26F357297EE8A`1.xml | Add MemberGroup summary for op_Multiply overload group. |
| xml/System.Numerics.Tensors/Tensor+<G>$DA50153CC5845951E014FF4FE92B697B`1.xml | Add MemberGroup summary for op_MultiplicationAssignment overload group. |
| xml/System.Numerics.Tensors/Tensor+<G>$D9E4183FC275B9B07CFB3981C6D65D2E`1.xml | Add MemberGroup summaries for bitwise operator overload groups. |
| xml/System.Numerics.Tensors/Tensor+<G>$C73EBF61CD0A1187D8FDBF1BBD2D8347`1.xml | Add MemberGroup summary for op_Addition overload group. |
| xml/System.Numerics.Tensors/Tensor+<G>$A3CEAD6D0793576ACF1EABBD275E177F`1.xml | Add MemberGroup summary for op_SubtractionAssignment overload group. |
| xml/System.Numerics.Tensors/Tensor+<G>$72B9B4120A764E0A07B9794EF88815C1`1.xml | Add MemberGroup summary for op_AdditionAssignment overload group. |
| xml/System.Numerics.Tensors/Tensor+<G>$650F30A31A40FB5CC3043AFCE35209D3`1.xml | Add MemberGroup summaries for bitwise assignment operator overload groups. |
| xml/System.Numerics.Tensors/Tensor+<G>$5C653C742CCA06FEB22BE55E4C352ED5`1.xml | Add MemberGroup summary for op_DivisionAssignment overload group. |
| xml/System.Numerics.Tensors/Tensor+<G>$2A4286E6AF1C038195D63DA56E1CFB07`1.xml | Add MemberGroup summary for op_Subtraction overload group. |
| xml/System.Numerics.Tensors/Tensor+<G>$11ECEC3835A71DB7BDDB2EA6F4E3B0EA`1.xml | Add MemberGroup summary for op_Division overload group. |
| xml/System.Numerics.Tensors/Tensor`1.xml | Add MemberGroup summaries for span conversions, slicing, ToString, etc. |
| xml/System.Numerics.Tensors/ReadOnlyTensorSpan`1.xml | Add MemberGroup summaries for ctor/slice/ToString groups. |
| xml/System.Numerics.Tensors/ITensor`2.xml | Add MemberGroup summaries for span accessors and factory members. |
| xml/System.Numerics.Tensors/IReadOnlyTensor`2.xml | Add MemberGroup summaries for span accessors and slicing methods. |
| xml/System.Numerics.Colors/Rgba`1.xml | Add MemberGroup summary for ctor overload group. |
| xml/System.Numerics.Colors/Argb`1.xml | Add MemberGroup summary for ctor overload group. |
| xml/System.Net/SocketAddress.xml | Add MemberGroup summary for Equals overload group. |
| xml/System.Net/IPNetwork.xml | Add MemberGroup summaries for Equals/Parse/TryParse/TryFormat groups. |
| xml/System.Net/IPEndPoint.xml | Replace placeholder Parse / TryParse group summaries with descriptive text. |
| xml/System.Net/IPAddress.xml | Add MemberGroup summaries for Parse/TryParse/TryFormat groups. |
| xml/System.Net/Dns.xml | Add MemberGroup summaries for GetHostAddresses / GetHostAddressesAsync groups. |
| xml/System.Net.WebSockets/WebSocketStream.xml | Add MemberGroup summary for Create overload group. |
| xml/System.Net.WebSockets/WebSocket.xml | Add MemberGroup summaries for CreateFromStream/ReceiveAsync/SendAsync groups. |
| xml/System.Net.WebSockets/ClientWebSocket.xml | Add MemberGroup summaries for ConnectAsync/ReceiveAsync/SendAsync groups. |
| xml/System.Net.Sockets/UdpClient.xml | Add MemberGroup summaries for Dispose/ReceiveAsync groups. |
| xml/System.Net.Sockets/TcpListener.xml | Add MemberGroup summaries for AcceptSocketAsync/AcceptTcpClientAsync groups. |
| xml/System.Net.Sockets/TcpClient.xml | Add MemberGroup summary for Dispose group. |
| xml/System.Net.Sockets/SocketTaskExtensions.xml | Add MemberGroup summaries for common socket Task-based extension overload groups. |
| xml/System.Net.Sockets/SocketAsyncEventArgs.xml | Add MemberGroup summary for ctor overload group. |
| xml/System.Net.Sockets/Socket.xml | Add MemberGroup summaries for several overload groups (AcceptAsync, Receive*, Send*, etc.). |
| xml/System.Net.Sockets/SafeSocketHandle.xml | Add MemberGroup summary for ctor overload group. |
| xml/System.Net.Sockets/NetworkStream.xml | Add MemberGroup summaries for Close/Read/ReadAsync/Write/WriteAsync groups. |
| xml/System.Net.Sockets/IPPacketInformation.xml | Add MemberGroup summary for Equals overload group. |
| xml/System.Net.Security/SslStreamCertificateContext.xml | Add MemberGroup summary for Create overload group. |
| xml/System.Net.Security/SslStream.xml | Add MemberGroup summaries for Read/ReadAsync/WriteAsync groups. |
| xml/System.Net.Security/SslApplicationProtocol.xml | Add MemberGroup summaries for ctor/Equals groups. |
| xml/System.Net.Security/NegotiateStream.xml | Add MemberGroup summaries for ReadAsync/WriteAsync groups. |
| xml/System.Net.Security/NegotiateAuthentication.xml | Add MemberGroup summaries for ctor/GetOutgoingBlob groups. |
| xml/System.Net.Quic/QuicStream.xml | Add MemberGroup summaries for Read/ReadAsync/Write/WriteAsync groups. |
| xml/System.Net.NetworkInformation/Ping.xml | Add MemberGroup summary for Dispose group. |
| xml/System.Net.NetworkInformation/PhysicalAddress.xml | Add MemberGroup summaries for Parse/TryParse groups. |
| xml/System.Net.Mail/MailAddress.xml | Add MemberGroup summary for TryCreate overload group. |
| xml/System.Net.Http/StreamContent.xml | Add MemberGroup summary for SerializeToStreamAsync group. |
| xml/System.Net.Http/MultipartContent.xml | Add MemberGroup summaries for CreateContentReadStreamAsync/SerializeToStreamAsync groups. |
| xml/System.Net.Http/HttpContent.xml | Add MemberGroup summaries for CreateContentReadStreamAsync/ReadAs*/SerializeToStreamAsync groups. |
| xml/System.Net.Http/HttpClient.xml | Add MemberGroup summaries for PatchAsync and Send groups. |
| xml/System.Net.Http/ByteArrayContent.xml | Add MemberGroup summary for SerializeToStreamAsync group. |
| xml/System.Net.Http.Json/JsonContent.xml | Add MemberGroup summaries for Create overload groups. |
| xml/System.Net.Http.Json/HttpContentJsonExtensions.xml | Add MemberGroup summaries for ReadFromJson* overload groups. |
| xml/System.Net.Http.Json/HttpClientJsonExtensions.xml | Add MemberGroup summaries for various JSON client extension overload groups. |
| </Member> | ||
| <MemberGroup MemberName="AsVector3"> | ||
| <Docs> | ||
| <summary>Reinterprets a <see cref="T:System.Numerics.Vector4" /> as a new <see cref="T:System.Numerics.Vector3" />.</summary> |
| </Member> | ||
| <MemberGroup MemberName="AsVector4Unsafe"> | ||
| <Docs> | ||
| <summary>Converts a <see cref="T:System.Numerics.Vector3" /> to a new <see cref="T:System.Numerics.Vector4" /> with the new elements undefined.</summary> |
| </Member> | ||
| <MemberGroup MemberName="Equals"> | ||
| <Docs> | ||
| <summary>Returns a new vector whose elements signal whether the elements in two specified long integer vectors are equal.</summary> |
| </Member> | ||
| <MemberGroup MemberName="GreaterThan"> | ||
| <Docs> | ||
| <summary>Returns a new integral vector whose elements signal whether the elements in one integral vector are greater than their corresponding elements in a second integral vector.</summary> |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Comment on lines
+621
to
+625
| <MemberGroup MemberName="AsVector2"> | ||
| <Docs> | ||
| <summary>Reinterprets a <see cref="T:System.Numerics.Vector3" /> as a new <see cref="T:System.Numerics.Vector2" />.</summary> | ||
| </Docs> | ||
| </MemberGroup> |
Comment on lines
+687
to
+691
| <MemberGroup MemberName="AsVector3"> | ||
| <Docs> | ||
| <summary>Reinterprets a <see cref="T:System.Numerics.Vector4" /> as a new <see cref="T:System.Numerics.Vector3" />.</summary> | ||
| </Docs> | ||
| </MemberGroup> |
Comment on lines
+783
to
+787
| <MemberGroup MemberName="AsVector4"> | ||
| <Docs> | ||
| <summary>Reinterprets a <see cref="T:System.Numerics.Plane" /> as a new <see cref="T:System.Numerics.Vector4" />.</summary> | ||
| </Docs> | ||
| </MemberGroup> |
Comment on lines
+912
to
+916
| <MemberGroup MemberName="AsVector4Unsafe"> | ||
| <Docs> | ||
| <summary>Converts a <see cref="T:System.Numerics.Vector3" /> to a new <see cref="T:System.Numerics.Vector4" /> with the new elements undefined.</summary> | ||
| </Docs> | ||
| </MemberGroup> |
Comment on lines
+427
to
+431
| <MemberGroup MemberName="LeadingZeroCount"> | ||
| <Docs> | ||
| <summary>Counts the number of leading zero bits in an unsigned 32-bit integer mask.</summary> | ||
| </Docs> | ||
| </MemberGroup> |
Comment on lines
+2225
to
+2229
| <MemberGroup MemberName="ToString"> | ||
| <Docs> | ||
| <summary>Creates a <see cref="T:System.String" /> representation of the <see cref="T:System.Numerics.Tensors.TensorSpan`1" />.</summary> | ||
| </Docs> | ||
| </MemberGroup> |
Comment on lines
+372
to
+376
| <MemberGroup MemberName="GetSpan"> | ||
| <Docs> | ||
| <summary>Return a span that starts at the specified index and contains the specified number of items.</summary> | ||
| </Docs> | ||
| </MemberGroup> |
Comment on lines
+12229
to
+12233
| <MemberGroup MemberName="Pow<T>"> | ||
| <Docs> | ||
| <summary>Computes the element-wise power of a number in a specified tensor raised to a number in another specified tensors.</summary> | ||
| </Docs> | ||
| </MemberGroup> |
Comment on lines
+13397
to
+13401
| <MemberGroup MemberName="Round<T>"> | ||
| <Docs> | ||
| <summary>Computes the element-wise rounding of the numbers in the specified tensor</summary> | ||
| </Docs> | ||
| </MemberGroup> |
Comment on lines
+4320
to
+4324
| <MemberGroup MemberName="WriteAsync"> | ||
| <Docs> | ||
| <summary>Write asynchronously the specified number of <see cref="T:System.Byte" />s to the underlying stream.</summary> | ||
| </Docs> | ||
| </MemberGroup> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Contributes to #12626.