Skip to content

Commit 4b2ef3d

Browse files
【API】 common下jsdoc @description ::style 优化 review by songyumeng
1 parent 743a99b commit 4b2ef3d

Some content is hidden

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

64 files changed

+547
-411
lines changed

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
# Package Files #
22
/node_modules
33
/.idea
4+
/.vscode
45
/test/testcoverage
56
/.history
67
/docs
7-
/examples-test/reports
8+
/examples-test/reports
9+
/web/
10+
/package-lock.json

build/jsdocs/classic/docs.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
"src/classic","src/common/thirdparty"
2222
],
2323
"exclude": [
24-
"src/common/overlay/feature","src/common/overlay/levelRenderer","src/classic/libs","src/classic/theme","src/classic/resource"
24+
"src/classic/libs","src/classic/theme","src/classic/resource"
2525
]
2626
},
2727
"plugins": ["plugins/markdown"],

build/jsdocs/leaflet/categories.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

build/jsdocs/leaflet/docs.json

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,8 @@
2121
"excludePattern": ".+\\\\src\\\\common\\\\iServer\\\\.*Service.js?$",
2222
"include": [
2323
"src/common","src/leaflet"
24-
],
25-
"exclude": [
26-
"src/common/overlay/feature","src/common/overlay/levelRenderer"
2724
]
25+
2826
},
2927
"plugins": ["plugins/markdown","../plugins/factoryFunction","../plugins/linkdoc"],
3028
"templates": {

build/jsdocs/mapboxgl/categories.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

build/jsdocs/mapboxgl/docs.json

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,6 @@
2020
"excludePattern": ".+\\\\src\\\\common\\\\iServer\\\\.*Service|Base.js?$",
2121
"include": [
2222
"src/common","src/mapboxgl"
23-
],
24-
"exclude": [
25-
"src/common/overlay/feature","src/common/overlay/levelRenderer"
2623
]
2724
},
2825
"plugins": ["plugins/markdown","../plugins/linkdoc"],

build/jsdocs/openlayers/categories.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

build/jsdocs/openlayers/docs.json

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,6 @@
2020
"excludePattern": ".+\\\\src\\\\common\\\\iServer\\\\.*Service.js?$",
2121
"include": [
2222
"src/common","src/openlayers"
23-
],
24-
"exclude": [
25-
"src/common/overlay/feature","src/common/overlay/levelRenderer"
2623
]
2724
},
2825
"plugins": ["plugins/markdown","../plugins/linkdoc"],

src/common/commontypes/geometry/LineString.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ export class LineString extends Curve {
251251
* @description 根据点的类型画出不同类型的曲线
252252
* 点的类型有三种, LTypeArc, LTypeCurve, NONE
253253
* @param {Array.<SuperMap.Geometry.Point>} points - 传入的待计算的初始点串。
254-
* @returns {Array<SuperMap.Geometry.Point>} 计算出相应的lineEPS控制点。
254+
* @returns {Array.<SuperMap.Geometry.Point>} 计算出相应的lineEPS控制点。
255255
* @example
256256
* var points = [];
257257
* points.push(new SuperMap.Geometry.Point(-50,30));

src/common/iServer/FindPathParameters.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import {TransportationAnalystParameter} from './TransportationAnalystParameter';
1616
* @param {Object} options - 参数。<br>
1717
* @param {boolean} options.isAnalyzeById - 是否通过节点 ID 指定路径分析的结点。<br>
1818
* @param {boolean} options.hasLeastEdgeCount - 是否按照弧段数最少的进行最佳路径分析。<br>
19-
* @param {Array<SuperMap.Geometry.Point|L.LatLng|L.Point|ol.geom.Point|number>} options.nodes - 最佳路径分析经过的结点或设施点数组,必设字段。该字段至少包含两个点。<br>
19+
* @param {Array.<SuperMap.Geometry.Point|L.LatLng|L.Point|ol.geom.Point|number>} options.nodes - 最佳路径分析经过的结点或设施点数组,必设字段。该字段至少包含两个点。<br>
2020
* @param {SuperMap.TransportationAnalystParameter} options.parameter - 交通网络分析通用参数。
2121
*/
2222
export class FindPathParameters {

0 commit comments

Comments
 (0)