@param with name "foo", which was not used
When Parameter Name Matches Excluded Property Name From Parent Class
#2636
Labels
bug
Functionality does not match expectation
Search terms
The signature Foo.constructor has an @param with name "bar", which was not used
Expected Behavior
The behavior from TypeDoc versions 0.26.1 and below is expected. The documentation should not exclude documented parameters, nor should it warn about unrelated properties.
Actual Behavior
When a parent class (
A
in this example) has an excluded property (a
in this example) with a name that matches the name of a child class' (B
in this example) constructor parameter, a warning is given and the parameter is excluded from the documentation.Steps to reproduce the bug
Install TypeDoc version 2.6.2, 2.6.3, or 2.6.4.
Enable
excludeInternal
in your TypeDoc configuration.Use a file with the following contents as an entrypoint.
Execute
typedoc
.The following warning messages will be displayed:
Additionally, the generated documentation will exclude
a
from the constructor ofB
:Environment
The text was updated successfully, but these errors were encountered: