Skip to content

Commit 07dc60b

Browse files
authored
[Mono.Android] Generate API docs with "full" verbosity (#8435)
Updates `$(AndroidJavadocVerbosity)` to `full` to generate additional API docs content. A `javadocVerbosity` parameter has been added to the API docs build pipeline to make it easier to toggle this setting when queueing a docs build. The docs build pipeline has been updated to upload the output of the `Mono.Android` build to make it easier to download and push docs updates to the [apidrop/binaries][0] repository. [0]: https://apidrop.visualstudio.com/binaries/_git/binaries
1 parent a82a578 commit 07dc60b

File tree

2 files changed

+31
-7
lines changed

2 files changed

+31
-7
lines changed

build-tools/automation/azure-pipelines-apidocs.yaml

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@ parameters:
2929
type: string
3030
default: default
3131

32+
- name: javadocVerbosity
33+
displayName: AndroidJavadocVerbosity property value
34+
type: string
35+
default: default
36+
37+
3238
# Global variables
3339
variables:
3440
- template: yaml-templates/variables.yaml
@@ -40,6 +46,8 @@ variables:
4046
value: ''
4147
- name: MdocPackageVersionArg
4248
value: ''
49+
- name: AndroidJavadocVerbosity
50+
value: ''
4351

4452

4553
stages:
@@ -79,6 +87,10 @@ stages:
7987
- script: echo "##vso[task.setvariable variable=MdocPackageVersionArg]-p:MdocPackageVersion=${{ parameters.mdocVersion }}"
8088
displayName: set MdocPackageVersionArg
8189

90+
- ${{ if ne(parameters.javadocVerbosity, 'default') }}:
91+
- script: echo "##vso[task.setvariable variable=AndroidJavadocVerbosity]-p:AndroidJavadocVerbosity=${{ parameters.javadocVerbosity }}"
92+
displayName: set AndroidJavadocVerbosity
93+
8294
- template: yaml-templates/use-dot-net.yaml
8395

8496
- task: NuGetAuthenticate@0
@@ -97,15 +109,21 @@ stages:
97109

98110
- script: >-
99111
make update-api-docs CONFIGURATION=$(XA.Build.Configuration)
100-
MSBUILD_ARGS='$(DocsApiLevelArg) $(DocsPlatformIdArg) $(DocsFxVersionArg) $(MdocPackageVersionArg)'
112+
MSBUILD_ARGS='$(DocsApiLevelArg) $(DocsPlatformIdArg) $(DocsFxVersionArg) $(MdocPackageVersionArg) $(AndroidJavadocVerbosity)'
101113
workingDirectory: $(Build.SourcesDirectory)
102114
displayName: make update-api-docs
103115
104-
- template: yaml-templates/upload-results.yaml
105-
parameters:
106-
artifactName: Build Results - API Docs Update
107-
includeBuildResults: true
108-
condition: always()
116+
- script: >
117+
mkdir -p $(Build.StagingDirectory)/docs-binaries &&
118+
ln $(Build.SourcesDirectory)/bin/$(XA.Build.Configuration)/lib/xamarin.android/xbuild-frameworks/Microsoft.Android/34/*.dll $(Build.StagingDirectory)/docs-binaries/ &&
119+
ln $(Build.SourcesDirectory)/bin/$(XA.Build.Configuration)/lib/xamarin.android/xbuild-frameworks/Microsoft.Android/34/*.xml $(Build.StagingDirectory)/docs-binaries/
120+
displayName: copy docs files
121+
122+
- task: PublishPipelineArtifact@1
123+
displayName: upload docs files
124+
inputs:
125+
artifactName: Binaries
126+
targetPath: $(Build.StagingDirectory)/docs-binaries
109127

110128
- script: >
111129
mkdir -p $(Build.StagingDirectory)/api-doc-diff &&
@@ -118,6 +136,12 @@ stages:
118136
artifactName: Api Docs Diff
119137
targetPath: $(Build.StagingDirectory)/api-doc-diff
120138

139+
- template: yaml-templates/upload-results.yaml
140+
parameters:
141+
artifactName: Build Results - API Docs Update
142+
includeBuildResults: true
143+
condition: always()
144+
121145
- powershell: |
122146
$docsUpdateBinlog = Get-ChildItem -Path "$(Build.SourcesDirectory)/bin/Build$(XA.Build.Configuration)" -Filter *UpdateApiDocs-*.binlog | Select-Object -First 1
123147
$buildLog = "$(Build.SourcesDirectory)/bin/Build$(XA.Build.Configuration)/temp-build.log"

src/Mono.Android/Mono.Android.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
</PropertyGroup>
3838

3939
<PropertyGroup Condition=" '$(IncludeAndroidJavadoc)' == 'True' ">
40-
<AndroidJavadocVerbosity Condition=" '$(AndroidJavadocVerbosity)' == '' ">intellisense+extraremarks</AndroidJavadocVerbosity>
40+
<AndroidJavadocVerbosity Condition=" '$(AndroidJavadocVerbosity)' == '' ">full</AndroidJavadocVerbosity>
4141
<DocumentationFile>$(OutputPath)Mono.Android.xml</DocumentationFile>
4242
<NoWarn>$(NoWarn);CS1572;CS1573;CS1574;CS1584;CS1587;CS1591;CS1658;</NoWarn>
4343
</PropertyGroup>

0 commit comments

Comments
 (0)