Skip to content

Commit e2a5a12

Browse files
authored
[Mono.Android] Ignore CS1584, CS1658 documentation warnings (#5651)
Commit a7413a2 updated the non-PR `src/Mono.Android` build to import Android Javadoc comments and translate them into C# XML documentation comments when building on CI for non-PR branches, or locally when the `$(IncludeAndroidJavadoc)` MSBuild property is True: cd src/Mono.Android msbuild /restore /v:diag /p:IncludeAndroidJavadoc=True This translation is buggy and incomplete, e.g. it emits `<see/>` elements, but doesn't translate the `//see/@cref` value from Java: /// <c><see cref="#getChildStaticTransformation(View, android.view.animation.Transformation)" /></c> to be This results in an additional 40k+ warnings on our main CI, a'la: obj/Debug/netcoreapp3.1/android-30/mcw/Android.Views.ViewGroup.cs(5047,21): warning CS1584: XML comment has syntactically incorrect cref attribute '#getChildStaticTransformation(View, android.view.animation.Transformation)' obj/Debug/netcoreapp3.1/android-30/mcw/Android.Views.ViewGroup.cs(5047,21): warning CS1658: Identifier expected. See also error CS1001. This is why a7413a2 ignored multiple C# XML documentation warnings. Update `$(NoWarn)` to also ignore CS1584 and CS1658 warnings. This will hopefully bring the number of warnings reported on CI down to a more manageable level.
1 parent c7cec54 commit e2a5a12

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

src/Mono.Android/Mono.Android.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030

3131
<PropertyGroup Condition=" '$(IncludeAndroidJavadoc)' == 'True' ">
3232
<DocumentationFile>$(OutputPath)Mono.Android.xml</DocumentationFile>
33-
<NoWarn>$(NoWarn);CS1572;CS1573;CS1574;CS1587;CS1591;</NoWarn>
33+
<NoWarn>$(NoWarn);CS1572;CS1573;CS1574;CS1584;CS1587;CS1591;CS1658;</NoWarn>
3434
</PropertyGroup>
3535

3636
<PropertyGroup Condition=" '$(TargetFramework)' == 'monoandroid10' ">

0 commit comments

Comments
 (0)