Skip to content

[Mono.Android] Generate API docs with "full" verbosity #8435

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

Merged
jonpryor merged 2 commits into from
Oct 18, 2023
+31 −7
Merged

[Mono.Android] Generate API docs with "full" verbosity #8435

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
25d609f
[Mono.Android] Generate API docs with "full" verbosity
pjcollins Oct 17, 2023
0973d2e
Fix MonoAndroid output upload
pjcollins Oct 17, 2023
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
36 changes: 30 additions & 6 deletions build-tools/automation/azure-pipelines-apidocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,12 @@ parameters:
type: string
default: default

- name: javadocVerbosity
displayName: AndroidJavadocVerbosity property value
type: string
default: default


# Global variables
variables:
- template: yaml-templates/variables.yaml
Expand All @@ -40,6 +46,8 @@ variables:
value: ''
- name: MdocPackageVersionArg
value: ''
- name: AndroidJavadocVerbosity
value: ''


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

- ${{ if ne(parameters.javadocVerbosity, 'default') }}:
- script: echo "##vso[task.setvariable variable=AndroidJavadocVerbosity]-p:AndroidJavadocVerbosity=${{ parameters.javadocVerbosity }}"
displayName: set AndroidJavadocVerbosity

- template: yaml-templates/use-dot-net.yaml

- task: NuGetAuthenticate@0
Expand All @@ -97,15 +109,21 @@ stages:

- script: >-
make update-api-docs CONFIGURATION=$(XA.Build.Configuration)
MSBUILD_ARGS='$(DocsApiLevelArg) $(DocsPlatformIdArg) $(DocsFxVersionArg) $(MdocPackageVersionArg)'
MSBUILD_ARGS='$(DocsApiLevelArg) $(DocsPlatformIdArg) $(DocsFxVersionArg) $(MdocPackageVersionArg) $(AndroidJavadocVerbosity)'
workingDirectory: $(Build.SourcesDirectory)
displayName: make update-api-docs

- template: yaml-templates/upload-results.yaml
parameters:
artifactName: Build Results - API Docs Update
includeBuildResults: true
condition: always()
- script: >
mkdir -p $(Build.StagingDirectory)/docs-binaries &&
ln $(Build.SourcesDirectory)/bin/$(XA.Build.Configuration)/lib/xamarin.android/xbuild-frameworks/Microsoft.Android/34/*.dll $(Build.StagingDirectory)/docs-binaries/ &&
ln $(Build.SourcesDirectory)/bin/$(XA.Build.Configuration)/lib/xamarin.android/xbuild-frameworks/Microsoft.Android/34/*.xml $(Build.StagingDirectory)/docs-binaries/
displayName: copy docs files

- task: PublishPipelineArtifact@1
displayName: upload docs files
inputs:
artifactName: Binaries
targetPath: $(Build.StagingDirectory)/docs-binaries

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

- template: yaml-templates/upload-results.yaml
parameters:
artifactName: Build Results - API Docs Update
includeBuildResults: true
condition: always()

- powershell: |
$docsUpdateBinlog = Get-ChildItem -Path "$(Build.SourcesDirectory)/bin/Build$(XA.Build.Configuration)" -Filter *UpdateApiDocs-*.binlog | Select-Object -First 1
$buildLog = "$(Build.SourcesDirectory)/bin/Build$(XA.Build.Configuration)/temp-build.log"
Expand Down
2 changes: 1 addition & 1 deletion src/Mono.Android/Mono.Android.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
</PropertyGroup>

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