ui5-typescript icon indicating copy to clipboard operation
ui5-typescript copied to clipboard

`@sapui5/ts-types-esm` - broken links in docs

Open DetachHead opened this issue 3 years ago • 1 comments

  /**
   * @deprecated (since 1.85) - use {@link module:sap/base/security/URLListValidator.Entry} instead.
   *
   * Entry object of the URLWhitelist.
   */

webstorm: image

vscode: image clicking it takes you here: image

DetachHead avatar Nov 24 '21 07:11 DetachHead

TL;DR: not sure whether module:... JSDoc links are supposed to work at all right now.

https://github.com/microsoft/TypeScript/issues/16498 was about @link with http(s) links, but mentions that symbol links are harder to support due to lacking stuff in the TS compiler APIs.

https://github.com/microsoft/TypeScript/issues/35524 is about the rest and was closed by the "80% solution" in https://github.com/microsoft/TypeScript/pull/41877 which was then reverted and re-tried in https://github.com/microsoft/TypeScript/pull/43312

I frankly don't know whether this PR includes support for module:... links, which were earlier found to only be used in 2% of cases

Also related on VSCode side: https://github.com/microsoft/vscode/pull/99922 was closed, waiting for TS side

akudev avatar Dec 29 '21 16:12 akudev