优化中文API review by songym

Author: yaoxiaoni1

build/jsdocs/template/config.json

@@ -297,6 +297,10 @@
                 "name": "高效率点图层",
                 "name_en": "Graphic"
             },
+            "DeckGL": {
+                "name": "DeckGL",
+                "name_en": "DeckGL"
+            },
             "Theme": {
                 "name": "客户端专题图",
                 "name_en": "Theme"

src/mapboxgl/control/Logo.js

@@ -5,18 +5,18 @@ import {LogoBase64} from '@supermap/iclient-common/control/img/Logo';
 /**
  * @class mapboxgl.supermap.LogoControl
  * @category  Control
- * @classdesc Logo控件。默认不显示</br>
+ * @classdesc Logo控件。默认不显示。
  *
  * @example
  * (start code)
  *  map.addControl(new mapboxgl.supermap.LogoControl(),'bottom-right');
  * (end)
- * @param {Object} options - logo控件配置项</br>
- * @param {string} options.imageUrl - logo图片地址</br>
- * @param {string} options.width - logo图片宽</br>
- * @param {string} options.height - logo图片高</br>
- * @param {string} options.link - logo图片跳转链接</br>
- * @param {string} options.alt - logo图片失效时显示文本
+ * @param {Object} options - logo控件配置项。
+ * @param {string} [options.imageUrl] - logo图片地址。
+ * @param {string} [options.width] - logo图片宽。
+ * @param {string} [options.height] - logo图片高。
+ * @param {string} [options.link] - logo图片跳转链接。
+ * @param {string} [options.alt='SuperMap iClient'] - logo图片失效时显示文本。
  */
 export class Logo {
     constructor(options) {
@@ -35,8 +35,8 @@ export class Logo {
 
     /**
      * @function mapboxgl.supermap.LogoControl.prototype.onAdd
-     * @description 添加一个logo
-     * @returns {div} 返回创建的logo元素
+     * @description 添加一个logo。
+     * @returns {div} 返回创建的logo元素。
      */
     onAdd(map) {
         this._map = map;

src/mapboxgl/core/MapExtend.js

@@ -3,7 +3,7 @@ import '../core/Base';
 
 /**
  * @function mapboxgl.supermap.MapExtend
- * @description  扩展了mapboxgl.Map对图层相关的操作
+ * @description  扩展了mapboxgl.Map对图层相关的操作。
  * @private
  */
 export var MapExtend = function () {
@@ -78,7 +78,7 @@ export var MapExtend = function () {
 
     /**
      * @function mapboxgl.supermap.MapExtend.prototype.removeFromMap
-     * @description  移除事件
+     * @description  移除事件。
      */
     function removeLayer(layer) {
         layer.removeFromMap();
@@ -87,7 +87,7 @@ export var MapExtend = function () {
     /**
      * @function mapboxgl.supermap.MapExtend.prototype.setVisibility
      * @description  设置图层可见性，设置图层的隐藏，显示，重绘的相应的可见标记。
-     * @param {boolean} visibility - 是否显示图层（当前地图的resolution在最大最小resolution之间）。
+     * @param {boolean} [visibility] - 是否显示图层（当前地图的resolution在最大最小resolution之间）。
      */
     function setVisibility(layer, visibility) {
         layer.setVisibility(visibility);
@@ -96,8 +96,8 @@ export var MapExtend = function () {
     /**
      * @function mapboxgl.supermap.MapExtend.prototype.moveTo
      * @description 将图层移动到某个图层之前。
-     * @param {string} layerID -待插入的图层ID。</br>
-     * @param {boolean} beforeLayerID - 是否将本图层插入到图层id为layerID的图层之前(如果为false则将本图层插入到图层id为layerID的图层之后)。
+     * @param {string} layerID -待插入的图层ID。
+     * @param {boolean} [beforeLayerID] - 是否将本图层插入到图层id为layerID的图层之前(如果为false则将本图层插入到图层id为layerID的图层之后)。
      */
     function moveLayer(layerID, beforeLayerID) {
         var layer = document.getElementById(layerID);

src/mapboxgl/core/Util.js

@@ -4,14 +4,14 @@ import {Bounds, GeometryPoint, GeoJSON as GeoJSONFormat} from '@supermap/iclient
 
 /**
  * @class mapboxgl.supermap.Util
- * @classdesc 工具类
+ * @classdesc 工具类。
  */
 export class Util {
 
     /**
      * @function mapboxgl.supermap.Util.toSuperMapGeometry
-     * @description 将 geoJSON 对象转为SuperMap几何图形
-     * @param {Object} geoJSON - geoJSON 对象
+     * @description 将 geoJSON 对象转为SuperMap几何图形。
+     * @param {Object} geoJSON - geoJSON 对象。
      */
     static toSuperMapGeometry(geoJSON) {
         if (geoJSON && geoJSON.type) {
@@ -51,9 +51,9 @@ export class Util {
 
     /**
      * @function mapboxgl.supermap.Util.isArray
-     * @description 判断是否为数组格式
-     * @param {Object} obj - 待判断对象
-     * @returns {boolean} 是否是数组
+     * @description 判断是否为数组格式。
+     * @param {Object} obj - 待判断对象。
+     * @returns {boolean} 是否是数组。
      */
     static isArray(obj) {
         return Object.prototype.toString.call(obj) == '[object Array]'
@@ -62,8 +62,8 @@ export class Util {
 
     /**
      * @function mapboxgl.supermap.Util.toGeoJSON
-     * @description 将传入对象转为 GeoJSON 格式
-     * @param {Object} smObj - 待转参数
+     * @description 将传入对象转为 GeoJSON 格式。
+     * @param {Object} smObj - 待转参数。
      */
     static toGeoJSON(smObj) {
         if (smObj) {
@@ -74,9 +74,9 @@ export class Util {
 
     /**
      * @function mapboxgl.supermap.Util.toProcessingParam
-     * @description 将Region节点数组转为Processing服务需要的分析参数
-     * @param {Array} points - Region各个节点数组
-     * @returns {Object} processing 服务裁剪、查询分析的分析参数
+     * @description 将Region节点数组转为Processing服务需要的分析参数。
+     * @param {Array} points - Region各个节点数组。
+     * @returns {Object} processing 服务裁剪、查询分析的分析参数。
      */
     static toProcessingParam(points) {
         var geometryParam = {};
@@ -98,10 +98,10 @@ export class Util {
 
     /**
      * @function mapboxgl.supermap.Util.extend
-     * @description 对象拷贝赋值
-     * @param {Object} dest - 目标对象
-     * @param {Object} arguments - 待拷贝的对象
-     * @returns {Object} 赋值后的目标对象
+     * @description 对象拷贝赋值。
+     * @param {Object} dest - 目标对象。
+     * @param {Object} arguments - 待拷贝的对象。
+     * @returns {Object} 赋值后的目标对象。
      */
     static extend(dest) {
         for (var index = 0; index < Object.getOwnPropertyNames(arguments).length; index++) {