Skip to content

Commit

Permalink
Merge pull request #10297 from tannergooding/net9-numerics
Browse files Browse the repository at this point in the history
Ensure that various inheritdoc comments can be resolved
  • Loading branch information
tannergooding authored Aug 22, 2024
2 parents eaa80bc + 07721a8 commit 78d872d
Show file tree
Hide file tree
Showing 4 changed files with 60 additions and 60 deletions.
42 changes: 21 additions & 21 deletions xml/System.Numerics/Vector.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1818,7 +1818,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.Clamp(`0,`0,`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.Clamp``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="ClampNative&lt;T&gt;">
Expand Down Expand Up @@ -1888,7 +1888,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.ClampNative(`0,`0,`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.ClampNative``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="ConditionalSelect">
Expand Down Expand Up @@ -2280,7 +2280,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
</Parameters>
<Docs>
<param name="value">The vector to convert.</param>
<summary>Converts a <see cref="T:System.Numerics.Vector{System.Double}" /> to a <see cref="T:System.Numerics.Vector{System.Int64}" /> using platform specific behavior on overflow.</summary>
<summary>Converts a <see langword="System.Numerics.Vector&lt;System.Double&gt;" /> to a <see langword="System.Numerics.Vector&lt;System.Int64&gt;" /> using platform specific behavior on overflow.</summary>
<returns>The converted vector.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -2440,7 +2440,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
</Parameters>
<Docs>
<param name="value">The vector to convert.</param>
<summary>Converts a <see cref="T:System.Numerics.Vector{System.Single}" /> to a <see cref="T:System.Numerics.Vector{System.UInt32}" /> using platform specific behavior on overflow.</summary>
<summary>Converts a <see langword="System.Numerics.Vector&lt;System.Single&gt;" /> to a <see langword="System.Numerics.Vector&lt;System.UInt32&gt;" /> using platform specific behavior on overflow.</summary>
<returns>The converted vector.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -2518,7 +2518,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
</Parameters>
<Docs>
<param name="value">The vector to convert.</param>
<summary>Converts a <see cref="T:System.Numerics.Vector{System.Double}" /> to a <see cref="T:System.Numerics.Vector{System.UInt64}" /> using platform specific behavior on overflow.</summary>
<summary>Converts a <see langword="System.Numerics.Vector&lt;System.Double&gt;" /> to a <see langword="System.Numerics.Vector&lt;System.UInt64&gt;" /> using platform specific behavior on overflow.</summary>
<returns>The converted vector.</returns>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -2581,7 +2581,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.CopySign(`0,`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.CopySign``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="Cos">
Expand Down Expand Up @@ -4757,7 +4757,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.IsNaN(`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.IsNaN``1(System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="IsNegative&lt;T&gt;">
Expand Down Expand Up @@ -4809,7 +4809,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.IsNegative(`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.IsNegative``1(System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="IsPositive&lt;T&gt;">
Expand Down Expand Up @@ -4861,7 +4861,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.IsPositive(`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.IsPositive``1(System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="IsPositiveInfinity&lt;T&gt;">
Expand Down Expand Up @@ -4913,7 +4913,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.IsPositiveInfinity(`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.IsPositiveInfinity``1(System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="IsZero&lt;T&gt;">
Expand Down Expand Up @@ -4965,7 +4965,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.IsZero(`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.IsZero``1(System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="Lerp">
Expand Down Expand Up @@ -6349,7 +6349,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
<summary>Returns a new vector whose elements are the maximum of each pair of elements in the two given vectors.</summary>
<returns>The maximum vector.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.Max(`0,`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.Max``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="MaxMagnitude&lt;T&gt;">
Expand Down Expand Up @@ -6410,7 +6410,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.MaxMagnitude(`0,`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.MaxMagnitude``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="MaxMagnitudeNumber&lt;T&gt;">
Expand Down Expand Up @@ -6471,7 +6471,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.MaxMagnitudeNumber(`0,`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.MaxMagnitudeNumber``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="MaxNative&lt;T&gt;">
Expand Down Expand Up @@ -6532,7 +6532,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.MaxNative(`0,`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.MaxNative``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="MaxNumber&lt;T&gt;">
Expand Down Expand Up @@ -6593,7 +6593,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.MaxNumber(`0,`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.MaxNumber``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="Min&lt;T&gt;">
Expand Down Expand Up @@ -6673,7 +6673,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
<summary>Returns a new vector whose elements are the minimum of each pair of elements in the two given vectors.</summary>
<returns>The minimum vector.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.Min(`0,`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.Min``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="MinMagnitude&lt;T&gt;">
Expand Down Expand Up @@ -6734,7 +6734,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.MinMagnitude(`0,`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.MinMagnitude``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="MinMagnitudeNumber&lt;T&gt;">
Expand Down Expand Up @@ -6795,7 +6795,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.MinMagnitudeNumber(`0,`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.MinMagnitudeNumber``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="MinNative&lt;T&gt;">
Expand Down Expand Up @@ -6856,7 +6856,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.MinNative(`0,`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.MinNative``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="MinNumber&lt;T&gt;">
Expand Down Expand Up @@ -6917,7 +6917,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.MinNumber(`0,`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.MinNumber``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="Multiply&lt;T&gt;">
Expand Down
26 changes: 13 additions & 13 deletions xml/System.Numerics/Vector2.xml
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@
<summary>Restricts a vector between a minimum and a maximum value.</summary>
<returns>The restricted vector.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.Clamp(`0,`0,`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.Clamp``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="ClampNative">
Expand Down Expand Up @@ -368,7 +368,7 @@
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.ClampNative(`0,`0,`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.ClampNative``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="CopySign">
Expand Down Expand Up @@ -402,7 +402,7 @@
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.CopySign(`0,`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.CopySign``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<MemberGroup MemberName="CopyTo">
Expand Down Expand Up @@ -1725,7 +1725,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
<summary>Returns a vector whose elements are the maximum of each of the pairs of elements in two specified vectors.</summary>
<returns>The maximized vector.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.Max(`0,`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.Max``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="MaxMagnitude">
Expand Down Expand Up @@ -1759,7 +1759,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.MaxMagnitude(`0,`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.MaxMagnitude``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="MaxMagnitudeNumber">
Expand Down Expand Up @@ -1793,7 +1793,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.MaxMagnitudeNumber(`0,`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.MaxMagnitudeNumber``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="MaxNative">
Expand Down Expand Up @@ -1827,7 +1827,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.MaxNative(`0,`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.MaxNative``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="MaxNumber">
Expand Down Expand Up @@ -1861,7 +1861,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.MaxNumber(`0,`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.MaxNumber``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="Min">
Expand Down Expand Up @@ -1910,7 +1910,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
<summary>Returns a vector whose elements are the minimum of each of the pairs of elements in two specified vectors.</summary>
<returns>The minimized vector.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.Min(`0,`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.Min``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="MinMagnitude">
Expand Down Expand Up @@ -1944,7 +1944,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.MinMagnitude(`0,`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.MinMagnitude``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="MinMagnitudeNumber">
Expand Down Expand Up @@ -1978,7 +1978,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.MinMagnitudeNumber(`0,`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.MinMagnitudeNumber``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="MinNative">
Expand Down Expand Up @@ -2012,7 +2012,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.MinNative(`0,`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.MinNative``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="MinNumber">
Expand Down Expand Up @@ -2046,7 +2046,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.ISimdVector`2.MinNumber(`0,`0)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.MinNumber``1(System.Runtime.Intrinsics.Vector128{``0},System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<MemberGroup MemberName="Multiply">
Expand Down
Loading

0 comments on commit 78d872d

Please sign in to comment.