[fix]文档注释修改 src：mapboxgl review by jinny

Author: Wenxinyu1998

src/mapboxgl/core/MapExtend.js

@@ -123,7 +123,7 @@ export var MapExtend = function () {
      * @function MapExtend.prototype.moveTo
      * @description 将图层移动到某个图层之前。
      * @param {string} layerID -待插入的图层 ID。
-     * @param {boolean} [beforeLayerID] - 是否将本图层插入到图层 id 为 layerID 的图层之前(如果为 false 则将本图层插入到图层 id 为 layerID 的图层之后)。
+     * @param {boolean} [beforeLayerID] - 是否将本图层插入到图层 ID 为 layerID 的图层之前(如果为 false 则将本图层插入到图层 ID 为 layerID 的图层之后)。
      */
     function moveLayer(layerID, beforeLayerID) {
         var layer = document.getElementById(layerID);

src/mapboxgl/overlay/DeckglLayer.js

@@ -12,18 +12,18 @@ import { Util } from '../core/Util';
  * @classdesc Deckgl 高效率图层，该图图层为综合图层，通过该图层可创建 高效率点图层、路径图层（线图层）、高效率面图层、曲线图层、
  *            正六边形图层（蜂巢图层）、网格图层，只需给定相依配置，因此，在创建图层之前，请仔细阅读参数配置。
  * @param {string} layerTypeID - 高效率图层类型 ID，包括 "scatter-plot" 高效率点图层、"path-layer" 路径图层（线图层）、
- *                 "polygon-layer" 高效率面图层、 "arc-layer" 曲线图层、"hexagon-layer" 正六边形图层（蜂巢图层）、"screen-grid-layer" 网格图层。
+ *                 "polygon-layer" 高效率面图层、"arc-layer" 曲线图层、"hexagon-layer" 正六边形图层（蜂巢图层）、"screen-grid-layer" 网格图层。
  *
  * @param {Object} options -  图层配置项，包括以下参数：
  * @param {Object} [options.layerId] - DeckglLayer 图层 Dom 元素 ID。默认使用 CommonUtil.createUniqueID("graphicLayer_" + this.layerTypeID + "_") 创建专题图层 ID。
  * @param {Array.<GeoJSONObject>} options.data - 图层数据,支持 GeoJSON 规范数据类型。
  * @param {Object} options.callback - deckgl 图层回调函数配置项。
  * @param {Object} options.props - deckgl 图层配置项, 在该参数下配置图层配置项：
- * @param {boolean} options.props.coverage - "hexagon-layer" 配置项：六边形半径乘数，介于0 - 1之间。六边形的最终半径通过覆盖半径计算。 注意：覆盖范围不会影响分数的分配方式。 分配方式的半径仅由半径属性确定；
+ * @param {boolean} options.props.coverage - "hexagon-layer" 配置项：六边形半径乘数，介于0 - 1之间。六边形的最终半径通过覆盖半径计算。注意：覆盖范围不会影响分数的分配方式。分配方式的半径仅由半径属性确定；
  * @param {boolean} options.props.hexagonAggregator  - "hexagon-layer" 配置项：* @param {boolean}
  * @param {Object} options.props.lightSettings - 光照配置项。
- * @param {Array} options.props.lightSettings.lightsPosition - 光照配置项：指定为`[x，y，z]`的光在平面阵列中的位置`, 在一个平面阵列。 长度应该是 `3 x numberOfLights`。
- * @param {Array} options.props.lightSettings.lightsStrength - 光照配置项：平面阵列中指定为“[x，y]`的灯的强度。 长度应该是`2 x numberOfLights`。
+ * @param {Array} options.props.lightSettings.lightsPosition - 光照配置项：指定为`[x，y，z]`的光在平面阵列中的位置`, 在一个平面阵列。长度应该是 `3 x numberOfLights`。
+ * @param {Array} options.props.lightSettings.lightsStrength - 光照配置项：平面阵列中指定为“[x，y]`的灯的强度。长度应该是`2 x numberOfLights`。
  * @param {number} [options.props.lightSettings.numberOfLights=1]  - 光照配置项：光照值,最大值为 `5`。
  * @param {number} [options.props.lightSettings.coordinateSystem=COORDINATE_SYSTEM.LNGLAT]  - 光照配置项：指定灯位置的坐标系。
  * @param {number} [options.props.lightSettings.coordinateOrigin=[0, 0, 0]] - 光照配置项：指定灯位置的坐标原点。
@@ -66,7 +66,7 @@ import { Util } from '../core/Util';
  * @param {boolean} [options.props.strokeWidth=1] - "arc-layer" 配置项：线宽。
  * @param {boolean} [options.props.radius=1000] - "hexagon-layer" 配置项：六边形半径值。
  * @param {boolean} [options.props.extruded=false] - "hexagon-layer" 配置项：是否拉伸要素。
- * @param {boolean} [options.props.upperPercentile=100] - "hexagon-layer" 配置项：筛选箱并通过upperPercentile重新计算颜色。 颜色值大于upperPercentile的六边形将被隐藏。
+ * @param {boolean} [options.props.upperPercentile=100] - "hexagon-layer" 配置项：筛选箱并通过upperPercentile重新计算颜色。颜色值大于upperPercentile的六边形将被隐藏。
  * @param {boolean} [options.props.elevationScale=1] - "hexagon-layer" 配置项：高程乘数，实际海拔高度由 elevationScale * getElevation（d）计算。 elevationScale是一个方便的属性，可以在不更新数据的情况下缩放所有六边形。
  * @param {boolean} [options.props.colorDomain=false]  - "hexagon-layer" 配置项：色阶。
  * @param {boolean} [options.props.colorRange=[[255,255,178,255],[254,217,118,255],[254,178,76,255],[253,141,60,255],[240,59,32,255],[189,0,38,255]]]   - "hexagon-layer" 配置项：色带。
@@ -77,7 +77,7 @@ export class DeckglLayer {
         // Util.extend(defaultProps, options);
         /**
          * @member {string} DeckglLayer.prototype.id
-         * @description 高效率点图层 id。
+         * @description 高效率点图层 ID。
          */
         this.layerTypeID = layerTypeID;
         /**
@@ -165,7 +165,7 @@ export class DeckglLayer {
      * @function DeckglLayer.prototype.moveTo
      * @description 将图层移动到某个图层之前。
      * @param {string} layerID - 待插入的图层 ID。
-     * @param {boolean} [before=true] - 是否将本图层插入到图层 id 为 layerID 的图层之前。
+     * @param {boolean} [before=true] - 是否将本图层插入到图层 ID 为 layerID 的图层之前。
      */
     moveTo(layerID, before) {
         var layer = document.getElementById(this.id);

src/mapboxgl/overlay/GraphThemeLayer.js

@@ -320,7 +320,7 @@ export class Graph extends Theme {
 
     /**
      * @function GraphThemeLayer.prototype.isPointInPoly
-     * @description  判断一个点是否在多边形里面。(射线法)
+     * @description  判断一个点是否在多边形里面（射线法）。
      * @param {Object} pt - 需要判定的点对象，该对象含有属性 x (横坐标)，属性 y (纵坐标)。
      * @param {Array.<Object>} poly - 多边形节点数组。
      */
@@ -355,7 +355,7 @@ export class Graph extends Theme {
 
     /**
      * @function GraphThemeLayer.prototype.clearCache
-     * @description  清除缓存
+     * @description  清除缓存。
      */
     clearCache() {
         this.cache = {};

src/mapboxgl/overlay/GraphicLayer.js

@@ -43,7 +43,7 @@ export class GraphicLayer {
         let opt = Util.extend(this, defaultProps, options);
         /**
          * @member {string} GraphicLayer.prototype.id
-         * @description 高效率点图层 id。
+         * @description 高效率点图层 ID。
          */
         this.id = id || CommonUtil.createUniqueID("graphicLayer_");
         /**
@@ -248,8 +248,8 @@ export class GraphicLayer {
 
     /**
      * @function GraphicLayer.prototype.getGraphicById
-     * @description 通过给定一个 id，返回对应的矢量要素。
-     * @param {string} graphicId - 矢量要素的属性 id
+     * @description 通过给定一个 ID，返回对应的矢量要素。
+     * @param {string} graphicId - 矢量要素的属性 ID。
      * @returns {Graphic} 一个匹配的 graphic。
      */
     getGraphicById(graphicId) {
@@ -365,7 +365,7 @@ export class GraphicLayer {
      * @function GraphicLayer.prototype.moveTo
      * @description 将图层移动到某个图层之前。
      * @param {string} layerID - 待插入的图层 ID。
-     * @param {boolean} [before=true] - 是否将本图层插入到图层 id 为 layerID 的图层之前。
+     * @param {boolean} [before=true] - 是否将本图层插入到图层 ID 为 layerID 的图层之前。
      */
     moveTo(layerID, before) {
         var layer = document.getElementById(this.id);

src/mapboxgl/overlay/GraticuleLayer.js

@@ -35,22 +35,22 @@ import mapboxgl from 'mapbox-gl';
  */
 
 /**
- * @typedef {Object} GraticuleLayer.LabelStyle - 标签样式
- * @property {Array.<string>} [textFont = ['Calibri','sans-serif']] - 字体样式
- * @property {string} [textSize = '12px'] - 字体大小
- * @property {string} [textColor ='rgba(0,0,0,1)'] - 字体颜色
- * @property {string} [textHaloColor ='rgba(255,255,255,1)'] - 描边颜色
- * @property {number} [textHaloWidth = 1] - 描边宽度
- * @property {string} [textAnchor = 'bottom'] - 字体基线: "center", "left", "right", "top", "bottom", "top-left", "top-right", "bottom-left", "bottom-right"
+ * @typedef {Object} GraticuleLayer.LabelStyle - 标签样式。
+ * @property {Array.<string>} [textFont = ['Calibri','sans-serif']] - 字体样式。
+ * @property {string} [textSize = '12px'] - 字体大小。
+ * @property {string} [textColor ='rgba(0,0,0,1)'] - 字体颜色。
+ * @property {string} [textHaloColor ='rgba(255,255,255,1)'] - 描边颜色。
+ * @property {number} [textHaloWidth = 1] - 描边宽度。
+ * @property {string} [textAnchor = 'bottom'] - 字体基线: "center", "left", "right", "top", "bottom", "top-left", "top-right", "bottom-left", "bottom-right"。
  */
 
 /**
- * @typedef {Object} GraticuleLayer.StrokeStyle - 线样式
- * @property {string} [lineColor = 'red'] - 线颜色
- * @property {string} [lineCap = 'round'] - 线端点风格：butt, round, square
- * @property {string} [lineJoin = round] - 线连接样式：bevel, round, miter
- * @property {Array.<number>} [lindDasharray = [0.5,4]] - 虚线样式
- * @property {number} [lineWidth = 1] - 线宽
+ * @typedef {Object} GraticuleLayer.StrokeStyle - 线样式。
+ * @property {string} [lineColor = 'red'] - 线颜色。
+ * @property {string} [lineCap = 'round'] - 线端点风格：butt, round, square。
+ * @property {string} [lineJoin = round] - 线连接样式：bevel, round, miter。
+ * @property {Array.<number>} [lindDasharray = [0.5,4]] - 虚线样式。
+ * @property {number} [lineWidth = 1] - 线宽。
  */
 
 const defaultTextStyle = {
@@ -217,7 +217,7 @@ export class GraticuleLayer {
 
     /**
      * @function GraticuleLayer.prototype.setIntervals
-     * @description 设置经纬度的间隔（以度为单位)
+     * @description 设置经纬度的间隔（以度为单位）。
      * @param {number|function} interval - 经纬度的间隔（以度为单位），可以是数字，也可以是函数，参数是map。
      */
     setIntervals(interval) {

src/mapboxgl/overlay/HeatMapLayer.js

@@ -23,7 +23,7 @@ import { GeoText } from '@supermap/iclient-common/commontypes/geometry/GeoText';
  * @param {boolean} [options.loadWhileAnimating=true] - 是否实时重绘。(当绘制大数据量要素的情况下会出现卡顿，建议把该参数设为false)。
  * @param {number} [options.opacity=1] - 图层不透明度。
  * @param {Array.<string>} [options.colors=['blue','cyan','lime','yellow','red']] - 颜色线性渐变数组,颜色值必须为canvas所支。
- * @param {boolean} [options.useGeoUnit=false] - 使用地理单位，即默认热点半径默认使用像素单位。 当设置为 true 时，热点半径和图层地理坐标保持一致。
+ * @param {boolean} [options.useGeoUnit=false] - 使用地理单位，即默认热点半径默认使用像素单位。当设置为 true 时，热点半径和图层地理坐标保持一致。
  * @extends {mapboxgl.Evented}
  * @fires HeatMapLayer#featuresadded
  * @fires HeatMapLayer#changelayer
@@ -44,7 +44,7 @@ export class HeatMapLayer extends mapboxgl.Evented {
 
         /**
          * @member {string} HeatMapLayer.prototype.id
-         * @description 热力图图层 id。
+         * @description 热力图图层 ID。
          */
         this.id = _options.id ? _options.id : CommonUtil.createUniqueID("HeatMapLayer_");
 
@@ -79,7 +79,7 @@ export class HeatMapLayer extends mapboxgl.Evented {
 
         /**
          * @member {boolean} [HeatMapLayer.prototype.useGeoUnit=false]
-         * @description 使用地理单位，即默认热点半径默认使用像素单位。 当设置为 true 时，热点半径和图层地理坐标保持一致。
+         * @description 使用地理单位，即默认热点半径默认使用像素单位。当设置为 true 时，热点半径和图层地理坐标保持一致。
          */
         this.useGeoUnit = _options.useGeoUnit ? _options.useGeoUnit : false;
 
@@ -577,7 +577,7 @@ export class HeatMapLayer extends mapboxgl.Evented {
      * @function HeatMapLayer.prototype.moveTo
      * @description 将图层移动到某个图层之前。
      * @param {string} layerID - 待插入的图层ID。
-     * @param {boolean} [before=true] - 是否将本图层插入到图层 id 为 layerID 的图层之前(如果为 false 则将本图层插入到图层 id 为 layerID 的图层之后)。
+     * @param {boolean} [before=true] - 是否将本图层插入到图层 ID 为 layerID 的图层之前(如果为 false 则将本图层插入到图层 ID 为 layerID 的图层之后)。
      */
     moveTo(layerID, before) {
         var layer = document.getElementById(this.rootCanvas.id);

src/mapboxgl/overlay/LabelThemeLayer.js

@@ -969,10 +969,10 @@ export class Label extends GeoFeature {
 
     /**
      * @function LabelThemeLayer.prototype.isPointInPoly
-     * @description 判断一个点是否在多边形里面。(射线法)
+     * @description 判断一个点是否在多边形里面（射线法）。
      *
-     * @param {Object} pt - 需要判定的点对象，该对象含有属性x(横坐标)，属性y(纵坐标)。
-     * @param {Array.<Object>} poly - 多边形节点数组。例如一个四边形：[{"x":1,"y":1},{"x":3,"y":1},{"x":6,"y":4},{"x":2,"y":10},{"x":1,"y":1}]
+     * @param {Object} pt - 需要判定的点对象，该对象含有属性x（横坐标），属性y（纵坐标）。
+     * @param {Array.<Object>} poly - 多边形节点数组。例如一个四边形：[{"x":1,"y":1},{"x":3,"y":1},{"x":6,"y":4},{"x":2,"y":10},{"x":1,"y":1}]。
      * @returns {boolean} 点是否在多边形内。
      */
     isPointInPoly(pt, poly) {

src/mapboxgl/overlay/MapvLayer.js

@@ -70,7 +70,7 @@ export class MapvLayer {
      * @function MapvLayer.prototype.moveTo
      * @description 将图层移动到某个图层之前。
      * @param {string} layerID - 待插入的图层 ID。
-     * @param {boolean} [before=true] - 是否将本图层插入到图层 id 为 layerID 的图层之前。
+     * @param {boolean} [before=true] - 是否将本图层插入到图层 ID 为 layerID 的图层之前。
      */
     moveTo(layerID, before) {
         const layer = document.getElementById(this.canvas.id);

src/mapboxgl/overlay/RangeTheme3DLayer.js

@@ -8,7 +8,7 @@ import {Theme3DLayer} from './theme/Theme3DLayer';
  * @class RangeTheme3DLayer
  * @category  Visualization Theme
  * @classdesc 三维分段专题图。
- * @param  {string} [id] - 专题图图层 id。默认使用 CommonUtil.createUniqueID("theme3DLayer") 创建专题图层 ID。
+ * @param  {string} [id] - 专题图图层 ID。默认使用 CommonUtil.createUniqueID("theme3DLayer") 创建专题图层 ID。
  * @param  {Object} layerOptions - 专题图图层配置项,参数继承自 Theme3DLayer。
  * @param  {Array} [layerOptions.heightStops] - 新增参数，数据高度分段数组。
  * @param  {Array} layerOptions.colorStops - 新增参数，数据颜色分段数组。

src/mapboxgl/overlay/ThreeLayer.js

@@ -136,7 +136,7 @@ export class ThreeLayer extends mapboxgl.Evented {
 
     /**
      * @function ThreeLayer.prototype.getScene
-     * @description 获取threejs 场景对象
+     * @description 获取 threejs 场景对象。
      * @returns {THREE.Scene} threejs 场景对象。
      */
     getScene() {
@@ -145,7 +145,7 @@ export class ThreeLayer extends mapboxgl.Evented {
 
     /**
      * @function ThreeLayer.prototype.getCamera
-     * @description 获取threejs 相机。
+     * @description 获取 threejs 相机。
      * @returns {THREE.Camera} threejs 相机。
      */
     getCamera() {
@@ -238,9 +238,9 @@ export class ThreeLayer extends mapboxgl.Evented {
 
     /**
      * @function ThreeLayer.prototype.lngLatToPosition
-     * @description 经纬度转threejs 3D 失量对象。
+     * @description 经纬度转threejs 3D 矢量对象。
      * @param {(Array.<number>|Object)} lngLat - 经纬度坐标。
-     * @returns {THREE.Vector3} threejs 3D 失量对象。
+     * @returns {THREE.Vector3} threejs 3D 矢量对象。
      */
     lngLatToPosition(lngLat) {
         let zoom = Transform.projection.nativeMaxZoom;
@@ -250,11 +250,11 @@ export class ThreeLayer extends mapboxgl.Evented {
 
     /**
      * @function ThreeLayer.prototype.distanceToThreeVector3
-     * @description 计算距离指定坐标给定距离的新坐标的 threejs 3D 失量对象。
-     * @param {number} x - x 轴距离,单位米。
-     * @param {number} y - y 轴距离,单位米。
+     * @description 计算距离指定坐标给定距离的新坐标的 threejs 3D 矢量对象。
+     * @param {number} x - x 轴距离，单位米。
+     * @param {number} y - y 轴距离，单位米。
      * @param {(Array.<number>|Object)} lngLat - 源坐标。
-     * @returns {THREE.Vector3} 目标点的 threejs 3D 失量对象。
+     * @returns {THREE.Vector3} 目标点的 threejs 3D 矢量对象。
      */
     distanceToThreeVector3(x, y, lngLat) {
         let map = this._map;