-
-
Notifications
You must be signed in to change notification settings - Fork 5.8k
chore: fix / clean up jsdoc comments #1342
Copy link
Copy link
Open
Labels
choreGeneral improvementGeneral improvementcode qualityCode quality improvementCode quality improvementdocumentationPR that adds or fixes docs; issue that points out issues with the docsPR that adds or fixes docs; issue that points out issues with the docs
Description
Activity
Metadata
Metadata
Assignees
Labels
choreGeneral improvementGeneral improvementcode qualityCode quality improvementCode quality improvementdocumentationPR that adds or fixes docs; issue that points out issues with the docsPR that adds or fixes docs; issue that points out issues with the docs
Motivation
Many people who use libraries not only use help of jsdoc for methods, but also for the parameters. So, moving the jsdoc declaration from before
classto beforeconstructorwould definitely help many beginners using this library. Then, the descriptions would show up for the parameters as well.Examples
No response
Possible workarounds
The possible workaround is that instead of moving the jsdoc completely to before
constructor, the description can stay beforeclassbut the@paramneeds to be moved to beforeconstructorAdditional information
as stated by the documentation for classes