Closed Bug 1802358 Opened 2 months ago Closed 2 months ago

Enable require-jsdoc / valid-jsdoc rules for browser/components/migration and generate documentation from it

Categories

(Firefox :: Migration, task, P3)

task

Tracking

()

RESOLVED FIXED
109 Branch
Tracking Status
firefox109 --- fixed

People

(Reporter: mconley, Assigned: mconley)

References

(Blocks 2 open bugs)

Details

Attachments

(1 file)

I think this is worth doing in the short term because we've got some students who are doing projects in this area, and it'd be a good idea to have some documentation they can refer to at a glance.

This doesn't do a thorough job of actually documenting things, it just makes sure that
the existing documentation abides by the JSDoc formatting rules. I did flesh out some
documentation here and there, but writing new / updating / clarifying documentation is
left as later work.

Depends on D162623

Severity: -- → N/A
Priority: -- → P3
Blocks: 1802961
Blocks: 1802978
Blocks: 1802979
Pushed by mconley@mozilla.com:
https://hg.mozilla.org/integration/autoland/rev/59d98ca9fd51
Enable require-jsdoc / valid-jsdoc for browser/components/migration. r=kpatenio
Pushed by mconley@mozilla.com:
https://hg.mozilla.org/integration/autoland/rev/b947dde91534
Enable require-jsdoc / valid-jsdoc for browser/components/migration. r=kpatenio
Flags: needinfo?(mconley)
Status: NEW → RESOLVED
Closed: 2 months ago
Resolution: --- → FIXED
Target Milestone: --- → 109 Branch
You need to log in before you can comment on or make changes to this bug.