Skip to content

Commit c1b51f9

Browse files
tannergoodingtannergooding
committed
Ensure XML doc comments exist for the nested classes and IsSupported properties for intrinsics
1 parent 5921be3 commit c1b51f9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+270
-109
lines changed

‎src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/AdvSimd.PlatformNotSupported.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,7 @@ internal AdvSimd() { }
150150
// public static Vector64<float> MultiplySubtractScalar(Vector64<float> minuend, Vector64<float> left, Vector64<float> right) { throw new PlatformNotSupportedException(); }
151151
// }
152152

153+
/// <summary>This class provides access to the ARM AdvSIMD hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
153154
public new abstract class Arm64 : ArmBase.Arm64
154155
{
155156
internal Arm64() { }

‎src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/AdvSimd.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ public abstract class AdvSimd : ArmBase
1515
{
1616
internal AdvSimd() { }
1717

18+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
1819
public static new bool IsSupported { get => IsSupported; }
1920

2021
// [Intrinsic]
@@ -147,11 +148,13 @@ internal AdvSimd() { }
147148
// public static Vector64<float> MultiplySubtractScalar(Vector64<float> minuend, Vector64<float> left, Vector64<float> right) => MultiplySubtractScalar(minuend, left, right);
148149
// }
149150

151+
/// <summary>This class provides access to the ARM AdvSIMD hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
150152
[Intrinsic]
151153
public new abstract class Arm64 : ArmBase.Arm64
152154
{
153155
internal Arm64() { }
154156

157+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
155158
public static new bool IsSupported { get => IsSupported; }
156159

157160
/// <summary>

‎src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/Aes.PlatformNotSupported.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,15 @@ public abstract class Aes : ArmBase
1313
{
1414
internal Aes() { }
1515

16+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
1617
public static new bool IsSupported { [Intrinsic] get => false; }
1718

19+
/// <summary>This class provides access to the ARM AES hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
1820
public new abstract class Arm64 : ArmBase.Arm64
1921
{
2022
internal Arm64() { }
2123

24+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
2225
public static new bool IsSupported { [Intrinsic] get { return false; } }
2326
}
2427

‎src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/Aes.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,16 @@ public abstract class Aes : ArmBase
1414
{
1515
internal Aes() { }
1616

17+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
1718
public static new bool IsSupported { get => IsSupported; }
1819

20+
/// <summary>This class provides access to the ARM AES hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
1921
[Intrinsic]
2022
public new abstract class Arm64 : ArmBase.Arm64
2123
{
2224
internal Arm64() { }
2325

26+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
2427
public static new bool IsSupported { get => IsSupported; }
2528
}
2629

‎src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/ArmBase.PlatformNotSupported.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,15 @@ abstract class ArmBase
1818
{
1919
internal ArmBase() { }
2020

21+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
2122
public static bool IsSupported { [Intrinsic] get => false; }
2223

24+
/// <summary>This class provides access to the ARM base hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
2325
public abstract class Arm64
2426
{
2527
internal Arm64() { }
2628

29+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
2730
public static bool IsSupported { [Intrinsic] get => false; }
2831

2932
/// <summary>

‎src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/ArmBase.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,16 @@ public abstract class ArmBase
1414
{
1515
internal ArmBase() { }
1616

17+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
1718
public static bool IsSupported { get => IsSupported; }
1819

20+
/// <summary>This class provides access to the ARM base hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
1921
[Intrinsic]
2022
public abstract class Arm64
2123
{
2224
internal Arm64() { }
2325

26+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
2427
public static bool IsSupported { get => IsSupported; }
2528

2629
/// <summary>

‎src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/Crc32.PlatformNotSupported.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,15 @@ public abstract class Crc32 : ArmBase
1313
{
1414
internal Crc32() { }
1515

16+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
1617
public static new bool IsSupported { [Intrinsic] get { return false; } }
1718

19+
/// <summary>This class provides access to the ARM Crc32 hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
1820
public new abstract class Arm64 : ArmBase.Arm64
1921
{
2022
internal Arm64() { }
2123

24+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
2225
public static new bool IsSupported { [Intrinsic] get { return false; } }
2326

2427
/// <summary>

‎src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/Crc32.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,16 @@ public abstract class Crc32 : ArmBase
1414
{
1515
internal Crc32() { }
1616

17+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
1718
public static new bool IsSupported { get => IsSupported; }
1819

20+
/// <summary>This class provides access to the ARM Crc32 hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
1921
[Intrinsic]
2022
public new abstract class Arm64 : ArmBase.Arm64
2123
{
2224
internal Arm64() { }
2325

26+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
2427
public static new bool IsSupported { get => IsSupported; }
2528

2629
/// <summary>

‎src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/Dp.PlatformNotSupported.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,15 @@ public abstract class Dp : AdvSimd
1414
{
1515
internal Dp() { }
1616

17+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
1718
public static new bool IsSupported { [Intrinsic] get => false; }
1819

20+
/// <summary>This class provides access to the ARMv8.2-DotProd hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
1921
public new abstract class Arm64 : AdvSimd.Arm64
2022
{
2123
internal Arm64() { }
2224

25+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
2326
public static new bool IsSupported { [Intrinsic] get { return false; } }
2427
}
2528

‎src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/Dp.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,16 @@ public abstract class Dp : AdvSimd
1515
{
1616
internal Dp() { }
1717

18+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
1819
public static new bool IsSupported { get => IsSupported; }
1920

21+
/// <summary>This class provides access to the ARMv8.2-DotProd hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
2022
[Intrinsic]
2123
public new abstract class Arm64 : AdvSimd.Arm64
2224
{
2325
internal Arm64() { }
2426

27+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
2528
public static new bool IsSupported { get => IsSupported; }
2629
}
2730

‎src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/Rdm.PlatformNotSupported.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,15 @@ public abstract class Rdm : AdvSimd
1414
{
1515
internal Rdm() { }
1616

17+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
1718
public static new bool IsSupported { [Intrinsic] get => false; }
1819

20+
/// <summary>This class provides access to the ARMv8.1-RDMA hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
1921
public new abstract class Arm64 : AdvSimd.Arm64
2022
{
2123
internal Arm64() { }
2224

25+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
2326
public static new bool IsSupported { [Intrinsic] get { return false; } }
2427

2528
/// <summary>

‎src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/Rdm.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,16 @@ public abstract class Rdm : AdvSimd
1515
{
1616
internal Rdm() { }
1717

18+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
1819
public static new bool IsSupported { get => IsSupported; }
1920

21+
/// <summary>This class provides access to the ARMv8.1-RDMA hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
2022
[Intrinsic]
2123
public new abstract class Arm64 : AdvSimd.Arm64
2224
{
2325
internal Arm64() { }
2426

27+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
2528
public static new bool IsSupported { get => IsSupported; }
2629

2730
/// <summary>

‎src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/Sha1.PlatformNotSupported.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,15 @@ public abstract class Sha1 : ArmBase
1313
{
1414
internal Sha1() { }
1515

16+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
1617
public static new bool IsSupported { [Intrinsic] get => false; }
1718

19+
/// <summary>This class provides access to the ARM SHA1 hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
1820
public new abstract class Arm64 : ArmBase.Arm64
1921
{
2022
internal Arm64() { }
2123

24+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
2225
public static new bool IsSupported { [Intrinsic] get { return false; } }
2326
}
2427

‎src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/Sha1.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,16 @@ public abstract class Sha1 : ArmBase
1414
{
1515
internal Sha1() { }
1616

17+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
1718
public static new bool IsSupported { get => IsSupported; }
1819

20+
/// <summary>This class provides access to the ARM SHA1 hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
1921
[Intrinsic]
2022
public new abstract class Arm64 : ArmBase.Arm64
2123
{
2224
internal Arm64() { }
2325

26+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
2427
public static new bool IsSupported { get => IsSupported; }
2528
}
2629

‎src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/Sha256.PlatformNotSupported.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,15 @@ public abstract class Sha256 : ArmBase
1313
{
1414
internal Sha256() { }
1515

16+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
1617
public static new bool IsSupported { [Intrinsic] get => false; }
1718

19+
/// <summary>This class provides access to the ARM SHA256 hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
1820
public new abstract class Arm64 : ArmBase.Arm64
1921
{
2022
internal Arm64() { }
2123

24+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
2225
public static new bool IsSupported { [Intrinsic] get { return false; } }
2326
}
2427

‎src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/Sha256.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,16 @@ public abstract class Sha256 : ArmBase
1414
{
1515
internal Sha256() { }
1616

17+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
1718
public static new bool IsSupported { get => IsSupported; }
1819

20+
/// <summary>This class provides access to the ARM SHA256 hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
1921
[Intrinsic]
2022
public new abstract class Arm64 : ArmBase.Arm64
2123
{
2224
internal Arm64() { }
2325

26+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
2427
public static new bool IsSupported { get => IsSupported; }
2528
}
2629

‎src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/Sve.PlatformNotSupported.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,15 @@ abstract class Sve : AdvSimd
2222
{
2323
internal Sve() { }
2424

25+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
2526
public static new bool IsSupported { [Intrinsic] get { return false; } }
2627

28+
/// <summary>This class provides access to the ARM SVE hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
2729
public new abstract class Arm64 : AdvSimd.Arm64
2830
{
2931
internal Arm64() { }
3032

33+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
3134
public static new bool IsSupported { [Intrinsic] get { return false; } }
3235
}
3336

‎src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/Sve.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,16 @@ public abstract class Sve : AdvSimd
1818
{
1919
internal Sve() { }
2020

21+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
2122
public static new bool IsSupported { get => IsSupported; }
2223

24+
/// <summary>This class provides access to the ARM SVE hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
2325
[Intrinsic]
2426
public new abstract class Arm64 : AdvSimd.Arm64
2527
{
2628
internal Arm64() { }
2729

30+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
2831
public static new bool IsSupported { get => IsSupported; }
2932
}
3033

‎src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Wasm/PackedSimd.PlatformNotSupported.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ namespace System.Runtime.Intrinsics.Wasm
99
[CLSCompliant(false)]
1010
public abstract class PackedSimd
1111
{
12+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
1213
public static bool IsSupported { [Intrinsic] get { return false; } }
1314

1415
public static Vector128<sbyte> Splat(sbyte value) { throw new PlatformNotSupportedException(); }

‎src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Wasm/PackedSimd.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ namespace System.Runtime.Intrinsics.Wasm
1414
[CLSCompliant(false)]
1515
public abstract class PackedSimd
1616
{
17+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
1718
public static bool IsSupported { [Intrinsic] get { return IsSupported; } }
1819

1920
// Constructing SIMD Values

‎src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Wasm/WasmBase.PlatformNotSupported.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ namespace System.Runtime.Intrinsics.Wasm
55
{
66
internal abstract class WasmBase
77
{
8+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
89
public static bool IsSupported => false;
910

1011
/// <summary>

‎src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Wasm/WasmBase.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ namespace System.Runtime.Intrinsics.Wasm
99
[Intrinsic]
1010
internal abstract class WasmBase
1111
{
12+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
1213
public static bool IsSupported { get => IsSupported; }
1314

1415
/// <summary>

‎src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/X86/Aes.PlatformNotSupported.cs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,21 @@
88

99
namespace System.Runtime.Intrinsics.X86
1010
{
11-
/// <summary>
12-
/// This class provides access to Intel AES hardware instructions via intrinsics
13-
/// </summary>
11+
/// <summary>This class provides access to X86 AES hardware instructions via intrinsics.</summary>
1412
[CLSCompliant(false)]
1513
public abstract class Aes : Sse2
1614
{
1715
internal Aes() { }
1816

17+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
1918
public static new bool IsSupported { [Intrinsic] get { return false; } }
2019

20+
/// <summary>This class provides access to the X86 AES hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
2121
public new abstract class X64 : Sse2.X64
2222
{
2323
internal X64() { }
2424

25+
/// <summary>Gets <c>true</c> if the APIs in this class are supported; otherwise, <c>false</c> which indicates they will throw <see cref="PlatformNotSupportedException" />.</summary>
2526
public static new bool IsSupported { [Intrinsic] get { return false; } }
2627
}
2728

0 commit comments

Comments
 (0)