bump mdoc to 5.8.7 (#612)

huangmin-ms · web-flow · commit e1cd54c0f6f6 · 2022-03-01T17:47:17.000+08:00
* bump mdoc to 5.8.7 * mdoc: use //license/@expression, not //licenseUrl * fix in parameter issue * fix issue for microsoft.extensions.logging.console.consoleformatter.write api * Fix issue for system.diagnostics.taglist api * Fix test cases * update * update
diff --git a/mdoc/Consts.cs b/mdoc/Consts.cs
@@ -3,7 +3,7 @@ namespace Mono.Documentation
 {
     public static class Consts
     {
-        public static string MonoVersion = "5.8.6.1";
+        public static string MonoVersion = "5.8.7";
         public const string DocId = "DocId";
         public const string CppCli = "C++ CLI";
         public const string CppCx = "C++ CX";
diff --git a/mdoc/Mono.Documentation/Updater/Formatters/CSharpFullMemberFormatter.cs b/mdoc/Mono.Documentation/Updater/Formatters/CSharpFullMemberFormatter.cs
@@ -503,19 +503,19 @@ protected override StringBuilder AppendModifiers (StringBuilder buf, MethodDefin
         {
             string modifiers = String.Empty;
             if (method.IsStatic) modifiers += " static";
-            TypeDefinition declType = (TypeDefinition)method.DeclaringType;
-            if (declType.IsValueType && DocUtils.HasCustomAttribute(method, Consts.IsReadOnlyAttribute))
-            {
-                modifiers += " readonly";
-            }
             if (method.IsVirtual && !method.IsAbstract)
             {
                 if ((method.Attributes & MethodAttributes.NewSlot) != 0) modifiers += " virtual";
                 else modifiers += " override";
             }
+            TypeDefinition declType = (TypeDefinition)method.DeclaringType;
             if (method.IsAbstract && !declType.IsInterface) modifiers += " abstract";
             if (method.IsFinal) modifiers += " sealed";
             if (modifiers == " virtual sealed") modifiers = "";
+            if (declType.IsValueType && DocUtils.HasCustomAttribute(method, Consts.IsReadOnlyAttribute))
+            {
+                modifiers += buf.Length == 0 ? "readonly" : " readonly";
+            }
 
             switch (method.Name)
             {
@@ -593,13 +593,18 @@ private StringBuilder AppendParameter (StringBuilder buf, ParameterDefinition pa
         {
             TypeReference parameterType = parameter.ParameterType;
 
+            if (parameterType is RequiredModifierType requiredModifierType)
+            {
+                parameterType = requiredModifierType.ElementType;
+            }
+
             if (parameterType is ByReferenceType byReferenceType)
             {
                 if (parameter.IsOut)
                 {
                     buf.Append ("out ");
                 }
-                else if(parameter.IsIn)
+                else if(parameter.IsIn && DocUtils.HasCustomAttribute(parameter, Consts.IsReadOnlyAttribute))
                 {
                     buf.Append("in ");
                 }
diff --git a/mdoc/mdoc.Test/FormatterTests.cs b/mdoc/mdoc.Test/FormatterTests.cs
@@ -259,9 +259,11 @@ public void FuncParams()
         [TestCase(typeof(ReadonlyRefClass), "Ref", "public ref int Ref ();")]
         [TestCase(typeof(ReadonlyRefClass), "ReadonlyRef", "public ref readonly int ReadonlyRef ();")]
         [TestCase(typeof(ReadonlyRefClass), "RefInAndOutMethod", "public void RefInAndOutMethod (ref int a, in int b, out int c);")]
+        [TestCase(typeof(ReadonlyRefClass), "InAttributeMethod", "public void InAttributeMethod (ref int a, in int b, out int c);")]
         [TestCase(typeof(GenericRefClass<>), "Ref", "public ref T Ref ();")]
         [TestCase(typeof(GenericRefClass<>), "ReadonlyRef", "public ref readonly T ReadonlyRef ();")]
         [TestCase(typeof(GenericRefClass<>), "RefInAndOutMethod", "public void RefInAndOutMethod (ref T a, in T b, out T c);")]
+        [TestCase(typeof(GenericRefClass<>), "InAttributeMethod", "public void InAttributeMethod (ref T a, in T b, out T c);")]
         public void CSharpRefReturnMethodTest(Type type, string methodName, string expectedSignature)
         {
             var member = GetMethod(type, m => m.Name == methodName);
@@ -409,12 +411,13 @@ public void CSharpReadOnlyRefStructTest()
             Assert.AreEqual("public readonly ref struct ReadOnlyRefStruct", typeSignature);
         }
 
-        [Test]
-        public void CSharpReadOnlyMemberStructTest()
+        [TestCase("Sum", "public readonly double Sum ();")]
+        [TestCase("GetNum", "readonly int Struct_Interface_A.GetNum ();")]
+        public void CSharpReadOnlyMemberStructTest(string methodName, string expectedSignature)
         {
-            var method = GetMethod(typeof(SampleClasses.StructWithReadOnlyMethod), m => m.Name == "Sum");
+            var method = GetMethod(typeof(SampleClasses.StructWithReadOnlyMethod), m => m.Name.Contains(methodName));
             var methodSignature = formatter.GetDeclaration(method);
-            Assert.AreEqual("public readonly double Sum ();", methodSignature);
+            Assert.AreEqual(expectedSignature, methodSignature);
         }
 
         #region Helper Methods
diff --git a/mdoc/mdoc.Test/SampleClasses/ReadonlyRefClass.cs b/mdoc/mdoc.Test/SampleClasses/ReadonlyRefClass.cs
@@ -1,4 +1,6 @@
-﻿namespace mdoc.Test.SampleClasses
+﻿using System.Runtime.InteropServices;
+
+namespace mdoc.Test.SampleClasses
 {
     public class ReadonlyRefClass
     {
@@ -12,6 +14,8 @@ public class ReadonlyRefClass
         public ref readonly int this[int index] => throw null;
 
         public void RefInAndOutMethod(ref int a, in int b, out int c) => throw null;
+
+        public void InAttributeMethod([In] ref int a, [In] in int b, [Out] out int c) => throw null;
     }
 
     public class GenericRefClass<T>
@@ -25,5 +29,7 @@ public class GenericRefClass<T>
         public ref readonly T this[int index] => throw null;
 
         public void RefInAndOutMethod(ref T a, in T b, out T c) => throw null;
+
+        public void InAttributeMethod([In] ref T a, [In] in T b, [Out] out T c) => throw null;
     }
 }
diff --git a/mdoc/mdoc.Test/SampleClasses/StructWithReadOnlyMethod.cs b/mdoc/mdoc.Test/SampleClasses/StructWithReadOnlyMethod.cs
@@ -1,6 +1,6 @@
 ﻿namespace mdoc.Test.SampleClasses
 {
-    public struct StructWithReadOnlyMethod
+    public struct StructWithReadOnlyMethod : Struct_Interface_A
     {
         public double X { get; set; }
         public double Y { get; set; }
@@ -9,5 +9,7 @@ public readonly double Sum()
         {
             return X + Y;
         }
+
+        readonly int Struct_Interface_A.GetNum() => 1;
     }
 }
diff --git a/mdoc/mdoc.Test/SampleClasses/Struct_Interface_A.cs b/mdoc/mdoc.Test/SampleClasses/Struct_Interface_A.cs
@@ -0,0 +1,7 @@
+﻿namespace mdoc.Test.SampleClasses
+{
+    public interface Struct_Interface_A
+    {
+        int GetNum();
+    }
+}
diff --git a/mdoc/mdoc.nuspec b/mdoc/mdoc.nuspec
@@ -2,12 +2,12 @@
 <package >
   <metadata>
     <id>mdoc</id>
-    <version>5.8.6.1</version>
+    <version>5.8.7</version>
     <title>mdoc</title>
     <authors>Microsoft</authors>
     <owners>Microsoft</owners>
     <projectUrl>https://github.com/mono/api-doc-tools</projectUrl>
-    <licenseUrl>https://github.com/mono/api-doc-tools/blob/main/LICENSE.md</licenseUrl>
+    <license type="expression">MIT</license>
     <requireLicenseAcceptance>true</requireLicenseAcceptance>
     <description>.NET API Documentation toolchain</description>
     <copyright>© Microsoft Corporation. All rights reserved.</copyright>

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ namespace Mono.Documentation`
`3`	`3`	`{`
`4`	`4`	`public static class Consts`
`5`	`5`	`{`
`6`		`- public static string MonoVersion = "5.8.6.1";`
	`6`	`+ public static string MonoVersion = "5.8.7";`
`7`	`7`	`public const string DocId = "DocId";`
`8`	`8`	`public const string CppCli = "C++ CLI";`
`9`	`9`	`public const string CppCx = "C++ CX";`
Original file line number	Diff line number	Diff line change
`@@ -503,19 +503,19 @@ protected override StringBuilder AppendModifiers (StringBuilder buf, MethodDefin`
`503`	`503`	`{`
`504`	`504`	`string modifiers = String.Empty;`
`505`	`505`	`if (method.IsStatic) modifiers += " static";`
`506`		`- TypeDefinition declType = (TypeDefinition)method.DeclaringType;`
`507`		`- if (declType.IsValueType && DocUtils.HasCustomAttribute(method, Consts.IsReadOnlyAttribute))`
`508`		`- {`
`509`		`- modifiers += " readonly";`
`510`		`- }`
`511`	`506`	`if (method.IsVirtual && !method.IsAbstract)`
`512`	`507`	`{`
`513`	`508`	`if ((method.Attributes & MethodAttributes.NewSlot) != 0) modifiers += " virtual";`
`514`	`509`	`else modifiers += " override";`
`515`	`510`	`}`
	`511`	`+ TypeDefinition declType = (TypeDefinition)method.DeclaringType;`
`516`	`512`	`if (method.IsAbstract && !declType.IsInterface) modifiers += " abstract";`
`517`	`513`	`if (method.IsFinal) modifiers += " sealed";`
`518`	`514`	`if (modifiers == " virtual sealed") modifiers = "";`
	`515`	`+ if (declType.IsValueType && DocUtils.HasCustomAttribute(method, Consts.IsReadOnlyAttribute))`
	`516`	`+ {`
	`517`	`+ modifiers += buf.Length == 0 ? "readonly" : " readonly";`
	`518`	`+ }`
`519`	`519`
`520`	`520`	`switch (method.Name)`
`521`	`521`	`{`
`@@ -593,13 +593,18 @@ private StringBuilder AppendParameter (StringBuilder buf, ParameterDefinition pa`
`593`	`593`	`{`
`594`	`594`	`TypeReference parameterType = parameter.ParameterType;`
`595`	`595`
	`596`	`+ if (parameterType is RequiredModifierType requiredModifierType)`
	`597`	`+ {`
	`598`	`+ parameterType = requiredModifierType.ElementType;`
	`599`	`+ }`
	`600`	`+`
`596`	`601`	`if (parameterType is ByReferenceType byReferenceType)`
`597`	`602`	`{`
`598`	`603`	`if (parameter.IsOut)`
`599`	`604`	`{`
`600`	`605`	`buf.Append ("out ");`
`601`	`606`	`}`
`602`		`- else if(parameter.IsIn)`
	`607`	`+ else if(parameter.IsIn && DocUtils.HasCustomAttribute(parameter, Consts.IsReadOnlyAttribute))`
`603`	`608`	`{`
`604`	`609`	`buf.Append("in ");`
`605`	`610`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,6 @@`
`1`		`-namespace mdoc.Test.SampleClasses`
	`1`	`+using System.Runtime.InteropServices;`
	`2`	`+`
	`3`	`+namespace mdoc.Test.SampleClasses`
`2`	`4`	`{`
`3`	`5`	`public class ReadonlyRefClass`
`4`	`6`	`{`
`@@ -12,6 +14,8 @@ public class ReadonlyRefClass`
`12`	`14`	`public ref readonly int this[int index] => throw null;`
`13`	`15`
`14`	`16`	`public void RefInAndOutMethod(ref int a, in int b, out int c) => throw null;`
	`17`	`+`
	`18`	`+ public void InAttributeMethod([In] ref int a, [In] in int b, [Out] out int c) => throw null;`
`15`	`19`	`}`
`16`	`20`
`17`	`21`	`public class GenericRefClass<T>`
`@@ -25,5 +29,7 @@ public class GenericRefClass<T>`
`25`	`29`	`public ref readonly T this[int index] => throw null;`
`26`	`30`
`27`	`31`	`public void RefInAndOutMethod(ref T a, in T b, out T c) => throw null;`
	`32`	`+`
	`33`	`+ public void InAttributeMethod([In] ref T a, [In] in T b, [Out] out T c) => throw null;`
`28`	`34`	`}`
`29`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`namespace mdoc.Test.SampleClasses`
`2`	`2`	`{`
`3`		`- public struct StructWithReadOnlyMethod`
	`3`	`+ public struct StructWithReadOnlyMethod : Struct_Interface_A`
`4`	`4`	`{`
`5`	`5`	`public double X { get; set; }`
`6`	`6`	`public double Y { get; set; }`
`@@ -9,5 +9,7 @@ public readonly double Sum()`
`9`	`9`	`{`
`10`	`10`	`return X + Y;`
`11`	`11`	`}`
	`12`	`+`
	`13`	`+ readonly int Struct_Interface_A.GetNum() => 1;`
`12`	`14`	`}`
`13`	`15`	`}`