[jnigen] Propagate Javadoc deprecation messages#3475
Open
Siya-05 wants to merge 1 commit into
Open
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR is a follow-up to #3429 and addresses part of #2796.
The previous PR generated Dart
@Deprecatedannotations for Java methods annotated withjava.lang.Deprecated, using a generic deprecation message.This PR propagates the Java
@deprecatedJavadoc message into the generated Dart@Deprecated(...)annotation when bindings are generated with the doclet backend, providing developers with the original deprecation guidance from the Java source.When Javadocs are unavailable (for example, when using the ASM backend), the generator continues to fall back to the generic
"This Java method is deprecated."message.Changes
JavaDocComment.deprecatedMessagehelper to extract the@deprecatedJavadoc message.@Deprecated(...)annotations using the extracted Javadoc message when available.simple_packagetest fixture with a Javadoc deprecation message.Related Issues
Addresses part of #2796.
PR Checklist
dart tool/ci.dart --alllocally and resolved all issues identified. This ensures the PR is formatted, has no lint errors, and ran all code generators. This applies to the packages part of the toplevelpubspec.yamlworkspace.@deprecatedJavadoc message into generated Dart@Deprecated(...)annotations.CHANGELOG.mdfor the relevant packages. (Not needed for small changes such as doc typos.)