Support generating XML documentation file for each assembly file (#18719

) * Add Az.Post.props * Update all csproj files
Azure · Jun 24, 2022 · 97b7682 · 97b7682
1 parent 5160afe
commit 97b7682
Show file tree

Hide file tree

Showing 177 changed files with 551 additions and 171 deletions.
diff --git a/build.proj b/build.proj
@@ -191,7 +191,8 @@
       <BuildAction Condition="'$(Configuration)' != 'Release'">build</BuildAction>
       <BuildAction Condition="'$(Configuration)' == 'Release'">publish</BuildAction>
     </PropertyGroup>
-    <Exec Command="dotnet $(BuildAction) $(RepoArtifacts)Azure.PowerShell.sln -c $(Configuration)" />
+    <Exec Command="dotnet $(BuildAction) $(RepoArtifacts)Azure.PowerShell.sln -c $(Configuration)" Condition="$(GenerateDocumentationFile) != 'false'"/>
+    <Exec Command="dotnet $(BuildAction) $(RepoArtifacts)Azure.PowerShell.sln -c $(Configuration) -p:GenerateDocumentationFile=false" Condition="$(GenerateDocumentationFile) == 'false'"/>
 
     <!-- Build version controller -->
     <Exec Command="dotnet build $(RepoTools)VersionController/VersionController.Netcore.csproj -c $(Configuration)" />

diff --git a/src/ADDomainServices/Az.ADDomainServices.csproj b/src/ADDomainServices/Az.ADDomainServices.csproj
@@ -4,4 +4,6 @@
   </PropertyGroup>
 
   <Import Project="$(MSBuildThisFileDirectory)..\Az.autorest.props" />
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
 </Project>
diff --git a/src/Accounts/Accounts/Accounts.csproj b/src/Accounts/Accounts/Accounts.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <PsModuleName>Accounts</PsModuleName>
@@ -64,4 +64,6 @@
     </EmbeddedResource>
   </ItemGroup>
 
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
 </Project>
diff --git a/src/Accounts/Authentication.ResourceManager/Authentication.ResourceManager.csproj b/src/Accounts/Authentication.ResourceManager/Authentication.ResourceManager.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <PsModuleName>Accounts</PsModuleName>
@@ -30,4 +30,6 @@
     </EmbeddedResource>
   </ItemGroup>
 
-</Project>
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
+</Project>
diff --git a/src/Accounts/Authentication/Authentication.csproj b/src/Accounts/Authentication/Authentication.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <PsModuleName>Accounts</PsModuleName>
@@ -30,4 +30,6 @@
     </EmbeddedResource>
   </ItemGroup>
 
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
 </Project>
diff --git a/src/Accounts/AuthenticationAssemblyLoadContext/AuthenticationAssemblyLoadContext.csproj b/src/Accounts/AuthenticationAssemblyLoadContext/AuthenticationAssemblyLoadContext.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <PsModuleName>Accounts</PsModuleName>
   </PropertyGroup>
@@ -22,4 +22,6 @@
     <AssemblyOriginatorKeyFile>$(RepoSrc)MSSharedLibKey.snk</AssemblyOriginatorKeyFile>
     <DefineConstants>TRACE;RELEASE;SIGN</DefineConstants>
   </PropertyGroup>
-</Project>
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
+</Project>
diff --git a/src/Accounts/Authenticators/Authenticators.csproj b/src/Accounts/Authenticators/Authenticators.csproj
@@ -37,4 +37,6 @@
     <Copy SourceFiles="@(OutputAssembly)" DestinationFolder="$(RepoArtifacts)$(Configuration)\Az.Accounts\PreloadAssemblies" />
   </Target>
 
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
 </Project>
diff --git a/src/Advisor/Advisor/Advisor.csproj b/src/Advisor/Advisor/Advisor.csproj
@@ -15,4 +15,6 @@
     <PackageReference Include="Microsoft.Azure.Management.Advisor" Version="0.9.5-preview" />
   </ItemGroup>
 
-</Project>
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
+</Project>
diff --git a/src/Aks/Aks.Autorest/Az.Aks.csproj b/src/Aks/Aks.Autorest/Az.Aks.csproj
@@ -5,4 +5,6 @@
   </PropertyGroup>
 
   <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.autorest.hybrid.props" />
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
 </Project>
diff --git a/src/Aks/Aks/Aks.csproj b/src/Aks/Aks/Aks.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <PsModuleName>Aks</PsModuleName>
@@ -32,4 +32,6 @@
     </EmbeddedResource>
   </ItemGroup>
 
-</Project>
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
+</Project>
diff --git a/src/AlertsManagement/AlertsManagement/AlertsManagement.csproj b/src/AlertsManagement/AlertsManagement/AlertsManagement.csproj
@@ -25,4 +25,6 @@
     </EmbeddedResource>
   </ItemGroup>
 
-</Project>
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
+</Project>
diff --git a/src/AnalysisServices/AnalysisServices.Dataplane/AnalysisServices.Dataplane.csproj b/src/AnalysisServices/AnalysisServices.Dataplane/AnalysisServices.Dataplane.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <PsModuleName>AnalysisServices</PsModuleName>
@@ -10,4 +10,6 @@
     <AssemblyName>$(AzAssemblyPrefix)$(PsModuleName).Dataplane</AssemblyName>
     <RootNamespace>$(LegacyAssemblyPrefix)$(PsModuleName).Dataplane</RootNamespace>
   </PropertyGroup>
-</Project>
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
+</Project>
diff --git a/src/AnalysisServices/AnalysisServices/AnalysisServices.csproj b/src/AnalysisServices/AnalysisServices/AnalysisServices.csproj
@@ -16,4 +16,6 @@
     <PackageReference Include="System.Security.Permissions" Version="4.5.0" />
   </ItemGroup>
 
-</Project>
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
+</Project>
diff --git a/src/ApiManagement/ApiManagement.ServiceManagement/ApiManagement.ServiceManagement.csproj b/src/ApiManagement/ApiManagement.ServiceManagement/ApiManagement.ServiceManagement.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <PsModuleName>ApiManagement</PsModuleName>
@@ -31,4 +31,6 @@
     </EmbeddedResource>
   </ItemGroup>
 
-</Project>
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
+</Project>
diff --git a/src/ApiManagement/ApiManagement/ApiManagement.csproj b/src/ApiManagement/ApiManagement/ApiManagement.csproj
@@ -22,4 +22,6 @@
     <Compile Include="$(StorageToolsPath)Adapters\WindowsAzure.Storage.8\AzureContextAdapterExtensions.cs" />
   </ItemGroup>
 
-</Project>
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
+</Project>
diff --git a/src/App/Az.App.csproj b/src/App/Az.App.csproj
@@ -4,4 +4,6 @@
   </PropertyGroup>
 
   <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.autorest.props" />
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
 </Project>
diff --git a/src/AppConfiguration/Az.AppConfiguration.csproj b/src/AppConfiguration/Az.AppConfiguration.csproj
@@ -1,7 +1,9 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <PsModuleName>AppConfiguration</PsModuleName>
   </PropertyGroup>
 
   <Import Project="$(MSBuildThisFileDirectory)..\Az.autorest.props" />
-</Project>
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
+</Project>
diff --git a/src/ApplicationInsights/Az.ApplicationInsights.csproj b/src/ApplicationInsights/Az.ApplicationInsights.csproj
@@ -4,4 +4,6 @@
   </PropertyGroup>
 
   <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.autorest.props" />
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
 </Project>
diff --git a/src/Attestation/Attestation/Attestation.csproj b/src/Attestation/Attestation/Attestation.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <PsModuleName>Attestation</PsModuleName>
@@ -22,4 +22,6 @@
     </Reference>
   </ItemGroup>
 
-</Project>
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
+</Project>
diff --git a/src/Automation/Automation/Automation.csproj b/src/Automation/Automation/Automation.csproj
@@ -30,4 +30,6 @@
     </EmbeddedResource>
   </ItemGroup>
 
-</Project>
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
+</Project>
diff --git a/src/Az.Post.props b/src/Az.Post.props
@@ -0,0 +1,9 @@
+<Project>
+  <!-- XML -->
+  <PropertyGroup>
+    <!-- warning CS1591: Missing XML comment for publicly visible type or member -->
+    <NoWarn>$(NoWarn),1591</NoWarn>
+    <DocumentationFile>$(OutputPath)\$(AssemblyName).xml</DocumentationFile>
+  </PropertyGroup>
+</Project>
+
diff --git a/src/Az.autorest.hybrid.props b/src/Az.autorest.hybrid.props
@@ -18,8 +18,21 @@
     <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
     <OutputPath>$(RepoArtifacts)$(Configuration)\Az.$(PsRootModuleName)\$(PsModuleFolder)\bin</OutputPath>
     <PublishDir>$(OutputPath)</PublishDir>
+    <!-- warning CS1998: This async method lacks 'await' operators and will run synchronously -->
     <!-- Some methods are marked async and don't have an await in them -->
-    <NoWarn>1998</NoWarn>
+    <NoWarn>$(NoWarn);1998</NoWarn>
+  </PropertyGroup>
+
+  <!-- Generate XML file-->
+  <PropertyGroup>
+    <!-- warning CS1570: XML comment has badly formed XML -->
+    <!-- warning CS1572: XML comment on 'construct' has a param tag for 'parameter', but there is no parameter by that name -->
+    <!-- warning CS1573: Parameter 'parameter' has no matching param tag in the XML comment for 'parameter' -->
+    <!-- warning CS1574: XML comment has cref attribute 'sourceValue' -->
+    <!-- warning CS1584: XML comment on 'member' has syntactically incorrect cref attribute 'invalid_syntax' -->
+    <!-- warning CS1587: XML comment is not placed on a valid language element -->
+    <!-- warning CS1571: XML comment has a duplicate param tag for 'serverName' -->
+    <NoWarn>$(NoWarn);1570, 1571, 1572, 1573, 1574, 1584, 1587</NoWarn>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">

diff --git a/src/Az.autorest.props b/src/Az.autorest.props
@@ -14,8 +14,21 @@
     <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
     <OutputPath>$(RepoArtifacts)$(Configuration)\Az.$(PsModuleName)\bin</OutputPath>
     <PublishDir>$(OutputPath)</PublishDir>
+    <!-- warning CS1998: This async method lacks 'await' operators and will run synchronously -->
     <!-- Some methods are marked async and don't have an await in them -->
-    <NoWarn>1998</NoWarn>
+    <NoWarn>$(NoWarn);1998</NoWarn>
+  </PropertyGroup>
+
+<!-- Generate XML file-->
+  <PropertyGroup>
+    <!-- warning CS1570: XML comment has badly formed XML -->
+    <!-- warning CS1572: XML comment on 'construct' has a param tag for 'parameter', but there is no parameter by that name -->
+    <!-- warning CS1573: Parameter 'parameter' has no matching param tag in the XML comment for 'parameter' -->
+    <!-- warning CS1574: XML comment has cref attribute 'sourceValue' -->
+    <!-- warning CS1584: XML comment on 'member' has syntactically incorrect cref attribute 'invalid_syntax' -->
+    <!-- warning CS1587: XML comment is not placed on a valid language element -->
+    <!-- warning CS1571: XML comment has a duplicate param tag for 'serverName' -->
+    <NoWarn>$(NoWarn);1570, 1571, 1572, 1573, 1574, 1584, 1587</NoWarn>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">

diff --git a/src/BareMetal/Az.BareMetal.csproj b/src/BareMetal/Az.BareMetal.csproj
@@ -4,4 +4,6 @@
   </PropertyGroup>
 
   <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.autorest.props" />
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
 </Project>
diff --git a/src/Batch/Batch/Batch.csproj b/src/Batch/Batch/Batch.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <PsModuleName>Batch</PsModuleName>
@@ -23,4 +23,6 @@
     </Compile>
   </ItemGroup>
 
-</Project>
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
+</Project>
diff --git a/src/Billing/Billing/Billing.csproj b/src/Billing/Billing/Billing.csproj
@@ -14,4 +14,6 @@
     <PackageReference Include="Microsoft.Azure.Management.Billing" Version="4.1.0" />
   </ItemGroup>
 
-</Project>
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
+</Project>
diff --git a/src/Billing/Consumption/Consumption.csproj b/src/Billing/Consumption/Consumption.csproj
@@ -15,4 +15,6 @@
     <PackageReference Include="Microsoft.Azure.Management.Consumption" Version="3.0.2" />
   </ItemGroup>
 
-</Project>
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
+</Project>
diff --git a/src/Billing/UsageAggregates/UsageAggregates.csproj b/src/Billing/UsageAggregates/UsageAggregates.csproj
@@ -15,4 +15,6 @@
     <PackageReference Include="Microsoft.Azure.Commerce.UsageAggregates" Version="1.5.3" />
   </ItemGroup>
 
-</Project>
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
+</Project>
diff --git a/src/Blueprint/Blueprint/Blueprint.csproj b/src/Blueprint/Blueprint/Blueprint.csproj
@@ -26,4 +26,6 @@
     </EmbeddedResource>
   </ItemGroup>
 
-</Project>
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
+</Project>
diff --git a/src/BotService/Az.BotService.csproj b/src/BotService/Az.BotService.csproj
@@ -4,4 +4,6 @@
   </PropertyGroup>
 
   <Import Project="$(MSBuildThisFileDirectory)..\Az.autorest.props" />
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
 </Project>
diff --git a/src/Cdn/Az.Cdn.csproj b/src/Cdn/Az.Cdn.csproj
@@ -4,4 +4,6 @@
   </PropertyGroup>
 
   <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.autorest.props" />
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
 </Project>
diff --git a/src/ChangeAnalysis/Az.ChangeAnalysis.csproj b/src/ChangeAnalysis/Az.ChangeAnalysis.csproj
@@ -4,4 +4,6 @@
   </PropertyGroup>
 
   <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.autorest.props" />
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
 </Project>
diff --git a/src/CloudService/Az.CloudService.csproj b/src/CloudService/Az.CloudService.csproj
@@ -4,4 +4,6 @@
   </PropertyGroup>
 
   <Import Project="$(MSBuildThisFileDirectory)..\Az.autorest.props" />
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
 </Project>
diff --git a/src/CognitiveServices/CognitiveServices/CognitiveServices.csproj b/src/CognitiveServices/CognitiveServices/CognitiveServices.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <PsModuleName>CognitiveServices</PsModuleName>
@@ -20,4 +20,6 @@
     </Compile>
   </ItemGroup>
 
-</Project>
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
+</Project>
diff --git a/src/Communication/Az.Communication.csproj b/src/Communication/Az.Communication.csproj
@@ -4,4 +4,6 @@
   </PropertyGroup>
 
   <Import Project="$(MSBuildThisFileDirectory)..\Az.autorest.props" />
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
 </Project>
diff --git a/src/Compute/Compute.AlcWrapper/Compute.AlcWrapper.csproj b/src/Compute/Compute.AlcWrapper/Compute.AlcWrapper.csproj
@@ -17,4 +17,6 @@
     <PackageReference Include="Azure.Storage.Blobs" Version="12.1.0" />
   </ItemGroup>
 
-</Project>
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />
+
+</Project>