fix XML Documentation (Rewrite AddXmlLanguage and add to Nupkg Audit)

.props/_Nupkg.props

@@ -11,6 +11,7 @@
     <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
     <IncludeSymbols>True</IncludeSymbols>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
 
   <PropertyGroup>

.scripts/release_NupkgAudit.ps1

@@ -149,6 +149,22 @@ function Get-DoesXmlDocExist ([string]$dllPath) {
     Test-Condition (Test-Path $docFile) $message $requirement;
 }
 
+function Get-DoesXmlDocContainsLang ([string]$dllPath) {
+    # CONFIRM .XML DOCUMENTATION FILE EXISTS WITH EACH DLL
+    [string]$docFile = $dllPath -replace ".dll", ".xml";
+
+    [bool]$result = $false;
+    [string]$searchString = '<doc xml:lang="en">';
+
+    if (Test-Path $docFile) {
+        $result = select-string -path $docFile -Pattern $searchString -Quiet;
+    }
+
+    $message = "XML Documentation:";
+    $requirement = "Must contain xml:lang='en' ";
+    Test-Condition ($result) $message $requirement;
+}
+
 function Get-DoesDllVersionsMatch ([string]$dllPath) {
     # CONFIRM Assembly version matches File version
     [string]$fileVersion = [System.Diagnostics.FileVersionInfo]::GetVersionInfo($dllPath).FileVersion;
@@ -323,6 +339,7 @@ function Start-EvaluateNupkg ($nupkgPath) {
         Get-DoesDllVersionsMatch $_.FullName;
 
         Get-DoesXmlDocExist $_.FullName;
+        Get-DoesXmlDocContainsLang $_.FullName;
         }
 }
 

.targets/AddXmlLanguage.targets

@@ -1,80 +1,37 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
 
-  <Target Name="Info_AddXmlLanguageTargets"  BeforeTargets="Build" Condition=" $(Internal_Logging) == 'true' ">
-    <Message Text="Info: AddXmlLanguage.targets imported by $(MSBuildProjectName)." Importance="high"/>
-  </Target>
-
-
     <UsingTask TaskName="InjectXmlLanguage" TaskFactory="RoslynCodeTaskFactory" AssemblyFile="$(MSBuildToolsPath)\Microsoft.Build.Tasks.Core.dll">
         <ParameterGroup>
-            <InputFiles ParameterType="Microsoft.Build.Framework.ITaskItem[]" Required="true" />
+          <FilePath ParameterType="System.String" Required="true" />
         </ParameterGroup>
         <Task>
-            <!--<Reference Include="System" />-->
             <Using Namespace="System" />
             <Using Namespace="System.Diagnostics" />
             <Using Namespace="System.IO" />
           <!--
             Not sure where the requirement of xml:lang="en" came from. But to address it - hacking is the only way now:
             https://social.msdn.microsoft.com/forums/en-us/70b984eb-f490-4494-8fbc-12fe4a62e5e4/xmllang-on-doc-for-xml-doc-comments?forum=xmlandnetfx
           -->
