Doc should support JSDoc link

[iugo]

https://jsdoc.app/tags-inline-link.html

/**
 * {@link https://docs.github.com/en/free-pro-team@latest/rest doc}
 */

should be "doc"

not be " {@link https://docs.github.com/en/free-pro-team@latest/rest doc}"

[jaydenseric]

Inline links to other documented members in descriptions is absolutely critical, an MVP feature.

There are several variations of the original JSDoc @link inline tag, this being the most useful:

[`Foo`]{@link Foo}

Because you can link whatever markdown formatted text you need in a way consistent with regular markdown links, e.g:

/**
 * Lorem ipsum [dolor sit amet]{@link Foo}, consectetur [adipiscing](https://deno.land) elit.
 */

I've used this format extensively to document my npm packages using jsdoc-md: https://github.com/jaydenseric/jsdoc-md#inline-tags .

Example:

• Source: https://github.com/jaydenseric/graphql-upload/blob/v12.0.0/public/Upload.js#L4-L10
• Docs: https://github.com/jaydenseric/graphql-upload/tree/v12.0.0#class-upload

Note that TSDoc (which BTW is a very slow work-in-progress, often differs from "standard" JSDoc, and isn't even fully adopted by TypeScript / VS Code) has a take on inline links:

https://tsdoc.org/pages/tags/link