Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Use @link for jsdoc, and make compatible with lit.dev API documentation #503

Closed
AndrewJakubowicz opened this issue Sep 15, 2021 · 3 comments
Closed

Use @link for jsdoc, and make compatible with lit.dev API documentation #503

AndrewJakubowicz opened this issue Sep 15, 2021 · 3 comments
Assignees
@AndrewJakubowicz

Comments

@AndrewJakubowicz
Copy link
Contributor

Tracking issue from lit/lit#2161.

We should start using e.g. {@link ReactiveController}, since that will work in VSCode too. We will need to change or update this regexp to extract them for our lit.dev API docs:

lit.dev/packages/lit-dev-tools/src/generate-api-docs-data.ts

Line 730 in e2d7fd3

/\[\[[\s`]*(.+?)(?:[\s`]*\|[\s`]*(.+?))?[\s`]*\]\]/g,

@AndrewJakubowicz AndrewJakubowicz self-assigned this Sep 15, 2021
@AndrewJakubowicz AndrewJakubowicz mentioned this issue Sep 15, 2021
Merged
AndrewJakubowicz added a commit to lit/lit that referenced this issue Dec 14, 2021
@AndrewJakubowicz
Revert to a link syntax lit.dev understands.
fb04457 
See lit/lit.dev#503 for @link issue.
@AndrewJakubowicz
Copy link
Contributor Author

Bumping this onto my radar. @link is better for editors. VS code will allow clicking on @link and will jump to definition. Whilst [[ ]] renders directly in the editor without any possible user interaction.

@AndrewJakubowicz
Copy link
Contributor Author

Note, links in @param don't work.

AndrewJakubowicz added a commit to lit/lit that referenced this issue Dec 14, 2021
@AndrewJakubowicz
Revert to a link syntax lit.dev understands.
9d83806 
See lit/lit.dev#503 for @link issue.
@AndrewJakubowicz AndrewJakubowicz mentioned this issue Dec 14, 2021
Merged
AndrewJakubowicz added a commit to lit/lit that referenced this issue Dec 14, 2021
@AndrewJakubowicz
Revert to a link syntax lit.dev understands.
ff0faa9 
See lit/lit.dev#503 for @link issue.
AndrewJakubowicz added a commit to lit/lit that referenced this issue Dec 14, 2021
@AndrewJakubowicz
Revert to a link syntax lit.dev understands.
6283acd 
See lit/lit.dev#503 for @link issue.
@AndrewJakubowicz AndrewJakubowicz mentioned this issue Dec 21, 2021
Merged
@AndrewJakubowicz
Copy link
Contributor Author

Original issue is resolved.

Note, links in @param don't work.

This may still be an issue, but should have a separate issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@AndrewJakubowicz AndrewJakubowicz

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@AndrewJakubowicz