Skip to content

Commit 2602775

Browse files
wuzhuorui5wuzhuorui5
committed
common、mapboxgl、openlayers 新增部分注释 review by zhurongchang
1 parent 2aa2dc7 commit 2602775

File tree

133 files changed

+2560
-2574
lines changed

Some content is hidden

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

133 files changed

+2560
-2574
lines changed

‎package.json‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,10 +87,12 @@
8787
"webpack-node-externals": "^1.6.0"
8888
},
8989
"dependencies": {
90+
"@mapbox/vector-tile": "1.3.0",
9091
"fetch-jsonp": "1.0.6",
92+
"jaguarjs-jsdoc": "^1.1.0",
93+
"jsdoc": "^3.5.4",
9194
"pbf": "3.0.2",
9295
"proj4": "2.4.3",
93-
"@mapbox/vector-tile": "1.3.0",
9496
"whatwg-fetch-importable": "^1.0.3"
9597
}
9698
}

‎src/common/iPortal/iPortal.js‎

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,30 +9,30 @@ import IPortalServiceBase from './iPortalServiceBase';
99
/**
1010
* @class SuperMap.iPortal
1111
* @classdesc iPortal
12-
* @extends {SuperMap.iPortalServiceBase}
12+
* @extends SuperMap.iPortalServiceBase
1313
*
1414
*/
1515
export default class IPortal extends IPortalServiceBase {
16-
/**
17-
* @method SuperMap.iPortal.initialize
18-
* @param iportalUrl
16+
/*
17+
* @function SuperMap.iPortal.prototype.constructor
18+
* @param iportalUrl -{string} 地址
1919
*/
2020
constructor(iportalUrl) {
2121
super(iportalUrl);
2222
this.iportalUrl = iportalUrl;
2323
}
24-
2524
/**
26-
* @method SuperMap.iPortal.load
27-
* @param iportalUrl
25+
* @function SuperMap.iPortal.prototype.load
26+
* @description 页面加载
2827
*/
2928
load() {
3029
return FetchRequest.get(this.iportalUrl + '/web');
3130
}
3231

3332
/**
34-
* @method SuperMap.iPortal.queryServices
35-
* @param queryParams
33+
* @function SuperMap.iPortal.prototype.queryServices
34+
* @param queryParams -{string} 查询参数
35+
* @description 查询服务
3636
*/
3737
queryServices(queryParams) {
3838
var serviceUrl = this.iportalUrl + "/web/services";
@@ -46,17 +46,19 @@ export default class IPortal extends IPortalServiceBase {
4646
}
4747

4848
/**
49-
* @method SuperMap.iPortal.deleteServices
50-
* @param ids
49+
* @function SuperMap.iPortal.prototype.deleteServices
50+
* @param ids -{number} 服务的序号
51+
* @description 删除服务
5152
*/
5253
deleteServices(ids) {
5354
var serviceUrl = this.iportalUrl + "/web/services";
5455
return this.request("DELETE", serviceUrl, {ids: ids});
5556
}
5657

5758
/**
58-
* @method SuperMap.iPortal.queryMaps
59-
* @param queryParams
59+
* @function SuperMap.iPortal.prototype.queryMaps
60+
* @param queryParams -{string} 查询参数
61+
* @description 获取地图信息
6062
*/
6163
queryMaps(queryParams) {
6264
var mapsUrl = this.iportalUrl + "/web/maps";

‎src/common/iPortal/iPortalMap.js‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import IPortalServiceBase from './iPortalServiceBase';
44
/**
55
* @class SuperMap.iPortalMap
66
* @classdesc iPortal地图编辑
7-
* @extends {SuperMap.iPortalServiceBase}
7+
* @extends SuperMap.iPortalServiceBase
88
*
99
*/
1010
export default class IPortalMap extends IPortalServiceBase {
@@ -33,9 +33,9 @@ export default class IPortalMap extends IPortalServiceBase {
3333
visitCount = 0;
3434

3535
/**
36-
* @method SuperMap.iPortalMap.initialize
37-
* @param mapUrl
38-
* @param params
36+
* @function SuperMap.iPortalMap.prototype.constructor
37+
* @param mapUrl -{string} 地图地址
38+
* @param params -{string} 服务参数
3939
*/
4040
constructor(mapUrl, params) {
4141
super(mapUrl);
@@ -48,7 +48,8 @@ export default class IPortalMap extends IPortalServiceBase {
4848
}
4949

5050
/**
51-
* @method SuperMap.iPortalMap.load
51+
* @function SuperMap.iPortalMap.prototype.load
52+
* @description 加载地图信息
5253
*/
5354
load() {
5455
var me = this;
@@ -64,7 +65,8 @@ export default class IPortalMap extends IPortalServiceBase {
6465
}
6566

6667
/**
67-
* @method SuperMap.iPortalMap.update
68+
* @method SuperMap.iPortalMap.prototype.update
69+
* @description 更新地图参数
6870
*/
6971
update() {
7072
var mapUpdateParam = {

‎src/common/iPortal/iPortalMapsQueryParam.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ export default class IPortalMapsQueryParam {
2424
visitEnd = 0;
2525
filterFields = [];
2626

27-
/**
28-
* @method SuperMap.iPortalMapsQueryParam.initialize
29-
* @param params
27+
/*
28+
* @function SuperMap.iPortalMapsQueryParam.prototype.constructor
29+
* @param params -{string}
3030
*
3131
*/
3232
constructor(params) {

‎src/common/iPortal/iPortalService.js‎

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import IPortalServiceBase from './iPortalServiceBase';
44
/**
55
* @class SuperMap.iPortalService
66
* @classdesc iPortal服务
7-
* @extends {SuperMap.iPortalServiceBase}
7+
* @extends SuperMap.iPortalServiceBase
88
*
99
*/
1010
export default class IPortalService extends IPortalServiceBase {
@@ -37,10 +37,10 @@ export default class IPortalService extends IPortalServiceBase {
3737
version = null;
3838
visitCount = 0;
3939

40-
/**
41-
* @method SuperMap.iPortalService.initialize
42-
* @param seviceUrl
43-
* @param params
40+
/*
41+
* @function SuperMap.iPortalService.prototype.constructor
42+
* @param seviceUrl -{string} 服务地址
43+
* @param params -{string}
4444
*/
4545

4646
constructor(serviceUrl, params) {
@@ -52,9 +52,10 @@ export default class IPortalService extends IPortalServiceBase {
5252
this.serviceUrl = serviceUrl + "/" + this.id;
5353
}
5454
}
55-
5655
/**
57-
* @method SuperMap.iPortalService.load
56+
* @function SuperMap.iPortalService.prototype.load
57+
* @description 加载服务信息
58+
*
5859
*/
5960

6061
load() {
@@ -71,7 +72,9 @@ export default class IPortalService extends IPortalServiceBase {
7172
}
7273

7374
/**
74-
* @method SuperMap.iPortalService.update
75+
* @function SuperMap.iPortalService.prototype.update
76+
* @description 更新服务参数
77+
*
7578
*/
7679
update() {
7780
var serviceUpdateParam = {

‎src/common/iPortal/iPortalServiceBase.js‎

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@ import SuperMap from '../SuperMap';
22
import {ServerType} from '../REST';
33
import '../security/SecurityManager';
44
import {FetchRequest} from '../util/FetchRequest';
5-
65
/**
76
* @class SuperMap.iPortalServiceBase
87
* @classdesc iPortal服务基类(有权限限制的类需要实现此类)
98
*/
109

10+
1111
export default class IPortalServiceBase {
1212
/**
13-
* @method SuperMap.iPortalServiceBase.initialize
13+
* @function SuperMap.iPortalServiceBase.prototype.constructor
1414
*
15-
* @param url
15+
* @param url -{String}-服务器域名+端口，如：http://localhost:8092
1616
*/
1717
constructor(url) {
1818
var me = this;
@@ -21,12 +21,12 @@ export default class IPortalServiceBase {
2121
}
2222

2323
/**
24-
* @method SuperMap.iPortalServiceBase.request
24+
* @function SuperMap.iPortalServiceBase.prototype.request
2525
* @description 子类统一通过该方法发送请求
26-
* @param url
27-
* @param method
28-
* @param param
29-
* @param requestOptions
26+
* @param url -{String}-服务器域名+端口，如：http://localhost:8092
27+
* @param method -{INT}
28+
* @param requestOptions -{Object}
29+
* @description 获取返回参数的json数组
3030
*
3131
*/
3232

@@ -38,11 +38,12 @@ export default class IPortalServiceBase {
3838
}
3939

4040

41+
4142
/**
42-
* @method SuperMap.iPortalServiceBase.createCredentialUrl
43+
* @function SuperMap.iPortalServiceBase.prototype.createCredentialUrl
4344
* @description 追加授权信息
44-
* @param url
45-
* @return {string}
45+
* @param url -{String}-服务器域名+端口，如：http://localhost:8092
46+
* @return {string} 新地址
4647
*/
4748

4849
createCredentialUrl(url) {
@@ -65,7 +66,7 @@ export default class IPortalServiceBase {
6566

6667

6768
/**
68-
* @method SuperMap.iPortalServiceBase.getCredential
69+
* @function SuperMap.iPortalServiceBase.prototype.getCredential
6970
* @description 获取token
7071
* @return {string } 返回获取的token
7172
*
@@ -84,7 +85,7 @@ export default class IPortalServiceBase {
8485

8586

8687
/**
87-
* @method SuperMap.iPortalServiceBase.getKey
88+
* @function SuperMap.iPortalServiceBase.prototype.getKey
8889
* @description 其子类需要重写该方法，修改其中获取key的字段
8990
* 存储key可能是服务id字段，可能是url
9091
*/

‎src/common/iServer/AddressMatchService.js‎

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,26 @@ import GeoDecodingParameter from './GeoDecodingParameter';
66

77
/**
88
* @class SuperMap.AddressMatchService
9-
* @constructs SuperMap.AddressMatchService
10-
* @classdesc
11-
* 地址匹配服务，包括正向匹配和反向匹配。
12-
* @api
13-
9+
* @classdesc 地址匹配服务，包括正向匹配和反向匹配。
10+
* @param options - {Object} 参数。
11+
* @param url {string}
1412
*/
1513
export default class AddressMatchService extends CommonServiceBase {
16-
/**
17-
*
18-
* @method SuperMap.AddressMatchService.initialize
19-
* @param options - {Object} 参数。
20-
* @param url {string}
14+
/*
15+
* @function SuperMap.AddressMatchService.prototype.constructor
2116
*/
2217
constructor(url, options) {
2318
super(url, options);
2419
}
25-
20+
/**
21+
* @inheritDoc
22+
*/
2623
destroy() {
2724
super.destroy();
2825
}
2926

3027
/**
31-
* @method SuperMap.AddressMatchService.code
28+
* @function SuperMap.AddressMatchService.prototype.code
3229
* @param url {string} 正向地址匹配服务地址
3330
* @param params {object} 正向地址匹配服务参数
3431
*/
@@ -37,7 +34,7 @@ export default class AddressMatchService extends CommonServiceBase {
3734
}
3835

3936
/**
40-
* @method SuperMap.AddressMatchService.decode
37+
* @function SuperMap.AddressMatchService.prototype.decode
4138
* @param url {string} 反向地址匹配服务地址
4239
* @param params {object} 反向地址匹配服务参数
4340
*/

0 commit comments

Comments
 (0)