Skip to content

Fix various inheritdoc so there is only "one indirection" #12052

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
merged 3 commits into from
Nov 17, 2025
Merged

Fix various inheritdoc so there is only "one indirection" #12052

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c745dbd
Fix various inheritdoc so there is only "one indirection"
tannergooding Nov 17, 2025
9993f66
Respond to PR feedback
tannergooding Nov 17, 2025
09279d2
Respond to PR feedback
tannergooding Nov 17, 2025
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
16 changes: 8 additions & 8 deletions xml/System.Numerics/Vector.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3982,7 +3982,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.Numerics.Vector.ExtractMostSignificantBits(System.Numerics.Vector4)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.ExtractMostSignificantBits``1(System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="ExtractMostSignificantBits">
Expand Down Expand Up @@ -4017,7 +4017,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.Numerics.Vector.ExtractMostSignificantBits(System.Numerics.Vector4)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.ExtractMostSignificantBits``1(System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="ExtractMostSignificantBits">
Expand Down Expand Up @@ -4243,7 +4243,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.Numerics.Vector.GetElement(System.Numerics.Vector4,System.Int32)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.GetElement``1(System.Runtime.Intrinsics.Vector128{``0},System.Int32)" />
</Docs>
</Member>
<Member MemberName="GetElement">
Expand Down Expand Up @@ -4274,7 +4274,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.Numerics.Vector.GetElement(System.Numerics.Vector4,System.Int32)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.GetElement``1(System.Runtime.Intrinsics.Vector128{``0},System.Int32)" />
</Docs>
</Member>
<Member MemberName="GetElement">
Expand Down Expand Up @@ -11279,7 +11279,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.Numerics.Vector.ToScalar(System.Numerics.Vector4)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.ToScalar``1(System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="ToScalar">
Expand Down Expand Up @@ -11308,7 +11308,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.Numerics.Vector.ToScalar(System.Numerics.Vector4)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.ToScalar``1(System.Runtime.Intrinsics.Vector128{``0})" />
</Docs>
</Member>
<Member MemberName="ToScalar">
Expand Down Expand Up @@ -12314,7 +12314,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.Numerics.Vector.WithElement(System.Numerics.Vector4,System.Int32,System.Single)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.WithElement``1(System.Runtime.Intrinsics.Vector128{``0},System.Int32,``0)" />
</Docs>
</Member>
<Member MemberName="WithElement">
Expand Down Expand Up @@ -12347,7 +12347,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.Numerics.Vector.WithElement(System.Numerics.Vector4,System.Int32,System.Single)" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.WithElement``1(System.Runtime.Intrinsics.Vector128{``0},System.Int32,``0)" />
</Docs>
</Member>
<Member MemberName="WithElement">
Expand Down
147 changes: 73 additions & 74 deletions xml/System.Numerics/Vector2.xml
View file
Open in desktop

Large diffs are not rendered by default.

147 changes: 73 additions & 74 deletions xml/System.Numerics/Vector3.xml
View file
Open in desktop

Large diffs are not rendered by default.

3 changes: 1 addition & 2 deletions xml/System.Numerics/Vector4.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2016,7 +2016,7 @@
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.MultiplyAddEstimate(System.Runtime.Intrinsics.Vector128{System.Single},System.Runtime.Intrinsics.Vector128{System.Single},System.Runtime.Intrinsics.Vector128{System.Single})" />
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.FusedMultiplyAdd(System.Runtime.Intrinsics.Vector128{System.Single},System.Runtime.Intrinsics.Vector128{System.Single},System.Runtime.Intrinsics.Vector128{System.Single})" />
</Docs>
</Member>
<Member MemberName="GetHashCode">
Expand Down Expand Up @@ -3100,7 +3100,6 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi

]]></format>
</remarks>
<inheritdoc cref="M:System.Numerics.Vector4.Lerp(System.Numerics.Vector4,System.Numerics.Vector4,System.Numerics.Vector4)" />
</Docs>
</Member>
<Member MemberName="LessThan">
Expand Down
4 changes: 2 additions & 2 deletions xml/System.Numerics/Vector`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2257,9 +2257,9 @@ The type `T` can be any of the following numeric types:
<Docs>
<param name="left">The first vector to compare.</param>
<param name="right">The second vector to compare.</param>
<summary>Returns a value that indicates whether any single pair of elements in the specified vectors is equal.</summary>
<summary>Returns a value that indicates whether any single pair of elements in the specified vectors is not equal.</summary>
<returns>
<see langword="true" /> if any element pairs in left and right are equal. <see langword="false" /> if no element pairs are equal.</returns>
<see langword="true" /> if any element pairs in left and right are not equal. <see langword="false" /> if all element pairs are equal.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.NotSupportedException">.NET 5 and later: Type <see langword="T" /> is not supported.</exception>
</Docs>
Expand Down
Loading