Skip to content

Support # in links #1629

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

Closed
RunDevelopment opened this issue Jul 15, 2021 · 1 comment
Closed

Support # in links #1629

RunDevelopment opened this issue Jul 15, 2021 · 1 comment
Milestone

Comments

@RunDevelopment
Copy link
Contributor

Search Terms

link, member

Problem

JSDoc and JavaDoc use # to refer to instance methods and fields of a class (e.g. Class#method) while . is used for static methods and fields (e.g. Class.staticField).

TypeDoc does not support this. Even worse, TypeDoc doesn't even error or warn when encountering such links.

image

(input code, referenced method)

Suggested Solution

Support #. TypeDoc doesn't really differentiate between static and instance members right now, so treating # as a . should work.


Also, is it a bug that invalid links are just printed as is? Shouldn't there be a warning since it's an invalid reference?

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jul 16, 2021

Shouldn't there be a warning since it's an invalid reference?

There is, if you turn on listInvalidSymbolLinks

Semi-dupe of #488

@Gerrit0 Gerrit0 added this to the v0.23 milestone Apr 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants