Skip to content

Commit d7a3c99

Browse files
Fix various inheritdoc so there is only "one indirection" (#12052)
* Fix various inheritdoc so there is only "one indirection" * Respond to PR feedback * Respond to PR feedback
1 parent 9894846 commit d7a3c99

File tree

8 files changed

+682
-685
lines changed

8 files changed

+682
-685
lines changed

xml/System.Numerics/Vector.xml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3982,7 +3982,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
39823982
<summary>To be added.</summary>
39833983
<returns>To be added.</returns>
39843984
<remarks>To be added.</remarks>
3985-
<inheritdoc cref="M:System.Numerics.Vector.ExtractMostSignificantBits(System.Numerics.Vector4)" />
3985+
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.ExtractMostSignificantBits``1(System.Runtime.Intrinsics.Vector128{``0})" />
39863986
</Docs>
39873987
</Member>
39883988
<Member MemberName="ExtractMostSignificantBits">
@@ -4017,7 +4017,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
40174017
<summary>To be added.</summary>
40184018
<returns>To be added.</returns>
40194019
<remarks>To be added.</remarks>
4020-
<inheritdoc cref="M:System.Numerics.Vector.ExtractMostSignificantBits(System.Numerics.Vector4)" />
4020+
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.ExtractMostSignificantBits``1(System.Runtime.Intrinsics.Vector128{``0})" />
40214021
</Docs>
40224022
</Member>
40234023
<Member MemberName="ExtractMostSignificantBits">
@@ -4243,7 +4243,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
42434243
<summary>To be added.</summary>
42444244
<returns>To be added.</returns>
42454245
<remarks>To be added.</remarks>
4246-
<inheritdoc cref="M:System.Numerics.Vector.GetElement(System.Numerics.Vector4,System.Int32)" />
4246+
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.GetElement``1(System.Runtime.Intrinsics.Vector128{``0},System.Int32)" />
42474247
</Docs>
42484248
</Member>
42494249
<Member MemberName="GetElement">
@@ -4274,7 +4274,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
42744274
<summary>To be added.</summary>
42754275
<returns>To be added.</returns>
42764276
<remarks>To be added.</remarks>
4277-
<inheritdoc cref="M:System.Numerics.Vector.GetElement(System.Numerics.Vector4,System.Int32)" />
4277+
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.GetElement``1(System.Runtime.Intrinsics.Vector128{``0},System.Int32)" />
42784278
</Docs>
42794279
</Member>
42804280
<Member MemberName="GetElement">
@@ -11279,7 +11279,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
1127911279
<summary>To be added.</summary>
1128011280
<returns>To be added.</returns>
1128111281
<remarks>To be added.</remarks>
11282-
<inheritdoc cref="M:System.Numerics.Vector.ToScalar(System.Numerics.Vector4)" />
11282+
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.ToScalar``1(System.Runtime.Intrinsics.Vector128{``0})" />
1128311283
</Docs>
1128411284
</Member>
1128511285
<Member MemberName="ToScalar">
@@ -11308,7 +11308,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
1130811308
<summary>To be added.</summary>
1130911309
<returns>To be added.</returns>
1131011310
<remarks>To be added.</remarks>
11311-
<inheritdoc cref="M:System.Numerics.Vector.ToScalar(System.Numerics.Vector4)" />
11311+
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.ToScalar``1(System.Runtime.Intrinsics.Vector128{``0})" />
1131211312
</Docs>
1131311313
</Member>
1131411314
<Member MemberName="ToScalar">
@@ -12314,7 +12314,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
1231412314
<summary>To be added.</summary>
1231512315
<returns>To be added.</returns>
1231612316
<remarks>To be added.</remarks>
12317-
<inheritdoc cref="M:System.Numerics.Vector.WithElement(System.Numerics.Vector4,System.Int32,System.Single)" />
12317+
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.WithElement``1(System.Runtime.Intrinsics.Vector128{``0},System.Int32,``0)" />
1231812318
</Docs>
1231912319
</Member>
1232012320
<Member MemberName="WithElement">
@@ -12347,7 +12347,7 @@ Note that this method returns a <xref:System.Single> instead of an integral type
1234712347
<summary>To be added.</summary>
1234812348
<returns>To be added.</returns>
1234912349
<remarks>To be added.</remarks>
12350-
<inheritdoc cref="M:System.Numerics.Vector.WithElement(System.Numerics.Vector4,System.Int32,System.Single)" />
12350+
<inheritdoc cref="M:System.Runtime.Intrinsics.Vector128.WithElement``1(System.Runtime.Intrinsics.Vector128{``0},System.Int32,``0)" />
1235112351
</Docs>
1235212352
</Member>
1235312353
<Member MemberName="WithElement">

xml/System.Numerics/Vector2.xml

Lines changed: 73 additions & 74 deletions
Large diffs are not rendered by default.

xml/System.Numerics/Vector3.xml

Lines changed: 73 additions & 74 deletions
Large diffs are not rendered by default.

xml/System.Numerics/Vector4.xml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2016,7 +2016,7 @@
20162016
<summary>To be added.</summary>
20172017
<returns>To be added.</returns>
20182018
<remarks>To be added.</remarks>
2019-
<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})" />
2019+
<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})" />
20202020
</Docs>
20212021
</Member>
20222022
<Member MemberName="GetHashCode">
@@ -3100,7 +3100,6 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi
31003100
31013101
]]></format>
31023102
</remarks>
3103-
<inheritdoc cref="M:System.Numerics.Vector4.Lerp(System.Numerics.Vector4,System.Numerics.Vector4,System.Numerics.Vector4)" />
31043103
</Docs>
31053104
</Member>
31063105
<Member MemberName="LessThan">

xml/System.Numerics/Vector`1.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2257,9 +2257,9 @@ The type `T` can be any of the following numeric types:
22572257
<Docs>
22582258
<param name="left">The first vector to compare.</param>
22592259
<param name="right">The second vector to compare.</param>
2260-
<summary>Returns a value that indicates whether any single pair of elements in the specified vectors is equal.</summary>
2260+
<summary>Returns a value that indicates whether any single pair of elements in the specified vectors is not equal.</summary>
22612261
<returns>
2262-
<see langword="true" /> if any element pairs in left and right are equal. <see langword="false" /> if no element pairs are equal.</returns>
2262+
<see langword="true" /> if any element pairs in left and right are not equal. <see langword="false" /> if all element pairs are equal.</returns>
22632263
<remarks>To be added.</remarks>
22642264
<exception cref="T:System.NotSupportedException">.NET 5 and later: Type <see langword="T" /> is not supported.</exception>
22652265
</Docs>

0 commit comments

Comments
 (0)