Skip to content
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

@hidden annotation hides all documentation for overloads #1142

Closed
1 task done
fjcaetano opened this issue Nov 25, 2019 · 2 comments
Closed
1 task done

@hidden annotation hides all documentation for overloads #1142

fjcaetano opened this issue Nov 25, 2019 · 2 comments
Labels
enhancement Improved functionality help wanted Contributions are especially encouraged

Comments

@fjcaetano
Copy link

Expected Behavior

When using the @hidden annotation in an overload, only that overload's documentation should be hidden.

Actual Behavior

The documentation for all overloads, including the implementation is hidden.

Motivation

I have a method similar to Promise.all which I have implemented 10 overloads, supporting 10 different generic types. Since Typescript is able to import the documentation from the implementation, there's no need to document each single overload. At the same time, adding incremental overloads pollutes the Typedoc generated documentation, therefore, most of the overloads's documentation could be hidden.

Steps to reproduce the bug

Run Typedoc in the following playground link

Environment

  • Typedoc version: 0.15.0
  • Node.js version: v10.17.0
  • OS: macOS 10.14.6
@fjcaetano fjcaetano added the bug Functionality does not match expectation label Nov 25, 2019
@Gerrit0 Gerrit0 added enhancement Improved functionality help wanted Contributions are especially encouraged and removed bug Functionality does not match expectation labels Nov 26, 2019
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Nov 26, 2019

PR welcome, I'm kind of surprised this is how it works currently, I thought reflections were excluded based on their node comment...

If you give this a shot, be sure to add a test (editing an existing function test should be fine) that covers some/all/none of the overloads being hidden.

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jan 14, 2020

Fixed in v0.16.3 :) Thanks @socsieng!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improved functionality help wanted Contributions are especially encouraged
Projects
None yet
Development

No branches or pull requests

2 participants