[javadoc-to-mdoc] workaround Java6 annotation parsing failure. #568
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Docs for Java6 annotations are not parsed as expected and causing crash as https://bugzilla.xamarin.com/show_bug.cgi?id=55402 states. Since we are not going to seriously work on Java6 documentation parser, we just workaround the null issue.
jonpryor
pushed a commit
that referenced
this pull request
Apr 21, 2017
Docs for Java6 annotations are not parsed as expected and causing crash as https://bugzilla.xamarin.com/show_bug.cgi?id=55402 states. Since we are not going to seriously work on Java6 documentation parser, we just workaround the null issue.
jonpryor
pushed a commit
that referenced
this pull request
Feb 19, 2020
Context: dotnet/java-interop@8f30933 Changes: dotnet/java-interop@3226a4b...8f30933 * dotnet/java-interop@8f30933: [generator] Mark some Obsolete fields as errors (#568) * dotnet/java-interop@47201c4: [generator] Change protected members in final class to private (#569) * dotnet/java-interop@c5815fb: [generator] Be smarter about when members with same names need "new" (#567) * dotnet/java-interop@bfc0273: [generator] Ensure property setter parameter name is "value" (#566) This Java.Interop bump includes two changes which "break" API: * Certain fields are changed from `[Obsolete]` to `[Obsolete(error:true)]`, turning *use* of the field within C# code into a CS0619 error. * The C# compiler has long warned about the presence of `protected` members within `sealed` types, as they cannot be used. However, they were still emitted, resulting in CS0628 warnings when compiling `Mono.Android.dll`. We consider changing `[Obsolete]` to `[Obsolete(error:true)]` to be acceptable because this is being done to `const` fields, so this won't break ABI, as there are no IL references to `const` fields, and because (1) there are "replacement" members which can be used, and (2) these fields have been obsolete for *years*. The "problem" here is that `Microsoft.DotNet.ApiCompat.exe`, which the `<CheckApiCompatibility/>` task uses from `src/Mono.Android/Mono.Android.targets`, sees every such change as an API break. This in and of itself is plausibly sensible, but the error message *itself* is bananas, e.g.: namespace Android.AccessibilityServices { public abstract partial class AccessibilityService : Android.App.Service { [Register ("GESTURE_SWIPE_DOWN", ApiSince = 16)] [Obsolete ("This constant will be removed in the future version. Use Android.AccessibilityServices.AccessibilityGesture enum directly instead of this field.", error: true)] public const Android.AccessibilityServices.AccessibilityGesture GestureSwipeDown = (Android.AccessibilityServices.AccessibilityGesture) 2; } } results in: CannotRemoveAttribute : Attribute 'System.ObsoleteAttribute' exists on 'Android.AccessibilityServices.AccessibilityGesture Android.AccessibilityServices.AccessibilityService.GestureSwipeDown' in the contract but not the implementation. The message implies that `[Obsolete]` was removed, which isn't strictly true! `[Obsolete]` is still there! It's just that the constructor parameters have changed. This results in a ginormous change to `tests/api-compatibility/acceptable-breakages-vReference.txt`. The "`protected` members within `sealed` types" fix for CS0628 also resulted in errors from the Tests > API Compatibility job, which runs via `external/xamarin-android-api-compatibility`. Given that commit 07e7477 was intended to *replace* the Tests > API Compatibility job, *remove* the `external/xamarin-android-api-compatibility` submodule reference. We will no longer be using that submodule for API compat checks. Co-authored-by: Jonathan Pobst <monkey@jpobst.com>
jonpryor
pushed a commit
that referenced
this pull request
Feb 19, 2020
Context: dotnet/java-interop@8f30933 Changes: dotnet/java-interop@423e27f...fefe0ca * dotnet/java-interop@fefe0ca: [generator] Mark some Obsolete fields as errors (#568) * dotnet/java-interop@d969a0c: [generator] Change protected members in final class to private (#569) * dotnet/java-interop@3c4accf: [generator] Be smarter about when members with same names need "new" (#567) * dotnet/java-interop@41b87d0: [generator] Ensure property setter parameter name is "value" (#566) This Java.Interop bump includes two changes which "break" API: * Certain fields are changed from `[Obsolete]` to `[Obsolete(error:true)]`, turning *use* of the field within C# code into a CS0619 error. * The C# compiler has long warned about the presence of `protected` members within `sealed` types, as they cannot be used. However, they were still emitted, resulting in CS0628 warnings when compiling `Mono.Android.dll`. We consider changing `[Obsolete]` to `[Obsolete(error:true)]` to be acceptable because this is being done to `const` fields, so this won't break ABI, as there are no IL references to `const` fields, and because (1) there are "replacement" members which can be used, and (2) these fields have been obsolete for *years*. The "problem" here is that `Microsoft.DotNet.ApiCompat.exe`, which the `<CheckApiCompatibility/>` task uses from `src/Mono.Android/Mono.Android.targets`, sees every such change as an API break. This in and of itself is plausibly sensible, but the error message *itself* is bananas, e.g.: namespace Android.AccessibilityServices { public abstract partial class AccessibilityService : Android.App.Service { [Register ("GESTURE_SWIPE_DOWN", ApiSince = 16)] [Obsolete ("This constant will be removed in the future version. Use Android.AccessibilityServices.AccessibilityGesture enum directly instead of this field.", error: true)] public const Android.AccessibilityServices.AccessibilityGesture GestureSwipeDown = (Android.AccessibilityServices.AccessibilityGesture) 2; } } results in: CannotRemoveAttribute : Attribute 'System.ObsoleteAttribute' exists on 'Android.AccessibilityServices.AccessibilityGesture Android.AccessibilityServices.AccessibilityService.GestureSwipeDown' in the contract but not the implementation. The message implies that `[Obsolete]` was removed, which isn't strictly true! `[Obsolete]` is still there! It's just that the constructor parameters have changed. This results in a ginormous change to `tests/api-compatibility/acceptable-breakages-vReference.txt`. The "`protected` members within `sealed` types" fix for CS0628 also resulted in errors from the Tests > API Compatibility job, which runs via `external/xamarin-android-api-compatibility`. Given that commit 07e7477 was intended to *replace* the Tests > API Compatibility job, *remove* the `external/xamarin-android-api-compatibility` submodule reference. We will no longer be using that submodule for API compat checks. Co-authored-by: Jonathan Pobst <monkey@jpobst.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Docs for Java6 annotations are not parsed as expected and causing
crash as https://bugzilla.xamarin.com/show_bug.cgi?id=55402 states.
Since we are not going to seriously work on Java6 documentation parser,
we just workaround the null issue.