优化中文API review by songym

Author: yaoxiaoni1

build/jsdocs/template/typeLinkExt.js

@@ -1,7 +1,8 @@
 var olapi = "https://openlayers.org/en/v4.6.5/apidoc/";
 var lfapi = "http://leafletjs.com/reference-1.3.1.html";
 var mbglapi = "https://www.mapbox.com/mapbox-gl-js/api/";
-var mapv = "https://github.com/huiyan-fe/mapv/blob/master/src/"
+var mapv = "https://github.com/huiyan-fe/mapv/blob/master/src/";
+var classicapi="http://iclient.supermap.io/libs/iclient8c/apidoc/files/SuperMap"
 var typeLinks = {
     //openlayers
     "ol.Map": olapi + "ol.Map.html",
@@ -57,7 +58,11 @@ var typeLinks = {
     "mapboxgl.Map": mbglapi + '#map',
     //mapv
     "Mapv.DataSet": mapv + 'data/DataSet.md',
-    "Mapv.BaiduMapLayer": mapv + 'map/baidu-map/Layer.md'
+    "Mapv.BaiduMapLayer": mapv + 'map/baidu-map/Layer.md',
+
+    //classic
+    "SuperMap.Layer":classicapi + '/Layer-js.html',
+
 
 }
 exports.typeLinks = typeLinks;

src/common/commontypes/Bounds.js

@@ -459,7 +459,7 @@ export class Bounds {
      * @param {Object} options - 参数。
      * @param {boolean} [options.inclusive=true] - 边缘重合也看成相交。如果是false，
      *                               两个边界范围没有重叠部分仅仅是在边缘相接（重合），
-     *                               这种情况被认为没有相交。<br>
+     *                               这种情况被认为没有相交。
      * @param {SuperMap.Bounds} [options.worldBounds] - 提供了 worldBounds 参数, 如果他们相交时
      *                               是在全球范围内, 两个边界将被视为相交。这仅适用于交叉或完全不在世界范围的边界。
      * @returns {boolean} 传入的 bounds 对象与当前 bounds 相交。

src/common/control/TimeFlowControl.js

@@ -8,7 +8,7 @@ import {TimeControlBase} from './TimeControlBase';
  * @description 此类只负责时间上的控制，具体执行的操作需要用户在初始化时的回调函数内部进行实现。
  * 如设置起始时间为 1000，结束时间是 2000，步长设置为 1，
  * 那么表示按照每次1年（可以通过 setSpeed 进行修改）的变化从公元 1000 年开始到公元 2000 年为止，默认每 1 秒会 1 次（通过 setFrequency 修改）
- * @extends SuperMap.TimeControlBase
+ * @extends {SuperMap.TimeControlBase}
  * @param {function} callback - 每次刷新回调函数。具体的效果需要用户在此回调函数里面实现。
  * @param {Object} options - 该类开放的可选属性。
  * @param {number} [options.speed=1] - 步长（单位 ms）。不能小于 0，（每次刷新的数据之间的间隔为 1ms）。

src/common/format/GeoJSON.js

@@ -360,8 +360,8 @@ export class GeoJSON extends JSONFormat {
      * @param {string} [type='FeaureCollection'] - 可选的字符串，它决定了输出的格式。支持的值有："Geometry","Feature"，和 "FeatureCollection"，如果此值为null。
      * @returns {Object}  返回值依赖于 type 参数的值。
      *     -如果 type 等于 "FeatureCollection"，返回值将会是 {@link SuperMap.Feature.Vector}> 数组。
-     *     -如果 type 为 "Geometry",输入的 json 对象必须表示一个唯一的几何体，然后返回值就会是 <SuperMap.Feature.Geometry>。
-     *     -如果 type 为 "Feature"，输入的 json 对象也必须表示的一个要素，这样返回值才会是 {@link SuperMap.Feature.Vector}> 。
+     *     -如果 type 为 "Geometry",输入的 JSON 对象必须表示一个唯一的几何体，然后返回值就会是 {@link SuperMap.Feature.Geometry}。
+     *     -如果 type 为 "Feature"，输入的 JSON 对象也必须表示的一个要素，这样返回值才会是 {@link SuperMap.Feature.Vector}> 。
      */
 
      read(json, type, filter) {

src/common/format/JSON.js

@@ -5,7 +5,7 @@ import {Format} from './Format';
  * @class SuperMap.Format.JSON
  * @classdesc 安全的读写 JSON 的解析类。使用 {@link SuperMap.Format.JSON} 构造函数创建新实例。
  * @category BaseTypes Format
- * @extends SuperMap.Format
+ * @extends {SuperMap.Format}
  */
 export class JSONFormat extends Format {
 

src/common/format/WKT.js

@@ -14,7 +14,7 @@ import {MultiPolygon} from '../commontypes/geometry/MultiPolygon';
  * @class SuperMap.Format.WKT
  * @classdesc 用于读写常见文本的类。通过 {@link SuperMap.Format.WKT} 构造器来创建一个新的实例。
  * @category BaseTypes Format
- * @extends SuperMap.Format
+ * @extends {SuperMap.Format}
  * @param {Object} options - 可选的选项对象，其属性将被设置到实例。option 具体配置项继承自 {@link SuperMap.Format}。
  */
 export class WKT extends Format {

src/common/iPortal/iPortal.js

@@ -10,7 +10,7 @@ import {IPortalServiceBase} from './iPortalServiceBase';
  * @class SuperMap.iPortal
  * @classdesc 对接 SuperMap iPortal 基础服务。
  * @category iPortal/Online
- * @extends SuperMap.iPortalServiceBase
+ * @extends {SuperMap.iPortalServiceBase}
  * @param {string} iportalUrl - 地址。
  *
  */

src/common/iPortal/iPortalMap.js

@@ -8,7 +8,7 @@ import {IPortalServiceBase} from './iPortalServiceBase';
  * @category iPortal/Online
  * @param {string} mapUrl - 地图地址。
  * @param {Object} [params] - 服务参数。
- * @extends SuperMap.iPortalServiceBase
+ * @extends {SuperMap.iPortalServiceBase}
  *
  */
 export class IPortalMap extends IPortalServiceBase {

src/common/iPortal/iPortalService.js

@@ -6,7 +6,7 @@ import {IPortalServiceBase} from './iPortalServiceBase';
  * @class SuperMap.iPortalService
  * @classdesc iPortal 服务。
  * @category iPortal/Online
- * @extends SuperMap.iPortalServiceBase
+ * @extends {SuperMap.iPortalServiceBase}
  * @param {string} seviceUrl - 服务地址。
  * @param {Object} params - 服务请求参数。
  *

src/common/iServer/AreaSolarRadiationParameters.js

@@ -13,7 +13,7 @@ import {Util} from '../commontypes/Util';
  * @param {string} options.durationDatasetGridName - 指定地区太阳辐射太阳直射持续时间数据集的名称。 
  * @param {string} options.directDatasetGridName - 指定地区太阳辐射直射辐射量数据集的名称。
  * @param {number} options.latitude - 待计算区域的纬度值。 
- * @param {string} [options.timeMode = "MULTIDAYS"] - 时间模式。可选值"WITHINDAY"（单日）或"MULTIDAYS"（多日）。 
+ * @param {string} [options.timeMode = 'MULTIDAYS'] - 时间模式。可选值"WITHINDAY"（单日）或"MULTIDAYS"（多日）。
  * @param {number} options.dayStart - 起始日期（年内的第几天）。 
  * @param {number} options.dayEnd - 结束日期（年内的第几天）。 
  * @param {number} [options.hourStart] - 起始时间（一天中的第几个小时）。