TypeStrong / TypeStrong/typedoc

@internal interface still shown in 'Implements' panel and 'Implementation of' footers of implementing class

Open
#3,099 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
8.5k
Forks
775
PR merge metrics
No merged PRs in 30d

Description

Search terms

@internal, @hidden, excludeInternal, "Implements", "Implementation of", heritage clauses

Expected behavior

When an interface is hidden (@internal with excludeInternal, or @hidden), references to it from a documented implements-er should also be scrubbed:

  • it should not appear in the class's Implements panel, and
  • implemented methods should not show an Implementation of Foo.bar footer pointing at it.

Actual behavior

The Implements panel still lists the hidden interface (as plain text, since the page wasn't generated), and each implemented method still renders Implementation of Foo.bar referencing it. TypeDoc emits

Host, defined in .../host.ts, is referenced by Manager but not included in the documentation

so it knows the reference is dangling, but renders the heritage display anyway.

The same happens with @hidden (so it's not specific to excludeInternal), and whether the implementer is a class or an interface (e.g. via export type { default as Manager }).

Minimal reproduction

src/host.ts:

/** @internal */
export type Host = {
  adjust(at: number, count: number): void,
};

src/manager.ts:

import type { Host } from './host';

export default class Manager implements Host {
  adjust (at: number, count: number): void {
    void at; void count;
  }
}

src/index.ts:

export { default as Manager } from './manager';

typedoc.json:

{
  "entryPoints": ["src/index.ts"],
  "out": "docs",
  "excludeInternal": true
}

Run npx typedoc and open docs/classes/Manager.html. It contains:

<section class="tsd-panel">
  <h4>Implements</h4>
  <ul class="tsd-hierarchy">
    <li><span class="tsd-signature-type">Host</span></li>
  </ul>
</section>
…
<aside class="tsd-sources">
  <p>Implementation of Host.adjust</p>
  <ul><li>Defined in <a href=".../manager.ts#L4">manager.ts:4</a></li></ul>
</aside>

Both of those reference the Host type, which is @internal and I've specified "excludeInternal": true.

What I expect instead:

  1. the <section> with the Implements heading shouldn't be emitted at all.
  2. the <aside> for adjust should omit the <p>Implementation of Host.adjust</p>, leaving just:
<aside class="tsd-sources">
  <ul><li>Defined in <a href=".../manager.ts#L4">manager.ts:4</a></li></ul>
</aside>

Environment

  • TypeDoc: 0.28.19 (also 0.28.18)
  • TypeScript: 5.9.x
  • Node.js: v22
  • OS: macOS

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the minimal reproduction in src/host.ts, src/manager.ts, src/index.ts, and typedoc.json, then run npx typedoc and inspect docs/classes/Manager.html. Trace how TypeDoc renders the Implements panel and Implementation of footer for hidden references; done means neither reference appears while the Defined in source link remains.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.