Skip to content

Commit 4c749d7

Browse files
committed
[fix]文档注释修改 src:common iserver1 review by jinny
1 parent 7faae9c commit 4c749d7

Some content is hidden

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

44 files changed

+115
-115
lines changed

src/common/iServer/BuffersAnalystJobsParameter.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export class BuffersAnalystJobsParameter {
3737

3838
/**
3939
* @member {string} [BuffersAnalystJobsParameter.prototype.distance='15']
40-
* @description 缓冲距离,或称为缓冲区半径。当缓冲距离字段位空时,此参数有效。
40+
* @description 缓冲距离,或称为缓冲区半径。当缓冲距离字段为空时,此参数有效。
4141
*/
4242
this.distance = '';
4343

src/common/iServer/ChartQueryParameters.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export class ChartQueryParameters {
2626
constructor(options) {
2727
/**
2828
* @member {string} ChartQueryParameters.prototype.queryMode
29-
* @description 海图查询模式类型,支持两种查询方式:海图属性查询("ChartAttributeQuery")和海图空间查询("ChartBoundsQuery")
29+
* @description 海图查询模式类型,支持两种查询方式:海图属性查询("ChartAttributeQuery")和海图空间查询("ChartBoundsQuery")。
3030
*/
3131
this.queryMode = null;
3232

src/common/iServer/ClipParameter.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import {ServerGeometry} from './ServerGeometry';
1212
* @param {Object} options - 可选参数。
1313
* @param {string} [options.clipDatasetName] - 裁剪的数据集名。
1414
* @param {string} [options.clipDatasourceName] - 裁剪的数据集所在数据源的名字。
15-
* @param {GeometryPolygon|L.Polygon|L.GeoJSON|ol.geom.Polygon|ol.format.GeoJSON|GeoJSONObject}} [options.clipRegion] - 用户指定的裁剪区域。
15+
* @param {GeometryPolygon|L.Polygon|L.GeoJSON|ol.geom.Polygon|ol.format.GeoJSON|GeoJSONObject} [options.clipRegion] - 用户指定的裁剪区域。
1616
* @param {boolean} [options.isClipInRegion=true] - 是否对裁剪区内的数据集进行裁剪。
1717
* @param {boolean} [options.isExactClip=true] - 是否使用精确裁剪。
1818
* @usage

src/common/iServer/CommonServiceBase.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ export class CommonServiceBase {
185185
/**
186186
*
187187
* @function CommonServiceBase.prototype.ajaxPolling
188-
* @description 请求失败后,如果剩余请求失败次数不为 0,重新获取 URL 发送请求
188+
* @description 请求失败后,如果剩余请求失败次数不为 0,重新获取 URL 发送请求
189189
*/
190190
ajaxPolling() {
191191
let me = this,
@@ -333,7 +333,7 @@ export class CommonServiceBase {
333333

334334

335335
/**
336-
* 服务器请求回调函数
336+
* 服务器请求回调函数
337337
* @callback RequestCallback
338338
* @category BaseTypes Util
339339
* @example

src/common/iServer/CreateDatasetParameters.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import {Util} from '../commontypes/Util';
1111
* @param {Object} options - 参数。
1212
* @param {string} options.datasourceName - 数据源名称,此为必选参数。
1313
* @param {string} options.datasetName - 数据集名称,此为必选参数。
14-
* @param {string} options.datasetType - 数据集类型。目前支持创建的出聚集类型有:点、线、面、文本、复合(CAD)和属性数据集。
14+
* @param {string} options.datasetType - 数据集类型。目前支持创建的数据集类型有:点、线、面、文本、复合(CAD)和属性数据集。
1515
* @usage
1616
*/
1717
export class CreateDatasetParameters {
@@ -35,7 +35,7 @@ export class CreateDatasetParameters {
3535

3636
/**
3737
* @member {string} CreateDatasetParameters.prototype.datasetType
38-
* @description 数据集类型。目前支持创建的出聚集类型有:点、线、面、文本、复合(CAD)和属性数据集。
38+
* @description 数据集类型。目前支持创建的数据集类型有:点、线、面、文本、复合(CAD)和属性数据集。
3939
*/
4040
this.datasetType = null;
4141

src/common/iServer/DataFlowService.js

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ import {SecurityManager} from '../security/SecurityManager';
99
* @class DataFlowService
1010
* @deprecatedclass SuperMap.DataFlowService
1111
* @category iServer DataFlow
12-
* @classdesc 数据流服务类
12+
* @classdesc 数据流服务类
1313
* @extends {CommonServiceBase}
14-
* @param {string} url - 数据流服务地址
14+
* @param {string} url - 数据流服务地址
1515
* @param {Object} options - 参数。
1616
* @param {function} options.style - 设置数据加载样式。
1717
* @param {function} [options.onEachFeature] - 设置每个数据加载popup等。
1818
* @param {GeoJSONObject} [options.geometry] - 指定几何范围,该范围内的要素才能被订阅。
19-
* @param {Object} [options.excludeField] - -排除字段。
19+
* @param {Object} [options.excludeField] - 排除字段。
2020
* @param {boolean} [options.crossOrigin] - 是否允许跨域请求。
2121
* @param {Object} [options.headers] - 请求头。
2222
* @usage
@@ -42,13 +42,13 @@ export class DataFlowService extends CommonServiceBase {
4242

4343
/**
4444
* @member {Object} DataFlowService.prototype.prjCoordSys
45-
* @description 动态投影参数
45+
* @description 动态投影参数
4646
*/
4747
this.prjCoordSys = null;
4848

4949
/**
5050
* @member {Object} DataFlowService.prototype.excludeField
51-
* @description 排除字段
51+
* @description 排除字段
5252
*/
5353
this.excludeField = null;
5454

@@ -59,7 +59,7 @@ export class DataFlowService extends CommonServiceBase {
5959

6060
/**
6161
* @function DataFlowService.prototype.initBroadcast
62-
* @description 初始化广播
62+
* @description 初始化广播
6363
* @returns {DataFlowService}
6464
*/
6565
initBroadcast() {
@@ -101,7 +101,7 @@ export class DataFlowService extends CommonServiceBase {
101101

102102
/**
103103
* @function DataFlowService.prototype.initSubscribe
104-
* @description 初始化订阅数据
104+
* @description 初始化订阅数据
105105
* @returns {DataFlowService} DataFlowService的实例对象。
106106
*/
107107
initSubscribe() {
@@ -129,8 +129,8 @@ export class DataFlowService extends CommonServiceBase {
129129

130130
/**
131131
* @function DataFlowService.prototype.setExcludeField
132-
* @description 设置排除字段
133-
* @param {Object} excludeField - 排除字段
132+
* @description 设置排除字段
133+
* @param {Object} excludeField - 排除字段
134134
* @returns {DataFlowService} DataFlowService的实例对象。
135135
*/
136136
setExcludeField(excludeField) {
@@ -141,7 +141,7 @@ export class DataFlowService extends CommonServiceBase {
141141

142142
/**
143143
* @function DataFlowService.prototype.setGeometry
144-
* @description 设置添加的几何要素数据
144+
* @description 设置添加的几何要素数据
145145
* @param {GeoJSONObject} geometry - 指定几何范围,该范围内的要素才能被订阅。
146146
* @returns {DataFlowService} DataFlowService的实例对象。
147147
*/
@@ -153,7 +153,7 @@ export class DataFlowService extends CommonServiceBase {
153153

154154
/**
155155
* @function DataFlowService.prototype.unSubscribe
156-
* @description 结束订阅数据
156+
* @description 结束订阅数据
157157
*/
158158
unSubscribe() {
159159
if (!this.subscribeWebSocket) {
@@ -165,7 +165,7 @@ export class DataFlowService extends CommonServiceBase {
165165

166166
/**
167167
* @function DataFlowService.prototype.unBroadcast
168-
* @description 结束加载广播
168+
* @description 结束加载广播
169169
*/
170170
unBroadcast() {
171171
if (!this.broadcastWebSocket) {

src/common/iServer/DatasourceConnectionInfo.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import {EngineType} from '../REST'; // eslint-disable-line no-unused-vars
99
* @deprecatedclass SuperMap.DatasourceConnectionInfo
1010
* @category iServer Data Datasource
1111
* @classdesc 数据源连接信息类。该类包括了进行数据源连接的所有信息,如所要连接的服务器名称、数据库名称、用户名以及密码等。
12-
* 当保存为工作空间时, 工作空间中的数据源的连接信息都将存储到工作空间文件中。对于不同类型的数据源,其连接信息有所区别。
12+
* 当保存为工作空间时,工作空间中的数据源的连接信息都将存储到工作空间文件中。对于不同类型的数据源,其连接信息有所区别。
1313
* 所以在使 用该类所包含的成员时,请注意该成员所适用的数据源类型。对于从数据源对象中返回的数据连接信息对象,只有 connect 方法可以被修改,
1414
* 其他内容是不可以被修改的。对于用户创建的数据源连接信息对象,其内容都可以修改。
1515
* @param {Object} options - 参数。

src/common/iServer/FacilityAnalyst3DParameters.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export class FacilityAnalyst3DParameters {
4444
/**
4545
* @member {boolean} [FacilityAnalyst3DParameters.prototype.isUncertainDirectionValid=false]
4646
* @description 指定不确定流向是否有效。指定为 true,表示不确定流向有效,遇到不确定流向时分析继续进行;
47-
* 指定为 false,表示不确定流向无效,遇到不确定流向将停止在该方向上继续查找
47+
* 指定为 false,表示不确定流向无效,遇到不确定流向将停止在该方向上继续查找
4848
*/
4949
this.isUncertainDirectionValid = false;
5050
Util.extend(this, options);

src/common/iServer/FieldStatisticsParameters.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ export class FieldStatisticsParameters extends FieldParameters {
2424
super(options);
2525
/**
2626
* @member {string} FieldStatisticsParameters.prototype.fieldName
27-
* @description 字段名
27+
* @description 字段名
2828
*/
2929
this.fieldName = null;
3030

3131
/**
3232
* @member {(string.<StatisticMode>|Array.<string.<StatisticMode>>)} FieldStatisticsParameters.prototype.statisticMode
33-
* @description 字段统计方法类型
33+
* @description 字段统计方法类型
3434
*/
3535
this.statisticMode = null;
3636

src/common/iServer/FieldsFilter.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,19 @@ import { Util } from '../commontypes/Util';
1111
* @category iServer Data Field
1212
* @classdesc 指定返回的用于描述 Feature 的字段。
1313
* @param {Object} options - 可选参数。
14-
* @param {Array.<string>} [options.include] 对返回的字段内容进行过滤,需保留的字段列表
15-
* @param {Array.<string>} [options.exclude] 对返回的字段内容进行过滤,需排除的字段列表
14+
* @param {Array.<string>} [options.include] 对返回的字段内容进行过滤,需保留的字段列表
15+
* @param {Array.<string>} [options.exclude] 对返回的字段内容进行过滤,需排除的字段列表
1616
* @usage
1717
*/
1818
export default class FieldsFilter {
1919
constructor(options) {
2020
/**
21-
* @description 对返回的字段内容进行过滤,需保留的字段列表
21+
* @description 对返回的字段内容进行过滤,需保留的字段列表
2222
* @member {Array.<string>} FieldsFilter.prototype.include
2323
*/
2424
this.include = undefined;
2525
/**
26-
* @description 对返回的字段内容进行过滤,需排除的字段列表
26+
* @description 对返回的字段内容进行过滤,需排除的字段列表
2727
* @member {Array.<string>} FieldsFilter.prototype.exclude
2828
*/
2929
this.exclude = undefined;
@@ -46,9 +46,9 @@ export default class FieldsFilter {
4646
/**
4747
* @function FieldsFilter.prototype.constructFromObject
4848
* @description 目标对象新增该类的可选参数。
49-
* @param {Object} data 要转换的数据.
50-
* @param {FieldsFilter} obj 返回的模型.
51-
* @return {FieldsFilter} 返回结果
49+
* @param {Object} data 要转换的数据
50+
* @param {FieldsFilter} obj 返回的模型
51+
* @return {FieldsFilter} 返回结果
5252
*/
5353
static constructFromObject(data, obj) {
5454
if (data) {

0 commit comments

Comments
 (0)