Fix JSDoc lint warnings

[andycalder]

This PR fixes the 44 JSDoc lint warnings you get when you run yarn test:

mapbox-gl-js/src/geo/edge_insets.js
  37:5  warning  Missing JSDoc @param "start" declaration                         jsdoc/require-param
  41:0  warning  Expected @param names to be "start, target, t". Got "target, t"  jsdoc/check-param-names
  41:0  warning  Missing JSDoc @param "target" description                        jsdoc/require-param-description
  42:0  warning  Missing JSDoc @param "t" description                             jsdoc/require-param-description
  43:0  warning  Missing JSDoc @returns description                               jsdoc/require-returns-description
  59:0  warning  Missing JSDoc @param "width" description                         jsdoc/require-param-description
  60:0  warning  Missing JSDoc @param "height" description                        jsdoc/require-param-description
  61:0  warning  Missing JSDoc @returns description                               jsdoc/require-returns-description
  87:0  warning  Missing JSDoc @returns description                               jsdoc/require-returns-description

mapbox-gl-js/src/geo/transform.js
   332:5  warning  Missing JSDoc @returns declaration                               jsdoc/require-returns
   452:0  warning  Missing JSDoc @param "padding" description                       jsdoc/require-param-description
   453:0  warning  Missing JSDoc @returns description                               jsdoc/require-returns-description
   460:5  warning  Missing JSDoc @param "start" declaration                         jsdoc/require-param
   463:0  warning  Missing JSDoc @param "target" description                        jsdoc/require-param-description
   463:0  warning  Expected @param names to be "start, target, t". Got "target, t"  jsdoc/check-param-names
   464:0  warning  Missing JSDoc @param "t" description                             jsdoc/require-param-description
  1231:0  warning  Missing JSDoc @returns description                               jsdoc/require-returns-description
  1256:0  warning  Missing JSDoc @returns description                               jsdoc/require-returns-description
  1391:0  warning  Missing JSDoc @param "translation" description                   jsdoc/require-param-description
  1509:5  warning  Missing JSDoc @returns declaration                               jsdoc/require-returns

mapbox-gl-js/src/source/canvas_source.js
  170:0  warning  @param "coordinates" does not match an existing function parameter  jsdoc/check-param-names

mapbox-gl-js/src/style/query_geometry.js
   51:0  warning  Missing JSDoc @param "geometry" description   jsdoc/require-param-description
   52:0  warning  Missing JSDoc @param "transform" description  jsdoc/require-param-description
   53:0  warning  Missing JSDoc @returns description            jsdoc/require-returns-description
   79:0  warning  Missing JSDoc @param "buffer" description     jsdoc/require-param-description
   80:0  warning  Missing JSDoc @returns description            jsdoc/require-returns-description
   99:0  warning  Missing JSDoc @param "buffer" description     jsdoc/require-param-description
  100:0  warning  Missing JSDoc @returns description            jsdoc/require-returns-description
  115:0  warning  Missing JSDoc @param "tile" description       jsdoc/require-param-description
  116:0  warning  Missing JSDoc @param "transform" description  jsdoc/require-param-description
  117:0  warning  Missing JSDoc @param "use3D" description      jsdoc/require-param-description

mapbox-gl-js/src/terrain/elevation.js
   82:5  warning  Missing JSDoc @returns declaration               jsdoc/require-returns
  108:5  warning  Missing JSDoc @param "position" declaration      jsdoc/require-param
  108:5  warning  Missing JSDoc @param "dir" declaration           jsdoc/require-param
  108:5  warning  Missing JSDoc @param "exaggeration" declaration  jsdoc/require-param

mapbox-gl-js/src/ui/map.js
  2134:5  warning  Missing JSDoc @returns declaration  jsdoc/require-returns

mapbox-gl-js/src/util/browser.js
  28:5  warning  Missing JSDoc @returns declaration  jsdoc/require-returns

mapbox-gl-js/src/util/util.js
   93:0  warning  Missing JSDoc @param "min" description     jsdoc/require-param-description
   94:0  warning  Missing JSDoc @param "max" description     jsdoc/require-param-description
   95:0  warning  Missing JSDoc @param "buffer" description  jsdoc/require-param-description
   96:0  warning  Missing JSDoc @returns description         jsdoc/require-returns-description
  109:0  warning  Missing JSDoc @param "ring" description    jsdoc/require-param-description
  110:0  warning  Missing JSDoc @param "buffer" description  jsdoc/require-param-description
  111:0  warning  Missing JSDoc @returns description         jsdoc/require-returns-description

Launch Checklist

• briefly describe the changes in this PR
• document any changes to public APIs

[CLAassistant]

All committers have signed the CLA.

[mourner]

Thank you very much for the PR! I wonder what's going on with the CI there — build, test-browser and test-render unexpectedly failing for seemingly unrelated reasons...

[andycalder]

I think #10193 may fix the failing tests.

I pushed fixes for the remaining JSDoc lint warnings so yarn run lint is clean now.

[mourner]

@andycalder thank you! I've merged that build-fix PR — can we try rebasing this and seeing if it passes now?

[andycalder]

@mourner I rebased but they're still failing. It looks like my CI is still being run without environment variables. Strange...

[andycalder]

Edit: I've just seen #10231, which should fix this. Disregard below.

Hi @ryanhamley, it looks like my CI is being run without the following environment variables:

SIZE_CHECK_APP_PRIVATE_KEY This is causing the build job to fail.
MAPBOX_ACCESS_TOKEN This is causing test-browser and test-render to fail.

Is this something I can fix on my end? Thanks.

[ryanhamley]

Hi @andycalder this is something we're working to fix on our end with #10231. I'm hoping to get it reviewed and merged this week

[ryanhamley]

@andycalder #10231 was just merged so if you rebase against main, you should be able to get all your tests passing and we can move forward with this. Thanks for being patient!

[andycalder]

Thanks @ryanhamley. I rebased and all tests are passing now.