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.

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

Support usage of {@link url text} in @listens, et al #93

Closed
nalexander50 opened this issue Dec 14, 2020 · 1 comment
Closed

Support usage of {@link url text} in @listens, et al #93

nalexander50 opened this issue Dec 14, 2020 · 1 comment

Comments

@nalexander50
Copy link

Currently, if you add an @link tag for @listens, the URL gets broken by the insertion of a random event:. I looked through the codebase and couldn't figure out where event: was coming from. The only way I've found to fix it is to add a .replace('event:', '') to the method.tmpl file.

JavaScript

/**
* @listens {@link https://developer.mozilla.org/en-US/docs/Web/API/Element/contextmenu_event context-menu}
*/

HTML

<a href="https://developer.mozilla.event:org/en-US/docs/Web/API/Element/contextmenu_event">context-menu</a>

Notice that the domain has become Mozilla.event:org which is obviously invalid.

My assumption (although not verified) is that this problem is likely to exist in other places as well, such as @fires. Other than the broken URL, the remainder of the HTML is perfectly fine.

@ar2rsawseen
Copy link
Collaborator

I think we already receive parsed data from taffy like this, so it should be fixed on jsdoc side, I would recommend to open issue with them

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

No branches or pull requests

2 participants