Skip to content

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

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
merged 3 commits into from
Aug 19, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1bbdced
Ensure XML doc comments exist for the nested classes and IsSupported …
tannergooding Aug 7, 2024
593726f
Responding to PR feedback
tannergooding Aug 12, 2024
42ec5f3
Add missing period
tannergooding Aug 18, 2024
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
5 changes: 2 additions & 3 deletions .../System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/AdvSimd.PlatformNotSupported.cs
View file
Open in desktop
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
11 changes: 8 additions & 3 deletions src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/AdvSimd.cs
View file
Open in desktop
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
11 changes: 8 additions & 3 deletions ...ries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/Aes.PlatformNotSupported.cs
View file
Open in desktop
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>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should instead say something along the lines of "Always returns false, indicating that the APIs in this class are not supported."

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same suggestion for all the similar *.NotSupported.cs IsSupported properties that return false.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have 1 set of docs that exist, not separate ones for *.cs for *.PlatformNotSupported.cs

The *.PlatformNotSupported.cs are purely implementation details for corelib to be more optimal

/// <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
11 changes: 8 additions & 3 deletions src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/Aes.cs
View file
Open in desktop
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
11 changes: 8 additions & 3 deletions .../System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/ArmBase.PlatformNotSupported.cs
View file
Open in desktop
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
11 changes: 8 additions & 3 deletions src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/ArmBase.cs
View file
Open in desktop
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
11 changes: 8 additions & 3 deletions ...es/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/Crc32.PlatformNotSupported.cs
View file
Open in desktop
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
11 changes: 8 additions & 3 deletions src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/Crc32.cs
View file
Open in desktop
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
11 changes: 8 additions & 3 deletions ...aries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/Dp.PlatformNotSupported.cs
View file
Open in desktop
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
11 changes: 8 additions & 3 deletions src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/Dp.cs
View file
Open in desktop
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
11 changes: 8 additions & 3 deletions ...ries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/Rdm.PlatformNotSupported.cs
View file
Open in desktop
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
11 changes: 8 additions & 3 deletions src/libraries/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/Rdm.cs
View file
Open in desktop
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
11 changes: 8 additions & 3 deletions ...ies/System.Private.CoreLib/src/System/Runtime/Intrinsics/Arm/Sha1.PlatformNotSupported.cs
View file
Open in desktop
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
Loading