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

Status: RESOLVED FIXED

(Firefox :: Migration, task, P3)

Description

[Mike Conley (:mconley) (:⚙️)]

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.

Comment 1

[Mike Conley (:mconley) (:⚙️)]

Attachment: Bug 1802358 - Enable require-jsdoc / valid-jsdoc for browser/components/migration. r?kpatenio!

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

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/59d98ca9fd51
Enable require-jsdoc / valid-jsdoc for browser/components/migration. r=kpatenio

Comment 3

[Atila Butkovits]

Backed out for causing documentation failures.

Backout link: https://hg.mozilla.org/integration/autoland/rev/8fffa779f65d058abb25dc0b70e05d90733ae8bd

Push with failures: https://treeherder.mozilla.org/jobs?repo=autoland&selectedTaskRun=ILL7MNR0S36bp2atGiP_kw.0&resultStatus=testfailed%2Cbusted%2Cexception%2Cretry%2Cusercancel&revision=bb0f5e137128abefcaffb0a5d2302875cd444132

Failure log: https://treeherder.mozilla.org/logviewer?job_id=398795666&repo=autoland&lineNumber=2564

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/b947dde91534
Enable require-jsdoc / valid-jsdoc for browser/components/migration. r=kpatenio

Comment 5

[Cristian Tuns]

https://hg.mozilla.org/mozilla-central/rev/b947dde91534