Skip to content

Commit e8c3c9a

Browse files
Enable generation of documentation xml file for track1 SDKs (Azure#23824)
* Enable generation of documentation xml file for track1 SDKs Remove instances of duplicate property setters from individual SDKs * Disable generating doc file for projects with errors * Fix project names and sort entries
1 parent f393526 commit e8c3c9a

File tree

4 files changed

+43
-10
lines changed

4 files changed

+43
-10
lines changed

eng/Directory.Build.Common.props

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@
77

88
<MgmtAutorestVersion>3.0.0-beta.20210504.1</MgmtAutorestVersion>
99

10+
<!-- Enable documentation for all projects unless explicitly disabled. -->
11+
<DocumentationFile>$(IntermediateOutputPath)$(TargetFramework)\$(MSBuildProjectName).xml</DocumentationFile>
12+
1013
<!-- Client in this context is any library that is following the new Azure SDK guidelines -->
1114
<IsClientLibrary Condition="'$(IsClientLibrary)' == '' and $(MSBuildProjectName.StartsWith('Azure.'))">true</IsClientLibrary>
1215

@@ -177,13 +180,52 @@
177180
<AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory)MSSharedLibKey.snk</AssemblyOriginatorKeyFile>
178181
</PropertyGroup>
179182

183+
<!-- Disable documentation for projects that need fixes before this can be enabled. -->
184+
<PropertyGroup Condition="
185+
$(MSBuildProjectName.Equals('Microsoft.Azure.ApplicationInsights.Query')) or
186+
$(MSBuildProjectName.Equals('Microsoft.Azure.CognitiveServices.AnomalyDetector')) or
187+
$(MSBuildProjectName.Equals('Microsoft.Azure.CognitiveServices.Knowledge.QnAMaker')) or
188+
$(MSBuildProjectName.Equals('Microsoft.Azure.CognitiveServices.Language.LUIS.Authoring')) or
189+
$(MSBuildProjectName.Equals('Microsoft.Azure.CognitiveServices.Language.LUIS.Runtime')) or
190+
$(MSBuildProjectName.Equals('Microsoft.Azure.CognitiveServices.Language.SpellCheck')) or
191+
$(MSBuildProjectName.Equals('Microsoft.Azure.CognitiveServices.Language.TextAnalytics')) or
192+
$(MSBuildProjectName.Equals('Microsoft.Azure.CognitiveServices.Personalizer')) or
193+
$(MSBuildProjectName.Equals('Microsoft.Azure.CognitiveServices.Search.BingAutoSuggest')) or
194+
$(MSBuildProjectName.Equals('Microsoft.Azure.CognitiveServices.Search.BingCustomImageSearch')) or
195+
$(MSBuildProjectName.Equals('Microsoft.Azure.CognitiveServices.Search.BingCustomSearch')) or
196+
$(MSBuildProjectName.Equals('Microsoft.Azure.CognitiveServices.Search.BingEntitySearch')) or
197+
$(MSBuildProjectName.Equals('Microsoft.Azure.CognitiveServices.Search.BingImageSearch')) or
198+
$(MSBuildProjectName.Equals('Microsoft.Azure.CognitiveServices.Search.BingLocalSearch')) or
199+
$(MSBuildProjectName.Equals('Microsoft.Azure.CognitiveServices.Search.BingNewsSearch')) or
200+
$(MSBuildProjectName.Equals('Microsoft.Azure.CognitiveServices.Search.BingVideoSearch')) or
201+
$(MSBuildProjectName.Equals('Microsoft.Azure.CognitiveServices.Search.BingVisualSearch')) or
202+
$(MSBuildProjectName.Equals('Microsoft.Azure.CognitiveServices.Search.BingWebSearch')) or
203+
$(MSBuildProjectName.Equals('Microsoft.Azure.CognitiveServices.Vision.ComputerVision')) or
204+
$(MSBuildProjectName.Equals('Microsoft.Azure.CognitiveServices.Vision.ContentModerator')) or
205+
$(MSBuildProjectName.Equals('Microsoft.Azure.CognitiveServices.Vision.CustomVision.Prediction')) or
206+
$(MSBuildProjectName.Equals('Microsoft.Azure.CognitiveServices.Vision.CustomVision.Training')) or
207+
$(MSBuildProjectName.Equals('Microsoft.Azure.CognitiveServices.Vision.Face')) or
208+
$(MSBuildProjectName.Equals('Microsoft.Azure.CognitiveServices.Vision.FormRecognizer')) or
209+
$(MSBuildProjectName.Equals('Microsoft.Azure.ContainerRegistry')) or
210+
$(MSBuildProjectName.Equals('Microsoft.Azure.EventGrid')) or
211+
$(MSBuildProjectName.Equals('Microsoft.Azure.HDInsight.Job')) or
212+
$(MSBuildProjectName.Equals('Microsoft.Azure.Graph.RBAC')) or
213+
$(MSBuildProjectName.Equals('Microsoft.Azure.KeyVault')) or
214+
$(MSBuildProjectName.Equals('Microsoft.Azure.KeyVault.Core')) or
215+
$(MSBuildProjectName.Equals('Microsoft.Azure.KeyVault.Cryptography')) or
216+
$(MSBuildProjectName.Equals('Microsoft.Azure.KeyVault.Extensions')) or
217+
$(MSBuildProjectName.Equals('Microsoft.Azure.KeyVault.WebKey')) or
218+
$(MSBuildProjectName.Equals('Microsoft.Azure.OperationalInsights'))">
219+
220+
<DocumentationFile></DocumentationFile>
221+
</PropertyGroup>
222+
180223
<PropertyGroup Condition="'$(IsClientLibrary)' == 'true'">
181224
<!-- Use a full key for the new client libraries and disable delay signing -->
182225
<AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory)AzureSDKClient.snk</AssemblyOriginatorKeyFile>
183226
<DelaySign>false</DelaySign>
184227
<PublicSign>false</PublicSign>
185228
<ImportDefaultReferences>false</ImportDefaultReferences>
186-
<DocumentationFile>$(IntermediateOutputPath)$(TargetFramework)\$(MSBuildProjectName).xml</DocumentationFile>
187229

188230
<!-- The set of tags that should be added to the packages -->
189231
<PackageCommonTags>windowsazureofficial;azureofficial</PackageCommonTags>

sdk/personalizer/Directory.Build.props

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,4 @@
33
Add any shared properties you want for the projects under this package directory that need to be set before the auto imported Directory.Build.props
44
-->
55
<Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., Directory.Build.props))\Directory.Build.props" />
6-
<PropertyGroup>
7-
<DocumentationFile>$(IntermediateOutputPath)$(TargetFramework)\$(MSBuildProjectName).xml</DocumentationFile>
8-
</PropertyGroup>
96
</Project>

sdk/search/Directory.Build.props

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,4 @@
33
Add any shared properties you want for the projects under this package directory that need to be set before the auto imported Directory.Build.props
44
-->
55
<Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., Directory.Build.props))\Directory.Build.props" />
6-
<PropertyGroup>
7-
<DocumentationFile>$(IntermediateOutputPath)$(TargetFramework)\$(MSBuildProjectName).xml</DocumentationFile>
8-
</PropertyGroup>
96
</Project>

sdk/webpubsub/Directory.Build.props

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,4 @@
33
Add any shared properties you want for the projects under this package directory that need to be set before the auto imported Directory.Build.props
44
-->
55
<Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., Directory.Build.props))\Directory.Build.props" />
6-
<PropertyGroup>
7-
<DocumentationFile>$(IntermediateOutputPath)$(TargetFramework)\$(MSBuildProjectName).xml</DocumentationFile>
8-
</PropertyGroup>
96
</Project>

0 commit comments

Comments
 (0)