[mdoc] Multitarget net471 and net6.0 (#639)

Adds `net6.0` as a target framework to mdoc.  The artifacts from the
`net6.0` build will be output to `bin/$(Configuration)-net6.0`.

Mono.Cecil has been bumped from `0.10.0-beta5` to `0.10.0`.  This update
appears to have introduced a change in behavior in F# doc generation,
and the expected output in `PatternMatchingExamples.xml` has been
updated to reflect that.

The mdoc NuGet package has been updated to include both `net471` and
`net6.0` tools.  This can be considered a breaking change, as the path
of mdoc.exe has been changed to include a folder named after its target
framework.

Author: pjcollins

Directory.Build.props

@@ -1,9 +1,10 @@
 <Project>
   <PropertyGroup>
     <NuGetVersionFSharpCore>4.3.4</NuGetVersionFSharpCore>
-    <NuGetVersionMonoCecil>0.10.0-beta5</NuGetVersionMonoCecil>
+    <NuGetVersionMonoCecil>0.10.0</NuGetVersionMonoCecil>
     <NuGetVersionNUnit>3.10.1</NuGetVersionNUnit>
-    <NuGetVersionNUnit3TestAdapter>3.13.0</NuGetVersionNUnit3TestAdapter>
+    <NuGetVersionNUnit3TestAdapter>3.17.0</NuGetVersionNUnit3TestAdapter>
+    <NuGetVersionMicrosoftNETTestSdk>16.11.0</NuGetVersionMicrosoftNETTestSdk>
     <NuGetVersionQuickIONET>2.6.2.0</NuGetVersionQuickIONET>
     <NuGetVersionSharpZipLib>1.3.3</NuGetVersionSharpZipLib>
     <NuGetVersionSystemConfigurationConfigurationManager>6.0.0</NuGetVersionSystemConfigurationConfigurationManager>

Makefile

@@ -1,4 +1,3 @@
-MSBUILD = msbuild
 CONFIGURATION = Release
 BIN = bin/$(CONFIGURATION)
 MDOC = $(BIN)/mdoc.exe
@@ -9,15 +8,15 @@ all: build
 build: $(MDOC)
 
 $(MDOC):
-	$(MSBUILD) apidoctools.sln /p:Configuration=$(CONFIGURATION);
+	dotnet build -v:n apidoctools.sln /p:Configuration=$(CONFIGURATION)
 
 prepare:
 	git submodule update --init --recursive
-	nuget restore apidoctools.sln
+	dotnet restore apidoctools.sln
 	nuget install NUnit.Console -version 3.6.0 -NoCache -o packages
 
 clean:
-	#$(MSBUILD) apidoctools.sln /t:clean
+	dotnet build -v:n apidoctools.sln /t:clean /p:Configuration=$(CONFIGURATION)
 	rm -rf bin/$(CONFIGURATION)
 
 check: build check-monodoc check-mdoc

azure-pipelines.yml

@@ -95,19 +95,26 @@ stages:
     - task: NuGetToolInstaller@1
       displayName: Install NuGet Tool
 
-    - task: Bash@3
-      displayName: Run Unit and Integration Tests
-      inputs:
-        targetType: 'inline'
-        script: 'make prepare all check CONFIGURATION=$(buildConfiguration)'
-
     - task: UseDotNet@2
       displayName: 'Use .NET Core sdk'
       inputs:
         packageType: sdk
         version: 2.1.x
         installationPath: $(Agent.ToolsDirectory)/dotnet
 
+    - task: UseDotNet@2
+      displayName: 'Use .NET 6.0.x'
+      inputs:
+        packageType: sdk
+        version: 6.0.x
+        installationPath: $(Agent.ToolsDirectory)/dotnet
+
+    - task: Bash@3
+      displayName: Run Unit and Integration Tests
+      inputs:
+        targetType: 'inline'
+        script: 'make prepare all check CONFIGURATION=$(buildConfiguration)'
+
     - task: EsrpCodeSigning@1
       displayName: Sign executable and dll files
       condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest'))

mdoc/Makefile

@@ -61,6 +61,9 @@ cleanup:
 nunit: 
 	mono ../packages/NUnit.ConsoleRunner.3.6.0/tools/nunit3-console.exe mdoc.Test/bin/$(CONFIGURATION)/mdoc.Test.dll
 
+dotnet-test:
+	dotnet test mdoc.Test/bin/$(CONFIGURATION)-net6.0/mdoc.Test.dll
+
 Test/DocTest-VB-Eii.dll:
 	$(VBCOMPILE) -out:Test/DocTest-VB-Eii.dll  Test/ClassEnumerator.vb
 
@@ -960,5 +963,5 @@ check-doc-tools-update: check-monodocer-since-update \
 	check-mdoc-export-msxdoc-update \
 	check-mdoc-validate-update 
 
-check: nunit check-doc-tools
+check: nunit dotnet-test check-doc-tools
 	@echo "mdoc Tests Complete!"

mdoc/Mono.Documentation/Updater/Frameworks/MDocResolver.cs

@@ -564,6 +564,10 @@ static string GetCurrentMonoGac()
 
         internal AssemblyDefinition GetAssemblyInGac(AssemblyNameReference reference, ReaderParameters parameters)
         {
+#if NETCOREAPP
+            return null;
+#endif //NETCOREAPP
+
             if (reference.PublicKeyToken == null || reference.PublicKeyToken.Length == 0)
                 return null;
 

mdoc/Test/en.expected-fsharp/PatternMatching/PatternMatchingExamples.xml

@@ -161,9 +161,9 @@
       </Docs>
     </Member>
     <Member MemberName="detectZeroTuple">
-      <MemberSignature Language="C#" Value="public static void detectZeroTuple (int point_0, int point_1);" />
-      <MemberSignature Language="ILAsm" Value=".method public static void detectZeroTuple(int32 point_0, int32 point_1) cil managed" />
-      <MemberSignature Language="F#" Value="PatternMatching.PatternMatchingExamples.detectZeroTuple : int * int -&gt; unit" Usage="PatternMatching.PatternMatchingExamples.detectZeroTuple (point_0, point_1)" />
+      <MemberSignature Language="C#" Value="public static void detectZeroTuple (int var1, int var2);" />
+      <MemberSignature Language="ILAsm" Value=".method public static void detectZeroTuple(int32 var1, int32 var2) cil managed" />
+      <MemberSignature Language="F#" Value="PatternMatching.PatternMatchingExamples.detectZeroTuple : int * int -&gt; unit" Usage="PatternMatching.PatternMatchingExamples.detectZeroTuple (var1, var2)" />
       <MemberType>Method</MemberType>
       <AssemblyInfo>
         <AssemblyVersion>1.0.0.0</AssemblyVersion>
@@ -172,12 +172,12 @@
         <ReturnType>System.Void</ReturnType>
       </ReturnValue>
       <Parameters>
-        <Parameter Name="point_0" Type="System.Int32" />
-        <Parameter Name="point_1" Type="System.Int32" />
+        <Parameter Name="var1" Type="System.Int32" />
+        <Parameter Name="var2" Type="System.Int32" />
       </Parameters>
       <Docs>
-        <param name="point_0">To be added.</param>
-        <param name="point_1">To be added.</param>
+        <param name="var1">To be added.</param>
+        <param name="var2">To be added.</param>
         <summary>To be added.</summary>
         <remarks>To be added.</remarks>
       </Docs>
@@ -226,9 +226,9 @@
       </Docs>
     </Member>
     <Member MemberName="function1">
-      <MemberSignature Language="C#" Value="public static void function1 (int x_0, int x_1);" />
-      <MemberSignature Language="ILAsm" Value=".method public static void function1(int32 x_0, int32 x_1) cil managed" />
-      <MemberSignature Language="F#" Value="PatternMatching.PatternMatchingExamples.function1 : int * int -&gt; unit" Usage="PatternMatching.PatternMatchingExamples.function1 (x_0, x_1)" />
+      <MemberSignature Language="C#" Value="public static void function1 (int var1, int var2);" />
+      <MemberSignature Language="ILAsm" Value=".method public static void function1(int32 var1, int32 var2) cil managed" />
+      <MemberSignature Language="F#" Value="PatternMatching.PatternMatchingExamples.function1 : int * int -&gt; unit" Usage="PatternMatching.PatternMatchingExamples.function1 (var1, var2)" />
       <MemberType>Method</MemberType>
       <AssemblyInfo>
         <AssemblyVersion>1.0.0.0</AssemblyVersion>
@@ -237,12 +237,12 @@
         <ReturnType>System.Void</ReturnType>
       </ReturnValue>
       <Parameters>
-        <Parameter Name="x_0" Type="System.Int32" />
-        <Parameter Name="x_1" Type="System.Int32" />
+        <Parameter Name="var1" Type="System.Int32" />
+        <Parameter Name="var2" Type="System.Int32" />
       </Parameters>
       <Docs>
-        <param name="x_0">To be added.</param>
-        <param name="x_1">To be added.</param>
+        <param name="var1">To be added.</param>
+        <param name="var2">To be added.</param>
         <summary>To be added.</summary>
         <remarks>To be added.</remarks>
       </Docs>

mdoc/Test/en.expected-fsharp/index.xml

@@ -35,9 +35,6 @@
         <Attribute>
           <AttributeName>System.Reflection.AssemblyTrademark("")</AttributeName>
         </Attribute>
-        <Attribute>
-          <AttributeName>System.Reflection.AssemblyVersion("1.0.0.0")</AttributeName>
-        </Attribute>
         <Attribute>
           <AttributeName>System.Runtime.InteropServices.ComVisible(false)</AttributeName>
         </Attribute>

mdoc/mdoc.Test/CppCxFormatterMembersTests.cs

@@ -1,11 +1,14 @@
 using mdoc.Test.SampleClasses;
 using Mono.Documentation.Updater.Formatters.CppFormatters;
-using Mono_DocTest;
 using NUnit.Framework;
+#if !NETCOREAPP
+using Mono_DocTest;
 using Cpp = Mono_DocTest_Generic;
+#endif // !NETCOREAPP
 
 namespace mdoc.Test
 {
+#if !NETCOREAPP
     [TestFixture]
     [Category("CppCx")]
     public class CppCxFormatterMembersTests : BasicFormatterTests<CppCxFullMemberFormatter>
@@ -194,6 +197,7 @@ public void NoSupport_GenericMethodInUwp()
             TestMethodSignature(typeof(Cpp.GenericBase<>), null, "BaseMethod2");
         }
     }
+#endif //!NETCOREAPP
 
 }
 

