Skip to content

Commit 07ad783

Browse files
songyumengsongyumeng
committed
【fix】jsdoc
1 parent 0a8682a commit 07ad783

35 files changed

+112
-120
lines changed

‎src/common/commontypes/Util.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ const DOTS_PER_INCH = 96;
129129
const Util = {
130130

131131
/**
132-
* @function Util.extend
132+
* @memberOf CommonUtil
133133
* @description 对象拷贝赋值。
134134
* @param {Object} dest - 目标对象。
135135
* @param {Object} arguments - 待拷贝的对象。

‎src/common/commontypes/geometry/Polygon.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ export class Polygon extends Collection {
4040
}
4141

4242
/**
43-
* @function GeometryMultiPoint.prototype.getArea
43+
* @function GeometryPolygon.prototype.getArea
4444
* @description 获得区域面积，从区域的外部口径减去计此区域内部口径算所得的面积。
4545
* @returns {number} 几何对象的面积。
4646
*/

‎src/common/iServer/CommonServiceBase.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ export class CommonServiceBase {
110110
}
111111

112112
/**
113-
* @function CommonServiceBase.prototype.request
113+
* @function CommonServiceBase.prototype.request
114114
* @description: 该方法用于向服务发送请求。
115115
* @param {Object} options - 参数。
116116
* @param {string} [options.method='GET'] - 请求方式，包括 "GET"，"POST"，"PUT"，"DELETE"。

‎src/common/iServer/MapService.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,15 +51,15 @@ export class MapService extends CommonServiceBase {
5151
}
5252

5353
/**
54-
* @function destroy
54+
* @function MapService.prototype.destroy
5555
* @description 释放资源，将引用的资源属性置空。
5656
*/
5757
destroy() {
5858
super.destroy();
5959
}
6060

6161
/**
62-
* @function MapService.prototype.processAsync
62+
* @function MapService.prototype.processAsync
6363
* @description 负责将客户端的设置的参数传递到服务端，与服务端完成异步通讯。
6464
* @param {RequestCallback} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
6565
* @returns {Promise} Promise 对象。
@@ -75,7 +75,7 @@ export class MapService extends CommonServiceBase {
7575
}
7676

7777
/**
78-
* @function MapService.prototype.transformResult
78+
* @function MapService.prototype.transformResult
7979
* @description 状态完成时转换结果。
8080
* @param {Object} result - 服务器返回的结果对象。
8181
* @param {Object} options - 请求参数。

‎src/common/iServer/QueryServiceBase.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ export class QueryServiceBase extends CommonServiceBase {
6565
}
6666

6767
/**
68-
* @function QueryService.prototype.destroy
68+
* @function QueryServiceBase.prototype.destroy
6969
* @description 释放资源，将引用资源的属性置空。
7070
*/
7171
destroy() {
@@ -76,7 +76,7 @@ export class QueryServiceBase extends CommonServiceBase {
7676
}
7777

7878
/**
79-
* @function QueryService.prototype.processAsync
79+
* @function QueryServiceBase.prototype.processAsync
8080
* @description 负责将客户端的查询参数传递到服务端。
8181
* @param {QueryParameters} params - 查询参数。
8282
* @param {RequestCallback} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
@@ -111,7 +111,7 @@ export class QueryServiceBase extends CommonServiceBase {
111111
}
112112

113113
/**
114-
* @function QueryService.prototype.transformResult
114+
* @function QueryServiceBase.prototype.transformResult
115115
* @description 状态完成时转换结果。
116116
* @param {Object} result - 服务器返回的结果对象。
117117
* @param {Object} options - 请求参数。
@@ -145,7 +145,7 @@ export class QueryServiceBase extends CommonServiceBase {
145145
}
146146

147147
/**
148-
* @function QueryService.prototype.getQueryParameters
148+
* @function QueryServiceBase.prototype.getQueryParameters
149149
* @description 将 JSON 对象表示的查询参数转化为 QueryParameters 对象。
150150
* @param {Object} params - JSON 字符串表示的查询参数。
151151
* @returns {QueryParameters} 返回转化后的 QueryParameters 对象。

‎src/common/overlay/KnowledgeGraph.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -649,7 +649,7 @@ export class KnowledgeGraph {
649649
}
650650

651651
/**
652-
* @function KnowledgeGraph.prototype.showItem
652+
* @function KnowledgeGraph.prototype.hideItem
653653
* @description 隐藏指定元素。若 item 为节点，则相关边也会随之隐藏。而 hide() 则将只隐藏自身。
654654
* @param {string|Object} item - 元素 ID 或元素实例。
655655
* @param {boolean} [stack] -操作是否入 undo & redo 栈，当实例化 Graph 时设置 enableStack 为 true 时，默认情况下会自动入栈，入栈以后，就支持 undo & redo 操作，如果不需要，则设置该参数为 false 即可。

‎src/common/overlay/feature/ShapeFactory.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ export class ShapeFactory {
5252

5353

5454
/**
55-
* @function FeatureShapeFactory.prototype.destroy
55+
* @function FeatureShapeFactory.prototype.destroy
5656
* @description 销毁图形工厂类对象。
5757
*/
5858
destroy() {
@@ -61,7 +61,7 @@ export class ShapeFactory {
6161

6262

6363
/**
64-
* @function FeatureShapeFactory.prototype.createShape
64+
* @function FeatureShapeFactory.prototype.createShape
6565
* @description 创建一个图形。具体图形由 shapeParameters 决定。
6666
* @param {Object} shapeParameters - 图形参数对象，<{@link ShapeParameters}> 子类对象。
6767
* 此参数可选，如果使用此参数（不为 null），shapeParameters 属性值将被修改为参数的值，然后再使用 shapeParameters 属性值创建图形；
@@ -255,7 +255,7 @@ export class ShapeFactory {
255255

256256

257257
/**
258-
* @function FeatureShapeFactory.prototype.transformStyle
258+
* @function FeatureShapeFactory.prototype.transformStyle
259259
* @description 将用户 feature.style (类 Svg style 标准) 的样式，转换为 levelRenderer 的样式标准（类 CSS-Canvas 样式）
260260
* @param {Object} style - 用户 style。
261261
* @returns {Object} 符合 levelRenderer 的 style。
@@ -368,7 +368,7 @@ export class ShapeFactory {
368368
}
369369

370370
/**
371-
* @function FeatureShapeFactory.prototype.Background
371+
* @function FeatureShapeFactory.prototype.Background
372372
* @description 创建一个矩形背景框图形对象。
373373
* @param {FeatureShapeFactory} shapeFactory - 图形工厂对象。
374374
* @param {Array.<number>} box - 框区域，长度为 4 的一维数组，像素坐标，[left, bottom, right, top]。
@@ -406,7 +406,7 @@ export class ShapeFactory {
406406
}
407407

408408
/**
409-
* @function FeatureShapeFactory.prototype.GraphAxis
409+
* @function FeatureShapeFactory.prototype.GraphAxis
410410
* @description 创建一个统计图表坐标轴图形对象组。
411411
* @param {FeatureShapeFactory} shapeFactory - 图形工厂对象。
412412
* @param {Array.<number>} dataViewBox - 统计图表模型的数据视图框，长度为 4 的一维数组，像素坐标，[left, bottom, right, top]。
@@ -751,7 +751,7 @@ export class ShapeFactory {
751751
}
752752

753753
/**
754-
* @function FeatureShapeFactory.prototype.ShapeStyleTool
754+
* @function FeatureShapeFactory.prototype.ShapeStyleTool
755755
* @description 一个图形 style 处理工具。此工具将指定的默认 style，通用 style，按 styleGroup 取得的 style 和按数据值 value 范围取得的 style 进行合并，得到图形最终的 style。
756756
* @param {Object} defaultStyle - 默认style，此样式对象可设属性根据图形类型参考 <{@link ShapeParameters}> 子类对象的 style 属性。
757757
* @param {Object} style - 图形对象基础 style，此参数控制图形的基础样式，可设属性根据图形类型参考 <{@link ShapeParameters}> 子类对象的 style 属性。优先级低于 styleGroup，styleByCodomain。

‎src/common/overlay/knowledge-graph/G6Render.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ export class G6Render {
215215
}
216216

217217
/**
218-
* @function KnowledgeGraph.prototype.changeSize
218+
* @function G6Render.prototype.changeSize
219219
* @description 当源数据中现有节点/边 的数据项发生配置的变更时，根据新数据刷新视图。
220220
* @param {number} width - 宽度。
221221
* @param {number} height - 高度。

‎src/common/thirdparty/ai/BinaryClassification.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export class BinaryClassification extends MachineLearningBase {
1414
super(options);
1515
}
1616
/**
17-
* @function BinaryClassification.prototype.handleResult
17+
* @function BinaryClassification.prototype.handleResult
1818
* @description 对预测数据进行处理
1919
* @param {Object} prediction - 模型预测后的张量。
2020
* @returns {Object} 处理返回的数据

‎src/common/thirdparty/ai/LandcoverClassification.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export class LandcoverClassification extends MachineLearningBase {
1414
super(options);
1515
}
1616
/**
17-
* @function ObjectDetection.prototype.handleResult
17+
* @function ObjectDetection.prototype.handleResult
1818
* @description 对模型进行预测
1919
* @param {Object} prediction - 模型预测后的张量。
2020
* @returns {Object} 处理返回的数据

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy