Skip to content

Commit

Permalink
[Mono.Android] Emit only summary XML, not full XML
Browse files Browse the repository at this point in the history
Context: dotnet#5253 (comment)
Context: dotnet/java-interop#687 (comment)
Context: dotnet/java-interop@a65b8ab

It looks like only emitting `<summary/>`, `<param/>`, `<returns/>`,
and `<exception/>` is *much* faster than trying to do full
`<remarks/>`.

Update the `generator.exe` invocation to use
`generator --doc-comment-style=summary`, which will hopefully
speed things up.
  • Loading branch information
jonpryor committed Dec 17, 2020
1 parent f8c18d3 commit d5e9f73
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
6 changes: 5 additions & 1 deletion src/Mono.Android/Mono.Android.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,16 @@
</PropertyGroup>

<PropertyGroup>
<!--
<IncludeAndroidJavadoc Condition=" '$(IncludeAndroidJavadoc)' == '' And '$(CONVERT_JAVADOC_TO_XMLDOC)' == 'true' And '$(AndroidFrameworkVersion)' == '$(AndroidLatestStableFrameworkVersion)'">True</IncludeAndroidJavadoc>
-->
<!-- TODO: replace with above; for CI timing purposes only! -->
<IncludeAndroidJavadoc Condition=" '$(IncludeAndroidJavadoc)' == '' And '$(AndroidFrameworkVersion)' == '$(AndroidLatestStableFrameworkVersion)'">True</IncludeAndroidJavadoc>
</PropertyGroup>

<PropertyGroup Condition=" '$(IncludeAndroidJavadoc)' == 'True' ">
<DocumentationFile>$(OutputPath)Mono.Android.xml</DocumentationFile>
<NoWarn>CS1573;CS1591</NoWarn>
<NoWarn>CS1572;CS1573;CS1574;CS1587;CS1591;</NoWarn>
</PropertyGroup>

<PropertyGroup Condition=" '$(TargetFramework)' == 'monoandroid10' ">
Expand Down
2 changes: 1 addition & 1 deletion src/Mono.Android/Mono.Android.targets
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@
</ItemGroup>
<PropertyGroup>
<Generator>"$(XAInstallPrefix)xbuild\Xamarin\Android\generator.exe"</Generator>
<_GenFlags>--public --product-version=7</_GenFlags>
<_GenFlags>--doc-comment-style=summary --public --product-version=7</_GenFlags>
<_ApiLevel>--api-level=$(AndroidApiLevel)</_ApiLevel>
<_Out>-o "$(IntermediateOutputPath)mcw"</_Out>
<_Codegen>--codegen-target=XAJavaInterop1</_Codegen>
Expand Down

0 comments on commit d5e9f73

Please sign in to comment.