【fix】doc

SuperMap · Apr 29, 2024 · 5f3045c · 5f3045c
1 parent 999c920
commit 5f3045c
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 15 deletions.
diff --git a/build/jsdocs/mapboxgl/docs.json b/build/jsdocs/mapboxgl/docs.json
@@ -64,7 +64,8 @@
             "src/common/components/templates/Select",
             "src/common/security/KeyServiceParameter",
             "src/common/components/templates/TemplateBase",
-            "src/mapboxgl/core/Util"
+            "src/mapboxgl/core/Util",
+            "src/mapboxgl/overlay/L7/l7-render"
         ]
     },
     "plugins": ["plugins/markdown","../plugins/usage", "../plugins/moduleCategories"],

diff --git a/build/jsdocs/maplibregl/docs.json b/build/jsdocs/maplibregl/docs.json
@@ -62,7 +62,8 @@
       "src/common/components/templates/Select",
       "src/common/security/KeyServiceParameter",
       "src/common/components/templates/TemplateBase",
-      "src/mapboxgl/core/Util"
+      "src/mapboxgl/core/Util",
+      "src/mapboxgl/overlay/L7/l7-render"
     ]
   },
   "plugins": ["plugins/markdown", "../plugins/usage", "../plugins/moduleCategories"],

diff --git a/src/common/iServer/VideoFeature.js b/src/common/iServer/VideoFeature.js
@@ -25,20 +25,20 @@ export class VideoFeature {
     this.id;
     /**
      * @member {string} VideoFeature.prototype.name
-     * @description
+     * @description 视频名称
      */
     this.name = null;
 
     /**
      * @member {(L.Bounds|L.LatLngBounds|ol.extent|mapboxgl.LngLatBounds|GeoJSONObject|SuperMap.Bounds)} VideoFeature.prototype.geometry
-     * @description
+     * @description 视频参数对应的视频视角空间范围，只支持矩形
      *
      */
     this.geometry = null;
 
     /**
      * @member {string} VideoFeature.prototype.address
-     * @description
+     * @description 视频流地址
      */
     this.address = null;
 
@@ -58,7 +58,7 @@ export class VideoFeature {
 
   /**
    * @function VideoFeature.prototype.destroy
-   * @description
+   * @description 销毁此对象。
    */
   destroy() {
     if (this.geometry && this.geometry.destroy) {
@@ -73,7 +73,8 @@ export class VideoFeature {
   }
   /**
    * @function VideoFeature.prototype.toGeoJSONFeature
-   * @description
+   * @description 转换为GeoJSON Feature Object
+   * @return {Object}
    */
   toGeoJSONFeature(geometryFunction) {
     return {
@@ -87,7 +88,8 @@ export class VideoFeature {
   }
   /**
    * @function VideoFeature.prototype.toServerFeature
-   * @description
+   * @description 转换为iServer Feature Object
+   * @return {Object}
    */
   toServerFeature({ geometryFunction }) {
     const feature = {

diff --git a/src/common/wasm/util.js b/src/common/wasm/util.js
@@ -34,11 +34,6 @@ export function geojsonCoords2UGDoubleArray(coords) {
   return pDoubleArray
 }
 
-/**
- * 
- * @param {*} pDoubleArray 
- * @returns 
- */
 export function getJSArrayFromUGDoubleArray(pDoubleArray) {
   // get length of doublearray
   var length = window.Module._UGCWasm_Helper_GetDoubleArrayLength(pDoubleArray);
@@ -63,7 +58,8 @@ export function getJSArrayFromUGDoubleArray(pDoubleArray) {
 }
 
 /**
- * Convert UGC geometry pointer to GeoJSON object.
+ * @private
+ * @description Convert UGC geometry pointer to GeoJSON object.
  * @name ugGeometry2Geojson
  * @kind function
  * @param {number} pUGGeo - The UGC geometry pointer.
@@ -174,7 +170,8 @@ export function ugGeometry2Geojson(pUGGeo) {
 }
 
 /**
- * 转换 GeoJSON 对象到 GEOS geometry pointer。
+ * @private
+ * @description 转换 GeoJSON 对象到 GEOS geometry pointer。
  * @name geojsonToGeosGeom
  * @param {GeoJSON} geojson - The GeoJSON object.
  * @returns {number} A pointer to GEOS geometry