Bug 1519443 - Change jsdoc comments in highlighter file class declarations to match others the Firefox codebase r=gl

Differential Revision: https://phabricator.services.mozilla.com/D16327

--HG--
extra : moz-landing-system : lando

devtools/client/inspector/test/head.js

@@ -865,7 +865,7 @@ async function getDisplayedNodeTextContent(selector, inspector) {
  *        If true, the shapes highlighter is being shown. If false, it is being hidden
  * @param {Options} options
  *        Config option for the shapes highlighter. Contains:
- *        - {Boolean} transformMode: wether to show the highlighter in transforms mode
+ *        - {Boolean} transformMode: whether to show the highlighter in transforms mode
  */
 async function toggleShapesHighlighter(view, selector, property, show, options = {}) {
   info(`Toggle shapes highlighter ${show ? "on" : "off"} for ${property} on ${selector}`);

devtools/server/actors/highlighters/accessible.js

@@ -27,21 +27,20 @@ loader.lazyRequireGetter(this, "Infobar", "devtools/server/actors/highlighters/u
  * h.hide();
  * h.destroy();
  *
- * Available options:
+ * @param {Number} options.x
- *         - {Number} x
+ *        X coordinate of the top left corner of the accessible object
- *           x coordinate of the top left corner of the accessible object
+ * @param {Number} options.y
- *         - {Number} y
+ *        Y coordinate of the top left corner of the accessible object
- *           y coordinate of the top left corner of the accessible object
+ * @param {Number} options.w
- *         - {Number} w
+ *        Width of the the accessible object
- *           width of the the accessible object
+ * @param {Number} options.h
- *         - {Number} h
+ *        Height of the the accessible object
- *           height of the the accessible object
+ * @param {Number} options.duration
- *         - {Number} duration
+ *        Duration of time that the highlighter should be shown.
- *           Duration of time that the highlighter should be shown.
+ * @param {String|null} options.name
- *         - {String|null} name
+ *        Name of the the accessible object
- *           name of the the accessible object
+ * @param {String} options.role
- *         - {String} role
+ *        Role of the the accessible object
- *           role of the the accessible object
  *
  * Structure:
  * <div class="highlighter-container" aria-hidden="true">

devtools/server/actors/highlighters/box-model.js

@@ -47,23 +47,21 @@ const PSEUDO_CLASSES = [":hover", ":active", ":focus", ":focus-within"];
  * h.hide();
  * h.destroy();
  *
- * Available options:
+ * @param {String} options.region
- * - region {String}
+ *        Specifies the region that the guides should outline:
- *   "content", "padding", "border" or "margin"
+ *          "content" (default), "padding", "border" or "margin".
- *   This specifies the region that the guides should outline.
+ * @param {Boolean} options.hideGuides
- *   Defaults to "content"
+ *        Defaults to false
- * - hideGuides {Boolean}
+ * @param {Boolean} options.hideInfoBar
- *   Defaults to false
+ *        Defaults to false
- * - hideInfoBar {Boolean}
+ * @param {String} options.showOnly
- *   Defaults to false
+ *        If set, only this region will be highlighted. Use with onlyRegionArea
- * - showOnly {String}
+ *        to only highlight the area of the region:
- *   "content", "padding", "border" or "margin"
+ *        "content", "padding", "border" or "margin"
- *   If set, only this region will be highlighted. Use with onlyRegionArea to
+ * @param {Boolean} options.onlyRegionArea
- *   only highlight the area of the region.
+ *        This can be set to true to make each region's box only highlight the
- * - onlyRegionArea {Boolean}
+ *        area of the corresponding region rather than the area of nested
- *   This can be set to true to make each region's box only highlight the area
+ *        regions too. This is useful when used with showOnly.
- *   of the corresponding region rather than the area of nested regions too.
- *   This is useful when used with showOnly.
  *
  * Structure:
  * <div class="highlighter-container">

devtools/server/actors/highlighters/css-grid.js

@@ -134,36 +134,39 @@ const gCachedGridPattern = new Map();
  * h.hide();
  * h.destroy();
  *
- * Available Options:
+ * @param {String} options.color
- * - color(colorValue)
+ *        The color that should be used to draw the highlighter for this grid.
- *     @param  {String} colorValue
+ * @param {Boolean} options.showAllGridAreas
- *     The color that should be used to draw the highlighter for this grid.
+ *        Shows all the grid area highlights for the current grid if isShown is
- * - showAllGridAreas(isShown)
+ *        true.
- *     @param  {Boolean} isShown
+ * @param {String} options.showGridArea
- *     Shows all the grid area highlights for the current grid if isShown is true.
+ *        Shows the grid area highlight for the given area name.
- * - showGridArea(areaName)
+ * @param {Boolean} options.showGridAreasOverlay
- *     @param  {String} areaName
+ *        Displays an overlay of all the grid areas for the current grid
- *     Shows the grid area highlight for the given area name.
+ *        container if isShown is true.
- * - showGridAreasOverlay(isShown)
+ * @param {Object} options.showGridCell
- *     @param  {Boolean} isShown
+ *        An object containing the grid fragment index, row and column numbers
- *     Displays an overlay of all the grid areas for the current grid container if
+ *        to the corresponding grid cell to highlight for the current grid.
- *     isShown is true.
+ * @param {Number} options.showGridCell.gridFragmentIndex
- * - showGridCell({ gridFragmentIndex: Number, rowNumber: Number, columnNumber: Number })
+ *        Index of the grid fragment to render the grid cell highlight.
- *     @param  {Object} { gridFragmentIndex: Number, rowNumber: Number,
+ * @param {Number} options.showGridCell.rowNumber
- *                        columnNumber: Number }
+ *        Row number of the grid cell to highlight.
- *     An object containing the grid fragment index, row and column numbers to the
+ * @param {Number} options.showGridCell.columnNumber
- *     corresponding grid cell to highlight for the current grid.
+ *        Column number of the grid cell to highlight.
- * - showGridLineNames({ gridFragmentIndex: Number, lineNumber: Number,
+ * @param {Object} options.showGridLineNames
- *                       type: String })
+ *        An object containing the grid fragment index and line number to the
- *     @param  {Object} { gridFragmentIndex: Number, lineNumber: Number }
+ *        corresponding grid line to highlight for the current grid.
- *     An object containing the grid fragment index and line number to the
+ * @param {Number} options.showGridLineNames.gridFragmentIndex
- *     corresponding grid line to highlight for the current grid.
+ *        Index of the grid fragment to render the grid line highlight.
- * - showGridLineNumbers(isShown)
+ * @param {Number} options.showGridLineNames.lineNumber
- *     @param  {Boolean} isShown
+ *        Line number of the grid line to highlight.
- *     Displays the grid line numbers on the grid lines if isShown is true.
+ * @param {String} options.showGridLineNames.type
- * - showInfiniteLines(isShown)
+ *        The dimension type of the grid line.
- *     @param  {Boolean} isShown
+ * @param {Boolean} options.showGridLineNumbers
- *     Displays an infinite line to represent the grid lines if isShown is true.
+ *        Displays the grid line numbers on the grid lines if isShown is true.
+ * @param {Boolean} options.showInfiniteLines
+ *        Displays an infinite line to represent the grid lines if isShown is
+ *        true.
  *
  * Structure:
  * <div class="highlighter-container">

devtools/server/actors/highlighters/flexbox.js

@@ -59,16 +59,12 @@ const JUSTIFY_CONTENT = "justify-content";
  * The FlexboxHighlighter is the class that overlays a visual canvas on top of
  * display: [inline-]flex elements.
  *
- * Available Options:
+ * @param {String} options.color
- * - color(colorValue)
+ *        The color that should be used to draw the highlighter for this flexbox.
- *     @param  {String} colorValue
+ * @param {Boolean} options.showAlignment
- *     The color that should be used to draw the highlighter for this flexbox.
+ *        Shows the alignment in the flexbox highlighter.
- * - showAlignment(isShown)
+ * @param {Boolean} options.noCountainerOutline
- *     @param  {Boolean} isShown
+ *        Prevent drawing an outline around the flex container.
- *     Shows the alignment in the flexbox highlighter.
- * - noCountainerOutline(isShown)
- *     @param  {Boolean} noContainerOutline
- *     Prevent drawing an outline around the flex container.
  *
  * Structure:
  * <div class="highlighter-container">

devtools/server/actors/highlighters/shapes.js

@@ -66,6 +66,12 @@ const _dragging = Symbol("shapes/dragging");
  *
  * A refresher for coordinates and change of basis that may be helpful:
  * https://www.math.ubc.ca/~behrend/math221/Coords.pdf
+ *
+ * @param {String} options.hoverPoint
+ *        The point to highlight.
+ * @param {Boolean} options.transformMode
+ *        Whether to show the highlighter in transforms mode.
+ * @param {} options.mode
  */
 class ShapesHighlighter extends AutoRefreshHighlighter {
   constructor(highlighterEnv) {