Skip to content

Commit c24c3d5

Browse files
yaoxiaoni1yaoxiaoni1
committed
优化中文API review by songym
1 parent e1bc34e commit c24c3d5

File tree

136 files changed

+937
-924
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

136 files changed

+937
-924
lines changed

‎build/jsdocs/template/typeLinkExt.js

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
var olapi = "https://openlayers.org/en/v4.6.5/apidoc/";
22
var lfapi = "http://leafletjs.com/reference-1.3.1.html";
33
var mbglapi = "https://www.mapbox.com/mapbox-gl-js/api/";
4-
var mapv = "https://github.com/huiyan-fe/mapv/blob/master/src/"
4+
var mapv = "https://github.com/huiyan-fe/mapv/blob/master/src/";
5+
var classicapi="http://iclient.supermap.io/libs/iclient8c/apidoc/files/SuperMap"
56
var typeLinks = {
67
//openlayers
78
"ol.Map": olapi + "ol.Map.html",
@@ -57,7 +58,11 @@ var typeLinks = {
5758
"mapboxgl.Map": mbglapi + '#map',
5859
//mapv
5960
"Mapv.DataSet": mapv + 'data/DataSet.md',
60-
"Mapv.BaiduMapLayer": mapv + 'map/baidu-map/Layer.md'
61+
"Mapv.BaiduMapLayer": mapv + 'map/baidu-map/Layer.md',
62+
63+
//classic
64+
"SuperMap.Layer":classicapi + '/Layer-js.html',
65+
6166

6267
}
6368
exports.typeLinks = typeLinks;

‎src/common/commontypes/Bounds.js

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

‎src/common/control/TimeFlowControl.js

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

‎src/common/format/GeoJSON.js

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

367367
read(json, type, filter) {

‎src/common/format/JSON.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import {Format} from './Format';
55
* @class SuperMap.Format.JSON
66
* @classdesc 安全的读写 JSON 的解析类。使用 {@link SuperMap.Format.JSON} 构造函数创建新实例。
77
* @category BaseTypes Format
8-
* @extends SuperMap.Format
8+
* @extends {SuperMap.Format}
99
*/
1010
export class JSONFormat extends Format {
1111

‎src/common/format/WKT.js

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

‎src/common/iPortal/iPortal.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import {IPortalServiceBase} from './iPortalServiceBase';
1010
* @class SuperMap.iPortal
1111
* @classdesc 对接 SuperMap iPortal 基础服务。
1212
* @category iPortal/Online
13-
* @extends SuperMap.iPortalServiceBase
13+
* @extends {SuperMap.iPortalServiceBase}
1414
* @param {string} iportalUrl - 地址。
1515
*
1616
*/

‎src/common/iPortal/iPortalMap.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import {IPortalServiceBase} from './iPortalServiceBase';
88
* @category iPortal/Online
99
* @param {string} mapUrl - 地图地址。
1010
* @param {Object} [params] - 服务参数。
11-
* @extends SuperMap.iPortalServiceBase
11+
* @extends {SuperMap.iPortalServiceBase}
1212
*
1313
*/
1414
export class IPortalMap extends IPortalServiceBase {

‎src/common/iPortal/iPortalService.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import {IPortalServiceBase} from './iPortalServiceBase';
66
* @class SuperMap.iPortalService
77
* @classdesc iPortal 服务。
88
* @category iPortal/Online
9-
* @extends SuperMap.iPortalServiceBase
9+
* @extends {SuperMap.iPortalServiceBase}
1010
* @param {string} seviceUrl - 服务地址。
1111
* @param {Object} params - 服务请求参数。
1212
*

‎src/common/iServer/AreaSolarRadiationParameters.js

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

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy