-
Notifications
You must be signed in to change notification settings - Fork 34
[interop] Add Support for JSDoc Documentation #435
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.
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
Open
nikeokoronkwo
wants to merge
6
commits into
dart-lang:main
Choose a base branch
from
nikeokoronkwo:interop/docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
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
kevmoo
reviewed
Aug 4, 2025
# Conflicts: # web_generator/lib/src/ast/declarations.dart # web_generator/lib/src/ast/helpers.dart # web_generator/lib/src/interop_gen/transform/transformer.dart
srujzs
approved these changes
Aug 6, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very cool, thanks Nike!
@srujzs – can be merged? |
…form refactored `generateFromDocumentation` for nullable docs and removed unnecessary add for annotations in `transformer.dart`
srujzs
approved these changes
Aug 8, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, but let's wait to submit until we have CI no longer flaky again.
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.
Fixes #413
This PR adds support for parsing documentation for nodes/declarations in JSDoc and rewriting/providing them in a Dart-styled format, with support for
@link
references, annotations (@experimental
and@deprecated
for now), and more.Documentation is generated for all declarations where documentation is provided.