Skip to content

Support # in links #1629

Closed
Closed
Feature
@RunDevelopment

Description

@RunDevelopment

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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions