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

Feature request: Add ability to create docblock link to specific param tags #3

Open
Shrugsy opened this issue Apr 13, 2021 · 0 comments

Comments

@Shrugsy
Copy link
Contributor

Shrugsy commented Apr 13, 2021

Background

Currently when using a docblock link for params, it will show all params in a list, e.g.

Input docblock

/**
 * 
 * @param arg1 first arg
 * @param opts.opt1 first option
 * @param opts.opt2 second option
 */
function foo(arg1, { opt1, opt2 }) {}

docblock link

[params](docblock://index.ts?token=foo)

Output

  • arg1 first arg
  • opts.opt1 first option
  • opts.opt2 second option

Request

This feature request is for the ability to link directly to a specific param, and only provide the comment for that param.
e.g. (pseudo-code)

docblock link

[params](docblock://index.ts?token=foo?param=opts.opt1)

Desired output

first arg

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

1 participant