Update attributes and add docs / tests

dotnet · Jun 27, 2023 · 1541c54 · 1541c54
1 parent 3d11a7f
commit 1541c54
Show file tree

Hide file tree

Showing 11 changed files with 124 additions and 15 deletions.
diff --git a/...raries/System.Private.CoreLib/src/System/Runtime/CompilerServices/IsByRefLikeAttribute.cs b/...raries/System.Private.CoreLib/src/System/Runtime/CompilerServices/IsByRefLikeAttribute.cs
@@ -6,13 +6,14 @@
 namespace System.Runtime.CompilerServices
 {
     /// <summary>
-    /// Reserved to be used by the compiler for tracking metadata.
+    /// Reserved for use by a compiler for tracking metadata.
     /// This attribute should not be used by developers in source code.
     /// </summary>
     [EditorBrowsable(EditorBrowsableState.Never)]
     [AttributeUsage(AttributeTargets.Struct)]
     public sealed class IsByRefLikeAttribute : Attribute
     {
+        /// <summary>Initializes the attribute.</summary>
         public IsByRefLikeAttribute()
         {
         }

diff --git a/...braries/System.Private.CoreLib/src/System/Runtime/CompilerServices/IsReadOnlyAttribute.cs b/...braries/System.Private.CoreLib/src/System/Runtime/CompilerServices/IsReadOnlyAttribute.cs
@@ -6,13 +6,14 @@
 namespace System.Runtime.CompilerServices
 {
     /// <summary>
-    /// Reserved to be used by the compiler for tracking metadata.
+    /// Reserved for use by a compiler for tracking metadata.
     /// This attribute should not be used by developers in source code.
     /// </summary>
     [EditorBrowsable(EditorBrowsableState.Never)]
     [AttributeUsage(AttributeTargets.All, Inherited = false)]
     public sealed class IsReadOnlyAttribute : Attribute
     {
+        /// <summary>Initializes the attribute.</summary>
         public IsReadOnlyAttribute()
         {
         }

diff --git a/...raries/System.Private.CoreLib/src/System/Runtime/CompilerServices/IsUnmanagedAttribute.cs b/...raries/System.Private.CoreLib/src/System/Runtime/CompilerServices/IsUnmanagedAttribute.cs
@@ -1,9 +1,21 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using System.ComponentModel;
+
 namespace System.Runtime.CompilerServices
 {
+    /// <summary>
+    /// Reserved for use by a compiler for tracking metadata.
+    /// This attribute should not be used by developers in source code.
+    /// </summary>
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    [AttributeUsage(AttributeTargets.All)]
     public sealed class IsUnmanagedAttribute : Attribute
     {
+        /// <summary>Initializes the attribute.</summary>
+        public IsUnmanagedAttribute()
+        {
+        }
     }
 }
diff --git a/...libraries/System.Private.CoreLib/src/System/Runtime/CompilerServices/NullableAttribute.cs b/...libraries/System.Private.CoreLib/src/System/Runtime/CompilerServices/NullableAttribute.cs
@@ -1,18 +1,30 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using System.ComponentModel;
+
 namespace System.Runtime.CompilerServices
 {
-    [AttributeUsage(AttributeTargets.Class | AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Event | AttributeTargets.Parameter | AttributeTargets.ReturnValue | AttributeTargets.GenericParameter, AllowMultiple = false, Inherited = false)]
+    /// <summary>
+    /// Reserved for use by a compiler for tracking metadata.
+    /// This attribute should not be used by developers in source code.
+    /// </summary>
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    [AttributeUsage(AttributeTargets.Class | AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Event | AttributeTargets.Parameter | AttributeTargets.ReturnValue | AttributeTargets.GenericParameter, Inherited = false)]
     public sealed class NullableAttribute : Attribute
     {
+        /// <summary>Flags specifying metadata related to nullable reference types.</summary>
         public readonly byte[] NullableFlags;
 
+        /// <summary>Initializes the attribute.</summary>
+        /// <param name="value">The flags value.</param>
         public NullableAttribute(byte value)
         {
             NullableFlags = new[] { value };
         }
 
+        /// <summary>Initializes the attribute.</summary>
+        /// <param name="value">The flags value.</param>
         public NullableAttribute(byte[] value)
         {
             NullableFlags = value;

diff --git a/...es/System.Private.CoreLib/src/System/Runtime/CompilerServices/NullableContextAttribute.cs b/...es/System.Private.CoreLib/src/System/Runtime/CompilerServices/NullableContextAttribute.cs
@@ -1,13 +1,23 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using System.ComponentModel;
+
 namespace System.Runtime.CompilerServices
 {
-    [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Method | AttributeTargets.Interface | AttributeTargets.Delegate, AllowMultiple = false, Inherited = false)]
+    /// <summary>
+    /// Reserved for use by a compiler for tracking metadata.
+    /// This attribute should not be used by developers in source code.
+    /// </summary>
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Method | AttributeTargets.Interface | AttributeTargets.Delegate, Inherited = false)]
     public sealed class NullableContextAttribute : Attribute
     {
+        /// <summary>Flag specifying metadata related to nullable reference types.</summary>
         public readonly byte Flag;
 
+        /// <summary>Initializes the attribute.</summary>
+        /// <param name="value">The flag value.</param>
         public NullableContextAttribute(byte value)
         {
             Flag = value;

diff --git a/...System.Private.CoreLib/src/System/Runtime/CompilerServices/NullablePublicOnlyAttribute.cs b/...System.Private.CoreLib/src/System/Runtime/CompilerServices/NullablePublicOnlyAttribute.cs
@@ -1,13 +1,23 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using System.ComponentModel;
+
 namespace System.Runtime.CompilerServices
 {
-    [AttributeUsage(AttributeTargets.Module, AllowMultiple = false, Inherited = false)]
+    /// <summary>
+    /// Reserved for use by a compiler for tracking metadata.
+    /// This attribute should not be used by developers in source code.
+    /// </summary>
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    [AttributeUsage(AttributeTargets.Module, Inherited = false)]
     public sealed class NullablePublicOnlyAttribute : Attribute
     {
+        /// <summary>Indicates whether metadata for internal members is included.</summary>
         public readonly bool IncludesInternals;
 
+        /// <summary>Initializes the attribute.</summary>
+        /// <param name="value">Indicates whether metadata for internal members is included.</param>
         public NullablePublicOnlyAttribute(bool value)
         {
             IncludesInternals = value;

diff --git a/...ies/System.Private.CoreLib/src/System/Runtime/CompilerServices/RefSafetyRulesAttribute.cs b/...ies/System.Private.CoreLib/src/System/Runtime/CompilerServices/RefSafetyRulesAttribute.cs
@@ -1,10 +1,13 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using System.ComponentModel;
+
 namespace System.Runtime.CompilerServices
 {
     /// <summary>Indicates the language version of the ref safety rules used when the module was compiled.</summary>
-    [AttributeUsage(AttributeTargets.Module, AllowMultiple = false, Inherited = false)]
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    [AttributeUsage(AttributeTargets.Module, Inherited = false)]
     public sealed class RefSafetyRulesAttribute : Attribute
     {
         /// <summary>Initializes a new instance of the <see cref="RefSafetyRulesAttribute"/> class.</summary>

diff --git a/...ies/System.Private.CoreLib/src/System/Runtime/CompilerServices/RequiredMemberAttribute.cs b/...ies/System.Private.CoreLib/src/System/Runtime/CompilerServices/RequiredMemberAttribute.cs
@@ -1,10 +1,13 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using System.ComponentModel;
+
 namespace System.Runtime.CompilerServices
 {
     /// <summary>Specifies that a type has required members or that a member is required.</summary>
     [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Field | AttributeTargets.Property, AllowMultiple = false, Inherited = false)]
+    [EditorBrowsable(EditorBrowsableState.Never)]
 #if SYSTEM_PRIVATE_CORELIB
     public
 #else

diff --git a/...ibraries/System.Private.CoreLib/src/System/Runtime/CompilerServices/ScopedRefAttribute.cs b/...ibraries/System.Private.CoreLib/src/System/Runtime/CompilerServices/ScopedRefAttribute.cs
@@ -1,10 +1,21 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using System.ComponentModel;
+
 namespace System.Runtime.CompilerServices
 {
-    [AttributeUsage(AttributeTargets.Parameter, AllowMultiple = false, Inherited = false)]
+    /// <summary>
+    /// Reserved for use by a compiler for tracking metadata.
+    /// This attribute should not be used by developers in source code.
+    /// </summary>
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    [AttributeUsage(AttributeTargets.Parameter, Inherited = false)]
     public sealed class ScopedRefAttribute : Attribute
     {
+        /// <summary>Initializes the attribute.</summary>
+        public ScopedRefAttribute()
+        {
+        }
     }
 }
diff --git a/src/libraries/System.Runtime/ref/System.Runtime.cs b/src/libraries/System.Runtime/ref/System.Runtime.cs
@@ -8283,7 +8283,7 @@ public sealed partial class ExcludeFromCodeCoverageAttribute : System.Attribute
         public ExcludeFromCodeCoverageAttribute() { }
         public string? Justification { get { throw null; } set { } }
     }
-    [System.AttributeUsage(System.AttributeTargets.Assembly |  System.AttributeTargets.Module | System.AttributeTargets.Class | System.AttributeTargets.Struct | System.AttributeTargets.Enum | System.AttributeTargets.Constructor | System.AttributeTargets.Method | System.AttributeTargets.Property | System.AttributeTargets.Field | System.AttributeTargets.Event | System.AttributeTargets.Interface | System.AttributeTargets.Delegate, Inherited = false)]
+    [System.AttributeUsageAttribute(System.AttributeTargets.Assembly |  System.AttributeTargets.Module | System.AttributeTargets.Class | System.AttributeTargets.Struct | System.AttributeTargets.Enum | System.AttributeTargets.Constructor | System.AttributeTargets.Method | System.AttributeTargets.Property | System.AttributeTargets.Field | System.AttributeTargets.Event | System.AttributeTargets.Interface | System.AttributeTargets.Delegate, Inherited = false)]
     public sealed class ExperimentalAttribute : System.Attribute
     {
         public ExperimentalAttribute(string diagnosticId) { }
@@ -8360,7 +8360,7 @@ public RequiresUnreferencedCodeAttribute(string message) { }
         public string Message { get { throw null; } }
         public string? Url { get { throw null; } set { } }
     }
-    [System.AttributeUsage(System.AttributeTargets.Constructor, AllowMultiple = false, Inherited = false)]
+    [System.AttributeUsageAttribute(System.AttributeTargets.Constructor, AllowMultiple = false, Inherited = false)]
     public sealed class SetsRequiredMembersAttribute : System.Attribute
     {
         public SetsRequiredMembersAttribute() { }
@@ -12751,7 +12751,7 @@ public sealed partial class InterpolatedStringHandlerAttribute : System.Attribut
     {
         public InterpolatedStringHandlerAttribute() { }
     }
-    [AttributeUsage(System.AttributeTargets.Struct, AllowMultiple = false)]
+    [System.AttributeUsageAttribute(System.AttributeTargets.Struct, AllowMultiple = false)]
     [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
     public sealed partial class InlineArrayAttribute : System.Attribute
     {
@@ -12781,6 +12781,8 @@ public partial interface IStrongBox
     {
         object? Value { get; set; }
     }
+    [System.AttributeUsageAttribute(System.AttributeTargets.All)]
+    [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
     public sealed partial class IsUnmanagedAttribute : Attribute
     {
     }
@@ -12837,21 +12839,24 @@ public sealed partial class ModuleInitializerAttribute : System.Attribute
     {
         public ModuleInitializerAttribute() { }
     }
-    [AttributeUsage(AttributeTargets.Class | AttributeTargets.Property | AttributeTargets.Field | AttributeTargets.Event | AttributeTargets.Parameter | AttributeTargets.ReturnValue | AttributeTargets.GenericParameter, AllowMultiple = false, Inherited = false)]
+    [System.AttributeUsageAttribute(System.AttributeTargets.Class | System.AttributeTargets.Property | System.AttributeTargets.Field | System.AttributeTargets.Event | System.AttributeTargets.Parameter | System.AttributeTargets.ReturnValue | System.AttributeTargets.GenericParameter, Inherited = false)]
+    [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
     public sealed partial class NullableAttribute : Attribute
     {
         public readonly byte[] NullableFlags;
         public NullableAttribute(byte value) { }
 
         public NullableAttribute(byte[] value) { }
     }
-    [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Method | AttributeTargets.Interface | AttributeTargets.Delegate, AllowMultiple = false, Inherited = false)]
+    [System.AttributeUsageAttribute(System.AttributeTargets.Class | System.AttributeTargets.Struct | System.AttributeTargets.Method | System.AttributeTargets.Interface | System.AttributeTargets.Delegate, Inherited = false)]
+    [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
     public sealed partial class NullableContextAttribute : Attribute
     {
         public readonly byte Flag;
         public NullableContextAttribute(byte value) { }
     }
-    [AttributeUsage(AttributeTargets.Module, AllowMultiple = false, Inherited = false)]
+    [System.AttributeUsageAttribute(System.AttributeTargets.Module, Inherited = false)]
+    [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
     public sealed partial class NullablePublicOnlyAttribute : Attribute
     {
         public readonly bool IncludesInternals;
@@ -12889,13 +12894,15 @@ public sealed partial class PreserveBaseOverridesAttribute : System.Attribute
     {
         public PreserveBaseOverridesAttribute() { }
     }
-    [System.AttributeUsage(System.AttributeTargets.Module, AllowMultiple=false, Inherited=false)]
+    [System.AttributeUsageAttribute(System.AttributeTargets.Module, Inherited=false)]
+    [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
     public sealed partial class RefSafetyRulesAttribute : System.Attribute
     {
         public RefSafetyRulesAttribute(int version) { }
         public int Version { get { throw null; } }
     }
     [System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Struct | System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple = false, Inherited = false)]
+    [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
     public sealed class RequiredMemberAttribute : System.Attribute
     {
         public RequiredMemberAttribute() { }
@@ -12969,7 +12976,8 @@ public RuntimeWrappedException(object thrownObject) { }
         [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
         public override void GetObjectData(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context) { }
     }
-    [AttributeUsage(AttributeTargets.Parameter, AllowMultiple = false, Inherited = false)]
+    [System.AttributeUsageAttribute(System.AttributeTargets.Parameter, Inherited = false)]
+    [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
     public sealed partial class ScopedRefAttribute : Attribute
     {
     }

diff --git a/src/libraries/System.Runtime/tests/System/Runtime/CompilerServices/AttributesTests.cs b/src/libraries/System.Runtime/tests/System/Runtime/CompilerServices/AttributesTests.cs
@@ -192,6 +192,32 @@ public static void MethodImplAttributeTests()
             Assert.Equal(MethodImplOptions.Unmanaged, attr3.Value);
         }
 
+        [Fact]
+        public static void NullableAttributeTests()
+        {
+            var attr = new NullableAttribute(42);
+            Assert.Equal(new byte[] { 42 }, attr.NullableFlags);
+
+            attr = new NullableAttribute(new byte[] { 1, 2, 3 });
+            Assert.Equal(new byte[] { 1, 2, 3 }, attr.NullableFlags);
+        }
+
+        [Fact]
+        public static void NullableContextAttributeTests()
+        {
+            var attr = new NullableContextAttribute(42);
+            Assert.Equal(42, attr.Flag);
+        }
+
+        [Theory]
+        [InlineData(false)]
+        [InlineData(true)]
+        public static void NullablePublicOnlyAttributeTests(bool includeInternals)
+        {
+            var attr = new NullablePublicOnlyAttribute(includeInternals);
+            Assert.Equal(includeInternals, attr.IncludesInternals);
+        }
+
         [Theory]
         [InlineData(-1)]
         [InlineData(42)]
@@ -299,6 +325,12 @@ public static void IsReadOnlyAttributeTests()
             new IsReadOnlyAttribute();
         }
 
+        [Fact]
+        public static void IsUnmanagedAttributeTests()
+        {
+            new IsUnmanagedAttribute();
+        }
+
         [Fact]
         public static void EnumeratorCancellationAttributeTests()
         {
@@ -336,6 +368,12 @@ public static void RequiredMemberAttributeTests()
             new RequiredMemberAttribute();
         }
 
+        [Fact]
+        public static void ScopedRefAttributeTests()
+        {
+            new ScopedRefAttribute();
+        }
+
         [Fact]
         public static void CompilerFeatureRequiredTests()
         {