enforce no wrapIndent for jsdoc comments (#13139)

* enforce no wrapIndent for jsdoc comments

* fix linting errors

Author: chriswhong

.eslintrc

@@ -129,7 +129,8 @@
         "jsdoc/require-property-description": "off",
         "jsdoc/require-property-name": "off",
         "jsdoc/require-property-type": "off",
-        "jsdoc/require-returns-type": "off",
+        "jsdoc/require-returns-type": "off"
+        
       }
     },
     {
@@ -160,7 +161,7 @@
             "matchingFileName": "src/fake_filename_for_jsdoc_examples",
             "rejectExampleCodeRegex": "<script>"
         }],
-        "jsdoc/check-line-alignment": ["error", "any", {"wrapIndent": "    "}],
+        "jsdoc/check-line-alignment": ["error"],
         "jsdoc/check-property-names": "error",
         "jsdoc/check-types": "error",
         "jsdoc/tag-lines": ["error", "any", {"startLines": 1}],

src/geo/lng_lat.js

@@ -420,7 +420,7 @@ export class LngLatBounds {
      * Returns the bounding box represented as an array.
      *
      * @returns {Array<Array<number>>} The bounding box represented as an array, consisting of the
-     *     southwest and northeast coordinates of the bounding represented as arrays of numbers.
+     * southwest and northeast coordinates of the bounding represented as arrays of numbers.
      * @example
      * const llb = new mapboxgl.LngLatBounds([-73.9876, 40.7661], [-73.9397, 40.8002]);
      * llb.toArray(); // = [[-73.9876, 40.7661], [-73.9397, 40.8002]]
@@ -433,7 +433,7 @@ export class LngLatBounds {
      * Return the bounding box represented as a string.
      *
      * @returns {string} The bounding box represents as a string of the format
-     *     `'LngLatBounds(LngLat(lng, lat), LngLat(lng, lat))'`.
+     * `'LngLatBounds(LngLat(lng, lat), LngLat(lng, lat))'`.
      * @example
      * const llb = new mapboxgl.LngLatBounds([-73.9876, 40.7661], [-73.9397, 40.8002]);
      * llb.toString(); // = "LngLatBounds(LngLat(-73.9876, 40.7661), LngLat(-73.9397, 40.8002))"

src/geo/lng_lat_bounds.js

@@ -221,7 +221,7 @@ class LngLatBounds {
      * Returns the bounding box represented as an array.
      *
      * @returns {Array<Array<number>>} The bounding box represented as an array, consisting of the
-     *     southwest and northeast coordinates of the bounding represented as arrays of numbers.
+     * southwest and northeast coordinates of the bounding represented as arrays of numbers.
      * @example
      * const llb = new mapboxgl.LngLatBounds([-73.9876, 40.7661], [-73.9397, 40.8002]);
      * llb.toArray(); // = [[-73.9876, 40.7661], [-73.9397, 40.8002]]
@@ -234,7 +234,7 @@ class LngLatBounds {
      * Return the bounding box represented as a string.
      *
      * @returns {string} The bounding box represents as a string of the format
-     *     `'LngLatBounds(LngLat(lng, lat), LngLat(lng, lat))'`.
+     * `'LngLatBounds(LngLat(lng, lat), LngLat(lng, lat))'`.
      * @example
      * const llb = new mapboxgl.LngLatBounds([-73.9876, 40.7661], [-73.9397, 40.8002]);
      * llb.toString(); // = "LngLatBounds(LngLat(-73.9876, 40.7661), LngLat(-73.9397, 40.8002))"

src/index.js

@@ -297,9 +297,9 @@ Debug.extend(exported, {isSafari, getPerformanceMetrics: PerformanceUtils.getPer
  * @function supported
  * @param {Object} [options]
  * @param {boolean} [options.failIfMajorPerformanceCaveat=false] If `true`,
- *     the function will return `false` if the performance of Mapbox GL JS would
- *     be dramatically worse than expected (for example, a software WebGL renderer
- *     would be used).
+ * the function will return `false` if the performance of Mapbox GL JS would
+ * be dramatically worse than expected (for example, a software WebGL renderer
+ * would be used).
  * @return {boolean}
  * @example
  * // Show an alert if the browser does not support Mapbox GL
@@ -317,7 +317,7 @@ Debug.extend(exported, {isSafari, getPerformanceMetrics: PerformanceUtils.getPer
  * @param {string} pluginURL URL pointing to the Mapbox RTL text plugin source.
  * @param {Function} callback Called with an error argument if there is an error, or no arguments if the plugin loads successfully.
  * @param {boolean} lazy If set to `true`, MapboxGL will defer loading the plugin until right-to-left text is encountered, and
- *     right-to-left text will be rendered only after the plugin finishes loading.
+ * right-to-left text will be rendered only after the plugin finishes loading.
  * @example
  * mapboxgl.setRTLTextPlugin('https://api.mapbox.com/mapbox-gl-js/plugins/mapbox-gl-rtl-text/v0.2.0/mapbox-gl-rtl-text.js');
  * @see [Example: Add support for right-to-left scripts](https://www.mapbox.com/mapbox-gl-js/example/mapbox-gl-rtl-text/)

src/source/canvas_source.js

@@ -184,9 +184,9 @@ class CanvasSource extends ImageSource {
      * @instance
      * @memberof CanvasSource
      * @param {Array<Array<number>>} coordinates Four geographical coordinates,
-     *     represented as arrays of longitude and latitude numbers, which define the corners of the canvas.
-     *     The coordinates start at the top left corner of the canvas and proceed in clockwise order.
-     *     They do not have to represent a rectangle.
+     * represented as arrays of longitude and latitude numbers, which define the corners of the canvas.
+     * The coordinates start at the top left corner of the canvas and proceed in clockwise order.
+     * They do not have to represent a rectangle.
      * @returns {CanvasSource} Returns itself to allow for method chaining.
      */
 

src/source/custom_source.js

@@ -130,7 +130,7 @@ function isRaster(data: any): boolean {
  * @param {Object} options Options.
  * @param {AbortSignal} options.signal A signal object that communicates when the map cancels the tile loading request.
  * @returns {Promise<TextureImage | undefined | null>} The promise that resolves to the tile image data as an `HTMLCanvasElement`, `HTMLImageElement`, `ImageData`, `ImageBitmap` or object with `width`, `height`, and `data`.
- *     If `loadTile` resolves to `undefined`, a map will render an overscaled parent tile in the tile’s space. If `loadTile` resolves to `null`, a map will render nothing in the tile’s space.
+ * If `loadTile` resolves to `undefined`, a map will render an overscaled parent tile in the tile’s space. If `loadTile` resolves to `null`, a map will render nothing in the tile’s space.
  */
 export type CustomSourceInterface<T> = {
     id: string;

src/source/image_source.js

@@ -326,9 +326,9 @@ class ImageSource extends Evented implements Source {
      * @param {Object} options Options object.
      * @param {string} [options.url] Required image URL.
      * @param {Array<Array<number>>} [options.coordinates] Four geographical coordinates,
-     *     represented as arrays of longitude and latitude numbers, which define the corners of the image.
-     *     The coordinates start at the top left corner of the image and proceed in clockwise order.
-     *     They do not have to represent a rectangle.
+     * represented as arrays of longitude and latitude numbers, which define the corners of the image.
+     * The coordinates start at the top left corner of the image and proceed in clockwise order.
+     * They do not have to represent a rectangle.
      * @returns {ImageSource} Returns itself to allow for method chaining.
      * @example
      * // Add to an image source to the map with some initial URL and coordinates
@@ -415,9 +415,9 @@ class ImageSource extends Evented implements Source {
      * Sets the image's coordinates and re-renders the map.
      *
      * @param {Array<Array<number>>} coordinates Four geographical coordinates,
-     *     represented as arrays of longitude and latitude numbers, which define the corners of the image.
-     *     The coordinates start at the top left corner of the image and proceed in clockwise order.
-     *     They do not have to represent a rectangle.
+     * represented as arrays of longitude and latitude numbers, which define the corners of the image.
+     * The coordinates start at the top left corner of the image and proceed in clockwise order.
+     * They do not have to represent a rectangle.
      * @returns {ImageSource} Returns itself to allow for method chaining.
      * @example
      * // Add an image source to the map with some initial coordinates