Skip to content

Commit

Permalink
Ensure XML doc comments exist for the nested classes and IsSupported …
Browse files Browse the repository at this point in the history
…properties for intrinsics (#106091)

* Ensure XML doc comments exist for the nested classes and IsSupported properties for intrinsics

* Responding to PR feedback

* Add missing period
  • Loading branch information
tannergooding authored Aug 19, 2024
1 parent 729d314 commit 19b5242
Show file tree
Hide file tree
Showing 70 changed files with 585 additions and 171 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@

namespace System.Runtime.Intrinsics.Arm
{
/// <summary>
/// This class provides access to the ARM AdvSIMD hardware instructions via intrinsics
/// </summary>
/// <summary>Provides access to the ARM AdvSIMD hardware instructions via intrinsics.</summary>
[CLSCompliant(false)]
#if SYSTEM_PRIVATE_CORELIB
public
Expand Down Expand Up @@ -150,6 +148,7 @@ internal AdvSimd() { }
// public static Vector64<float> MultiplySubtractScalar(Vector64<float> minuend, Vector64<float> left, Vector64<float> right) { throw new PlatformNotSupportedException(); }
// }

/// <summary>Provides access to the ARM AdvSIMD hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
public new abstract class Arm64 : ArmBase.Arm64
{
internal Arm64() { }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,16 @@

namespace System.Runtime.Intrinsics.Arm
{
/// <summary>
/// This class provides access to the ARM AdvSIMD hardware instructions via intrinsics
/// </summary>
/// <summary>Provides access to the ARM AdvSIMD hardware instructions via intrinsics.</summary>
[Intrinsic]
[CLSCompliant(false)]
public abstract class AdvSimd : ArmBase
{
internal AdvSimd() { }

/// <summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
/// <value><see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
/// <remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="PlatformNotSupportedException" />.</remarks>
public static new bool IsSupported { get => IsSupported; }

// [Intrinsic]
Expand Down Expand Up @@ -147,11 +148,15 @@ internal AdvSimd() { }
// public static Vector64<float> MultiplySubtractScalar(Vector64<float> minuend, Vector64<float> left, Vector64<float> right) => MultiplySubtractScalar(minuend, left, right);
// }

/// <summary>Provides access to the ARM AdvSIMD hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
[Intrinsic]
public new abstract class Arm64 : ArmBase.Arm64
{
internal Arm64() { }

/// <summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
/// <value><see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
/// <remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="PlatformNotSupportedException" />.</remarks>
public static new bool IsSupported { get => IsSupported; }

/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,25 @@

namespace System.Runtime.Intrinsics.Arm
{
/// <summary>
/// This class provides access to the ARM AES hardware instructions via intrinsics
/// </summary>
/// <summary>Provides access to the ARM AES hardware instructions via intrinsics.</summary>
[CLSCompliant(false)]
public abstract class Aes : ArmBase
{
internal Aes() { }

/// <summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
/// <value><see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
/// <remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="PlatformNotSupportedException" />.</remarks>
public static new bool IsSupported { [Intrinsic] get => false; }

/// <summary>Provides access to the ARM AES hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
public new abstract class Arm64 : ArmBase.Arm64
{
internal Arm64() { }

/// <summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
/// <value><see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
/// <remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="PlatformNotSupportedException" />.</remarks>
public static new bool IsSupported { [Intrinsic] get { return false; } }
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,27 @@

namespace System.Runtime.Intrinsics.Arm
{
/// <summary>
/// This class provides access to the ARM AES hardware instructions via intrinsics
/// </summary>
/// <summary>Provides access to the ARM AES hardware instructions via intrinsics.</summary>
[Intrinsic]
[CLSCompliant(false)]
public abstract class Aes : ArmBase
{
internal Aes() { }

/// <summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
/// <value><see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
/// <remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="PlatformNotSupportedException" />.</remarks>
public static new bool IsSupported { get => IsSupported; }

/// <summary>Provides access to the ARM AES hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
[Intrinsic]
public new abstract class Arm64 : ArmBase.Arm64
{
internal Arm64() { }

/// <summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
/// <value><see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
/// <remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="PlatformNotSupportedException" />.</remarks>
public static new bool IsSupported { get => IsSupported; }
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@

namespace System.Runtime.Intrinsics.Arm
{
/// <summary>
/// This class provides access to the ARM base hardware instructions via intrinsics
/// </summary>
/// <summary>Provides access to the ARM base hardware instructions via intrinsics.</summary>
[CLSCompliant(false)]
#if SYSTEM_PRIVATE_CORELIB
public
Expand All @@ -18,12 +16,19 @@ abstract class ArmBase
{
internal ArmBase() { }

/// <summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
/// <value><see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
/// <remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="PlatformNotSupportedException" />.</remarks>
public static bool IsSupported { [Intrinsic] get => false; }

/// <summary>Provides access to the ARM base hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
public abstract class Arm64
{
internal Arm64() { }

/// <summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
/// <value><see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
/// <remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="PlatformNotSupportedException" />.</remarks>
public static bool IsSupported { [Intrinsic] get => false; }

/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,27 @@

namespace System.Runtime.Intrinsics.Arm
{
/// <summary>
/// This class provides access to the ARM base hardware instructions via intrinsics
/// </summary>
/// <summary>Provides access to the ARM base hardware instructions via intrinsics.</summary>
[Intrinsic]
[CLSCompliant(false)]
public abstract class ArmBase
{
internal ArmBase() { }

/// <summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
/// <value><see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
/// <remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="PlatformNotSupportedException" />.</remarks>
public static bool IsSupported { get => IsSupported; }

/// <summary>Provides access to the ARM base hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
[Intrinsic]
public abstract class Arm64
{
internal Arm64() { }

/// <summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
/// <value><see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
/// <remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="PlatformNotSupportedException" />.</remarks>
public static bool IsSupported { get => IsSupported; }

/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,25 @@

namespace System.Runtime.Intrinsics.Arm
{
/// <summary>
/// This class provides access to the ARM Crc32 hardware instructions via intrinsics
/// </summary>
/// <summary>Provides access to the ARM Crc32 hardware instructions via intrinsics.</summary>
[CLSCompliant(false)]
public abstract class Crc32 : ArmBase
{
internal Crc32() { }

/// <summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
/// <value><see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
/// <remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="PlatformNotSupportedException" />.</remarks>
public static new bool IsSupported { [Intrinsic] get { return false; } }

/// <summary>Provides access to the ARM Crc32 hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
public new abstract class Arm64 : ArmBase.Arm64
{
internal Arm64() { }

/// <summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
/// <value><see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
/// <remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="PlatformNotSupportedException" />.</remarks>
public static new bool IsSupported { [Intrinsic] get { return false; } }

/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,27 @@

namespace System.Runtime.Intrinsics.Arm
{
/// <summary>
/// This class provides access to the ARM Crc32 hardware instructions via intrinsics
/// </summary>
/// <summary>Provides access to the ARM Crc32 hardware instructions via intrinsics.</summary>
[Intrinsic]
[CLSCompliant(false)]
public abstract class Crc32 : ArmBase
{
internal Crc32() { }

/// <summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
/// <value><see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
/// <remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="PlatformNotSupportedException" />.</remarks>
public static new bool IsSupported { get => IsSupported; }

/// <summary>Provides access to the ARM Crc32 hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
[Intrinsic]
public new abstract class Arm64 : ArmBase.Arm64
{
internal Arm64() { }

/// <summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
/// <value><see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
/// <remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="PlatformNotSupportedException" />.</remarks>
public static new bool IsSupported { get => IsSupported; }

/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,25 @@

namespace System.Runtime.Intrinsics.Arm
{
/// <summary>
/// This class provides access to the ARMv8.2-DotProd hardware instructions via intrinsics
/// </summary>
/// <summary>Provides access to the ARMv8.2-DotProd hardware instructions via intrinsics.</summary>
[CLSCompliant(false)]
public abstract class Dp : AdvSimd
{
internal Dp() { }

/// <summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
/// <value><see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
/// <remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="PlatformNotSupportedException" />.</remarks>
public static new bool IsSupported { [Intrinsic] get => false; }

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

/// <summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
/// <value><see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
/// <remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="PlatformNotSupportedException" />.</remarks>
public static new bool IsSupported { [Intrinsic] get { return false; } }
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,27 @@

namespace System.Runtime.Intrinsics.Arm
{
/// <summary>
/// This class provides access to the ARMv8.2-DotProd hardware instructions via intrinsics
/// </summary>
/// <summary>Provides access to the ARMv8.2-DotProd hardware instructions via intrinsics.</summary>
[Intrinsic]
[CLSCompliant(false)]
public abstract class Dp : AdvSimd
{
internal Dp() { }

/// <summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
/// <value><see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
/// <remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="PlatformNotSupportedException" />.</remarks>
public static new bool IsSupported { get => IsSupported; }

/// <summary>Provides access to the ARMv8.2-DotProd hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
[Intrinsic]
public new abstract class Arm64 : AdvSimd.Arm64
{
internal Arm64() { }

/// <summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
/// <value><see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
/// <remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="PlatformNotSupportedException" />.</remarks>
public static new bool IsSupported { get => IsSupported; }
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,25 @@

namespace System.Runtime.Intrinsics.Arm
{
/// <summary>
/// This class provides access to the ARMv8.1-RDMA hardware instructions via intrinsics
/// </summary>
/// <summary>Provides access to the ARMv8.1-RDMA hardware instructions via intrinsics.</summary>
[CLSCompliant(false)]
public abstract class Rdm : AdvSimd
{
internal Rdm() { }

/// <summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
/// <value><see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
/// <remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="PlatformNotSupportedException" />.</remarks>
public static new bool IsSupported { [Intrinsic] get => false; }

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

/// <summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
/// <value><see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
/// <remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="PlatformNotSupportedException" />.</remarks>
public static new bool IsSupported { [Intrinsic] get { return false; } }

/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,27 @@

namespace System.Runtime.Intrinsics.Arm
{
/// <summary>
/// This class provides access to the ARMv8.1-RDMA hardware instructions via intrinsics
/// </summary>
/// <summary>Provides access to the ARMv8.1-RDMA hardware instructions via intrinsics.</summary>
[Intrinsic]
[CLSCompliant(false)]
public abstract class Rdm : AdvSimd
{
internal Rdm() { }

/// <summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
/// <value><see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
/// <remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="PlatformNotSupportedException" />.</remarks>
public static new bool IsSupported { get => IsSupported; }

/// <summary>Provides access to the ARMv8.1-RDMA hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
[Intrinsic]
public new abstract class Arm64 : AdvSimd.Arm64
{
internal Arm64() { }

/// <summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
/// <value><see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
/// <remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="PlatformNotSupportedException" />.</remarks>
public static new bool IsSupported { get => IsSupported; }

/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,25 @@

namespace System.Runtime.Intrinsics.Arm
{
/// <summary>
/// This class provides access to the ARM SHA1 hardware instructions via intrinsics
/// </summary>
/// <summary>Provides access to the ARM SHA1 hardware instructions via intrinsics.</summary>
[CLSCompliant(false)]
public abstract class Sha1 : ArmBase
{
internal Sha1() { }

/// <summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
/// <value><see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
/// <remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="PlatformNotSupportedException" />.</remarks>
public static new bool IsSupported { [Intrinsic] get => false; }

/// <summary>Provides access to the ARM SHA1 hardware instructions, that are only available to 64-bit processes, via intrinsics.</summary>
public new abstract class Arm64 : ArmBase.Arm64
{
internal Arm64() { }

/// <summary>Gets a value that indicates whether the APIs in this class are supported.</summary>
/// <value><see langword="true" /> if the APIs are supported; otherwise, <see langword="false" />.</value>
/// <remarks>A value of <see langword="false" /> indicates that the APIs will throw <see cref="PlatformNotSupportedException" />.</remarks>
public static new bool IsSupported { [Intrinsic] get { return false; } }
}

Expand Down
Loading

0 comments on commit 19b5242

Please sign in to comment.