#945509 Support ref readonly parameters

Add support for correct rendering of "ref readonly" parameter in C# method signature documentation.
mono · Sep 11, 2024 · b8d8963 · b8d8963
1 parent 97940aa
commit b8d8963
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 2 deletions.
diff --git a/mdoc/Consts.cs b/mdoc/Consts.cs
@@ -49,6 +49,7 @@ public static class Consts
         public const string CompilerGeneratedAttribute = "System.Runtime.CompilerServices.CompilerGeneratedAttribute";
         public const string IsByRefLikeAttribute = "System.Runtime.CompilerServices.IsByRefLikeAttribute";
         public const string IsReadOnlyAttribute = "System.Runtime.CompilerServices.IsReadOnlyAttribute";
+        public const string RequiresLocationAttribute = "System.Runtime.CompilerServices.RequiresLocationAttribute";
         public const string InAttribute = "System.Runtime.InteropServices.InAttribute";
         public const string OutAttribute = "System.Runtime.InteropServices.OutAttribute";
         public const string TupleElementNamesAttribute = "System.Runtime.CompilerServices.TupleElementNamesAttribute";

diff --git a/mdoc/Mono.Documentation/Updater/Formatters/CSharpFullMemberFormatter.cs b/mdoc/Mono.Documentation/Updater/Formatters/CSharpFullMemberFormatter.cs
@@ -610,7 +610,7 @@ private StringBuilder AppendParameters (StringBuilder buf, MethodDefinition meth
         protected override StringBuilder AppendParameter(StringBuilder buf, ParameterDefinition parameter)
         {
             TypeReference parameterType = parameter.ParameterType;
-            var refType = new BitArray(3);
+            var refType = new BitArray(4);
 
             if (parameter.HasCustomAttributes)
             {
@@ -641,14 +641,18 @@ protected override StringBuilder AppendParameter(StringBuilder buf, ParameterDef
                 {
                     refType.Set(0, true);
                 }
+                else if (parameter.IsIn && DocUtils.HasCustomAttribute(parameter, Consts.RequiresLocationAttribute))
+                {
+                    refType.Set(3, true);
+                }
                 else
                 {
                     refType.Set(2, true);
                 }
                 parameterType = byReferenceType.ElementType;
             }
 
-            buf.Append(refType.Get(0) ? "in " : (refType.Get(1) ? "out " : (refType.Get(2) ? "ref ": "")));
+            buf.Append(refType.Get(0) ? "in " : (refType.Get(1) ? "out " : (refType.Get(2) ? "ref ": (refType.Get(3) ? "ref readonly " : ""))));
 
             if (parameter.HasCustomAttributes)
             {

diff --git a/mdoc/mdoc.Test/FormatterTests.cs b/mdoc/mdoc.Test/FormatterTests.cs
@@ -601,6 +601,14 @@ public void CSharpStaticEventImplementation(string typeFullName, string eventNam
             TestEventSignature(staticVirtualMemberDllPath, typeFullName, eventName, expectedSignature);
         }
 
+        [TestCase("MethodWithRefReadonlyParam", "public void MethodWithRefReadonlyParam (ref readonly int i);")]
+        public void CSharpRefReadonlyTest(string methodName, string expectedSignature)
+        {
+            var method = GetMethod(typeof(SampleClasses.SomeClass), m => m.Name == methodName);
+            var methodSignature = formatter.GetDeclaration(method);
+            Assert.AreEqual(expectedSignature, methodSignature);
+        }
+
         #region Helper Methods
         string RealTypeName(string name){
             switch (name) {

diff --git a/mdoc/mdoc.Test/SampleClasses/SomeClass.cs b/mdoc/mdoc.Test/SampleClasses/SomeClass.cs
@@ -104,6 +104,10 @@ public ref T TestScopedParams<T>(scoped in T p1, scoped out T p2, scoped ref T p
             throw new PlatformNotSupportedException();
         }
 
+        public void MethodWithRefReadonlyParam(ref readonly int i)
+        {
+        }
+
         public event EventHandler<object> AppMemoryUsageIncreased;
         public static event EventHandler<object> StaticEvent;
         private static event EventHandler<object> PrivateEvent;