mdoc/mdoc.Test/CppCxFormatterTypesTests.cs

@@ -1,12 +1,16 @@
 using System;
 using Mono.Cecil;
 using Mono.Documentation.Updater.Formatters.CppFormatters;
+#if !NETCOREAPP
 using Mono_DocTest;
 using Mono_DocTest_Generic;
+#endif //!NETCOREAPP
 using NUnit.Framework;
 
 namespace mdoc.Test
 {
+#if !NETCOREAPP
+
     [TestFixture]
     [Category("CppCx")]
     public class CppCxFormatterTypesTests : BasicFormatterTests<CppCxMemberFormatter>
@@ -259,5 +263,8 @@ public void TearDown()
             moduleCash.Clear();
         }
     }
+
+#endif //!NETCOREAPP
+
 }
 

mdoc/mdoc.Test/CppFormatterTests.cs

@@ -2,11 +2,14 @@
 using Mono.Cecil;
 using NUnit.Framework;
 using Mono.Documentation.Updater.Formatters.CppFormatters;
+#if !NETCOREAPP
 using Mono_DocTest_Generic;
 using Mono_DocTest;
+#endif //!NETCOREAPP
 
 namespace mdoc.Test
 {
+#if !NETCOREAPP
     public class CppFormatterTests : BasicFormatterTests<CppMemberFormatter>
     {
         #region Types
@@ -191,4 +194,6 @@ protected override TypeDefinition GetType(Type type)
         }
 
     }
+#endif //!NETCOREAPP
+
 }