优化中文API review by songym

yaoxiaoni1 · yaoxiaoni1 · commit 3fb1c483b242 · 2018-07-20T17:58:54.000+08:00
diff --git a/src/classic/overlay/MapVLayer.js b/src/classic/overlay/MapVLayer.js
@@ -6,10 +6,9 @@ import {MapVRenderer} from './mapv/MapVRenderer';
  * @category  Visualization MapV
  * @classdesc MapV图层。
  * @extends SuperMap.Layer
- * @param name - {string} 图层名
- * @param options  - {Object} 可选参数，有如下两个参数：<br>
- *        dataSet - {mapv.DataSet} mapv 的dataSet对象 <br>
- *        options - {Object} mapv 绘图风格配置信息
+ * @param name - {string} 图层名。
+ * @param {Object} options - 可选参数，有如下两个参数：
+ * @param {Mapv.DataSet} options.dataSet - mapv 的dataSet对象。
  */
 export class MapVLayer extends SuperMap.Layer {
 
@@ -28,33 +27,33 @@ export class MapVLayer extends SuperMap.Layer {
         super(name, options);
 
         /**
-         * @member SuperMap.Layer.MapVLayer.prototype.dataSet -{mapv.DataSet}
-         * @description mapv dataset 对象
+         * @member {mapv.DataSet} - SuperMap.Layer.MapVLayer.prototype.dataSet
+         * @description mapv dataset 对象。
          */
         this.dataSet = null;
 
         /**
-         * @member SuperMap.Layer.MapVLayer.prototype.options -{Object}
-         * @description mapv 绘图风格配置信息
+         * @member {Object} - SuperMap.Layer.MapVLayer.prototype.options
+         * @description mapv 绘图风格配置信息。
          */
         this.options = null;
 
         /**
-         * @member SuperMap.Layer.MapVLayer.prototype.supported -{boolean}
-         * @description 当前浏览器是否支持canvas绘制，默认为false。决定了MapV图是否可用，内部判断使用。
+         * @member {boolean} - [SuperMap.Layer.MapVLayer.prototype.supported=false]
+         * @description 当前浏览器是否支持canvas绘制。决定了MapV图是否可用，内部判断使用。
          */
         this.supported = false;
 
         /**
-         * @member SuperMap.Layer.MapVLayer.prototype.canvas {Canvas}
-         * @description MapV图主绘制面板。
+         * @member {Canvas} SuperMap.Layer.MapVLayer.prototype.canvas
+         * @description MapV 图主绘制面板。
          */
         this.canvas = null;
 
         /**
          * @private
-         * @member SuperMap.Layer.MapVLayer.prototype.canvasContext -{CanvasContext}
-         * @description MapV图主绘制对象。
+         * @member {CanvasContext} - SuperMap.Layer.MapVLayer.prototype.canvasContext
+         * @description MapV 图主绘制对象。
          */
         this.canvasContext = null;
 
@@ -105,9 +104,9 @@ export class MapVLayer extends SuperMap.Layer {
 
     /**
      * @function SuperMap.Layer.MapVLayer.prototype.addData
-     * @description 追加数据
-     * @param dataSet - {mapv.DataSet} mapv数据集
-     * @param options - {Object} mapv绘图参数
+     * @description 追加数据。
+     * @param {mapv.DataSet} dataSet - mapv数据集。
+     * @param {Object} options - mapv绘图参数。
      */
     addData(dataSet, options) {
         this.renderer && this.renderer.addData(dataSet, options);
@@ -116,9 +115,9 @@ export class MapVLayer extends SuperMap.Layer {
 
     /**
      * @function SuperMap.Layer.MapVLayer.prototype.
-     * @description 设置数据
-     * @param dataSet {mapv.DataSet} mapv数据集
-     * @param options {Object} mapv绘图参数
+     * @description 设置数据。
+     * @param {mapv.DataSet} dataSet - mapv数据集。
+     * @param {Object} options - mapv绘图参数。
      */
     setData(dataSet, options) {
         this.renderer && this.renderer.setData(dataSet, options);
@@ -127,8 +126,8 @@ export class MapVLayer extends SuperMap.Layer {
 
     /**
      * @function SuperMap.Layer.MapVLayer.prototype.getData
-     * @description 获取数据
-     * @return {mapv.DataSet} mapv数据集
+     * @description 获取数据。
+     * @returns {mapv.DataSet} - mapv数据集。
      */
     getData() {
         if (this.renderer) {
@@ -139,8 +138,8 @@ export class MapVLayer extends SuperMap.Layer {
 
     /**
      * @function SuperMap.Layer.MapVLayer.prototype.removeData
-     * @description 删除符合过滤条件的数据
-     * @param filter - {function} 过滤条件。条件参数为数据项，返回值为true,表示删除该元素；否则表示不删除
+     * @description 删除符合过滤条件的数据。
+     * @param {function} [filter] -  过滤条件。条件参数为数据项，返回值为true,表示删除该元素；否则表示不删除。
      * @example
      *  filter=function(data){
      *    if(data.id=="1"){
@@ -166,7 +165,7 @@ export class MapVLayer extends SuperMap.Layer {
      * @function SuperMap.Layer.MapVLayer.prototype.setMap
      * @description 图层已经添加到Map中。
      *              如果当前浏览器支持canvas，则开始渲染要素；如果不支持则移除图层。
-     * @param map - {SuperMap.Map} 需要绑定的map对象
+     * @param {SuperMap.Map} map - 需要绑定的map对象。
      */
     setMap(map) {
         super.setMap(map);
@@ -182,9 +181,9 @@ export class MapVLayer extends SuperMap.Layer {
      * @function SuperMap.Layer.MapVLayer.prototype.moveTo
      * @description 重置当前MapV图层的div，再一次与Map控件保持一致。
      *              修改当前显示范围，当平移或者缩放结束后开始重绘MapV图的渲染效果。
-     * @param bounds - {SuperMap.Bounds} 图层范围
-     * @param zoomChanged - {boolean} 缩放级别是否改变
-     * @param dragging - {boolean} 是否拖动
+     * @param {SuperMap.Bounds} bounds - 图层范围。
+     * @param {boolean} [zoomChanged] - 缩放级别是否改变。
+     * @param {boolean} [dragging] - 是否拖动。
      */
     moveTo(bounds, zoomChanged, dragging) {
         super.moveTo(bounds, zoomChanged, dragging);
@@ -221,8 +220,8 @@ export class MapVLayer extends SuperMap.Layer {
 
     /**
      * @function SuperMap.Layer.MapVLayer.prototype.transferToMapLatLng
-     * @description 将经纬度转成底图的投影坐标
-     * @param latLng - {SuperMap.Lonlat} 经纬度坐标
+     * @description 将经纬度转成底图的投影坐标。
+     * @param {SuperMap.Lonlat} [latLng] - 经纬度坐标。
      */
     transferToMapLatLng(latLng) {
         var source = "EPSG:4326", dest = "EPSG:4326";
diff --git a/src/classic/overlay/mapv/MapVRenderer.js b/src/classic/overlay/mapv/MapVRenderer.js
@@ -5,11 +5,11 @@ import {baiduMapLayer, DataSet} from 'mapv';
  * @class MapVRenderer
  * @classdesc MapV渲染器。
  * @private
- * @extends mapv.MapVBaseLayer
- * @param map - {SuperMap.Map} 待渲染的地图
- * @param layer - {mapv.baiduMapLayer} 待渲染的图层
- * @param dataSet - {mapv.DataSet} 待渲染的数据集
- * @param options - {Object} 渲染的参数
+ * @extends {mapv.baiduMapLayer}
+ * @param {SuperMap.Map} map - 待渲染的地图。
+ * @param {SuperMap.Layer.MapVLayer} layer - 待渲染的图层。
+ * @param {Mapv.DataSet} dataSet - 待渲染的数据集。
+ * @param {Object} options - 渲染的参数。
  */
 var MapVBaseLayer = baiduMapLayer ? baiduMapLayer.__proto__ : Function;
 
@@ -34,8 +34,8 @@ export class MapVRenderer extends MapVBaseLayer {
 
     /**
      * @function MapvRenderer.prototype.clickEvent
-     * @description 点击事件
-     * @param e - {Object} 触发对象
+     * @description 点击事件。
+     * @param {Object} e -  触发对象。
      */
     clickEvent(e) {
         var pixel = e.xy;
@@ -44,8 +44,8 @@ export class MapVRenderer extends MapVBaseLayer {
 
     /**
      * @function MapvRenderer.prototype.mousemoveEvent
-     * @description 鼠标移动事件
-     * @param  e - {Object} 触发对象
+     * @description 鼠标移动事件。
+     * @param {Object} e - 触发对象。
      */
     mousemoveEvent(e) {
         var pixel = e.xy;
@@ -54,7 +54,7 @@ export class MapVRenderer extends MapVBaseLayer {
 
     /**
      * @function MapvRenderer.prototype.bindEvent
-     * @description 绑定鼠标移动和鼠标点击事件
+     * @description 绑定鼠标移动和鼠标点击事件。
      */
     bindEvent() {
         var map = this.map;
@@ -71,7 +71,7 @@ export class MapVRenderer extends MapVBaseLayer {
 
     /**
      * @function MapvRenderer.prototype.unbindEvent
-     * @description 解绑鼠标移动和鼠标滑动触发的事件
+     * @description 解绑鼠标移动和鼠标滑动触发的事件。
      */
     unbindEvent() {
         var map = this.map;
@@ -88,7 +88,7 @@ export class MapVRenderer extends MapVBaseLayer {
 
     /**
      * @function MapvRenderer.prototype.getContext
-     * @description 获取信息
+     * @description 获取信息。
      */
     getContext() {
         return this.canvasLayer && this.canvasLayer.canvasContext;
@@ -97,8 +97,8 @@ export class MapVRenderer extends MapVBaseLayer {
     /**
      * @function MapvRenderer.prototype.addData
      * @description 追加数据
-     * @param data - {oject} 待添加的数据
-     * @param options - {oject} 待添加的数据信息
+     * @param {oject} data - 待添加的数据。
+     * @param {oject} options - 待添加的数据信息。
      */
     addData(data, options) {
         var _data = data;
@@ -111,9 +111,9 @@ export class MapVRenderer extends MapVBaseLayer {
 
     /**
      * @function MapvRenderer.prototype.updateData
-     * @description 更新覆盖原数据
-     * @param data - {oject} 待更新的数据
-     * @param options - {oject} 待更新的数据信息
+     * @description 更新覆盖原数据。
+     * @param {oject} data - 待更新的数据。
+     * @param {oject} options - 待更新的数据信息。
      */
     setData(data, options) {
         var _data = data;
@@ -127,16 +127,16 @@ export class MapVRenderer extends MapVBaseLayer {
 
     /**
      * @function MapvRenderer.prototype.getData
-     * @description 获取数据
+     * @description 获取数据。
      */
     getData() {
         return this.dataSet;
     }
 
     /**
      * @function MapvRenderer.prototype.removeData
-     * @description 删除符合过滤条件的数据
-     * @param filter - {function} 过滤条件。条件参数为数据项，返回值为true,表示删除该元素；否则表示不删除
+     * @description 删除符合过滤条件的数据。
+     * @param {function} [filter] - 过滤条件。条件参数为数据项，返回值为true,表示删除该元素；否则表示不删除。
      */
     removeData(filter) {
         if (!this.dataSet) {
@@ -153,7 +153,7 @@ export class MapVRenderer extends MapVBaseLayer {
 
     /**
      * @function MapvRenderer.prototype.clearData
-     * @description 清除数据
+     * @description 清除数据。
      */
     clearData() {
         this.dataSet && this.dataSet.clear();
@@ -162,16 +162,16 @@ export class MapVRenderer extends MapVBaseLayer {
 
     /**
      * @function MapvRenderer.prototype.render
-     * @description 着色
-     * @param time - {number}
+     * @description 着色。
+     * @param {number} time
      */
     render(time) {
         this._canvasUpdate(time);
     }
 
     /**
      * @function MapvRenderer.prototype.transferToMercator
-     * @description 墨卡托坐标为经纬度
+     * @description 墨卡托坐标为经纬度。
      */
     transferToMercator() {
         if (this.options.coordType && ["bd09mc", "coordinates_mercator"].indexOf(this.options.coordType) > -1) {
@@ -292,7 +292,7 @@ export class MapVRenderer extends MapVBaseLayer {
 
     /**
      * @function MapvRenderer.prototype.addAnimatorEvent
-     * @description 添加动画事件
+     * @description 添加动画事件。
      */
     addAnimatorEvent() {
         this.map.events.on({'movestart': this.animatorMovestartEvent.bind(this)});
@@ -301,24 +301,24 @@ export class MapVRenderer extends MapVBaseLayer {
 
     /**
      * @function MapvRenderer.prototype.clear
-     * @description 清除环境
-     * @param context - {Object} 当前环境
+     * @description 清除环境。
+     * @param {Object} context - 当前环境。
      */
     clear(context) {
         context && context.clearRect && context.clearRect(0, 0, context.canvas.width, context.canvas.height);
     }
 
     /**
      * @function MapvRenderer.prototype.show
-     * @description 展示渲染效果
+     * @description 展示渲染效果。
      */
     show() {
         this.map.addLayer(this.canvasLayer);
     }
 
     /**
      * @function MapvRenderer.prototype.hide
-     * @description 隐藏渲染效果
+     * @description 隐藏渲染效果。
      */
     hide() {
         this.map.removeLayer(this.canvasLayer);
@@ -327,7 +327,7 @@ export class MapVRenderer extends MapVBaseLayer {
 
     /**
      * @function MapvRenderer.prototype.draw
-     * @description 渲染绘制
+     * @description 渲染绘制。
      */
     draw() {
         this.canvasLayer.redraw();
diff --git a/src/classic/services/AddressMatchService.js b/src/classic/services/AddressMatchService.js
@@ -7,8 +7,8 @@ import {AddressMatchService as CommonAddressMatchService} from '@supermap/iclien
  * @category  iServer AddressMatch
  * @classdesc 地址匹配服务，包括正向匹配和反向匹配。
  * @extends {SuperMap.REST.CommonServiceBase}
- * @param {string} url - 服务地址
- * @param {Object} options - 参数
+ * @param {string} url - 服务地址。
+ * @param {Object} options - 参数。
  */
 export class AddressMatchService extends CommonServiceBase {
 
@@ -19,9 +19,9 @@ export class AddressMatchService extends CommonServiceBase {
 
     /**
      * @function SuperMap.REST.AddressMatchService.prototype.code
-     * @description 正向匹配
-     * @param {SuperMap.GeoCodingParameter} params - 正向匹配参数
-     * @param {function} callback - 回调函数
+     * @description 正向匹配。
+     * @param {SuperMap.GeoCodingParameter} params - 正向匹配参数。
+     * @param {function} callback - 回调函数。
      */
     code(params, callback) {
         var me = this;
@@ -40,9 +40,9 @@ export class AddressMatchService extends CommonServiceBase {
 
     /**
      * @function SuperMap.REST.AddressMatchService.prototype.decode
-     * @description 反向匹配
-     * @param {SuperMap.GeoDeCodingParameter} params -  反向匹配参数
-     * @param {function} callback - 回调函数
+     * @description 反向匹配。
+     * @param {SuperMap.GeoDeCodingParameter} params - 反向匹配参数。
+     * @param {function} callback - 回调函数。
      */
     decode(params, callback) {
         var me = this;
diff --git a/src/classic/services/ProcessingService.js b/src/classic/services/ProcessingService.js
