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

Add support for @see documentation links #58

Closed
curthusting opened this issue Feb 19, 2021 · 1 comment · Fixed by #59
Closed

Add support for @see documentation links #58

curthusting opened this issue Feb 19, 2021 · 1 comment · Fixed by #59

Comments

@curthusting
Copy link

Is your feature request related to a problem? Please describe.

I am attempting to link to external resources via the jsdoc examples, i.e.;

/**
 * The jQuery plugin namespace.
 * @external "jQuery.fn"
 * @see {@link http://learn.jquery.com/plugins/|jQuery Plugins}
 */

Describe the solution you'd like

The built in template that comes with jsdoc provides a link to the external resource
image
whereas it appears this is ignored within this template
image

Describe alternatives you've considered

I have tried implementing this through alternate jsdoc tags, but to no avail...and if I had a greater knowledge of how to customize the templates, I would submit a PR, but being so new to jsdoc I am not aware of any other solution

Additional context

If you could point me in the right direction, I could try my hand at submitting a PR for this, but I would need some assistance getting started

@ankitskvmdam
Copy link
Owner

Thanks for reporting an issue. I will look into this and guide you accordingly.

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 a pull request may close this issue.

2 participants