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

feat: reflect the location of the referenced symbols inside JSDoc comments #208

Open
2 tasks done
jordimarimon opened this issue Oct 1, 2023 · 0 comments
Open
2 tasks done
Assignees
Labels
feature Feature requests. Please vote with reactions!

Comments

@jordimarimon
Copy link
Owner

Prerequisites

Describe the Feature Request

A lot of block tags allow to reference symbols that are defined elsewhere in the source code.

When reflecting the JSDoc, it would be useful to know the location where the referenced symbol is defined.

Describe the Use Case

For example:

/**
 * Both of these will link to the bar function.
 * @see {@link bar}
 * @see bar
 */
function foo() {}

/**
 * @see {@link foo} for further information.
 */
function bar() {}

When one generates the documentation, they will want to link the above two functions.

There are a lot of block tags where you can reference other symbols (another example would be the @borrows block tag: https://jsdoc.app/tags-borrows.html)

@jordimarimon jordimarimon self-assigned this Oct 21, 2023
@jordimarimon jordimarimon added the feature Feature requests. Please vote with reactions! label Oct 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Feature requests. Please vote with reactions!
Projects
None yet
Development

No branches or pull requests

1 participant