Skip to content

Commit dadd836

Browse files
luoxiao-supermapluoxiao-supermap
committed
[fix]排查api review by xiongjj
1 parent a66b9ac commit dadd836

File tree

8 files changed

+109
-31
lines changed

8 files changed

+109
-31
lines changed

‎build/jsdocs/leaflet/docs.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@
2626
"src/common/overlay/levelRenderer",
2727
"src/common/lang/locales",
2828
"src/common/iPortal/iPortalQueryResult",
29-
"src/common/iManager/iManagerServiceBase",
3029
"src/common/online/OnlineServiceBase",
3130
"src/common/online/OnlineData",
31+
"src/common/iManager/iManagerServiceBase",
3232
"src/common/iServer/GetFeaturesServiceBase",
3333
"src/common/iServer/NetworkAnalystServiceBase",
3434
"src/common/iServer/SpatialAnalystBase",
@@ -61,6 +61,7 @@
6161
"src/common/components/templates/PopContainer",
6262
"src/common/components/templates/Select",
6363
"src/common/security/KeyServiceParameter",
64+
"src/common/components/templates/TemplateBase",
6465

6566
"src/leaflet/components/clientcomputation/ClientComputationViewModel",
6667
"src/leaflet/components/dataflow/DataFlowViewModel",
@@ -73,7 +74,6 @@
7374
"src/leaflet/components/commonmodels/GeoJsonLayersModel" ,
7475
"src/leaflet/core/CommontypesConversion"
7576
]
76-
7777
},
7878
"plugins": ["plugins/markdown","../plugins/usage"],
7979
"markdown": {

‎build/jsdocs/mapboxgl/docs.json‎

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,48 @@
2323
],
2424
"exclude": [
2525
"src/common/overlay/levelRenderer",
26-
"src/common/lang/locales"
26+
"src/common/lang/locales",
27+
"src/common/iPortal/iPortalQueryResult",
28+
"src/common/online/OnlineServiceBase",
29+
"src/common/online/OnlineData",
30+
"src/common/online/Online",
31+
"src/common/iManager/iManagerServiceBase",
32+
"src/common/iServer/GetFeaturesServiceBase",
33+
"src/common/iServer/NetworkAnalystServiceBase",
34+
"src/common/iServer/SpatialAnalystBase",
35+
"src/common/iServer/ProcessingServiceBase",
36+
"src/common/iServer/PointWithMeasure",
37+
"src/common/iServer/ServerTheme",
38+
"src/common/overlay/RankSymbol",
39+
"src/common/overlay/ThemeVector",
40+
"src/common/overlay/Graph",
41+
"src/common/overlay/feature/ShapeFactory",
42+
"src/common/overlay/feature/ShapeParameters",
43+
"src/common/overlay/feature/Rectangle",
44+
"src/common/overlay/feature/Circle",
45+
"src/common/overlay/feature/Image",
46+
"src/common/overlay/feature/Label",
47+
"src/common/overlay/feature/Line",
48+
"src/common/overlay/feature/Point",
49+
"src/common/overlay/feature/Polygon",
50+
"src/common/overlay/feature/Sector",
51+
"src/common/overlay/feature/Theme",
52+
"src/common/commontypes/Credential",
53+
"src/common/components/chart/ChartViewModel",
54+
"src/common/components/util/Util",
55+
"src/common/components/templates/AttributesPopContainer",
56+
"src/common/components/templates/CityTabsPage",
57+
"src/common/components/templates/CommonContainer",
58+
"src/common/components/templates/DropDownBox",
59+
"src/common/components/templates/NavTabsPage",
60+
"src/common/components/templates/IndexTabsPageContainer",
61+
"src/common/components/templates/PaginationContainer",
62+
"src/common/components/templates/PopContainer",
63+
"src/common/components/templates/Select",
64+
"src/common/security/KeyServiceParameter",
65+
"src/common/components/templates/TemplateBase",
66+
67+
"src/mapboxgl/core/Util"
2768
]
2869
},
2970
"plugins": ["plugins/markdown","../plugins/usage"],

