Skip to content

Commit 96a3504

Browse files
chenmeiyiSupermapchenmeiyiSupermap
committed
【API】规范、修正common/iServer下的API Doc
1 parent 0c4ad91 commit 96a3504

15 files changed

+504
-542
lines changed

‎build/jsdocs/template/typeLinkExt.js‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,12 @@ var typeLinks = {
66
"ol.extent": olapi + "ol.extent.html",
77
"ol.feature": olapi + "ol.feature.html",
88
"ol.geom.Polygon": olapi + "ol.geom.Polygon.html",
9+
"ol.geom.LineString": olapi + "ol.geom.LineString.html",
910
"ol.geom.Point": olapi + "ol.geom.Point.html",
1011
"ol.format.GeoJSON": olapi + "ol.format.GeoJSON.html",
1112
"L.Bounds": lfapi + "#bounds",
1213
"L.Polygon": lfapi + "#polygon",
14+
"L.Polyline": lfapi + "#polyline",
1315
"L.Point": lfapi + "#point",
1416
"L.LatLng": lfapi + "#latlng",
1517
"L.GeoJSON": lfapi + "#geojson"

‎dist/iclient-classic.js‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7184,11 +7184,11 @@ function _classCallCheck(instance, Constructor) { if (!(instance instanceof Cons
71847184
* @class SuperMap.VectorClipJobsParameter
71857185
* @category iServer ProcessingService VectorClip
71867186
* @classdesc 矢量裁剪分析任务参数类
7187-
* @param options - {Object} 必填参数。<br>
7188-
* datasetName -{string} 数据集名。 <br>
7189-
* datasetOverlay -{string} 裁剪对象数据集。 <br>
7190-
* mode -{{@link SuperMap.ClipAnalystMode}} 裁剪分析模式 。 <br>
7191-
* output -{SuperMap.OutputSetting} 输出参数设置 <br>
7187+
* @param {Object} options - 参数。<br>
7188+
* @param {string} options.datasetName - 数据集名。<br>
7189+
* @param {string} options.datasetOverlay - 裁剪对象数据集。<br>
7190+
* @param {SuperMap.ClipAnalystMode} options.mode - 裁剪分析模式。<br>
7191+
* @param {SuperMap.OutputSetting} options.output - 输出参数设置。<br>
71927192
*/
71937193
var VectorClipJobsParameter = exports.VectorClipJobsParameter = function () {
71947194
function VectorClipJobsParameter(options) {
@@ -7197,31 +7197,31 @@ var VectorClipJobsParameter = exports.VectorClipJobsParameter = function () {
71977197
options = options || {};
71987198

71997199
/**
7200-
* @member SuperMap.VectorClipJobsParameter.prototype.datasetName -{string}
7200+
* @member {string} SuperMap.VectorClipJobsParameter.prototype.datasetName
72017201
* @description 数据集名。
72027202
*/
72037203
this.datasetName = "";
72047204

72057205
/**
7206-
* @member SuperMap.VectorClipJobsParameter.prototype.datasetOverlay -{string}
7206+
* @member {string} SuperMap.VectorClipJobsParameter.prototype.datasetOverlay
72077207
* @description 裁剪对象数据集。
72087208
*/
72097209
this.datasetVectorClip = "";
72107210

72117211
/**
7212-
* @member SuperMap.VectorClipJobsParameter.prototype.geometryClip -{string}
7212+
* @member {string} SuperMap.VectorClipJobsParameter.prototype.geometryClip
72137213
* @description 裁剪几何对象。
72147214
*/
72157215
this.geometryClip = "";
72167216

72177217
/**
7218-
* @member SuperMap.VectorClipJobsParameter.prototype.mode -{SuperMap.ClipAnalystMode}
7218+
* @member {SuperMap.ClipAnalystMode} SuperMap.VectorClipJobsParameter.prototype.mode
72197219
* @description 裁剪分析模式 。
72207220
*/
72217221
this.mode = _REST.ClipAnalystMode.CLIP;
72227222

72237223
/**
7224-
* @member SuperMap.VectorClipJobsParameter.prototype.output -{SuperMap.OutputSetting}
7224+
* @member {SuperMap.OutputSetting} SuperMap.VectorClipJobsParameter.prototype.output
72257225
* @description 输出参数设置类
72267226
*/
72277227
this.output = null;
@@ -7252,8 +7252,8 @@ var VectorClipJobsParameter = exports.VectorClipJobsParameter = function () {
72527252

72537253
/**
72547254
* @function SuperMap.VectorClipJobsParameter.toObject
7255-
* @param vectorClipJobsParameter -{Object} 区域汇总分析服务参数
7256-
* @param tempObj - {Object} 目标对象。
7255+
* @param {Object} vectorClipJobsParameter - 区域汇总分析服务参数
7256+
* @param {Object} tempObj - 目标对象。
72577257
* @description 矢量裁剪分析任务对象
72587258
*/
72597259

@@ -7314,9 +7314,9 @@ function _inherits(subClass, superClass) { if (typeof superClass !== "function"
73147314
* @class SuperMap.VectorClipJobsService
73157315
* @category iServer ProcessingService VectorClip
73167316
* @classdesc 矢量裁剪分析服务类
7317-
* @extends SuperMap.ProcessingServiceBase
7318-
* @param url -{string} 矢量裁剪分析服务地址。
7319-
* @param options - {Object} 交互服务时所需可选参数。
7317+
* @extends {SuperMap.ProcessingServiceBase}
7318+
* @param {string} url -矢量裁剪分析服务地址。
7319+
* @param {Object} options - 交互服务时所需可选参数。
73207320
*/
73217321
var VectorClipJobsService = exports.VectorClipJobsService = function (_ProcessingServiceBas) {
73227322
_inherits(VectorClipJobsService, _ProcessingServiceBas);
@@ -7356,7 +7356,7 @@ var VectorClipJobsService = exports.VectorClipJobsService = function (_Processin
73567356
/**
73577357
* @function SuperMap.KernelDensityJobsService.protitype.getVectorClipJob
73587358
* @description 获取指定id的矢量裁剪分析服务
7359-
* @param id -{string} 指定要获取数据的id
7359+
* @param {string} id - 指定要获取数据的id
73607360
*/
73617361

73627362
}, {
@@ -7368,8 +7368,8 @@ var VectorClipJobsService = exports.VectorClipJobsService = function (_Processin
73687368
/**
73697369
* @function SuperMap.VectorClipJobsService.protitype.addVectorClipJob
73707370
* @description 新建矢量裁剪分析服务
7371-
* @param params - {SuperMap.VectorClipJobsParameter} 创建一个空间分析的请求参数。
7372-
* @param seconds - {number}开始创建后，获取创建成功结果的时间间隔。
7371+
* @param {SuperMap.VectorClipJobsParameter} params - 创建一个空间分析的请求参数。
7372+
* @param {number} seconds - 开始创建后，获取创建成功结果的时间间隔。
73737373
*/
73747374

73757375
}, {

0 commit comments

Comments
 (0)