Closed Bug 1963014 Opened 1 year ago Closed 1 year ago

Fix JSDoc documentation & enable ESLint valid-jsdoc/require-jsdoc collections on various modules in toolkit/

Categories

(Toolkit :: General, task, P3)

Product:
Toolkit
Component:
General
Type:
task

Tracking

()

Status:
RESOLVED FIXED
Milestone:
140 Branch
Tracking Flags:
Tracking Status
firefox140 --- fixed

People

(Reporter: standard8, Assigned: standard8)

References

Details

Attachments

(8 external files)

I've been doing various bits of tidy up in toolkit/modules relating to JSDoc and improving the type documentation on modules that my team uses frequently (and a few others where it made exclusions simpler).

This appears to be unused since it was first added in bug 1155877, and we are now working towards better ways of identifying issues.

Pushed by mbanner@mozilla.com: https://hg.mozilla.org/integration/autoland/rev/96e088ca29d2 Convert DeferredTask to use class syntax. r=firefox-desktop-core-reviewers ,mossop https://hg.mozilla.org/integration/autoland/rev/f25d7077fec6 Enable ESLint valid-jsdoc and require-jsdoc rulesets on DeferredTask and ensure all member types are defined. r=firefox-desktop-core-reviewers ,frontend-codestyle-reviewers,mossop https://hg.mozilla.org/integration/autoland/rev/ddbecd248a02 Add jsdoc for IgnoreLists.sys.mjs. r=search-reviewers,frontend-codestyle-reviewers,daleharvey,mossop https://hg.mozilla.org/integration/autoland/rev/8692782e408c Remove unused ObjectUtils.strict. r=firefox-desktop-core-reviewers ,mossop https://hg.mozilla.org/integration/autoland/rev/4df46947d96f Fix jsdoc issues in OSKeyStore.sys.mjs and ObjectUtils.sys.mjs. r=firefox-desktop-core-reviewers ,frontend-codestyle-reviewers,mossop https://hg.mozilla.org/integration/autoland/rev/076cbc895e0c Add jsdoc to Timer.sys.mjs. r=firefox-desktop-core-reviewers ,mossop https://hg.mozilla.org/integration/autoland/rev/db1cc23f2502 Fix JSDoc issues and add more type information in Region.sys.mjs. r=daleharvey https://hg.mozilla.org/integration/autoland/rev/10cd387da114 Fix JSDoc Issues in ResetProfile.sys.mjs. r=firefox-desktop-core-reviewers ,frontend-codestyle-reviewers,mossop

Backed out for causing mochitests failures in browser_UsageTelemetry.js.

  • Backout link
  • Push with failures
  • Failure Log
  • Failure line: TEST-UNEXPECTED-FAIL | browser/modules/test/browser/browser_UsageTelemetry.js | TAB_COUNT - Opened new tab in new window - {"1":0,"2":1,"3":2,"4":1,"5":0} deepEqual {"1":0,"2":1,"3":2,"4":1,"5":1,"6":0} -
Flags: needinfo?(standard8)
See Also: → 1963125
Flags: needinfo?(standard8)
Pushed by mbanner@mozilla.com: https://hg.mozilla.org/integration/autoland/rev/4567f56e9aa6 Convert DeferredTask to use class syntax. r=firefox-desktop-core-reviewers ,mossop https://hg.mozilla.org/integration/autoland/rev/caf5393395f4 Enable ESLint valid-jsdoc and require-jsdoc rulesets on DeferredTask and ensure all member types are defined. r=firefox-desktop-core-reviewers ,frontend-codestyle-reviewers,mossop https://hg.mozilla.org/integration/autoland/rev/22f5cf90689d Add jsdoc for IgnoreLists.sys.mjs. r=search-reviewers,frontend-codestyle-reviewers,daleharvey,mossop https://hg.mozilla.org/integration/autoland/rev/681cce2787bb Remove unused ObjectUtils.strict. r=firefox-desktop-core-reviewers ,mossop https://hg.mozilla.org/integration/autoland/rev/5d9256a88527 Fix jsdoc issues in OSKeyStore.sys.mjs and ObjectUtils.sys.mjs. r=firefox-desktop-core-reviewers ,frontend-codestyle-reviewers,mossop https://hg.mozilla.org/integration/autoland/rev/70ac74587ef2 Add jsdoc to Timer.sys.mjs. r=firefox-desktop-core-reviewers ,mossop https://hg.mozilla.org/integration/autoland/rev/a249a29ea28c Fix JSDoc issues and add more type information in Region.sys.mjs. r=daleharvey https://hg.mozilla.org/integration/autoland/rev/927e5de7c9ae Fix JSDoc Issues in ResetProfile.sys.mjs. r=firefox-desktop-core-reviewers ,frontend-codestyle-reviewers,mossop
QA Whiteboard: [qa-triage-done-c141/b140]
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Creator:
Created:
Updated:
Size: