Page MenuHomePhabricator

Write documentation for UploadWizard in JSDuck format
Closed, ResolvedPublic

Description

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

Details

Reference
bz49989

Event Timeline

bzimport raised the priority of this task from to Low.Nov 22 2014, 1:50 AM
bzimport set Reference to bz49989.
bzimport added a subscriber: Unknown Object (MLST).

Change 70919 had a related patch set uploaded by MarkTraceur:
Clean up the jsduck docs after first two patches

https://gerrit.wikimedia.org/r/70919

Change 70925 had a related patch set uploaded by MarkTraceur:
Add UWUI to the jsduck docs

https://gerrit.wikimedia.org/r/70925

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.

matmarex claimed this task.
matmarex added a subscriber: matmarex.

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.)