‎build/jsdocs/openlayers/docs.json‎

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,45 @@
2323
],
2424
"exclude": [
2525
"src/common/overlay/levelRenderer",
26-
"src/common/lang/locales"
26+
"src/common/lang/locales",
27+
"src/common/iPortal/iPortalQueryResult",
28+
"src/common/online/OnlineServiceBase",
29+
"src/common/online/OnlineData",
30+
"src/common/iManager/iManagerServiceBase",
31+
"src/common/iServer/GetFeaturesServiceBase",
32+
"src/common/iServer/NetworkAnalystServiceBase",
33+
"src/common/iServer/SpatialAnalystBase",
34+
"src/common/iServer/ProcessingServiceBase",
35+
"src/common/iServer/PointWithMeasure",
36+
"src/common/iServer/ServerTheme",
37+
"src/common/overlay/RankSymbol",
38+
"src/common/overlay/Graph",
39+
"src/common/overlay/feature/ShapeFactory",
40+
"src/common/overlay/feature/ShapeParameters",
41+
"src/common/overlay/feature/Rectangle",
42+
"src/common/overlay/feature/Circle",
43+
"src/common/overlay/feature/Image",
44+
"src/common/overlay/feature/Label",
45+
"src/common/overlay/feature/Line",
46+
"src/common/overlay/feature/Point",
47+
"src/common/overlay/feature/Polygon",
48+
"src/common/overlay/feature/Sector",
49+
"src/common/commontypes/Credential",
50+
"src/common/components/chart/ChartViewModel",
51+
"src/common/components/util/Util",
52+
"src/common/components/templates/AttributesPopContainer",
53+
"src/common/components/templates/CityTabsPage",
54+
"src/common/components/templates/CommonContainer",
55+
"src/common/components/templates/DropDownBox",
56+
"src/common/components/templates/NavTabsPage",
57+
"src/common/components/templates/IndexTabsPageContainer",
58+
"src/common/components/templates/PaginationContainer",
59+
"src/common/components/templates/PopContainer",
60+
"src/common/components/templates/Select",
61+
"src/common/security/KeyServiceParameter",
62+
"src/common/components/templates/TemplateBase",
63+
64+
"src/openlayers/core/Util"
2765
]
2866
},
2967
"plugins": ["plugins/markdown","../plugins/usage"],

‎package.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@
3838
"citest": "npm install ./src/common && karma start ./test/karma.conf.js --single-run --no-auto-watch",
3939
"exampletest": "nightwatch --config ./examples-test/nightwatch.json",
4040
"build-docs": "npm run build-docs-leaflet&&npm run build-docs-openlayers&&npm run build-docs-mapboxgl&&npm run build-docs-classic",
41-
"build-docs-leaflet": "jsdoc -c ./build/jsdocs/leaflet/docs.json -R ./build/jsdocs/leaflet/index.md",
42-
"build-docs-openlayers": "jsdoc -c ./build/jsdocs/openlayers/docs.json -R ./build/jsdocs/openlayers/index.md",
43-
"build-docs-mapboxgl": "jsdoc -c ./build/jsdocs/mapboxgl/docs.json -R ./build/jsdocs/mapboxgl/index.md",
44-
"build-docs-classic": "jsdoc -c ./build/jsdocs/classic/docs.json -R ./build/jsdocs/classic/index.md",
41+
"build-docs-leaflet": "rimraf ./docs/leaflet && jsdoc -c ./build/jsdocs/leaflet/docs.json -R ./build/jsdocs/leaflet/index.md",
42+
"build-docs-openlayers": "rimraf ./docs/openlayers && jsdoc -c ./build/jsdocs/openlayers/docs.json -R ./build/jsdocs/openlayers/index.md",
43+
"build-docs-mapboxgl": "rimraf ./docs/mapboxgl && jsdoc -c ./build/jsdocs/mapboxgl/docs.json -R ./build/jsdocs/mapboxgl/index.md",
44+
"build-docs-classic": "rimraf ./docs/classic && jsdoc -c ./build/jsdocs/classic/docs.json -R ./build/jsdocs/classic/index.md",
4545
"pre-publish": "node ./build/publish.js --leaflet && node ./build/publish.js --openlayers && node ./build/publish.js --mapboxgl && node ./build/publish.js --classic",
4646
"publish": "npm run pre-publish && cd ./src/common && npm publish && cd ../leaflet && npm publish && cd ../openlayers && npm publish && cd ../mapboxgl && npm publish && cd ../classic && npm publish"
4747
},

‎src/mapboxgl/services/AddressMatchService.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export class AddressMatchService extends ServiceBase {
3232
/**
3333
* @function AddressMatchService.prototype.code
3434
* @description 获取正向地址匹配结果。
35-
* @param {Object} params - 正向匹配参数。
35+
* @param {GeoCodingParameter} params - 正向匹配参数。
3636
* @param {RequestCallback} callback - 回调函数。
3737
*/
3838
code(params, callback) {
@@ -55,7 +55,7 @@ export class AddressMatchService extends ServiceBase {
5555
/**
5656
* @function AddressMatchService.prototype.decode
5757
* @description 获取反向地址匹配结果。
58-
* @param {Object} params -反向匹配参数。
58+
* @param {GeoDecodingParameter} params -反向匹配参数。
5959
* @param {RequestCallback} callback - 回调函数。
6060
*/
6161
decode(params, callback) {

‎src/mapboxgl/services/SpatialAnalystService.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ export class SpatialAnalystService extends ServiceBase {
172172
/**
173173
* @function SpatialAnalystService.prototype.interpolationAnalysis
174174
* @description 插值分析。
175-
* @param {InterpolationRBFAnalystParameters} params - 样条插值（径向基函数插值法）分析参数类。
175+
* @param {InterpolationDensityAnalystParameters|InterpolationIDWAnalystParameters|InterpolationRBFAnalystParameters|InterpolationKrigingAnalystParameters} params - 样条插值（径向基函数插值法）分析参数类。
176176
* @param {RequestCallback} callback - 回调函数。
177177
* @param {DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回结果类型。
178178
*/
@@ -347,7 +347,7 @@ export class SpatialAnalystService extends ServiceBase {
347347
/**
348348
* @function SpatialAnalystService.prototype.thiessenAnalysis
349349
* @description 泰森多边形分析。
350-
* @param {DatasetThiessenAnalystParameters} params - 数据集泰森多边形分析参数类。
350+
* @param {DatasetThiessenAnalystParameters|GeometryThiessenAnalystParameters} params - 数据集泰森多边形分析参数类。
351351
* @param {RequestCallback} callback - 回调函数。
352352
* @param {DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回结果类型。
353353
*/

‎src/openlayers/services/ProcessingService.js‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -499,7 +499,7 @@ export class ProcessingService extends ServiceBase {
499499
}
500500

501501
/**
502-
* @function processingService.prototype.getOverlayGeoJobs
502+
* @function ProcessingService.prototype.getOverlayGeoJobs
503503
* @description 获取叠加分析的列表。
504504
* @param {RequestCallback} callback 回调函数。
505505
* @param {DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回结果类型。
@@ -524,7 +524,7 @@ export class ProcessingService extends ServiceBase {
524524
}
525525

526526
/**
527-
* @function processingService.prototype.getOverlayGeoJob
527+
* @function ProcessingService.prototype.getOverlayGeoJob
528528
* @description 获取叠加分析。
529529
* @param {string} id - 空间分析的 ID。
530530
* @param {RequestCallback} callback 回调函数。
@@ -550,7 +550,7 @@ export class ProcessingService extends ServiceBase {
550550
}
551551

552552
/**
553-
* @function processingService.prototype.addOverlayGeoJob
553+
* @function ProcessingService.prototype.addOverlayGeoJob
554554
* @description 叠加分析。
555555
* @param {OverlayGeoJobParameter} params - 叠加分析任务参数类。
556556
* @param {RequestCallback} callback 回调函数。
@@ -581,7 +581,7 @@ export class ProcessingService extends ServiceBase {
581581
}
582582

583583
/**
584-
* @function processingService.prototype.getoverlayGeoJobState
584+
* @function ProcessingService.prototype.getoverlayGeoJobState
585585
* @description 获取叠加分析的状态。
586586
* @param {string} id - 叠加分析的 ID。
587587
* @returns {Object} 叠加分析的状态
@@ -591,7 +591,7 @@ export class ProcessingService extends ServiceBase {
591591
}
592592

593593
/**
594-
* @function processingService.prototype.getBuffersJobs
594+
* @function ProcessingService.prototype.getBuffersJobs
595595
* @description 获取缓冲区分析的列表。
596596
* @param {RequestCallback} callback 回调函数。
597597
* @param {DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回结果类型。
@@ -616,7 +616,7 @@ export class ProcessingService extends ServiceBase {
616616
}
617617

618618
/**
619-
* @function processingService.prototype.getBuffersJob
619+
* @function ProcessingService.prototype.getBuffersJob
620620
* @description 获取缓冲区分析。
621621
* @param {string} id - 空间分析的 ID。
622622
* @param {RequestCallback} callback 回调函数。
@@ -642,7 +642,7 @@ export class ProcessingService extends ServiceBase {
642642
}
643643

644644
/**
645-
* @function processingService.prototype.addBuffersJob
645+
* @function ProcessingService.prototype.addBuffersJob
646646
* @description 缓冲区分析。
647647
* @param {BuffersAnalystJobsParameter} params - 缓冲区分析任务参数类。
648648
* @param {RequestCallback} callback 回调函数。
@@ -673,7 +673,7 @@ export class ProcessingService extends ServiceBase {
673673
}
674674

675675
/**
676-
* @function processingService.prototype.getBuffersJobState
676+
* @function ProcessingService.prototype.getBuffersJobState
677677
* @description 获取缓冲区分析的状态。
678678
* @param {string} id - 缓冲区分析的 ID。
679679
* @returns {Object} 缓冲区分析的状态。
@@ -683,7 +683,7 @@ export class ProcessingService extends ServiceBase {
683683
}
684684

685685
/**
686-
* @function processingService.prototype.getTopologyValidatorJobs
686+
* @function ProcessingService.prototype.getTopologyValidatorJobs
687687
* @description 获取拓扑检查分析的列表。
688688
* @param {RequestCallback} callback 回调函数。
689689
* @param {DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回结果类型。
@@ -708,7 +708,7 @@ export class ProcessingService extends ServiceBase {
708708
}
709709

710710
/**
711-
* @function processingService.prototype.getTopologyValidatorJob
711+
* @function ProcessingService.prototype.getTopologyValidatorJob
712712
* @description 获取拓扑检查分析。
713713
* @param {string} id - 空间分析的 ID。
714714
* @param {RequestCallback} callback - 回调函数。
@@ -734,7 +734,7 @@ export class ProcessingService extends ServiceBase {
734734
}
735735

736736
/**
737-
* @function processingService.prototype.addTopologyValidatorJob
737+
* @function ProcessingService.prototype.addTopologyValidatorJob
738738
* @description 拓扑检查分析。
739739
* @param {TopologyValidatorJobsParameter} params - 拓扑检查分析任务参数类。
740740
* @param {RequestCallback} callback - 回调函数。
@@ -765,7 +765,7 @@ export class ProcessingService extends ServiceBase {
765765
}
766766

767767
/**
768-
* @function processingService.prototype.getTopologyValidatorJobState
768+
* @function ProcessingService.prototype.getTopologyValidatorJobState
769769
* @description 获取拓扑检查分析的状态。
770770
* @param {string} id - 拓扑检查分析的 ID。
771771
* @returns {Object} 拓扑检查分析的状态
@@ -775,7 +775,7 @@ export class ProcessingService extends ServiceBase {
775775
}
776776

777777
/**
778-
* @function processingService.prototype.getSummaryAttributesJobs
778+
* @function ProcessingService.prototype.getSummaryAttributesJobs
779779
* @description 获取拓扑检查属性汇总分析的列表。
780780
* @param {RequestCallback} callback - 回调函数。
781781
* @param {DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回结果类型。
@@ -800,7 +800,7 @@ export class ProcessingService extends ServiceBase {
800800
}
801801

802802
/**
803-
* @function processingService.prototype.getSummaryAttributesJob
803+
* @function ProcessingService.prototype.getSummaryAttributesJob
804804
* @description 获取属性汇总分析。
805805
* @param {string} id - 空间分析的 ID。
806806
* @param {RequestCallback} callback - 回调函数。
@@ -826,7 +826,7 @@ export class ProcessingService extends ServiceBase {
826826
}
827827

828828
/**
829-
* @function processingService.prototype.addSummaryAttributesJob
829+
* @function ProcessingService.prototype.addSummaryAttributesJob
830830
* @description 属性汇总分析。
831831
* @param {SummaryAttributesJobsParameter} params - 属性汇总分析任务参数类。
832832
* @param {RequestCallback} callback - 回调函数。
@@ -857,7 +857,7 @@ export class ProcessingService extends ServiceBase {
857857
}
858858

859859
/**
860-
* @function processingService.prototype.getSummaryAttributesJobState
860+
* @function ProcessingService.prototype.getSummaryAttributesJobState
861861
* @description 获取属性汇总分析的状态。
862862
* @param {string} id - 属性汇总分析的 ID。
863863
* @returns {Object} 属性汇总分析的状态。

‎src/openlayers/services/SpatialAnalystService.js‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ export class SpatialAnalystService extends ServiceBase {
174174
/**
175175
* @function SpatialAnalystService.prototype.interpolationAnalysis
176176
* @description 插值分析。
177-
* @param {InterpolationRBFAnalystParameters} params - 样条插值分析参数类。
177+
* @param {InterpolationRBFAnalystParameters|InterpolationDensityAnalystParameters|InterpolationIDWAnalystParameters|InterpolationKrigingAnalystParameters} params - 样条插值分析参数类。
178178
* @param {RequestCallback} callback 回调函数。
179179
* @param {DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回的结果类型。
180180
*/
@@ -195,7 +195,6 @@ export class SpatialAnalystService extends ServiceBase {
195195
});
196196
interpolationAnalystService.processAsync(me._processParams(params));
197197
}
198-
199198
/**
200199
* @function SpatialAnalystService.prototype.mathExpressionAnalysis
201200
* @description 栅格代数运算。
@@ -349,7 +348,7 @@ export class SpatialAnalystService extends ServiceBase {
349348
/**
350349
* @function SpatialAnalystService.prototype.thiessenAnalysis
351350
* @description 泰森多边形分析。
352-
* @param {DatasetThiessenAnalystParameters} params - 数据集泰森多边形分析参数类。
351+
* @param {DatasetThiessenAnalystParameters|GeometryThiessenAnalystParameters} params - 数据集泰森多边形分析参数类。
353352
* @param {RequestCallback} callback 回调函数。
354353
* @param {DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回的结果类型。
355354
*/

0 commit comments

Comments
 (0)