Skip to content

Commit 058b1ef

Browse files
authored
Fix some mismatches in <inheritdoc /> (#115653)
* Fix some mismatches in <inheritdoc /> * Fix reference to IsSynchronized, by pointing towards not generic interface
1 parent 5ac238b commit 058b1ef

File tree

9 files changed

+15
-15
lines changed

9 files changed

+15
-15
lines changed

src/libraries/System.Collections/src/System/Collections/Generic/Stack.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ public Stack(IEnumerable<T> collection)
6262
/// </summary>
6363
public int Capacity => _array.Length;
6464

65-
/// <inheritdoc cref="ICollection{T}"/>
65+
/// <inheritdoc cref="ICollection.IsSynchronized" />
6666
bool ICollection.IsSynchronized => false;
6767

6868
object ICollection.SyncRoot => this;

src/libraries/System.Private.CoreLib/src/System/Collections/Generic/Queue.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ public Queue(IEnumerable<T> collection)
5959
/// </summary>
6060
public int Capacity => _array.Length;
6161

62-
/// <inheritdoc cref="ICollection{T}"/>
62+
/// <inheritdoc cref="ICollection.IsSynchronized" />
6363
bool ICollection.IsSynchronized => false;
6464

6565
object ICollection.SyncRoot => this;

src/libraries/System.Private.CoreLib/src/System/Numerics/Vector2.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -715,11 +715,11 @@ public static Vector2 LoadUnsafe(ref readonly float source, nuint elementOffset)
715715
return Unsafe.ReadUnaligned<Vector2>(in address);
716716
}
717717

718-
/// <inheritdoc cref="Vector4.Log2(Vector4)" />
718+
/// <inheritdoc cref="Vector4.Log(Vector4)" />
719719
[MethodImpl(MethodImplOptions.AggressiveInlining)]
720720
public static Vector2 Log(Vector2 vector) => Vector128.Log(Vector4.Create(vector, 1.0f, 1.0f).AsVector128()).AsVector2();
721721

722-
/// <inheritdoc cref="Vector4.Log(Vector4)" />
722+
/// <inheritdoc cref="Vector4.Log2(Vector4)" />
723723
[MethodImpl(MethodImplOptions.AggressiveInlining)]
724724
public static Vector2 Log2(Vector2 vector) => Vector128.Log2(Vector4.Create(vector, 1.0f, 1.0f).AsVector128()).AsVector2();
725725

src/libraries/System.Private.CoreLib/src/System/Numerics/Vector3.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -748,11 +748,11 @@ public static Vector3 LoadUnsafe(ref readonly float source, nuint elementOffset)
748748
return Unsafe.ReadUnaligned<Vector3>(in address);
749749
}
750750

751-
/// <inheritdoc cref="Vector4.Log2(Vector4)" />
751+
/// <inheritdoc cref="Vector4.Log(Vector4)" />
752752
[MethodImpl(MethodImplOptions.AggressiveInlining)]
753753
public static Vector3 Log(Vector3 vector) => Vector128.Log(Vector4.Create(vector, 1.0f).AsVector128()).AsVector3();
754754

755-
/// <inheritdoc cref="Vector4.Log(Vector4)" />
755+
/// <inheritdoc cref="Vector4.Log2(Vector4)" />
756756
[MethodImpl(MethodImplOptions.AggressiveInlining)]
757757
public static Vector3 Log2(Vector3 vector) => Vector128.Log2(Vector4.Create(vector, 1.0f).AsVector128()).AsVector3();
758758

src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/NFloat.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1247,7 +1247,7 @@ bool IFloatingPoint<NFloat>.TryWriteSignificandLittleEndian(Span<byte> destinati
12471247
/// <inheritdoc cref="INumber{TSelf}.Clamp(TSelf, TSelf, TSelf)" />
12481248
public static NFloat Clamp(NFloat value, NFloat min, NFloat max) => new NFloat(NativeType.Clamp(value._value, min._value, max._value));
12491249

1250-
/// <inheritdoc cref="INumber{TSelf}.Clamp(TSelf, TSelf, TSelf)" />
1250+
/// <inheritdoc cref="INumber{TSelf}.ClampNative(TSelf, TSelf, TSelf)" />
12511251
public static NFloat ClampNative(NFloat value, NFloat min, NFloat max) => new NFloat(NativeType.ClampNative(value._value, min._value, max._value));
12521252

12531253
/// <inheritdoc cref="INumber{TSelf}.CopySign(TSelf, TSelf)" />
@@ -1889,7 +1889,7 @@ public static (NFloat Sin, NFloat Cos) SinCos(NFloat x)
18891889
return (new NFloat(sin), new NFloat(cos));
18901890
}
18911891

