Skip to content

Links for "Implementation of X.y" are missing sometimes #2233

@RunDevelopment

Description

@RunDevelopment

Search terms

Implementation of

Expected Behavior

The "Implementation of X.y" section should always link to both X and y.

image

Actual Behavior

If y and the implementation of y are not the same kind, then there will be no link.

Note: I have only tested with methods implementing a property, but I highly suspect that properties implementing a method will have the same issue. Another case that should be tested is accessors implementing methods.

In the following example, isFinal is declared as a property, but implemented as a method.

image
image

Steps to reproduce the bug

  1. Download https://github.com/RunDevelopment/refa
  2. npm ci
  3. npm i -d typedoc@0.24.1
  4. npm run build:docs
  5. Open docs/index.html

Or see the doc pages generated by 0.23.28: ENFA.Builder#isFinal and FABuilder#isFinal.

Environment

  • Typedoc version: 0.24.1 (or 0.23.x)
  • TypeScript version: 5.0.2
  • Node.js version: 16.13.0
  • OS: Win10

Additional context

It's import for typedoc to support both styles. Property style declarations in interfaces have slightly different semantics to method style declarations, so we sometimes must use property style to ensure correctness. For more info, see TypeScript ESLint's method-signature-style rule.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No fields configured for Bug.

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions