Skip to content

Commit 732f6cd

Browse files
chenmeiyiSupermapchenmeiyiSupermap
committed
【API】优化jsdoc
1 parent ff841a0 commit 732f6cd

36 files changed

+327
-330
lines changed

‎src/classic/services/AddressMatchService.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ import {AddressMatchService as CommonAddressMatchService} from '@supermap/iclien
66
* @class SuperMap.REST.AddressMatchService
77
* @category iServer AddressMatch
88
* @classdesc 地址匹配服务，包括正向匹配和反向匹配。
9-
* @extends SuperMap.REST.CommonServiceBase
9+
* @extends {SuperMap.REST.CommonServiceBase}
1010
* @param {string} url - 服务地址
11-
* @param {Object} options - 地址匹配服务可选参数
11+
* @param {Object} options - 参数
1212
*/
1313
export class AddressMatchService extends CommonServiceBase {
1414

@@ -21,7 +21,7 @@ export class AddressMatchService extends CommonServiceBase {
2121
* @function SuperMap.REST.AddressMatchService.prototype.code
2222
* @description 正向匹配
2323
* @param {SuperMap.GeoCodingParameter} params - 正向匹配参数
24-
* @param callback - {function} 回调函数
24+
* @param {function} callback - 回调函数
2525
*/
2626
code(params, callback) {
2727
var me = this;
@@ -42,7 +42,7 @@ export class AddressMatchService extends CommonServiceBase {
4242
* @function SuperMap.REST.AddressMatchService.prototype.decode
4343
* @description 反向匹配
4444
* @param {SuperMap.GeoDeCodingParameter} params - 反向匹配参数
45-
* @param callback - {function} 回调函数
45+
* @param {function} callback - 回调函数
4646
*/
4747
decode(params, callback) {
4848
var me = this;

‎src/classic/services/ProcessingService.js‎

Lines changed: 101 additions & 101 deletions
Large diffs are not rendered by default.

‎src/leaflet/services/AddressMatchService.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ import {AddressMatchService as CommonMatchAddressService} from '@supermap/iclien
88
* @constructs L.supermap.addressMatchService
99
* @classdesc 地址匹配服务
1010
* @category iServer AddressMatch
11-
* @extends L.supermap.ServiceBase
11+
* @extends {L.supermap.ServiceBase}
1212
* @example
1313
* L.supermap.addressMatchService(url,options)
1414
* .code(function(result){
1515
* //doSomething
1616
* })
1717
* @param {string} url - 地址匹配服务地址。
18-
* @param {Object} options - 地址匹配服务可选参数。
18+
* @param {Object} options - 参数。
1919
* @param {string} options.proxy - 服务代理地址。
2020
* @param {SuperMap.ServerType} [options.serverType=SuperMap.ServerType.ISERVER] - 服务来源 iServer|iPortal|online。
2121
* @param {boolean} [options.withCredentials=false] - 请求是否携带cookie。
@@ -30,7 +30,7 @@ export var AddressMatchService = ServiceBase.extend({
3030
* @function L.supermap.addressMatchService.prototype.code
3131
* @description 获取正向地址匹配结果。
3232
* @param {SuperMap.GeoCodingParameter} params - 正向匹配参数。
33-
* @param {RequestCallback} callback 请求结果的回调函数。
33+
* @param {RequestCallback} callback - 请求结果的回调函数。
3434
*/
3535
code: function (params, callback) {
3636
var me = this;
@@ -51,7 +51,7 @@ export var AddressMatchService = ServiceBase.extend({
5151
* @function L.supermap.addressMatchService.prototype.decode
5252
* @description 获取反向地址匹配结果。
5353
* @param {SuperMap.GeoDecodingParameter} params - 反向匹配参数。
54-
* @param {RequestCallback} callback 请求结果的回调函数。
54+
* @param {RequestCallback} callback - 请求结果的回调函数。
5555
*/
5656
decode: function (params, callback) {
5757
var me = this;

‎src/leaflet/services/ChartService.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ import {CommontypesConversion} from '../core/CommontypesConversion';
77
/**
88
* @class L.supermap.chartService
99
* @classdesc 海图服务。
10-
* @category iServer Map Chart
11-
* @extends L.supermap.ServiceBase
10+
* @category iServer Map Chart
11+
* @extends {L.supermap.ServiceBase}
1212
* @example
1313
* L.supermap.chartService(url)
1414
* .queryChart(param,function(result){
1515
* //doSomething
1616
* })
1717
* @param {string} url - 与客户端交互的海图服务地址。
18-
* @param {Object} options - 可选参数
18+
* @param {Object} options - 参数。
1919
* @param {string} options.proxy - 服务代理地址。
2020
* @param {SuperMap.ServerType} [options.serverType=SuperMap.ServerType.ISERVER] - 服务来源 iServer|iPortal|online。
2121
* @param {boolean} [options.withCredentials=false] - 请求是否携带cookie。

‎src/leaflet/services/DataFlowService.js‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ import {DataFlowService as DataFlow} from '@supermap/iclient-common';
77
* @class L.supermap.dataFlowService
88
* @classdesc 实时数据服务类
99
* @category iServer DataFlow
10-
* @extends L.supermap.ServiceBase
10+
* @extends {L.supermap.ServiceBase}
1111
* @param {string} url - 实时数据服务地址。
12-
* @param {Object} options - 加载实时数据可选参数。
12+
* @param {Object} options - 参数。
1313
* @param {SuperMap.ServerType} [options.serverType=SuperMap.ServerType.ISERVER] - 服务来源 iServer|iPortal|online。
14-
* @param {Function} options.style - 设置数据加载样式。
15-
* @param {Function} options.onEachFeature - 设置每个数据加载popup等。
14+
* @param {function} options.style - 设置数据加载样式。
15+
* @param {function} options.onEachFeature - 设置每个数据加载popup等。
1616
* @param {Array.<Object>} options.geometry - 设置增添的几何要素对象数组。
1717
* @param {Object} options.excludeField - 排除字段。
1818
*/
@@ -57,7 +57,7 @@ export var DataFlowService = ServiceBase.extend({
5757
/**
5858
* @function L.supermap.dataFlowService.prototype.broadcast
5959
* @description 加载广播数据
60-
* @param {JSONObject} obj - json格式的要素数据。
60+
* @param {JSONObject} obj - json格式的要素数据。
6161
*/
6262
broadcast: function (obj) {
6363
this.dataFlow.broadcast(obj);
@@ -76,7 +76,7 @@ export var DataFlowService = ServiceBase.extend({
7676
/**
7777
* @function L.supermap.dataFlowService.prototype.setExcludeField
7878
* @description 设置排除字段
79-
* @param {Object} excludeField - 排除字段
79+
* @param {Object} excludeField - 排除字段
8080
*/
8181
setExcludeField: function (excludeField) {
8282
this.dataFlow.setExcludeField(excludeField);
@@ -87,7 +87,7 @@ export var DataFlowService = ServiceBase.extend({
8787
/**
8888
* @function L.supermap.dataFlowService.prototype.setGeometry
8989
* @description 设置添加的GeoJSON几何要素数据
90-
* @param {Array<Object>} geometry - 设置增添的GeoJSON几何要素对象数组。
90+
* @param {Array.<Object>} geometry - 设置增添的GeoJSON几何要素对象数组。
9191
*/
9292
setGeometry: function (geometry) {
9393
this.dataFlow.setGeometry(geometry);

‎src/leaflet/services/FeatureService.js‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ import {
2222
* .getFeaturesByIDs(param,function(result){
2323
* //doSomething
2424
* })
25-
* @extends L.supermap.ServiceBase
25+
* @extends {L.supermap.ServiceBase}
2626
* @param {string} url - 要素数据集服务地址
27-
* @param {Object} options - 创建要素数据集服务类可选参数。
27+
* @param {Object} options - 参数。
2828
* @param {string} options.proxy - 服务代理地址。
2929
* @param {SuperMap.ServerType} [options.serverType=SuperMap.ServerType.ISERVER] - 服务来源 iServer|iPortal|online。
3030
* @param {boolean} [options.withCredentials=false] - 请求是否携带cookie。
@@ -38,9 +38,9 @@ export var FeatureService = ServiceBase.extend({
3838
/**
3939
* @function L.supermap.featureService.prototype.getFeaturesByIDs
4040
* @description 数据集ID查询服务
41-
* @param {SuperMap.GetFeaturesByIDsParameters} params ID 查询参数类。
42-
* @param {RequestCallback} callback 回调函数
43-
* @param {SuperMap.DataFormat} resultFormat 返回结果类型
41+
* @param {SuperMap.GetFeaturesByIDsParameters} params - ID 查询参数类。
42+
* @param {RequestCallback} callback - 回调函数。
43+
* @param {SuperMap.DataFormat} resultFormat - 返回结果类型。
4444
*/
4545
getFeaturesByIDs: function (params, callback, resultFormat) {
4646
var me = this;
@@ -63,7 +63,7 @@ export var FeatureService = ServiceBase.extend({
6363
* @description 数据集Bounds查询服务
6464
* @param {SuperMap.GetFeaturesByBoundsParameters} params - 数据集范围查询参数类。
6565
* @param {RequestCallback} callback - 回调函数
66-
* @param {SuperMap.DataFormat} resultFormat - 返回结果类型
66+
* @param {SuperMap.DataFormat} resultFormat - 返回结果类型
6767
*/
6868
getFeaturesByBounds: function (params, callback, resultFormat) {
6969
var me = this;
@@ -83,7 +83,7 @@ export var FeatureService = ServiceBase.extend({
8383
/**
8484
* @function L.supermap.featureService.prototype.getFeaturesByBuffer
8585
* @description 数据集Buffer查询服务
86-
* @param {SuperMap.GetFeaturesByBufferParameters} params - 数据服务中数据集缓冲区查询参数类。
86+
* @param {SuperMap.GetFeaturesByBufferParameters} params - 数据服务中数据集缓冲区查询参数类。
8787
* @param {RequestCallback} callback - 回调函数
8888
* @param {SuperMap.DataFormat} resultFormat - 返回结果类型
8989
*/
@@ -106,7 +106,7 @@ export var FeatureService = ServiceBase.extend({
106106
* @function L.supermap.featureService.prototype.getFeaturesBySQL
107107
* @description 数据集SQL查询服务
108108
* @param {SuperMap.GetFeaturesBySQLParameters} params - 数据服务中数据集SQL查询参数类。
109-
* @param {RequestCallback} callback 回调函数
109+
* @param {RequestCallback} callback - 回调函数
110110
* @param {SuperMap.DataFormat} resultFormat - 返回结果类型
111111
*/
112112
getFeaturesBySQL: function (params, callback, resultFormat) {
@@ -128,7 +128,7 @@ export var FeatureService = ServiceBase.extend({
128128
* @function L.supermap.featureService.prototype.getFeaturesByGeometry
129129
* @description 数据集几何查询服务类
130130
* @param {SuperMap.GetFeaturesByGeometryParameters} params - 数据集几何查询参数类。
131-
* @param {RequestCallback} callback 回调函数
131+
* @param {RequestCallback} callback - 回调函数
132132
* @param {SuperMap.DataFormat} resultFormat - 返回结果类型
133133
*/
134134
getFeaturesByGeometry: function (params, callback, resultFormat) {
@@ -149,8 +149,8 @@ export var FeatureService = ServiceBase.extend({
149149
/**
150150
* @function L.supermap.featureService.prototype.editFeatures
151151
* @description 地物编辑服务
152-
* @param {SuperMap.EditFeaturesParameters} params 数据服务中数据集添加、修改、删除参数类。
153-
* @param {RequestCallback} callback 回调函数
152+
* @param {SuperMap.EditFeaturesParameters} params - 数据服务中数据集添加、修改、删除参数类。
153+
* @param {RequestCallback} callback - 回调函数
154154
*/
155155
editFeatures: function (params, callback) {
156156

‎src/leaflet/services/FieldService.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ import {GetFieldsService, FieldStatisticService, FieldStatisticsParameters} from
77
* @class L.supermap.fieldService
88
* @classdesc 字段服务类
99
* @category iServer Data Field
10-
* @extends L.supermap.ServiceBase
10+
* @extends {L.supermap.ServiceBase}
1111
* @example
1212
* L.supermap.fieldService(url).getFields(function(result){
1313
* //doSomething
1414
* });
1515
* @param {string} url - 字段服务地址。
16-
* @param {Object} options - 字段服务类可选参数。
16+
* @param {Object} options - 参数。
1717
* @param {string} options.proxy - 服务代理地址。
1818
* @param {SuperMap.ServerType} [options.serverType=SuperMap.ServerType.ISERVER] - 服务来源 iServer|iPortal|online。
1919
* @param {boolean} [options.withCredentials=false] - 请求是否携带cookie。
@@ -30,7 +30,7 @@ export var FieldService = ServiceBase.extend({
3030
* @function L.supermap.fieldService.prototype.getFields
3131
* @description 字段查询服务
3232
* @param {SuperMap.FieldParameters} params - 字段信息查询参数类
33-
* @param {RequestCallback} callback 回调函数
33+
* @param {RequestCallback} callback - 回调函数
3434
*/
3535
getFields: function (params, callback) {
3636
var me = this;

‎src/leaflet/services/GridCellInfosService.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ import {GetGridCellInfosService, GetGridCellInfosParameters} from '@supermap/icl
77
* @class L.supermap.gridCellInfosService
88
* @classdesc 数据栅格查询服务
99
* @category iServer Data Grid
10-
* @extends L.supermap.ServiceBase
10+
* @extends {L.supermap.ServiceBase}
1111
* @example
1212
* L.supermap.gridCellInfosService(url)
1313
* .getGridCellInfos(param,function(result){
1414
* //doSomething
1515
* })
1616
* @param {string} url - 数据栅格查询服务地址。
17-
* @param {Object} options - 数据栅格查询服务类可选参数。
17+
* @param {Object} options - 参数。
1818
* @param {string} options.proxy - 服务代理地址。
1919
* @param {SuperMap.ServerType} [options.serverType=SuperMap.ServerType.ISERVER] - 服务来源 iServer|iPortal|online。
2020
* @param {boolean} [options.withCredentials=false] - 请求是否携带cookie。
@@ -27,8 +27,8 @@ export var GridCellInfosService = ServiceBase.extend({
2727

2828
/**
2929
* @function L.supermap.gridCellInfosService.prototype.getGridCellInfos
30-
* @param params {SuperMap.GetGridCellInfosParameters} 数据服务栅格查询参数类
31-
* @param {RequestCallback} callback 回调函数
30+
* @param {SuperMap.GetGridCellInfosParameters} params - 数据服务栅格查询参数类
31+
* @param {RequestCallback} callback - 回调函数
3232
*/
3333
getGridCellInfos: function (params, callback) {
3434
if (!(params instanceof GetGridCellInfosParameters)) {

‎src/leaflet/services/LayerInfoService.js‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ import {
1515
* @class L.supermap.layerInfoService
1616
* @classdesc 图层信息类
1717
* @category iServer Map Layer
18-
* @extends L.supermap.ServiceBase
18+
* @extends {L.supermap.ServiceBase}
1919
* @example
2020
* L.supermap.layerInfoService(url).getLayersInfo(function(result){
2121
* //doSomething
2222
* })
2323
* @param {string} url - 与服务端交互的地图服务地址。请求地图服务URL 应为：http://{服务器地址}:{服务端口号}/iserver/services/{地图服务名}/rest/maps/{地图名}"；
24-
* @param {Object} options - 交互服务时所需可选参数.
24+
* @param {Object} options - 参数。
2525
* @param {string} options.proxy - 服务代理地址。
2626
* @param {SuperMap.ServerType} [options.serverType=SuperMap.ServerType.ISERVER] - 服务来源 iServer|iPortal|online。
2727
* @param {boolean} [options.withCredentials=false] - 请求是否携带cookie。
@@ -35,7 +35,7 @@ export var LayerInfoService = ServiceBase.extend({
3535
/**
3636
* @function L.supermap.layerInfoService.prototype.getLayerInfo
3737
* @description 获取图层信息
38-
* @param {RequestCallback} callback 获取信息完成后的回调函数
38+
* @param {RequestCallback} callback - 获取信息完成后的回调函数
3939
*/
4040
getLayersInfo: function (callback) {
4141
var me = this;
@@ -55,7 +55,7 @@ export var LayerInfoService = ServiceBase.extend({
5555
* @function L.supermap.layerInfoService.prototype.setLayerInfo
5656
* @description 设置图层信息服务。可以实现临时图层中子图层的修改
5757
* @param {SuperMap.SetLayerInfoParameters} params - 图层信息相关参数
58-
* @param {RequestCallback} callback 回调函数
58+
* @param {RequestCallback} callback - 回调函数
5959
*/
6060
setLayerInfo: function (params, callback) {
6161
if (!(params instanceof SetLayerInfoParameters)) {
@@ -89,7 +89,7 @@ export var LayerInfoService = ServiceBase.extend({
8989
* @function L.supermap.layerInfoService.prototype.setLayersInfo
9090
* @description 设置图层信息。可以实现创建新的临时图层和对现有临时图层的修改
9191
* @param {SuperMap.SetLayersInfoParameters} params - 图层信息设置参数,包括临时图层。
92-
* @param {RequestCallback} callback 回调函数
92+
* @param {RequestCallback} callback - 回调函数
9393
*/
9494
setLayersInfo: function (params, callback) {
9595
if (!(params instanceof SetLayersInfoParameters)) {
@@ -122,7 +122,7 @@ export var LayerInfoService = ServiceBase.extend({
122122
* @function L.supermap.layerInfoService.prototype.setLayerStatus
123123
* @description 负责将子图层显示控制参数传递到服务端，并获取服务端返回的图层显示状态。
124124
* @param {SuperMap.SetLayerStatusParameters} params - 图层信息显示控制参数。
125-
* @param {RequestCallback} callback 回调函数
125+
* @param {RequestCallback} callback - 回调函数
126126
*/
127127
setLayerStatus: function (params, callback) {
128128
if (!(params instanceof SetLayerStatusParameters)) {

‎src/leaflet/services/MapService.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ import {MapService as CommonMapService, TilesetsService} from '@supermap/iclient
77
* @class L.supermap.mapService
88
* @classdesc 地图信息服务类
99
* @category iServer Map
10-
* @extends L.supermap.ServiceBase
10+
* @extends {L.supermap.ServiceBase}
1111
* @param {string} url - 地图服务地址
12-
* @param {Object} options - 地图服务信息相关参数。
12+
* @param {Object} options - 参数。
1313
* @param {string} options.proxy - 服务代理地址。
1414
* @param {SuperMap.ServerType} [options.serverType=SuperMap.ServerType.ISERVER] - 服务来源 iServer|iPortal|online。
1515
* @param {boolean} [options.withCredentials=false] - 请求是否携带cookie。
@@ -37,7 +37,7 @@ export var MapService = ServiceBase.extend({
3737
/**
3838
* @function L.supermap.mapService.prototype.getMapInfo
3939
* @description 获取地图信息
40-
* @param {RequestCallback} callback 回调函数
40+
* @param {RequestCallback} callback - 回调函数
4141
*/
4242
getMapInfo: function (callback) {
4343
var me = this;
@@ -57,7 +57,7 @@ export var MapService = ServiceBase.extend({
5757
/**
5858
* @function L.supermap.mapService.prototype.getTilesets
5959
* @description 获取切片列表信息
60-
* @param {RequestCallback} callback 回调函数
60+
* @param {RequestCallback} callback - 回调函数
6161
*/
6262
getTilesets: function (callback) {
6363
var me = this;

0 commit comments

Comments
 (0)