Skip to content

[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
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

nikeokoronkwo
Copy link
Collaborator

@nikeokoronkwo nikeokoronkwo commented Aug 2, 2025

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.

There is currently no way to get library-level documentation via the TypeScript API

@nikeokoronkwo nikeokoronkwo marked this pull request as ready for review August 2, 2025 06:44
@nikeokoronkwo nikeokoronkwo requested a review from srujzs August 2, 2025 06:44
# Conflicts:
#	web_generator/lib/src/ast/declarations.dart
#	web_generator/lib/src/ast/helpers.dart
#	web_generator/lib/src/interop_gen/transform/transformer.dart
Copy link
Contributor

@srujzs srujzs left a 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!

@kevmoo
Copy link
Member

kevmoo commented Aug 8, 2025

@srujzs – can be merged?

…form

refactored `generateFromDocumentation` for nullable docs and removed unnecessary add for annotations in `transformer.dart`
Copy link
Contributor

@srujzs srujzs left a 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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Interop Gen: Support Documentation
3 participants