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

JSDoc and TypeScript IntelliSense support for @link inline tag #57495

Closed
fredrikhr opened this issue Aug 29, 2018 · 1 comment
Closed

JSDoc and TypeScript IntelliSense support for @link inline tag #57495

fredrikhr opened this issue Aug 29, 2018 · 1 comment
Assignees
Labels
*duplicate Issue identified as a duplicate of another issue(s) javascript JavaScript support issues upstream Issue identified as 'upstream' component related (exists outside of VS Code)

Comments

@fredrikhr
Copy link

fredrikhr commented Aug 29, 2018

Use JSDoc: {@link} defines the @link, @linkplain and @linkcode tags in JavaScript and TypeScript JSDoc-style documentation comments.

As can be seen in the screenshot below the IntelliSense tooltip does not recognize the presence of the @link tag correctly.

image

The following describes how the different usages of @link should be rendered:

Thus the following example from Use JSDoc: {@link}#Examples

/**
 * See {@link MyClass} and [MyClass's foo property]{@link MyClass#foo}.
 * Also, check out {@link http://www.google.com|Google} and
 * {@link https://github.com GitHub}.
 */

should render in the VS Code Intellisense tootip as:

See MyClass and MyClass's foo property. Also, check out Google and GitHub

Using the @linkplain tag instead of @link should suppress link colouring and make the link text appear as normal text.

Using the @linkcode tag instead of @link should make the link appear in a monospace font (as if the entire Link was wrapped inside an HTML <code></code> tag.

Use JSDoc: {@link} also states that the link target can be a namepath instead of a URL. Ideally, IntelliSense should suggest all known symbols in the current scope when writing the @link tag. When written, the namepath should support go-to-definition and find-all-references behaviour.

@fredrikhr fredrikhr changed the title JSDoc and TypeScript IntelliSense suuport for @link inline tag JSDoc and TypeScript IntelliSense support for @link inline tag Aug 29, 2018
@mjbvz
Copy link
Contributor

mjbvz commented Sep 4, 2018

Duplicate of microsoft/TypeScript#16498

@mjbvz mjbvz marked this as a duplicate of microsoft/TypeScript#16498 Sep 4, 2018
@mjbvz mjbvz closed this as completed Sep 4, 2018
@mjbvz mjbvz added upstream Issue identified as 'upstream' component related (exists outside of VS Code) javascript JavaScript support issues *duplicate Issue identified as a duplicate of another issue(s) labels Sep 4, 2018
@vscodebot vscodebot bot locked and limited conversation to collaborators Oct 19, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
*duplicate Issue identified as a duplicate of another issue(s) javascript JavaScript support issues upstream Issue identified as 'upstream' component related (exists outside of VS Code)
Projects
None yet
Development

No branches or pull requests

2 participants