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
Running typedoc for fully documented constructor types should not produce any warnings.
Actual Behavior
The following warnings are produced:
[warning] Constructor.__type (ConstructorSignature), defined in ./index.ts, does not have any documentation.
[warning] TypedConstructor.__type (ConstructorSignature), defined in ./index.ts, does not have any documentation.
Steps to reproduce the bug
index.ts
/** * Constructor. * * @param args - Constructor arguments. * @returns New instance. */exporttypeConstructor=new(...args: any[])=>object;/** * Typed constructor. * * @typeParam T - Class type. * @param args - Constructor arguments. * @returns New instance. */exporttypeTypedConstructor<T>=new(...args: any[])=>T;
Signatures are the bane of my existence, there are entirely too many edge cases around them, so I always seem to miss at least one when touching that code...
Search terms
notDocumented, constructor, warning
Expected Behavior
Running typedoc for fully documented constructor types should not produce any warnings.
Actual Behavior
The following warnings are produced:
Steps to reproduce the bug
index.ts
tsconfig.json
typedoc.json
Environment
Notes
The latest typedoc where it worked was
0.25.4
. The warnings started to appear after updating to0.25.5
or higher,The text was updated successfully, but these errors were encountered: