【 fix 】修复 classic 文档跳转和 新增 L 端 transform 的文档； review by luox

yang-mengyue · yang-mengyue · commit 14898e02b155 · 2022-01-19T17:58:26.000+08:00
diff --git a/build/jsdocs/classic/docs.json b/build/jsdocs/classic/docs.json
@@ -39,6 +39,9 @@
       "src/common/iServer/ServerColor.js",
       "src/common/iServer/DatasourceConnectionInfo.js",
       "src/common/iServer/SetDatasourceParameters.js",
+      "src/common/commontypes/Bounds.js",
+      "src/common/commontypes/LonLat.js",
+      "src/common/commontypes/Pixel.js",
       "src/common/REST.js"
     ],
     "exclude": [
diff --git a/src/classic/overlay/MapVLayer.js b/src/classic/overlay/MapVLayer.js
@@ -80,6 +80,7 @@ export class MapVLayer extends SuperMap.Layer {
 
     /**
      * @function SuperMap.Layer.MapVLayer.prototype.destroy
+     * @description 销毁此图层，销毁后此图层的所有属性为 null。
      * @override
      */
     destroy() {
@@ -121,7 +122,7 @@ export class MapVLayer extends SuperMap.Layer {
     /**
      * @function SuperMap.Layer.MapVLayer.prototype.getData
      * @description 获取数据。
-     * @returns {Mapv.DataSet} - mapv 的 dataSet 对象。
+     * @returns {Mapv.DataSet} mapv 的 dataSet 对象。
      */
     getData() {
         if (this.renderer) {
diff --git a/src/classic/services/ProcessingService.js b/src/classic/services/ProcessingService.js
@@ -125,7 +125,7 @@ export class ProcessingService extends CommonServiceBase {
      * @function SuperMap.REST.ProcessingService.prototype.getKernelDensityJobState
      * @description 获取密度分析的状态。
      * @param {string} id - 密度分析的 id。
-     * @returns {Object} - 密度分析的状态。
+     * @returns {Object} 密度分析的状态。
      */
     getKernelDensityJobState(id) {
         return this.kernelDensityJobs[id];
diff --git a/src/common/commontypes/LonLat.js b/src/common/commontypes/LonLat.js
@@ -5,15 +5,13 @@ import {Util} from './Util';
 
 /**
  * @class LonLat
- * @deprecatedclass SuperMap.LonLat
  * @category BaseTypes Geometry
  * @classdesc  这个类用来表示经度和纬度对。
  * @param {number|Array.<number>} [lon=0.0] - 地图单位上的 X 轴坐标或者横纵坐标组成的数组；如果地图是地理投影，则此值是经度，否则，此值是地图地理位置的 x 坐标。
  * @param {number} [lat=0.0] - 地图单位上的 Y 轴坐标，如果地图是地理投影，则此值是纬度，否则，此值是地图地理位置的 y 坐标。
  * @example
  * var lonLat = new LonLat(30,45);
  * @usage
- * @private
  */
 export class LonLat {
 
diff --git a/src/leaflet/core/Attributions.js b/src/leaflet/core/Attributions.js
@@ -2,7 +2,10 @@
  * This program are made available under the terms of the Apache License, Version 2.0
  * which accompanies this distribution and is available at http://www.apache.org/licenses/LICENSE-2.0.html.*/
 /**
- * attribution版权相关配置
+ * @enum attribution
+ * @description 版权相关配置。
+ * @type {string}
+ * @private
  */
 
 let Attributions = {
diff --git a/src/leaflet/core/Transform.js b/src/leaflet/core/Transform.js
@@ -5,13 +5,30 @@ import L from "leaflet";
 import { Util as CommonUtil } from '@supermap/iclient-common/commontypes/Util';
 
 /**
- * @function Util.transform
+ * @function transform
  * @description 转换要素坐标。
  * @param {(L.Marker|L.CircleMarker|L.Polyline|L.Polygon|L.Rectangle|L.LatLngBounds|L.Bounds|Object)} feature - 待转换要素：Leaflet Vector Layers 。
  *              的 {@link L.Marker}|{@link L.CircleMarker}|{@link L.Polyline}|{@link L.Polygon}|{@link L.Rectangle}|{@link L.LatLngBounds}|{@link L.Bounds}|{@link GeoJSONObject} 类型。
  * @param {CRS} [sourceCRS=L.CRS.EPSG4326] - 转换要素的源坐标系。
  * @param {CRS} targetCRS - 转换要素的目标坐标系。
  * @returns {GeoJSONObject} 返回 GeoJSON 规范的数据类型。
+ * @usage
+ * ```
+ * // 浏览器
+ * <script type="text/javascript" src="{cdn}"></script>
+ * <script>
+ *   {namespace}.Util.transform(feature, sourceCRS, targetCRS);
+ * 
+ *   // 弃用的写法: 
+ *   L.Util.transform(feature, sourceCRS, targetCRS);
+ * 
+ * </script>
+ *
+ * // ES6 Import
+ * import { transform } from '{npm}';
+ *
+ * transform(feature, sourceCRS, targetCRS);
+ * ```
  */
 export var transform = function (feature, sourceCRS = L.CRS.EPSG4326, targetCRS) {
     let selfFeatures = null;
diff --git a/src/leaflet/index.js b/src/leaflet/index.js
@@ -18,7 +18,8 @@ import {
     resolutionToScale,
     scaleToResolution,
     GetResolutionFromScaleDpi,
-    NormalizeScale
+    NormalizeScale,
+    transform
 } from './core';
 import {
     BaiduTileLayer,
@@ -213,7 +214,8 @@ export {
     resolutionToScale,
     scaleToResolution,
     GetResolutionFromScaleDpi,
-    NormalizeScale
+    NormalizeScale,
+    transform
 };
 export {
     BaiduTileLayer,
