RFC: `@see` block tag specifies an item for a "See Also" section

I use the eslint-plugin-tsdoc for linting, and noticed that the JSDoc @see tag is not supported in the list of TSDoc tags.

We use @see tags extensively in one of our projects, so it would be great to add support for it so the TSDoc ESLint plugin doesn’t warn for using that tag.

I’m happy to write a PR. Is all it takes adding this to the list of TSDoc tags?

[octogonz]

JSDoc also specifies:

You can provide either a symbol’s namepath or free-form text.

This aspect seems problematic. Namepaths are ambiguous with free-form text.

For example, if instead of this:

 * @see *Elements* 
 * by Euclid

…I wrote it as:

 * @see Elements

…then how is the parser supposed to know whether Elements was meant to be an API item reference or a free-form title?

Thus I’d propose that TSDoc omit this aspect and instead require an explicit {@link} for any hyperlinks with @see.

Are you guys okay with that?

[rbuckton]

You cannot emulate @seealso properly with DocFX, as how seealso entries are rendered depends on the DocFX template in place since they are unique items in the schema.

Also, @see is supported by the jsdoc package: