Skip to content

Commit bcb497f

Browse files
wuzhuorui5wuzhuorui5
committed
mapboxgl、openlayers 修改部分注释 review by zhurongchang
1 parent e73471d commit bcb497f

File tree

97 files changed

+787
-295
lines changed

Some content is hidden

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

97 files changed

+787
-295
lines changed

‎build/jsdocs/leaflet/docs.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
},
1111
"source": {
1212
"includePattern": ".+\\.js?$",
13-
"excludePattern": ".+\\\\src\\\\common\\\\iServer\\\\.*Service|Base.js?$",
13+
"excludePattern": ".+\\\\src\\\\common\\\\iServer\\\\.*Service.js?$",
1414
"include": [
1515
"src/common","src/leaflet"
1616
]

‎build/jsdocs/openlayers/docs.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
},
1111
"source": {
1212
"includePattern": ".+\\.js?$",
13-
"excludePattern": ".+\\\\src\\\\common\\\\iServer\\\\.*Service|Base.js?$",
13+
"excludePattern": ".+\\\\src\\\\common\\\\iServer\\\\.*Service.js?$",
1414
"include": [
1515
"src/common","src/openlayers"
1616
]

‎src/common/iPortal/iPortal.js‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import IPortalServiceBase from './iPortalServiceBase';
1010
* @class SuperMap.iPortal
1111
* @classdesc iPortal
1212
* @extends SuperMap.iPortalServiceBase
13+
* @param iportalUrl -{string} 地址
1314
*
1415
*/
1516
export default class IPortal extends IPortalServiceBase {
@@ -31,7 +32,7 @@ export default class IPortal extends IPortalServiceBase {
3132

3233
/**
3334
* @function SuperMap.iPortal.prototype.queryServices
34-
* @param queryParams -{string} 查询参数
35+
* @param queryParams -{SuperMap.iPortalServicesQueryParam} 查询参数
3536
* @description 查询服务
3637
*/
3738
queryServices(queryParams) {
@@ -47,7 +48,7 @@ export default class IPortal extends IPortalServiceBase {
4748

4849
/**
4950
* @function SuperMap.iPortal.prototype.deleteServices
50-
* @param ids -{number} 服务的序号
51+
* @param ids -{number} 服务的id
5152
* @description 删除服务
5253
*/
5354
deleteServices(ids) {
@@ -57,7 +58,7 @@ export default class IPortal extends IPortalServiceBase {
5758

5859
/**
5960
* @function SuperMap.iPortal.prototype.queryMaps
60-
* @param queryParams -{string} 查询参数
61+
* @param queryParams -{SuperMap.iPortalMapsQueryParam} 查询参数
6162
* @description 获取地图信息
6263
*/
6364
queryMaps(queryParams) {

‎src/common/iPortal/iPortalMap.js‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ import IPortalServiceBase from './iPortalServiceBase';
44
/**
55
* @class SuperMap.iPortalMap
66
* @classdesc iPortal地图编辑
7+
* @param mapUrl -{string} 地图地址
8+
* @param params -{object} 服务参数
79
* @extends SuperMap.iPortalServiceBase
810
*
911
*/
@@ -32,10 +34,10 @@ export default class IPortalMap extends IPortalServiceBase {
3234
userName = "";
3335
visitCount = 0;
3436

35-
/**
37+
/*
3638
* @function SuperMap.iPortalMap.prototype.constructor
3739
* @param mapUrl -{string} 地图地址
38-
* @param params -{string} 服务参数
40+
* @param params -{object} 服务参数
3941
*/
4042
constructor(mapUrl, params) {
4143
super(mapUrl);
@@ -65,7 +67,7 @@ export default class IPortalMap extends IPortalServiceBase {
6567
}
6668

6769
/**
68-
* @method SuperMap.iPortalMap.prototype.update
70+
* @function SuperMap.iPortalMap.prototype.update
6971
* @description 更新地图参数
7072
*/
7173
update() {

‎src/common/iPortal/iPortalMapsQueryParam.js‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import SuperMap from '../SuperMap';
33
/**
44
* @class SuperMap.iPortalMapsQueryParam
55
* @classdesc iPortal地图资源查询参数
6+
* @param params -{string}
67
*
78
*/
89
export default class IPortalMapsQueryParam {
@@ -26,7 +27,7 @@ export default class IPortalMapsQueryParam {
2627

2728
/*
2829
* @function SuperMap.iPortalMapsQueryParam.prototype.constructor
29-
* @param params -{string}
30+
* @param params -{object} iPortal地图资源查询具体参数
3031
*
3132
*/
3233
constructor(params) {

‎src/common/iPortal/iPortalService.js‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
import SuperMap from '../SuperMap';
22
import IPortalServiceBase from './iPortalServiceBase';
3-
43
/**
54
* @class SuperMap.iPortalService
65
* @classdesc iPortal服务
76
* @extends SuperMap.iPortalServiceBase
7+
* @param seviceUrl -{string} 服务地址
8+
* @param params -{string}
89
*
910
*/
1011
export default class IPortalService extends IPortalServiceBase {
@@ -40,7 +41,7 @@ export default class IPortalService extends IPortalServiceBase {
4041
/*
4142
* @function SuperMap.iPortalService.prototype.constructor
4243
* @param seviceUrl -{string} 服务地址
43-
* @param params -{string}
44+
* @param params -{object}
4445
*/
4546

4647
constructor(serviceUrl, params) {
@@ -73,7 +74,7 @@ export default class IPortalService extends IPortalServiceBase {
7374

7475
/**
7576
* @function SuperMap.iPortalService.prototype.update
76-
* @description 更新服务参数
77+
* @description 更新服务
7778
*
7879
*/
7980
update() {

‎src/common/iPortal/iPortalServiceBase.js‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export default class IPortalServiceBase {
1212
/**
1313
* @function SuperMap.iPortalServiceBase.prototype.constructor
1414
*
15-
* @param url -{String}-服务器域名+端口，如：http://localhost:8092
15+
* @param url -{String} 服务器域名+端口，如：http://localhost:8092
1616
*/
1717
constructor(url) {
1818
var me = this;
@@ -23,9 +23,10 @@ export default class IPortalServiceBase {
2323
/**
2424
* @function SuperMap.iPortalServiceBase.prototype.request
2525
* @description 子类统一通过该方法发送请求
26-
* @param url -{String}-服务器域名+端口，如：http://localhost:8092
26+
* @param url -{String} 服务器域名+端口，如：http://localhost:8092
2727
* @param method -{INT}
2828
* @param requestOptions -{Object}
29+
* @param param -{Object}
2930
* @description 获取返回参数的json数组
3031
*
3132
*/
@@ -42,7 +43,7 @@ export default class IPortalServiceBase {
4243
/**
4344
* @function SuperMap.iPortalServiceBase.prototype.createCredentialUrl
4445
* @description 追加授权信息
45-
* @param url -{String}-服务器域名+端口，如：http://localhost:8092
46+
* @param url -{String} 服务器域名+端口，如：http://localhost:8092
4647
* @return {string} 新地址
4748
*/
4849

‎src/common/iPortal/iPortalServicesQueryParam.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import SuperMap from '../SuperMap';
33
/**
44
* @class SuperMap.iPortalServicesQueryParam
55
* @classdesc iPortal服务查询参数
6+
* @param params -{object} 服务参数
67
*
78
*/
89

‎src/common/iServer/AreaSolarRadiationParameters.js‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,13 @@ import SuperMap from '../SuperMap';
22
/**
33
* @class SuperMap.AreaSolarRadiationParameters
44
* @classdesc 地区太阳辐射参数类。
5+
* @param option -{Object} 参数。
56
*/
67
export default class AreaSolarRadiationParameters {
78

89
/**
910
* @member SuperMap.AreaSolarRadiationParameters.prototype.dataset -{String}
10-
*@description 要用来做地区太阳辐射数据源中数据集的名称。
11+
* @description 要用来做地区太阳辐射数据源中数据集的名称。
1112
* 该名称用形如"数据集名称@数据源别名"形式来表示，例如：JingjinTerrain@Jingjin （必设参数）。
1213
*
1314
* 注：地区太阳辐射数据必须为栅格数据集。
@@ -104,7 +105,7 @@ export default class AreaSolarRadiationParameters {
104105
*/
105106
deleteExistResultDataset = false;
106107

107-
/**
108+
/*
108109
* @method SuperMap.AreaSolarRadiationParameters.prototype.constructor
109110
* @param options - {Object} 可選参数。如</br>
110111
* dataset - {String} 要用来做地区太阳辐射数据源中数据集的名称。该名称用形如"数据集名称@数据源别名"形式来表示，例如：JingjinTerrain@Jingjin。（必设参数）。

‎src/common/iServer/AreaSolarRadiationService.js‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@ import AreaSolarRadiationParameters from './AreaSolarRadiationParameters';
44

55
/**
66
* @class SuperMap.AreaSolarRadiationService
7-
* @classdesc
8-
* 地区太阳辐射服务类。
9-
* @extends {SuperMap.SpatialAnalystBase}
7+
* @classdesc 地区太阳辐射服务类。
8+
* @param url - {String} 服务的访问地址。如</br> http://localhost:8090/iserver/services/spatialanalyst-sample/restjsr/spatialanalyst 。</br>
9+
* @param options - {Object} 参数。如:</br>
10+
* eventListeners - {Object} 需要被注册的监听器对象。
11+
* @extends SuperMap.SpatialAnalystBase
1012
* @example 例如：
1113
* (start code)
1214
* var myAreaSolarRadiationService = new SuperMap.AreaSolarRadiationService(url);

0 commit comments

Comments
 (0)