`{@link ...}` macros are broken with typedoc 0.23

Question

`{@link ...}` macros are broken with typedoc 0.23

Closed this issue 2 years ago · 4 comments

Originally reported to typedoc, but after more debugging it looks like its a problem with the postprocessing. Looks like the JSON definition has changed in 0.23. Previosly the link macros were there intact, now they are provided as separate items in summary array.

with 0.22:

and with 0.23:

Answer 1 · 2022-07-20T02:04:42.000Z

@B4nan Thanks just pushed a fix. This will use the same functionality as previously.

Answer 2 · 2022-07-20T19:22:33.000Z

Looks like it works for regular links, but when I tried the suggestion to get rid of the warnings as described in TypeStrong/typedoc#2000 the link is not rendered correctly.

edit: hmm and the typedoc warning is also still there

Btw how does the @apilink work, is it just aliasing and the changes done in typedoc for @link resolution will be reflected here as well?

Answer 3 · 2022-07-20T19:47:48.000Z

@B4nan This plugin puts everything into the global scope and references that way. It doesn't work in the same way the typedoc itself does, so that @crawlee/cheerio... pattern won't work.

Answer 4 · 2022-07-20T19:51:53.000Z

Ok so even better, it won't be needed and things continue working, right? But given how the warning looks, I am affraid such links will produce errors when generating the JSON file as they will be considered invalid :/

(it literally says "This link will break in v0.24..", but maybe it won't be a build failure, let's see when it comes)