Closed Bug 1519443 Opened 10 months ago Closed 10 months ago

Change jsdoc comments in highlighter file class declarations to match others the Firefox codebase

Categories

(DevTools :: Inspector, enhancement, P2)

enhancement

Tracking

(firefox66 fixed)

RESOLVED FIXED
Firefox 66
Tracking Status
firefox66 --- fixed

People

(Reporter: miker, Assigned: miker)

References

Details

Attachments

(1 file)

The jsdoc comments for the following class files need to be updated:

  • devtools/client/inspector/test/head.js
  • devtools/server/actors/highlighters/accessible.js
  • devtools/server/actors/highlighters/box-model.js
  • devtools/server/actors/highlighters/css-grid.js
  • devtools/server/actors/highlighters/flexbox.js
  • devtools/server/actors/highlighters/shapes.js

For example we have this in devtools/server/actors/highlighters/accessible.js:

* Available options:
*         - {Number} x
*           x coordinate of the top left corner of the accessible object
*         - {Number} y
*           y coordinate of the top left corner of the accessible object
*         - {Number} w
*           width of the the accessible object
*         - {Number} h
*           height of the the accessible object
*         - {Number} duration
*           Duration of time that the highlighter should be shown.
*         - {String|null} name
*           name of the the accessible object
*         - {String} role
*           role of the the accessible object

It should look like this:

* @param {Number} options.x
*        X coordinate of the top left corner of the accessible object
* @param {Number} options.y
*        Y coordinate of the top left corner of the accessible object
* @param {Number} options.w
*        Width of the the accessible object
* @param {Number} options.h
*        Height of the the accessible object
* @param {Number} options.duration
*        Duration of time that the highlighter should be shown.
* @param {String|null} options.name
*        Name of the the accessible object
* @param {String} options.role
*        Role of the the accessible object
Assignee: nobody → mratcliffe
Status: NEW → ASSIGNED
Pushed by mratcliffe@mozilla.com:
https://hg.mozilla.org/integration/autoland/rev/0f7827253b52
Change jsdoc comments in highlighter file class declarations to match others the Firefox codebase r=gl
Status: ASSIGNED → RESOLVED
Closed: 10 months ago
Resolution: --- → FIXED
Target Milestone: --- → Firefox 66
You need to log in before you can comment on or make changes to this bug.