Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support generating XML documentation file for each assembly file #18719

Merged
merged 2 commits into from
Jun 24, 2022
Merged

Support generating XML documentation file for each assembly file #18719

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cf4ec8b
Add Az.Post.props
BethanyZhou Jun 24, 2022
1a189e7
Update all csproj files
BethanyZhou Jun 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion build.proj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)" />
Expand Down
2 changes: 2 additions & 0 deletions src/ADDomainServices/Az.ADDomainServices.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@
</PropertyGroup>

<Import Project="$(MSBuildThisFileDirectory)..\Az.autorest.props" />
<Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />

</Project>
4 changes: 3 additions & 1 deletion src/Accounts/Accounts/Accounts.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<PsModuleName>Accounts</PsModuleName>
Expand Down Expand Up @@ -64,4 +64,6 @@
</EmbeddedResource>
</ItemGroup>

<Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />

</Project>
6 changes: 4 additions & 2 deletions src/Accounts/Authentication.ResourceManager/Authentication.ResourceManager.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<PsModuleName>Accounts</PsModuleName>
Expand Down Expand Up @@ -30,4 +30,6 @@
</EmbeddedResource>
</ItemGroup>

</Project>
<Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />

</Project>
4 changes: 3 additions & 1 deletion src/Accounts/Authentication/Authentication.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<PsModuleName>Accounts</PsModuleName>
Expand Down Expand Up @@ -30,4 +30,6 @@
</EmbeddedResource>
</ItemGroup>

<Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />

</Project>
6 changes: 4 additions & 2 deletions src/Accounts/AuthenticationAssemblyLoadContext/AuthenticationAssemblyLoadContext.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<PsModuleName>Accounts</PsModuleName>
</PropertyGroup>
Expand All @@ -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>
2 changes: 2 additions & 0 deletions src/Accounts/Authenticators/Authenticators.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
4 changes: 3 additions & 1 deletion src/Advisor/Advisor/Advisor.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
2 changes: 2 additions & 0 deletions src/Aks/Aks.Autorest/Az.Aks.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
6 changes: 4 additions & 2 deletions src/Aks/Aks/Aks.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<PsModuleName>Aks</PsModuleName>
Expand Down Expand Up @@ -32,4 +32,6 @@
</EmbeddedResource>
</ItemGroup>

</Project>
<Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />

</Project>
4 changes: 3 additions & 1 deletion src/AlertsManagement/AlertsManagement/AlertsManagement.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,6 @@
</EmbeddedResource>
</ItemGroup>

</Project>
<Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />

</Project>
6 changes: 4 additions & 2 deletions src/AnalysisServices/AnalysisServices.Dataplane/AnalysisServices.Dataplane.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<PsModuleName>AnalysisServices</PsModuleName>
Expand All @@ -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>
4 changes: 3 additions & 1 deletion src/AnalysisServices/AnalysisServices/AnalysisServices.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
6 changes: 4 additions & 2 deletions src/ApiManagement/ApiManagement.ServiceManagement/ApiManagement.ServiceManagement.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<PsModuleName>ApiManagement</PsModuleName>
Expand Down Expand Up @@ -31,4 +31,6 @@
</EmbeddedResource>
</ItemGroup>

</Project>
<Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />

</Project>
4 changes: 3 additions & 1 deletion src/ApiManagement/ApiManagement/ApiManagement.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
2 changes: 2 additions & 0 deletions src/App/Az.App.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
6 changes: 4 additions & 2 deletions src/AppConfiguration/Az.AppConfiguration.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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>
2 changes: 2 additions & 0 deletions src/ApplicationInsights/Az.ApplicationInsights.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
6 changes: 4 additions & 2 deletions src/Attestation/Attestation/Attestation.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<PsModuleName>Attestation</PsModuleName>
Expand All @@ -22,4 +22,6 @@
</Reference>
</ItemGroup>

</Project>
<Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />

</Project>
4 changes: 3 additions & 1 deletion src/Automation/Automation/Automation.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,6 @@
</EmbeddedResource>
</ItemGroup>

</Project>
<Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />

</Project>
9 changes: 9 additions & 0 deletions src/Az.Post.props
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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>

15 changes: 14 additions & 1 deletion src/Az.autorest.hybrid.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'">
Expand Down
15 changes: 14 additions & 1 deletion src/Az.autorest.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'">
Expand Down
2 changes: 2 additions & 0 deletions src/BareMetal/Az.BareMetal.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
6 changes: 4 additions & 2 deletions src/Batch/Batch/Batch.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<PsModuleName>Batch</PsModuleName>
Expand All @@ -23,4 +23,6 @@
</Compile>
</ItemGroup>

</Project>
<Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />

</Project>
4 changes: 3 additions & 1 deletion src/Billing/Billing/Billing.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
4 changes: 3 additions & 1 deletion src/Billing/Consumption/Consumption.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
4 changes: 3 additions & 1 deletion src/Billing/UsageAggregates/UsageAggregates.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
4 changes: 3 additions & 1 deletion src/Blueprint/Blueprint/Blueprint.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,6 @@
</EmbeddedResource>
</ItemGroup>

</Project>
<Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />

</Project>
2 changes: 2 additions & 0 deletions src/BotService/Az.BotService.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@
</PropertyGroup>

<Import Project="$(MSBuildThisFileDirectory)..\Az.autorest.props" />
<Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />

</Project>
2 changes: 2 additions & 0 deletions src/Cdn/Az.Cdn.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
2 changes: 2 additions & 0 deletions src/ChangeAnalysis/Az.ChangeAnalysis.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
2 changes: 2 additions & 0 deletions src/CloudService/Az.CloudService.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@
</PropertyGroup>

<Import Project="$(MSBuildThisFileDirectory)..\Az.autorest.props" />
<Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />

</Project>
6 changes: 4 additions & 2 deletions src/CognitiveServices/CognitiveServices/CognitiveServices.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<PsModuleName>CognitiveServices</PsModuleName>
Expand All @@ -20,4 +20,6 @@
</Compile>
</ItemGroup>

</Project>
<Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />

</Project>
2 changes: 2 additions & 0 deletions src/Communication/Az.Communication.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@
</PropertyGroup>

<Import Project="$(MSBuildThisFileDirectory)..\Az.autorest.props" />
<Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., build.proj))\src\Az.Post.props" />

</Project>
4 changes: 3 additions & 1 deletion src/Compute/Compute.AlcWrapper/Compute.AlcWrapper.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Loading