1892-
/// <inheritdoc cref="ITrigonometricFunctions{TSelf}.SinCos(TSelf)" />
1892+
/// <inheritdoc cref="ITrigonometricFunctions{TSelf}.SinCosPi(TSelf)" />
18931893
public static (NFloat SinPi, NFloat CosPi) SinCosPi(NFloat x)
18941894
{
18951895
var (sinPi, cosPi) = NativeType.SinCosPi(x._value);

src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Vector128.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3743,7 +3743,7 @@ public static Vector128<float> Sin(Vector128<float> vector)
37433743
}
37443744
}
37453745

3746-
/// <inheritdoc cref="Vector64.Cos(Vector64{double})" />
3746+
/// <inheritdoc cref="Vector64.SinCos(Vector64{double})" />
37473747
[MethodImpl(MethodImplOptions.AggressiveInlining)]
37483748
public static (Vector128<double> Sin, Vector128<double> Cos) SinCos(Vector128<double> vector)
37493749
{
@@ -3763,7 +3763,7 @@ public static (Vector128<double> Sin, Vector128<double> Cos) SinCos(Vector128<do
37633763
}
37643764
}
37653765

3766-
/// <inheritdoc cref="Vector64.Cos(Vector64{float})" />
3766+
/// <inheritdoc cref="Vector64.SinCos(Vector64{float})" />
37673767
[MethodImpl(MethodImplOptions.AggressiveInlining)]
37683768
public static (Vector128<float> Sin, Vector128<float> Cos) SinCos(Vector128<float> vector)
37693769
{

src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Vector256.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3735,7 +3735,7 @@ public static Vector256<float> Sin(Vector256<float> vector)
37353735
}
37363736
}
37373737

3738-
/// <inheritdoc cref="Vector128.Cos(Vector128{double})" />
3738+
/// <inheritdoc cref="Vector128.SinCos(Vector128{double})" />
37393739
[MethodImpl(MethodImplOptions.AggressiveInlining)]
37403740
public static (Vector256<double> Sin, Vector256<double> Cos) SinCos(Vector256<double> vector)
37413741
{
@@ -3755,7 +3755,7 @@ public static (Vector256<double> Sin, Vector256<double> Cos) SinCos(Vector256<do
37553755
}
37563756
}
37573757

3758-
/// <inheritdoc cref="Vector128.Cos(Vector128{float})" />
3758+
/// <inheritdoc cref="Vector128.SinCos(Vector128{float})" />
37593759
[MethodImpl(MethodImplOptions.AggressiveInlining)]
37603760
public static (Vector256<float> Sin, Vector256<float> Cos) SinCos(Vector256<float> vector)
37613761
{

src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Vector512.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3753,7 +3753,7 @@ public static Vector512<float> Sin(Vector512<float> vector)
37533753
}
37543754
}
37553755

3756-
/// <inheritdoc cref="Vector256.Cos(Vector256{double})" />
3756+
/// <inheritdoc cref="Vector256.SinCos(Vector256{double})" />
37573757
[MethodImpl(MethodImplOptions.AggressiveInlining)]
37583758
public static (Vector512<double> Sin, Vector512<double> Cos) SinCos(Vector512<double> vector)
37593759
{
@@ -3773,7 +3773,7 @@ public static (Vector512<double> Sin, Vector512<double> Cos) SinCos(Vector512<do
37733773
}
37743774
}
37753775

3776-
/// <inheritdoc cref="Vector256.Cos(Vector256{float})" />
3776+
/// <inheritdoc cref="Vector256.SinCos(Vector256{float})" />
37773777
[MethodImpl(MethodImplOptions.AggressiveInlining)]
37783778
public static (Vector512<float> Sin, Vector512<float> Cos) SinCos(Vector512<float> vector)
37793779
{

src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Vector64_1.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -528,7 +528,7 @@ private string ToString([StringSyntax(StringSyntaxAttribute.NumericFormat)] stri
528528
/// <inheritdoc cref="ISimdVector{TSelf, T}.Alignment" />
529529
static int ISimdVector<Vector64<T>, T>.Alignment => Vector64.Alignment;
530530

531-
/// <inheritdoc cref="ISimdVector{TSelf, T}.Count" />
531+
/// <inheritdoc cref="ISimdVector{TSelf, T}.ElementCount" />
532532
static int ISimdVector<Vector64<T>, T>.ElementCount => Vector64<T>.Count;
533533

534534
/// <inheritdoc cref="ISimdVector{TSelf, T}.IsHardwareAccelerated" />

0 commit comments

Comments
 (0)