Skip to content

Fix some mismatches in <inheritdoc /> #115653

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
jkotas merged 2 commits into from
May 17, 2025
Merged

Fix some mismatches in <inheritdoc /> #115653

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9c6b0f9
Fix some mismatches in <inheritdoc />
rhuijben May 16, 2025
2841961
Fix reference to IsSynchronized, by pointing towards not generic inte…
rhuijben May 16, 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
2 changes: 1 addition & 1 deletion src/libraries/System.Collections/src/System/Collections/Generic/Stack.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public Stack(IEnumerable<T> collection)
/// </summary>
public int Capacity => _array.Length;

/// <inheritdoc cref="ICollection{T}"/>
/// <inheritdoc cref="ICollection.IsSynchronized" />
bool ICollection.IsSynchronized => false;

object ICollection.SyncRoot => this;
Expand Down
2 changes: 1 addition & 1 deletion src/libraries/System.Private.CoreLib/src/System/Collections/Generic/Queue.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ public Queue(IEnumerable<T> collection)
/// </summary>
public int Capacity => _array.Length;

/// <inheritdoc cref="ICollection{T}"/>
/// <inheritdoc cref="ICollection.IsSynchronized" />
bool ICollection.IsSynchronized => false;

object ICollection.SyncRoot => this;
Expand Down
4 changes: 2 additions & 2 deletions src/libraries/System.Private.CoreLib/src/System/Numerics/Vector2.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -715,11 +715,11 @@ public static Vector2 LoadUnsafe(ref readonly float source, nuint elementOffset)
return Unsafe.ReadUnaligned<Vector2>(in address);
}

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

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

Expand Down
4 changes: 2 additions & 2 deletions src/libraries/System.Private.CoreLib/src/System/Numerics/Vector3.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -748,11 +748,11 @@ public static Vector3 LoadUnsafe(ref readonly float source, nuint elementOffset)
return Unsafe.ReadUnaligned<Vector3>(in address);
}

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

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

Expand Down
4 changes: 2 additions & 2 deletions src/libraries/System.Private.CoreLib/src/System/Runtime/InteropServices/NFloat.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1247,7 +1247,7 @@ bool IFloatingPoint<NFloat>.TryWriteSignificandLittleEndian(Span<byte> destinati
/// <inheritdoc cref="INumber{TSelf}.Clamp(TSelf, TSelf, TSelf)" />
public static NFloat Clamp(NFloat value, NFloat min, NFloat max) => new NFloat(NativeType.Clamp(value._value, min._value, max._value));

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

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

/// <inheritdoc cref="ITrigonometricFunctions{TSelf}.SinCos(TSelf)" />
/// <inheritdoc cref="ITrigonometricFunctions{TSelf}.SinCosPi(TSelf)" />
public static (NFloat SinPi, NFloat CosPi) SinCosPi(NFloat x)
{
var (sinPi, cosPi) = NativeType.SinCosPi(x._value);
Expand Down
4 changes: 2 additions & 2 deletions src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Vector128.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3743,7 +3743,7 @@ public static Vector128<float> Sin(Vector128<float> vector)
}
}

/// <inheritdoc cref="Vector64.Cos(Vector64{double})" />
/// <inheritdoc cref="Vector64.SinCos(Vector64{double})" />
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static (Vector128<double> Sin, Vector128<double> Cos) SinCos(Vector128<double> vector)
{
Expand All @@ -3763,7 +3763,7 @@ public static (Vector128<double> Sin, Vector128<double> Cos) SinCos(Vector128<do
}
}

/// <inheritdoc cref="Vector64.Cos(Vector64{float})" />
/// <inheritdoc cref="Vector64.SinCos(Vector64{float})" />
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static (Vector128<float> Sin, Vector128<float> Cos) SinCos(Vector128<float> vector)
{
Expand Down
4 changes: 2 additions & 2 deletions src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Vector256.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3735,7 +3735,7 @@ public static Vector256<float> Sin(Vector256<float> vector)
}
}

/// <inheritdoc cref="Vector128.Cos(Vector128{double})" />
/// <inheritdoc cref="Vector128.SinCos(Vector128{double})" />
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static (Vector256<double> Sin, Vector256<double> Cos) SinCos(Vector256<double> vector)
{
Expand All @@ -3755,7 +3755,7 @@ public static (Vector256<double> Sin, Vector256<double> Cos) SinCos(Vector256<do
}
}

/// <inheritdoc cref="Vector128.Cos(Vector128{float})" />
/// <inheritdoc cref="Vector128.SinCos(Vector128{float})" />
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static (Vector256<float> Sin, Vector256<float> Cos) SinCos(Vector256<float> vector)
{
Expand Down
4 changes: 2 additions & 2 deletions src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Vector512.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3753,7 +3753,7 @@ public static Vector512<float> Sin(Vector512<float> vector)
}
}

/// <inheritdoc cref="Vector256.Cos(Vector256{double})" />
/// <inheritdoc cref="Vector256.SinCos(Vector256{double})" />
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static (Vector512<double> Sin, Vector512<double> Cos) SinCos(Vector512<double> vector)
{
Expand All @@ -3773,7 +3773,7 @@ public static (Vector512<double> Sin, Vector512<double> Cos) SinCos(Vector512<do
}
}

/// <inheritdoc cref="Vector256.Cos(Vector256{float})" />
/// <inheritdoc cref="Vector256.SinCos(Vector256{float})" />
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static (Vector512<float> Sin, Vector512<float> Cos) SinCos(Vector512<float> vector)
{
Expand Down
2 changes: 1 addition & 1 deletion src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Vector64_1.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -528,7 +528,7 @@ private string ToString([StringSyntax(StringSyntaxAttribute.NumericFormat)] stri
/// <inheritdoc cref="ISimdVector{TSelf, T}.Alignment" />
static int ISimdVector<Vector64<T>, T>.Alignment => Vector64.Alignment;

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

/// <inheritdoc cref="ISimdVector{TSelf, T}.IsHardwareAccelerated" />
Expand Down
Loading