Skip to content

Commit 5f3045c

Browse files
committed
【fix】doc
1 parent 999c920 commit 5f3045c

4 files changed

Lines changed: 16 additions & 15 deletions

File tree

build/jsdocs/mapboxgl/docs.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,8 @@
6464
"src/common/components/templates/Select",
6565
"src/common/security/KeyServiceParameter",
6666
"src/common/components/templates/TemplateBase",
67-
"src/mapboxgl/core/Util"
67+
"src/mapboxgl/core/Util",
68+
"src/mapboxgl/overlay/L7/l7-render"
6869
]
6970
},
7071
"plugins": ["plugins/markdown","../plugins/usage", "../plugins/moduleCategories"],

build/jsdocs/maplibregl/docs.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,8 @@
6262
"src/common/components/templates/Select",
6363
"src/common/security/KeyServiceParameter",
6464
"src/common/components/templates/TemplateBase",
65-
"src/mapboxgl/core/Util"
65+
"src/mapboxgl/core/Util",
66+
"src/mapboxgl/overlay/L7/l7-render"
6667
]
6768
},
6869
"plugins": ["plugins/markdown", "../plugins/usage", "../plugins/moduleCategories"],

src/common/iServer/VideoFeature.js

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,20 +25,20 @@ export class VideoFeature {
2525
this.id;
2626
/**
2727
* @member {string} VideoFeature.prototype.name
28-
* @description
28+
* @description 视频名称
2929
*/
3030
this.name = null;
3131

3232
/**
3333
* @member {(L.Bounds|L.LatLngBounds|ol.extent|mapboxgl.LngLatBounds|GeoJSONObject|SuperMap.Bounds)} VideoFeature.prototype.geometry
34-
* @description
34+
* @description 视频参数对应的视频视角空间范围,只支持矩形
3535
*
3636
*/
3737
this.geometry = null;
3838

3939
/**
4040
* @member {string} VideoFeature.prototype.address
41-
* @description
41+
* @description 视频流地址
4242
*/
4343
this.address = null;
4444

@@ -58,7 +58,7 @@ export class VideoFeature {
5858

5959
/**
6060
* @function VideoFeature.prototype.destroy
61-
* @description
61+
* @description 销毁此对象。
6262
*/
6363
destroy() {
6464
if (this.geometry && this.geometry.destroy) {
@@ -73,7 +73,8 @@ export class VideoFeature {
7373
}
7474
/**
7575
* @function VideoFeature.prototype.toGeoJSONFeature
76-
* @description
76+
* @description 转换为GeoJSON Feature Object
77+
* @return {Object}
7778
*/
7879
toGeoJSONFeature(geometryFunction) {
7980
return {
@@ -87,7 +88,8 @@ export class VideoFeature {
8788
}
8889
/**
8990
* @function VideoFeature.prototype.toServerFeature
90-
* @description
91+
* @description 转换为iServer Feature Object
92+
* @return {Object}
9193
*/
9294
toServerFeature({ geometryFunction }) {
9395
const feature = {

src/common/wasm/util.js

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,6 @@ export function geojsonCoords2UGDoubleArray(coords) {
3434
return pDoubleArray
3535
}
3636

37-
/**
38-
*
39-
* @param {*} pDoubleArray
40-
* @returns
41-
*/
4237
export function getJSArrayFromUGDoubleArray(pDoubleArray) {
4338
// get length of doublearray
4439
var length = window.Module._UGCWasm_Helper_GetDoubleArrayLength(pDoubleArray);
@@ -63,7 +58,8 @@ export function getJSArrayFromUGDoubleArray(pDoubleArray) {
6358
}
6459

6560
/**
66-
* Convert UGC geometry pointer to GeoJSON object.
61+
* @private
62+
* @description Convert UGC geometry pointer to GeoJSON object.
6763
* @name ugGeometry2Geojson
6864
* @kind function
6965
* @param {number} pUGGeo - The UGC geometry pointer.
@@ -174,7 +170,8 @@ export function ugGeometry2Geojson(pUGGeo) {
174170
}
175171

176172
/**
177-
* 转换 GeoJSON 对象到 GEOS geometry pointer。
173+
* @private
174+
* @description 转换 GeoJSON 对象到 GEOS geometry pointer。
178175
* @name geojsonToGeosGeom
179176
* @param {GeoJSON} geojson - The GeoJSON object.
180177
* @returns {number} A pointer to GEOS geometry

0 commit comments

Comments
 (0)