-            <Code Type="Fragment" Language="cs">
-                <![CDATA[
-                    Log.LogMessage("Called InjectXmlLanguage");
-                    foreach (var inputFilePath in InputFiles.Select(f => f.ItemSpec))
-                    {
-                        Log.LogMessage("Fixing {0}", inputFilePath);
-                        string filePath = inputFilePath;
-                        if (filePath.EndsWith(".dll", StringComparison.OrdinalIgnoreCase))
-                        {
-                            filePath = filePath.Substring(0, filePath.Length - 3) + "xml";
-                        }
-
-                        if (filePath.EndsWith(".xml", StringComparison.OrdinalIgnoreCase))
-                        {
-                            string[] files = null;
-                            int starIndex = filePath.IndexOf('*');
-                            if (starIndex >= 0)
-                            {
-                                string dir = filePath.Substring(0, starIndex);
-                                if (string.IsNullOrEmpty(dir))
-                                {
-                                    dir = ".";
-                                }
+            <Code Type="Fragment" Language="cs"><![CDATA[
+                    Log.LogMessage(MessageImportance.High, "InjectXmlLanguage -> {0}", FilePath);
 
-                                string file = Path.GetFileName(filePath.Substring(starIndex));
-                                files = Directory.GetFiles(dir, file, SearchOption.AllDirectories);
-                            }
-                            else
-                            {
-                                files = new[] { filePath };
-                            }
-
-                            foreach (string fileName in files)
-                            {
-                                if (File.Exists(fileName))
-                                {
-                                    Log.LogMessage("Processing XML: {0}", fileName);
-                                    string text = File.ReadAllText(fileName);
-                                    text = text.Replace("<doc>", "<doc xml:lang=\"en\">");
-                                    File.WriteAllText(fileName, text);
-                                }
-                            }
-                        }
+                    if (File.Exists(FilePath))
+                    {
+                        string text = File.ReadAllText(FilePath);
+                        text = text.Replace("<doc>", "<doc xml:lang=\"en\">");
+                        File.WriteAllText(FilePath, text);
+                    }
+                    else
+                    {
+                      Log.LogError("InjectXmlLanguage: Assembly XML Doc file not found in bin folder.");
                     }
-                ]]>
-            </Code>
+            ]]></Code>
         </Task>
     </UsingTask>
 
     <Target Name="FixXmlDocumentation" AfterTargets="AfterBuild" DependsOnTargets="AfterBuild"  Condition="$(OS) == 'Windows_NT'">
-        <InjectXmlLanguage InputFiles="$(DocumentationFile)" />
+        <InjectXmlLanguage FilePath="$(OutputPath)\$(AssemblyName).XML" />
     </Target>
 
-  <Target Name="AddXmlDocToNugetPackage" Condition="$(OS) == 'Windows_NT'">
-    <ItemGroup>
-      <BuildOutputInPackage Include="$(OutputPath)$(TargetName).xml" />
-    </ItemGroup>
-  </Target>
 </Project>

BASE/Common.props

@@ -37,7 +37,4 @@
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <DefineConstants>$(DefineConstants);TRACE</DefineConstants>
   </PropertyGroup>
-  <PropertyGroup>
-    <TargetsForTfmSpecificBuildOutput>$(TargetsForTfmSpecificBuildOutput);AddXmlDocToNugetPackage</TargetsForTfmSpecificBuildOutput>
-  </PropertyGroup>
 </Project>

BASE/Common.targets

@@ -2,6 +2,6 @@
 <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
 
   <Import Project="Signing.targets" />
-  <Import Project="AddXmlLanguage.targets" />
+  <Import Project="$(TargetsRoot)\AddXmlLanguage.targets" />
 
 </Project>

BASE/src/Microsoft.ApplicationInsights/Product.props

@@ -11,6 +11,5 @@
   <PropertyGroup>
     <RootNamespace>Microsoft.ApplicationInsights</RootNamespace>
     <AssemblyName>$(RootNamespace)</AssemblyName>
-    <DocumentationFile>$(OutputPath)\$(TargetFramework)\$(AssemblyName).XML</DocumentationFile>
   </PropertyGroup>
 </Project>

BASE/src/ServerTelemetryChannel/Product.props

@@ -11,6 +11,5 @@
   <PropertyGroup>
     <RootNamespace>Microsoft.ApplicationInsights.WindowsServer.TelemetryChannel</RootNamespace>
     <AssemblyName>Microsoft.AI.ServerTelemetryChannel</AssemblyName>
-    <DocumentationFile>$(OutputPath)\$(TargetFramework)\$(AssemblyName).XML</DocumentationFile>
   </PropertyGroup>
 </Project>

LOGGING/Common.props

@@ -24,7 +24,4 @@
     <DefineConstants>$(DefineConstants);TRACE</DefineConstants>
   </PropertyGroup>
 
-  <PropertyGroup>
-    <TargetsForTfmSpecificBuildOutput>$(TargetsForTfmSpecificBuildOutput);AddXmlDocToNugetPackage</TargetsForTfmSpecificBuildOutput>
-  </PropertyGroup>
 </Project>

LOGGING/Common.targets

@@ -2,6 +2,6 @@
 <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
 
   <Import Project="Signing.targets" />
-  <Import Project="AddXmlLanguage.targets" />
+  <Import Project="$(TargetsRoot)\AddXmlLanguage.targets" />
 
 </Project>

LOGGING/src/Product.props

@@ -11,9 +11,4 @@
     <OutputPath>$([System.IO.Path]::GetFullPath( $(OutputPath) ))\</OutputPath>
   </PropertyGroup>
 
-  <PropertyGroup>
-    <DocumentationFile>$(OutputPath)\$(TargetFramework)\$(AssemblyName).XML</DocumentationFile>
-    <GenerateDocumentationFile>true</GenerateDocumentationFile>
-  </PropertyGroup>
-
 </Project>

NETCORE/src/Microsoft.ApplicationInsights.AspNetCore/Microsoft.ApplicationInsights.AspNetCore.csproj

@@ -19,11 +19,6 @@
     <PackageTags>$(PackageTags)aspnetcore;</PackageTags>
   </PropertyGroup>
 
-  <PropertyGroup>
-    <!--Package Settings-->
-    <GenerateDocumentationFile>true</GenerateDocumentationFile>
-  </PropertyGroup>
-
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
     <!--Symbols Settings-->
     <DebugType>full</DebugType>
@@ -112,4 +107,5 @@
     <PackageReference Include="System.Net.NameResolution" Version="4.3.0" />
   </ItemGroup>
 
+  <Import Project="$(TargetsRoot)\AddXmlLanguage.targets" />
 </Project>

NETCORE/src/Microsoft.ApplicationInsights.WorkerService/Microsoft.ApplicationInsights.WorkerService.csproj

@@ -18,11 +18,6 @@
     <PackageTags>$(PackageTags)worker;console;backgroundtasks;</PackageTags>
   </PropertyGroup>
 
-  <PropertyGroup>
-    <!--Package Settings-->
-    <GenerateDocumentationFile>true</GenerateDocumentationFile>
-  </PropertyGroup>
-
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
     <!--Symbols Settings-->
     <DebugType>full</DebugType>
@@ -88,4 +83,6 @@
 
     <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="2.2.0" />
   </ItemGroup>
+
+  <Import Project="$(TargetsRoot)\AddXmlLanguage.targets" />
 </Project>