Skip to content

Commit 1b706fb

Browse files
authored
Fix documentation for Narrow methods in Vector128 (#116582)
* Fix summary documentation for `Narrow` methods in `Vector128` to reflect correct types * Use consistent formatting for type references
1 parent 1ba24c4 commit 1b706fb

File tree

1 file changed

+14
-14
lines changed
  • src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics

1 file changed

+14
-14
lines changed

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

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2637,7 +2637,7 @@ internal static Vector128<TResult> Narrow<TSource, TResult>(Vector128<TSource> l
26372637
return result;
26382638
}
26392639

2640-
/// <summary>Narrows two vector of <see cref="double"/> instances into one vector of <see cref="float" />.</summary>
2640+
/// <summary>Narrows two vector of <see cref="double" /> instances into one vector of <see cref="float" />.</summary>
26412641
/// <param name="lower">The vector that will be narrowed to the lower half of the result vector.</param>
26422642
/// <param name="upper">The vector that will be narrowed to the upper half of the result vector.</param>
26432643
/// <returns>A vector of <see cref="float" /> containing elements narrowed from <paramref name="lower" /> and <paramref name="upper" />.</returns>
@@ -2647,7 +2647,7 @@ internal static Vector128<TResult> Narrow<TSource, TResult>(Vector128<TSource> l
26472647
public static Vector128<float> Narrow(Vector128<double> lower, Vector128<double> upper)
26482648
=> Narrow<double, float>(lower, upper);
26492649

2650-
/// <summary>Narrows two vector of <see cref="short"/> instances into one vector of <see cref="sbyte" />.</summary>
2650+
/// <summary>Narrows two vector of <see cref="short" /> instances into one vector of <see cref="sbyte" />.</summary>
26512651
/// <param name="lower">The vector that will be narrowed to the lower half of the result vector.</param>
26522652
/// <param name="upper">The vector that will be narrowed to the upper half of the result vector.</param>
26532653
/// <returns>A vector of <see cref="sbyte" /> containing elements narrowed from <paramref name="lower" /> and <paramref name="upper" />.</returns>
@@ -2658,7 +2658,7 @@ public static Vector128<float> Narrow(Vector128<double> lower, Vector128<double>
26582658
public static Vector128<sbyte> Narrow(Vector128<short> lower, Vector128<short> upper)
26592659
=> Narrow<short, sbyte>(lower, upper);
26602660

2661-
/// <summary>Narrows two vector of <see cref="int"/> instances into one vector of <see cref="short" />.</summary>
2661+
/// <summary>Narrows two vector of <see cref="int" /> instances into one vector of <see cref="short" />.</summary>
26622662
/// <param name="lower">The vector that will be narrowed to the lower half of the result vector.</param>
26632663
/// <param name="upper">The vector that will be narrowed to the upper half of the result vector.</param>
26642664
/// <returns>A vector of <see cref="short" /> containing elements narrowed from <paramref name="lower" /> and <paramref name="upper" />.</returns>
@@ -2668,7 +2668,7 @@ public static Vector128<sbyte> Narrow(Vector128<short> lower, Vector128<short> u
26682668
public static Vector128<short> Narrow(Vector128<int> lower, Vector128<int> upper)
26692669
=> Narrow<int, short>(lower, upper);
26702670

2671-
/// <summary>Narrows two vector of <see cref="long"/> instances into one vector of <see cref="int" />.</summary>
2671+
/// <summary>Narrows two vector of <see cref="long" /> instances into one vector of <see cref="int" />.</summary>
26722672
/// <param name="lower">The vector that will be narrowed to the lower half of the result vector.</param>
26732673
/// <param name="upper">The vector that will be narrowed to the upper half of the result vector.</param>
26742674
/// <returns>A vector of <see cref="int" /> containing elements narrowed from <paramref name="lower" /> and <paramref name="upper" />.</returns>
@@ -2678,7 +2678,7 @@ public static Vector128<short> Narrow(Vector128<int> lower, Vector128<int> upper
26782678
public static Vector128<int> Narrow(Vector128<long> lower, Vector128<long> upper)
26792679
=> Narrow<long, int>(lower, upper);
26802680

2681-
/// <summary>Narrows two vector of <see cref="byte"/> instances into one vector of <see cref="ushort" />.</summary>
2681+
/// <summary>Narrows two vector of <see cref="ushort" /> instances into one vector of <see cref="byte" />.</summary>
26822682
/// <param name="lower">The vector that will be narrowed to the lower half of the result vector.</param>
26832683
/// <param name="upper">The vector that will be narrowed to the upper half of the result vector.</param>
26842684
/// <returns>A vector of <see cref="byte" /> containing elements narrowed from <paramref name="lower" /> and <paramref name="upper" />.</returns>
@@ -2689,7 +2689,7 @@ public static Vector128<int> Narrow(Vector128<long> lower, Vector128<long> upper
26892689
public static Vector128<byte> Narrow(Vector128<ushort> lower, Vector128<ushort> upper)
26902690
=> Narrow<ushort, byte>(lower, upper);
26912691

2692-
/// <summary>Narrows two vector of <see cref="uint"/> instances into one vector of <see cref="ushort" />.</summary>
2692+
/// <summary>Narrows two vector of <see cref="uint" /> instances into one vector of <see cref="ushort" />.</summary>
26932693
/// <param name="lower">The vector that will be narrowed to the lower half of the result vector.</param>
26942694
/// <param name="upper">The vector that will be narrowed to the upper half of the result vector.</param>
26952695
/// <returns>A vector of <see cref="ushort" /> containing elements narrowed from <paramref name="lower" /> and <paramref name="upper" />.</returns>
@@ -2700,7 +2700,7 @@ public static Vector128<byte> Narrow(Vector128<ushort> lower, Vector128<ushort>
27002700
public static Vector128<ushort> Narrow(Vector128<uint> lower, Vector128<uint> upper)
27012701
=> Narrow<uint, ushort>(lower, upper);
27022702

2703-
/// <summary>Narrows two vector of <see cref="ulong"/> instances into one vector of <see cref="uint" />.</summary>
2703+
/// <summary>Narrows two vector of <see cref="ulong" /> instances into one vector of <see cref="uint" />.</summary>
27042704
/// <param name="lower">The vector that will be narrowed to the lower half of the result vector.</param>
27052705
/// <param name="upper">The vector that will be narrowed to the upper half of the result vector.</param>
27062706
/// <returns>A vector of <see cref="uint" /> containing elements narrowed from <paramref name="lower" /> and <paramref name="upper" />.</returns>
@@ -2734,7 +2734,7 @@ internal static Vector128<TResult> NarrowWithSaturation<TSource, TResult>(Vector
27342734
return result;
27352735
}
27362736

2737-
/// <summary>Narrows two vector of <see cref="double"/> instances into one vector of <see cref="float" /> using a saturating conversion.</summary>
2737+
/// <summary>Narrows two vector of <see cref="double" /> instances into one vector of <see cref="float" /> using a saturating conversion.</summary>
27382738
/// <param name="lower">The vector that will be narrowed to the lower half of the result vector.</param>
27392739
/// <param name="upper">The vector that will be narrowed to the upper half of the result vector.</param>
27402740
/// <returns>A vector of <see cref="float" /> containing elements narrowed with saturation from <paramref name="lower" /> and <paramref name="upper" />.</returns>
@@ -2743,7 +2743,7 @@ internal static Vector128<TResult> NarrowWithSaturation<TSource, TResult>(Vector
27432743
public static Vector128<float> NarrowWithSaturation(Vector128<double> lower, Vector128<double> upper)
27442744
=> NarrowWithSaturation<double, float>(lower, upper);
27452745

2746-
/// <summary>Narrows two vector of <see cref="short"/> instances into one vector of <see cref="sbyte" /> using a saturating conversion.</summary>
2746+
/// <summary>Narrows two vector of <see cref="short" /> instances into one vector of <see cref="sbyte" /> using a saturating conversion.</summary>
27472747
/// <param name="lower">The vector that will be narrowed to the lower half of the result vector.</param>
27482748
/// <param name="upper">The vector that will be narrowed to the upper half of the result vector.</param>
27492749
/// <returns>A vector of <see cref="sbyte" /> containing elements narrowed with saturation from <paramref name="lower" /> and <paramref name="upper" />.</returns>
@@ -2753,7 +2753,7 @@ public static Vector128<float> NarrowWithSaturation(Vector128<double> lower, Vec
27532753
public static Vector128<sbyte> NarrowWithSaturation(Vector128<short> lower, Vector128<short> upper)
27542754
=> NarrowWithSaturation<short, sbyte>(lower, upper);
27552755

2756-
/// <summary>Narrows two vector of <see cref="int"/> instances into one vector of <see cref="short" /> using a saturating conversion.</summary>
2756+
/// <summary>Narrows two vector of <see cref="int" /> instances into one vector of <see cref="short" /> using a saturating conversion.</summary>
27572757
/// <param name="lower">The vector that will be narrowed to the lower half of the result vector.</param>
27582758
/// <param name="upper">The vector that will be narrowed to the upper half of the result vector.</param>
27592759
/// <returns>A vector of <see cref="short" /> containing elements narrowed with saturation from <paramref name="lower" /> and <paramref name="upper" />.</returns>
@@ -2762,7 +2762,7 @@ public static Vector128<sbyte> NarrowWithSaturation(Vector128<short> lower, Vect
27622762
public static Vector128<short> NarrowWithSaturation(Vector128<int> lower, Vector128<int> upper)
27632763
=> NarrowWithSaturation<int, short>(lower, upper);
27642764

2765-
/// <summary>Narrows two vector of <see cref="long"/> instances into one vector of <see cref="int" /> using a saturating conversion.</summary>
2765+
/// <summary>Narrows two vector of <see cref="long" /> instances into one vector of <see cref="int" /> using a saturating conversion.</summary>
27662766
/// <param name="lower">The vector that will be narrowed to the lower half of the result vector.</param>
27672767
/// <param name="upper">The vector that will be narrowed to the upper half of the result vector.</param>
27682768
/// <returns>A vector of <see cref="int" /> containing elements narrowed with saturation from <paramref name="lower" /> and <paramref name="upper" />.</returns>
@@ -2771,7 +2771,7 @@ public static Vector128<short> NarrowWithSaturation(Vector128<int> lower, Vector
27712771
public static Vector128<int> NarrowWithSaturation(Vector128<long> lower, Vector128<long> upper)
27722772
=> NarrowWithSaturation<long, int>(lower, upper);
27732773

2774-
/// <summary>Narrows two vector of <see cref="byte"/> instances into one vector of <see cref="ushort" /> using a saturating conversion.</summary>
2774+
/// <summary>Narrows two vector of <see cref="ushort" /> instances into one vector of <see cref="byte" /> using a saturating conversion.</summary>
27752775
/// <param name="lower">The vector that will be narrowed to the lower half of the result vector.</param>
27762776
/// <param name="upper">The vector that will be narrowed to the upper half of the result vector.</param>
27772777
/// <returns>A vector of <see cref="byte" /> containing elements narrowed with saturation from <paramref name="lower" /> and <paramref name="upper" />.</returns>
@@ -2781,7 +2781,7 @@ public static Vector128<int> NarrowWithSaturation(Vector128<long> lower, Vector1
27812781
public static Vector128<byte> NarrowWithSaturation(Vector128<ushort> lower, Vector128<ushort> upper)
27822782
=> NarrowWithSaturation<ushort, byte>(lower, upper);
27832783

2784-
/// <summary>Narrows two vector of <see cref="uint"/> instances into one vector of <see cref="ushort" /> using a saturating conversion.</summary>
2784+
/// <summary>Narrows two vector of <see cref="uint" /> instances into one vector of <see cref="ushort" /> using a saturating conversion.</summary>
27852785
/// <param name="lower">The vector that will be narrowed to the lower half of the result vector.</param>
27862786
/// <param name="upper">The vector that will be narrowed to the upper half of the result vector.</param>
27872787
/// <returns>A vector of <see cref="ushort" /> containing elements narrowed with saturation from <paramref name="lower" /> and <paramref name="upper" />.</returns>
@@ -2791,7 +2791,7 @@ public static Vector128<byte> NarrowWithSaturation(Vector128<ushort> lower, Vect
27912791
public static Vector128<ushort> NarrowWithSaturation(Vector128<uint> lower, Vector128<uint> upper)
27922792
=> NarrowWithSaturation<uint, ushort>(lower, upper);
27932793

2794-
/// <summary>Narrows two vector of <see cref="ulong"/> instances into one vector of <see cref="uint" /> using a saturating conversion.</summary>
2794+
/// <summary>Narrows two vector of <see cref="ulong" /> instances into one vector of <see cref="uint" /> using a saturating conversion.</summary>
27952795
/// <param name="lower">The vector that will be narrowed to the lower half of the result vector.</param>
27962796
/// <param name="upper">The vector that will be narrowed to the upper half of the result vector.</param>
27972797
/// <returns>A vector of <see cref="uint" /> containing elements narrowed with saturation from <paramref name="lower" /> and <paramref name="upper" />.</returns>

0 commit comments

Comments
 (0)