fix: JSDoc comments do not automatically apply to overloads #1704
Labels
status: needs triage
Issues which needs to be reproduced to be verified report.
type: fix
Issues describing a broken feature.
Description
In the index.ts file (src/index.ts), only the first overload of each function was documented using JSDoc comments. The intention here seems to be that the same comment should be displayed for all overloads, but that is not how (most?) editors work.
For example, the
@deprecated
warning forplainToClass
does not appear for the second and third overload.Minimal code-snippet showcasing the problem
class-transformer/src/index.ts
Lines 12 to 24 in a073b5e
Expected behavior
Every function should be documented individually.
Actual behavior
Deprecated overloads are not displayed as such in editors.
The text was updated successfully, but these errors were encountered: