【update】文档优化; review by luox

xiongjiaojiao · xiongjiaojiao · commit 6a1a1fb7a24a · 2022-01-04T12:44:02.000+08:00
diff --git a/build/jsdocs/leaflet/index.md b/build/jsdocs/leaflet/index.md
@@ -28,7 +28,7 @@ SuperMap iClient for Leaflet 是一套基于Leaflet的云GIS网络客户端开
     <th width="33.3%">可视化</th><th width="33.3%">地图</th><th width="33.3%">投影</th>
 </tr><tr>
     <td><p>丰富的可视化效果，矢量瓦片、客户端专题图、开源可视化库[ECharts](https://echarts.baidu.com/)，[MapV](https://mapv.baidu.com/)</p>
-        <a href="TileVectorLayer.html">TileVectorLayer</a><br>
+        <a href="TiledVectorLayer.html">TiledVectorLayer</a><br>
         <a href="GraphicLayer.html">GraphicLayer</a><br>
         <a href="DataFlowLayer.html">DataFlowLayer</a><br>
         <a href="RangeThemeLayer.html">RangeThemeLayer</a><br>
diff --git a/src/common/commontypes/geometry/MultiPolygon.js b/src/common/commontypes/geometry/MultiPolygon.js
@@ -30,7 +30,7 @@ export class MultiPolygon extends Collection {
     constructor(components) {
         super(components);
         /**
-         * @member {Array.<string>} [GeometryMultiPoint.prototype.componentTypes=["SuperMap.Geometry.Polygon"]]
+         * @member {Array.<string>} [GeometryMultiPolygon.prototype.componentTypes=["SuperMap.Geometry.Polygon"]]
          * @description components 存储的的几何对象所支持的几何类型数组。
          * @readonly
          */
diff --git a/src/common/commontypes/geometry/Point.js b/src/common/commontypes/geometry/Point.js
@@ -111,6 +111,7 @@ export class Point extends Geometry {
 
     /**
      * @function GeometryPoint.prototype.toShortString
+     * @description 将 x/y 坐标转换成简单字符串。
      * @returns {string} 字符串代表点对象。(ex. <i>"5, 42"</i>)
      */
     toShortString() {
diff --git a/src/common/commontypes/geometry/Polygon.js b/src/common/commontypes/geometry/Polygon.js
@@ -30,7 +30,7 @@ export class Polygon extends Collection {
     constructor(components) {
         super(components);
         /**
-         * @member {Array.<string>} [GeometryMultiPoint.prototype.componentTypes=["SuperMap.Geometry.LinearRing"]]
+         * @member {Array.<string>} [GeometryPolygon.prototype.componentTypes=["SuperMap.Geometry.LinearRing"]]
          * @description components 存储的的几何对象所支持的几何类型数组。
          * @readonly
          */
diff --git a/src/common/iServer/BufferSetting.js b/src/common/iServer/BufferSetting.js
@@ -40,7 +40,7 @@ export class BufferSetting {
          * @member {BufferDistance} [BufferSetting.prototype.rightDistance=100]
          * @description 右侧缓冲距离。
          * 当为 GeometryBufferAnalyst 时，单位为默认地图的投影系的单位（如3857为米，4326为度），
-         * 当为 DatasetBufferAnalyst 时，单位通过{@link BufferSetting.radiusUnit}设置（默认全部为米）。
+         * 当为 DatasetBufferAnalyst 时，单位通过{@link BufferSetting#radiusUnit}设置（默认全部为米）。
          */
         this.rightDistance = new BufferDistance();
 
@@ -52,7 +52,7 @@ export class BufferSetting {
 
         /**
          * @member {BufferRadiusUnit} [BufferSetting.prototype.radiusUnit = BufferRadiusUnit.METER]
-         * @description 缓冲半径单位，可以是{@link BufferRadiusUnit.METER}、{@link BufferRadiusUnit.MILIMETER}、
+         * @description 缓冲半径单位，可以是{@link BufferRadiusUnit.METER}、{@link BufferRadiusUnit.MILLIMETER}、
          * {@link BufferRadiusUnit.CENTIMETER}、{@link BufferRadiusUnit.DECIMETER}、{@link BufferRadiusUnit.KILOMETER}、
          * {@link BufferRadiusUnit.FOOT}、{@link BufferRadiusUnit.INCH}、{@link BufferRadiusUnit.MILE}、{@link BufferRadiusUnit.YARD}。
          * 仅对BufferAnalyst有效。
diff --git a/src/common/iServer/FacilityAnalyst3DParameters.js b/src/common/iServer/FacilityAnalyst3DParameters.js
@@ -54,7 +54,7 @@ export class FacilityAnalyst3DParameters {
 
     /**
      * @function FacilityAnalyst3DParameters.prototype.destroy
-     * @override
+     * @description 释放资源，将资源的属性置空。
      */
     destroy() {
         var me = this;
diff --git a/src/common/iServer/GetFeaturesParametersBase.js b/src/common/iServer/GetFeaturesParametersBase.js
@@ -33,7 +33,7 @@ export class GetFeaturesParametersBase {
         this.targetEpsgCode = null;
 
         /**
-         * @member {Object} GetFeaturesParametersBase.prototype.targetEpsgCode
+         * @member {Object} GetFeaturesParametersBase.prototype.targetPrj
          * @description 动态投影的目标坐标系。使用时需设置 returnContent 参数为 true。 如：prjCoordSys={"epsgCode":3857}。当同时设置 targetEpsgCode 参数时，此参数不生效。
          */
         this.targetPrj = null;
diff --git a/src/common/iServer/HillshadeParameter.js b/src/common/iServer/HillshadeParameter.js
@@ -53,7 +53,7 @@ export class HillshadeParameter extends RasterFunctionParameter {
         this.zFactor = 1;
 
         /**
-         * @member {RasterFunctionType} RasterFunctionParameter.prototype.type
+         * @member {RasterFunctionType} HillshadeParameter.prototype.type
          * @description 栅格分析方法。
          */
         this.type = RasterFunctionType.HILLSHADE;
diff --git a/src/common/iServer/LabelImageCell.js b/src/common/iServer/LabelImageCell.js
@@ -13,7 +13,7 @@ import {LabelMatrixCell} from './LabelMatrixCell';
  * 矩阵标签专题图是标签专题图（ThemeLabel）的一种，其中矩阵标签中的填充元素又可分为图片类型（{@link LabelImageCell}）、
  * 符号类型（{@link LabelSymbolCell}）、专题图类型（{@link LabelThemeCell}）三种，该类是这三种类型的矩阵标签元素其中的一种，
  * 用于定义符号类型的矩阵标签，如符号 ID 字段名称（符号 ID 与 SuperMap 桌面产品中点、线、面符号的 ID 对应） 、大小等。
- * 用户在实现矩阵标签专题图时只需将定义好的矩阵标签元素赋值予 {@link ThemeLabel.matrixCells} 属性即可。matrixCells 是一个二维数组，
+ * 用户在实现矩阵标签专题图时只需将定义好的矩阵标签元素赋值予 {@link ThemeLabel#matrixCells} 属性即可。matrixCells 是一个二维数组，
  * 每一维可以是任意类型的矩阵标签元素组成的数组（也可是单个标签元素组成的数组，即数组中只有一个元素）。
  * @extends {LabelMatrixCell}
  * @param {Object} options - 可选参数。
diff --git a/src/common/iServer/LabelSymbolCell.js b/src/common/iServer/LabelSymbolCell.js
@@ -14,7 +14,7 @@ import {LabelMatrixCell} from './LabelMatrixCell';
  * 矩阵标签专题图是标签专题图（{@link ThemeLabel}）的一种，其中矩阵标签中的填充元素又可分为图片类型（{@link LabelImageCell}）、
  * 符号类型（{@link LabelSymbolCell}）、专题图类型（{@link LabelThemeCell}）三种，该类是这三种类型的矩阵标签元素其中的一种，
  * 用于定义符号类型的矩阵标签，如符号 ID 字段名称（符号 ID 与 SuperMap 桌面产品中点、线、面符号的 ID 对应） 、大小等。
- * 用户在实现矩阵标签专题图时只需将定义好的矩阵标签元素赋值予 {@link ThemeLabel.matrixCells} 属性即可。matrixCells 属是一个二维数组，
+ * 用户在实现矩阵标签专题图时只需将定义好的矩阵标签元素赋值予 {@link ThemeLabel#matrixCells} 属性即可。matrixCells 属是一个二维数组，
  * 每一维可以是任意类型的矩阵标签元素组成的数组（也可是单个标签元素组成的数组，即数组中只有一个元素）。
  * @extends {LabelMatrixCell}
  * @param {Object} options - 参数。
@@ -28,8 +28,8 @@ export class LabelSymbolCell extends LabelMatrixCell {
         super(options);
         /**
          * @member {ServerStyle} LabelSymbolCell.prototype.style
-         * @description 获取或设置符号样式—— {@link ServerStyle} 对象，包括符号大小（{@link ServerStyle.markerSize}）
-         *              和符号旋转（{@link ServerStyle.markerAngle}）角度，其中用于设置符号 ID 的属性（{@link ServerStyle.markerSymbolID}）在此处不起作用。
+         * @description 获取或设置符号样式—— {@link ServerStyle} 对象，包括符号大小（{@link ServerStyle#markerSize}）
+         *              和符号旋转（{@link ServerStyle#markerAngle}）角度，其中用于设置符号 ID 的属性（{@link ServerStyle#markerSymbolID}）在此处不起作用。
          */
         this.style = new ServerStyle();
 
diff --git a/src/common/iServer/LabelThemeCell.js b/src/common/iServer/LabelThemeCell.js
@@ -14,7 +14,7 @@ import {LabelMatrixCell} from './LabelMatrixCell';
  *              矩阵标签专题图是标签专题图（{@link ThemeLabel}）的一种，其中矩阵标签中的填充元素又可分为图片类型（{@link LabelImageCell}）、
  *              符号类型（{@link LabelSymbolCell}）、专题图类型（{@link LabelThemeCell}）三种，该类是这三种类型的矩阵标签元素其中的一种，
  *              用于定义符号类型的矩阵标签，如符号 ID 字段名称（符号 ID 与 SuperMap 桌面产品中点、线、面符号的 ID 对应） 、大小等。
- *              用户在实现矩阵标签专题图时只需将定义好的矩阵标签元素赋值予 {@link ThemeLabel.matrixCells} 属性即可。matrixCells 属是一个二维数组，
+ *              用户在实现矩阵标签专题图时只需将定义好的矩阵标签元素赋值予 {@link ThemeLabel#matrixCells} 属性即可。matrixCells 属是一个二维数组，
  *              每一维可以是任意类型的矩阵标签元素组成的数组（也可是单个标签元素组成的数组，即数组中只有一个元素）。
  * @extends {LabelMatrixCell}
  * @param {Object} options -参数。
diff --git a/src/common/iServer/NDVIParameter.js b/src/common/iServer/NDVIParameter.js
@@ -40,7 +40,7 @@ export class NDVIParameter extends RasterFunctionParameter {
             '0:ffffe5ff;0.1:f7fcb9ff;0.2:d9f0a3ff;0.3:addd8eff;0.4:78c679ff;0.5:41ab5dff;0.6:238443ff;0.7:006837ff;1:004529ff';
 
         /**
-         * @member {RasterFunctionType} [RasterFunctionParameter.prototype.type]
+         * @member {RasterFunctionType} [NDVIParameter.prototype.type]
          * @description 栅格分析方法。
          */
         this.type = RasterFunctionType.NDVI;
diff --git a/src/common/iServer/OverlayGeoJobParameter.js b/src/common/iServer/OverlayGeoJobParameter.js
@@ -74,7 +74,7 @@ export class OverlayGeoJobParameter {
 
     /**
      * @function OverlayGeoJobParameter.destroy
-     * @override
+     * @description 释放资源，将资源的属性置空。
      */
     destroy() {
         this.datasetName = null;
diff --git a/src/common/iServer/RasterFunctionParameter.js b/src/common/iServer/RasterFunctionParameter.js
@@ -15,11 +15,13 @@ import { Util } from '../commontypes/Util';
 export class RasterFunctionParameter {
     constructor(options) {
         options = options || {};
+
         /**
          * @member {RasterFunctionType} [RasterFunctionParameter.prototype.type]
          * @description 栅格分析方法。
          */
         this.type = null;
+
         Util.extend(this, options);
         this.CLASS_NAME = 'SuperMap.RasterFunctionParameter';
     }
diff --git a/src/common/iServer/ServerGeometry.js b/src/common/iServer/ServerGeometry.js
@@ -239,7 +239,7 @@ export class ServerGeometry {
     }
 
     /**
-     * @function ServerGeometry.prototype.toGeoLine
+     * @function ServerGeometry.prototype.toGeoLinem
      * @description 将服务端的路由线几何对象转换为客户端几何对象。包括 LinearRing、LineString、MultiLineString。
      * @returns {Geometry} 转换后的客户端几何对象。
      */
diff --git a/src/common/iServer/SummaryAttributesJobsParameter.js b/src/common/iServer/SummaryAttributesJobsParameter.js
@@ -62,7 +62,7 @@ export class SummaryAttributesJobsParameter {
 
     /**
      * @function SummaryAttributesJobsParameter.destroy
-     * @override
+     * @description 释放资源，将资源的属性置空。
      */
     destroy() {
         this.datasetName = null;
diff --git a/src/common/iServer/SummaryMeshJobParameter.js b/src/common/iServer/SummaryMeshJobParameter.js
@@ -98,7 +98,7 @@ export class SummaryMeshJobParameter {
 
     /**
      * @function SummaryMeshJobParameter.destroy
-     * @override
+     * @description 释放资源，将资源的属性置空。
      */
     destroy() {
         this.datasetName = null;
diff --git a/src/common/iServer/ThemeGraph.js b/src/common/iServer/ThemeGraph.js
@@ -102,7 +102,7 @@ export class ThemeGraph extends Theme {
         /**
          * @member {Array.<number>} ThemeGraph.prototype.memoryKeys
          * @description 以内存数组方式制作专题图时的键数组。
-         *              键数组内的数值代表 SmID 值，它与 ThemeGraphItem 类中的值数组（ThemeGraphItem.memoryDoubleValues）要关联起来应用。
+         *              键数组内的数值代表 SmID 值，它与 {@link ThemeGraphItem} 类中的值数组（{@link ThemeGraphItem#memoryDoubleValues}）要关联起来应用。
          *              键数组中数值的个数必须要与值数组的数值个数一致。值数组中的值将代替原来的专题值来制作统计专题图。
          *              目前所有的专题图都支持以内存数组的方式制作专题图，但统计专题图与其他专题图指定内存数组的方式不同，
          *              统计专题图使用 memoryKeys 指定内存数组，而其他专题图则使用 memoryData 来指定内存数组。
diff --git a/src/common/iServer/ThemeGraphItem.js b/src/common/iServer/ThemeGraphItem.js
@@ -35,7 +35,7 @@ export class ThemeGraphItem {
         /**
          * @member {Array.<number>} [ThemeGraphItem.prototype.memoryDoubleValues]
          * @description 内存数组方式制作专题图时的值数组。<br>
-         *              内存数组方式制作专题图时，只对 SmID 值在键数组（{@link ThemeGraph.memoryKeys}）中的记录制作专题图。
+         *              内存数组方式制作专题图时，只对 SmID 值在键数组（{@link ThemeGraph#memoryKeys}）中的记录制作专题图。
          *              值数组的数值个数必须与键数组中数值的个数一致。 值数组中的值将代替原来的专题值来制作统计专题图。
          *              比如：利用面积字段和周长字段（即有两个统计专题图子项 ）作为专题变量制作统计专题图。
          */
diff --git a/src/common/iServer/ThemeLabelText.js b/src/common/iServer/ThemeLabelText.js
@@ -26,28 +26,28 @@ export class ThemeLabelText {
         /**
          * @member {number} [ThemeLabelText.prototype.maxTextHeight=0]
          * @description 标签中文本的最大高度。当标签文本不固定大小时，即 ServerTextStyle.sizeFixed = false 有效，
-         *              当放大后的文本高度超过最大高度之后就不再放大。高度单位为 0.1 毫米。
+         *              当放大后的文本高度超过最大高度之后就不再放大。高度单位为毫米。
          */
         this.maxTextHeight = 0;
 
         /**
          * @member {number} [ThemeLabelText.prototype.maxTextWidth=0]
          * @description 标签中文本的最大宽度。当标签文本不固定大小时，即 ServerTextStyle.sizeFixed = false 有效，
-         *              当放大后的文本宽度超过最大高度之后就不再放大。宽度单位为 0.1 毫米。
+         *              当放大后的文本宽度超过最大高度之后就不再放大。宽度单位为毫米。
          */
         this.maxTextWidth = 0;
 
         /**
          * @member {number} [ThemeLabelText.prototype.minTextHeight=0]
          * @description 标签中文本的最小高度。当标签文本不固定大小时，即 ServerTextStyle.sizeFixed = false 有效，
-         *              当缩小后的文本高度小于最小高度之后就不再缩小。高度单位为 0.1 毫米。
+         *              当缩小后的文本高度小于最小高度之后就不再缩小。高度单位为毫米。
          */
         this.minTextHeight = 0;
 
         /**
          * @member {number} [ThemeLabelText.prototype.minTextWidth=0]
          * @description 标签中文本的最小宽度。当标签文本不固定大小时，即 ServerTextStyle.sizeFixed = false 有效，
-         *              当缩小后的文本宽度小于最小宽度之后就不再缩小。宽度单位为 0.1 毫米。
+         *              当缩小后的文本宽度小于最小宽度之后就不再缩小。宽度单位为毫米。
          */
         this.minTextWidth = 0;
 
diff --git a/src/common/overlay/Graph.js b/src/common/overlay/Graph.js
@@ -30,7 +30,7 @@ export class Graph extends Theme {
         super(data, layer, fields, setting, lonlat, options);
 
         /**
-         * @member {ShapeFactory} FeatureThemeGraph.prototype.shapeFactory
+         * @member {FeatureShapeFactory} FeatureThemeGraph.prototype.shapeFactory
          * @description 内置的图形工厂对象，调用其 createShape 方法创建图形。
          */
         this.shapeFactory = new ShapeFactory();
diff --git a/src/common/overlay/feature/Label.js b/src/common/overlay/feature/Label.js
@@ -15,23 +15,22 @@ import { ShapeParameters } from './ShapeParameters';
  * @param {string} text - 图形中的附加文本。
  * @usage
  * ```
- * 
  * // 浏览器
  * <script type="text/javascript" src="{cdn}"></script>
  * <script>
- *   new {namespace}.Feature.ShapeParameters.Label(components);
- * 
+ *   new {namespace}.Feature.ShapeParameters.Label(x, y, text);
+ *
  *   // 弃用的写法
- *   new SuperMap.Feature.ShapeParameters.Label(components);
+ *   new SuperMap.Feature.ShapeParameters.Label(x, y, text);
  *
  * </script>
  * // ES6 Import
  * import { ShapeParametersLabel } from '{npm}';
- * new ShapeParametersLabel(components);
- * 
+ * new ShapeParametersLabel(x, y, text);
+ *
  * // 弃用的写法
  * import { Label } from '{npm}';
- * new Label(components);
+ * new Label(x, y, text);
  *
  * ```
  */
diff --git a/src/common/security/SecurityManager.js b/src/common/security/SecurityManager.js
@@ -322,7 +322,7 @@ export class SecurityManager {
      * @version 10.1.2
      * @function SecurityManager.appendCredential
      * @param {string} url - 服务URL
-     * @returns {string} - 绑定了token或者key的服务URL
+     * @returns {string} 绑定了token或者key的服务URL
      */
     static appendCredential(url) {
         var newUrl = url;
diff --git a/src/common/thirdparty/elasticsearch/ElasticSearch.js b/src/common/thirdparty/elasticsearch/ElasticSearch.js
@@ -136,7 +136,7 @@ export class ElasticSearch {
     }
 
     /**
-     * @function  ElasticSearch.prototype.count
+     * @function  ElasticSearch.prototype.create
      * @description 在特定索引中添加一个类型化的JSON文档，使其可搜索。如果具有相同index，type且id已经存在的文档将发生错误。</br>
      * 参数设置参考 {@link https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html#api-create}
      * 更多信息参考 {@link https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html}
@@ -543,7 +543,7 @@ export class ElasticSearch {
     }
 
     /**
-     * @function  ElasticSearch.prototype.update
+     * @function  ElasticSearch.prototype.updateByQuery
      * @description 通过查询API来更新文档。
      * 参数设置参考 {@link https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html#api-updatebyquery}</br>
      * 更多信息参考 {@link https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html}</br>
diff --git a/src/common/util/ColorsPickerUtil.js b/src/common/util/ColorsPickerUtil.js
@@ -5,9 +5,9 @@ var ColorRender = new Color();
 // 					"www.qzct.net": "#7ed321" = new LevelRenderer.Tool.Color();
 
 /**
- * Created by yzy on 2016/11/9.
- * 色带选择器工具类  用于1、创建canvas对象，2、从几种颜色中获取一定数量的渐变色
- *
+ * @class ColorsPickerUtil
+ * @classdesc 色带选择器工具类  用于1、创建canvas对象，2、从几种颜色中获取一定数量的渐变色
+ * @usage
  */
 export class ColorsPickerUtil  {
     /**
diff --git a/src/common/util/FetchRequest.js b/src/common/util/FetchRequest.js
@@ -10,7 +10,7 @@ let fetch = window.fetch;
 export var setFetch = function (newFetch) {
     fetch = newFetch;
 }
-var RequestJSONPPromise = {
+export var RequestJSONPPromise = {
   limitLength: 1500,
   queryKeys: [],
   queryValues: [],
@@ -185,12 +185,12 @@ var RequestTimeout;
  * <script type="text/javascript" src="{cnd}"></script>
  * <script>
  *   {namespace}.setCORS(cors);
- * 
+ *
  *   // 弃用的写法
  *   SuperMap.setCORS(cors);
- * 
+ *
  * </script>
- * 
+ *
  * // ES6 Import
  * import { setCORS } from '{npm}';
  *
diff --git a/src/leaflet/components/commonmodels/GeoJsonLayersModel.js b/src/leaflet/components/commonmodels/GeoJsonLayersModel.js
diff --git a/src/leaflet/overlay/dataflow/NormalRenderer.js b/src/leaflet/overlay/dataflow/NormalRenderer.js
diff --git a/src/leaflet/overlay/theme/GeoFeatureThemeLayer.js b/src/leaflet/overlay/theme/GeoFeatureThemeLayer.js
diff --git a/src/leaflet/services/MeasureService.js b/src/leaflet/services/MeasureService.js
diff --git a/src/mapboxgl/overlay/UniqueThemeLayer.js b/src/mapboxgl/overlay/UniqueThemeLayer.js
diff --git a/src/openlayers/control/ChangeTileVersion.js b/src/openlayers/control/ChangeTileVersion.js
diff --git a/src/openlayers/control/Logo.js b/src/openlayers/control/Logo.js
diff --git a/src/openlayers/overlay/Label.js b/src/openlayers/overlay/Label.js
diff --git a/src/openlayers/overlay/Range.js b/src/openlayers/overlay/Range.js
diff --git a/src/openlayers/overlay/Unique.js b/src/openlayers/overlay/Unique.js
diff --git a/src/openlayers/overlay/theme/GeoFeature.js b/src/openlayers/overlay/theme/GeoFeature.js
diff --git a/src/openlayers/overlay/vectortile/VectorTileStyles.js b/src/openlayers/overlay/vectortile/VectorTileStyles.js
diff --git a/src/openlayers/services/ServiceBase.js b/src/openlayers/services/ServiceBase.js
