Our convention on JavaScript code documentation was nearly nil, but now it involves JSDuck. So we should probably run through and rewrite a whole bunch of comments to make more sense.
Version: master
Severity: enhancement
Description
Description
Details
Details
- Reference
- bz49989
| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Invalid | None | T51987 UploadWizard has some pretty awful code in places (tracking) | |||
| Resolved | matmarex | T51989 Write documentation for UploadWizard in JSDuck format |
Event Timeline
Comment Actions
Change 70919 had a related patch set uploaded by MarkTraceur:
Clean up the jsduck docs after first two patches
Comment Actions
Change 70925 had a related patch set uploaded by MarkTraceur:
Add UWUI to the jsduck docs
Comment Actions
Besides formatting, a good chunk of the documentation is just wrong. I've frequently seen comments that either mention a parameter that is no longer used, or don't mention one that is used.
Comment Actions
The patches above are abandoned, but now that JSCS checks the doc comments, we were "forced" to clean them up a bit recently. (It also compares the @param annotation to the actual list of function parameters.)