【update】文档优化; review by luox

xiongjiaojiao · xiongjiaojiao · commit 1b1ac2f07cd4 · 2022-01-06T09:33:59.000+08:00
diff --git a/build/jsdocs/template/typeLinkExt.js b/build/jsdocs/template/typeLinkExt.js
@@ -106,7 +106,6 @@ var typeLinks = {
     "THREE.Vector3": threeApi + '#api/math/Vector3',
     "THREE.Scene": threeApi + '#api/scenes/Scene',
     "THREE.WebGLRenderer": threeApi + '#api/renderers/WebGLRenderer',
-    "THREE.CanvasRenderer": threeApi + '#examples/renderers/CanvasRenderer',
     "THREE.Material": threeApi + '#api/en/materials/Material',
     "THREE.Mesh": threeApi + '#api/objects/Mesh',
     "THREE.Shape": threeApi + '#api/extras/core/Shape'
diff --git a/src/common/commontypes/Geometry.js b/src/common/commontypes/Geometry.js
@@ -26,8 +26,7 @@ export class Geometry {
 
         /**
          * @member {Geometry} Geometry.prototype.parent
-         * @description This is set when a Geometry is added as component
-         * of another geometry
+         * @description 父类几何对象。
          */
         this.parent = null;
 
diff --git a/src/common/commontypes/Vector.js b/src/common/commontypes/Vector.js
@@ -175,7 +175,7 @@ export class Vector extends Feature {
 
     /**
      * @function FeatureVector.prototype.destroy
-     * @description nullify references to prevent circular references and memory leaks
+     * @description 释放资源，将引用资源的属性置空。
      */
     destroy() {
         if (this.layer) {
@@ -189,9 +189,8 @@ export class Vector extends Feature {
 
     /**
      * @function FeatureVector.prototype.clone
-     * @description Create a clone of this vector feature.  Does not set any non-standard
-     *     properties.
-     * @returns {FeatureVector} An exact clone of this vector feature.
+     * @description 复制矢量要素，并返回复制后的新对象。
+     * @returns {FeatureVector} 相同要素的新的矢量要素。
      */
     clone() {
         return new Vector(
diff --git a/src/common/commontypes/geometry/LineString.js b/src/common/commontypes/geometry/LineString.js
@@ -45,10 +45,7 @@ export class LineString extends Curve {
 
     /**
      * @function GeometryLineString.prototype.getSortedSegments
-     * @returns {array} An array of segment objects.  Segment objects have properties
-     *     x1, y1, x2, and y2.  The start point is represented by x1 and y1.
-     *     The end point is represented by x2 and y2.  Start and end are
-     *     ordered so that x1 < x2.
+     * @returns {array} 升序排列的点坐标对象数组。
      */
     getSortedSegments() {
         var numSeg = this.components.length - 1;
diff --git a/src/common/control/TimeFlowControl.js b/src/common/control/TimeFlowControl.js
@@ -143,7 +143,7 @@ export class TimeFlowControl extends TimeControlBase {
 
     /**
      * @function TimeFlowControl.prototype.update
-     * @override
+     * @description 更新控件。
      */
     update() {
         var me = this;
diff --git a/src/common/iServer/InterpolationKrigingAnalystParameters.js b/src/common/iServer/InterpolationKrigingAnalystParameters.js
@@ -183,7 +183,7 @@ export class InterpolationKrigingAnalystParameters extends InterpolationAnalystP
         this.maxPointCountForInterpolation = 200;
 
         /**
-         * @member {number} [InterpolationKrigingAnalystParameters.prototype.maxPointCountForInterpolation=50]
+         * @member {number} [InterpolationKrigingAnalystParameters.prototype.maxPointCountInNode=50]
          * @description 【块查找】方式下，设置单个块内最多参与运算点数。
          * 仅用于普通克吕金插值，简单克吕金和泛克吕金不支持块查找。
          */
diff --git a/src/common/iServer/OverlayGeoJobParameter.js b/src/common/iServer/OverlayGeoJobParameter.js
@@ -73,7 +73,7 @@ export class OverlayGeoJobParameter {
     }
 
     /**
-     * @function OverlayGeoJobParameter.destroy
+     * @function OverlayGeoJobParameter.prototype.destroy
      * @description 释放资源，将资源的属性置空。
      */
     destroy() {
diff --git a/src/common/iServer/ServerTheme.js b/src/common/iServer/ServerTheme.js
@@ -46,6 +46,7 @@ export class ServerTheme extends UGCSubLayer {
 
     /**
      * @function ServerTheme.prototype.destroy
+     * @description 释放资源，将引用资源的属性置空。
      * @override
      */
     destroy() {
diff --git a/src/common/iServer/SummaryAttributesJobsParameter.js b/src/common/iServer/SummaryAttributesJobsParameter.js
@@ -61,7 +61,7 @@ export class SummaryAttributesJobsParameter {
     }
 
     /**
-     * @function SummaryAttributesJobsParameter.destroy
+     * @function SummaryAttributesJobsParameter.prototype.destroy
      * @description 释放资源，将资源的属性置空。
      */
     destroy() {
diff --git a/src/common/iServer/SummaryMeshJobParameter.js b/src/common/iServer/SummaryMeshJobParameter.js
@@ -97,7 +97,7 @@ export class SummaryMeshJobParameter {
 
 
     /**
-     * @function SummaryMeshJobParameter.destroy
+     * @function SummaryMeshJobParameter.prototype.destroy
      * @description 释放资源，将资源的属性置空。
      */
     destroy() {
diff --git a/src/common/iServer/UpdateDatasetParameters.js b/src/common/iServer/UpdateDatasetParameters.js
@@ -40,7 +40,7 @@ export class UpdateDatasetParameters {
 
         /**
          * @member {boolean} UpdateDatasetParameters.prototype.isFileCache
-         * @description 是否使用文件形式的缓存。仅对数据库型数据源中的矢量数据集有效。。
+         * @description 是否使用文件形式的缓存。仅对数据库型数据源中的矢量数据集有效。
          */
         this.isFileCache = null;
 
diff --git a/src/common/overlay/feature/Theme.js b/src/common/overlay/feature/Theme.js
@@ -14,7 +14,7 @@ import {Util} from '../../commontypes/Util';
  * @classdesc 专题要素基类。
  * @param {Object} data - 用户数据，用于生成可视化 shape。
  * @param {SuperMap.Layer.Theme} layer - 此专题要素所在图层。
- * @usage 
+ * @usage
  */
 export class Theme {
     constructor(data, layer) {
@@ -48,7 +48,7 @@ export class Theme {
         /**
          * @readonly
          * @member {Object} FeatureTheme.prototype.data
-         * @description 用户数据，用于生成可视化 shape，可在子类中规定数据格式或类型，如：<FeatureVector>。
+         * @description 用户数据，用于生成可视化 shape，可在子类中规定数据格式或类型，如：<{@link FeatureVector}>。
          */
         this.data = data;
 
diff --git a/src/mapboxgl/overlay/GraphThemeLayer.js b/src/mapboxgl/overlay/GraphThemeLayer.js
diff --git a/src/mapboxgl/overlay/ThreeLayer.js b/src/mapboxgl/overlay/ThreeLayer.js
diff --git a/src/mapboxgl/overlay/theme/GeoFeatureThemeLayer.js b/src/mapboxgl/overlay/theme/GeoFeatureThemeLayer.js
diff --git a/src/mapboxgl/services/DatasetService.js b/src/mapboxgl/services/DatasetService.js

Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ export class OverlayGeoJobParameter {`
`73`	`73`	`}`
`74`	`74`
`75`	`75`	`/**`
`76`		`- * @function OverlayGeoJobParameter.destroy`
	`76`	`+ * @function OverlayGeoJobParameter.prototype.destroy`
`77`	`77`	`* @description 释放资源，将资源的属性置空。`
`78`	`78`	`*/`
`79`	`79`	`destroy() {`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ export class SummaryAttributesJobsParameter {`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`/**`
`64`		`- * @function SummaryAttributesJobsParameter.destroy`
	`64`	`+ * @function SummaryAttributesJobsParameter.prototype.destroy`
`65`	`65`	`* @description 释放资源，将资源的属性置空。`
`66`	`66`	`*/`
`67`	`67`	`destroy() {`