You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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.
socsieng
added a commit
to socsieng/typedoc
that referenced
this issue
Jan 14, 2020
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
0.15.0
v10.17.0
macOS 10.14.6
The text was updated successfully, but these errors were encountered: