Skip to content

Commit 5cc928f

Browse files
committed
[fix]文档注释修改 src:common remain review by jinny
1 parent 1d53f7e commit 5cc928f

File tree

16 files changed

+76
-76
lines changed

16 files changed

+76
-76
lines changed

src/common/iServer/WebPrintingJobScaleBarOptions.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import { Util } from '../commontypes/Util';
1010
* @category iServer WebPrintingJob
1111
* @version 10.1.0
1212
* @param {Object} option - 参数。
13-
* @param {string} [option.scaleText] - 比例尺文本信息。例如:1:1000000
13+
* @param {string} [option.scaleText] - 比例尺文本信息。例如:1:1000000
1414
* @param {WebScaleOrientationType} [option.orientation] - 比例尺的方位样式。
1515
* @param {WebScaleType} [option.type] - 比例尺的样式。
1616
* @param {number} [option.intervals] - 比例尺条的段数。

src/common/overlay/Graph.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ export class Graph extends Theme {
7474
* @readonly
7575
* @member {Array.<number>} FeatureThemeGraph.prototype.chartBox
7676
* @description 专题要素(图表)区域,即图表框,长度为 4 的一维数组,数组的 4 个元素依次表示图表框左端 x 坐标值、
77-
* 下端 y坐标值、 右端 x坐标值、 上端 y 坐标值;[left, bottom, right, top]。
77+
* 下端 y坐标值、右端 x坐标值、上端 y 坐标值;[left, bottom, right, top]。
7878
*/
7979
this.chartBox = null;
8080

src/common/overlay/ThemeVector.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ import {LonLat} from '../commontypes/LonLat';
3434
* @param {SuperMap.Layer} layer - 此专题要素所在图层。
3535
* @param {Object} style - 样式。
3636
* @param {Object} options - 创建专题要素时的可选参数。
37-
* @param {number} [options.nodesClipPixel=2] - 节点抽稀像素距离, 单位:像素。
37+
* @param {number} [options.nodesClipPixel=2] - 节点抽稀像素距离单位:像素。
3838
* @param {boolean} [options.isHoverAble=true] - 图形是否可 hover。
3939
* @param {boolean} [options.isMultiHover=true] - 是否使用多图形高亮,isHoverAble 为 true 时生效。
4040
* @param {boolean} [options.isClickAble=true] - 图形是否可点击。

src/common/overlay/feature/ShapeFactory.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -762,7 +762,7 @@ export class ShapeFactory {
762762
* // styleByCodomain 的每个元素是个包含值域信息和与值域对应样式信息的对象,该对象(必须)有三个属性:
763763
* // start: 值域值下限(包含);
764764
* // end: 值域值上限(不包含);
765-
* // style: 数据可视化图形的 style,其可设属性根据图形类型参考 <ShapeParameters> 子类对象的 style 属性。
765+
* // style: 数据可视化图形的 style,其可设属性根据图形类型参考 <ShapeParameters> 子类对象的 style 属性。
766766
* // dataStyleByCodomain 数组形如:
767767
* [
768768
* {

src/common/overlay/feature/ShapeParameters.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export class ShapeParameters {
1818
* refOriginalPosition 表示图形的参考中心,通常情况下,图形是使用 canvas 的原点位置作为位置参考,
1919
* 但 refOriginalPosition 可以改变图形的参考位置,例如: refOriginalPosition = [80, 80],
2020
* 图形圆的 style.x = 20, style.y = 20,那么圆在 canvas 中的实际位置是 [100, 100]。
21-
* 图形(Shape) 的所有位置相关属性都是以 refOriginalPosition 为参考中心,
21+
* 图形(Shape)的所有位置相关属性都是以 refOriginalPosition 为参考中心,
2222
* 也就是说图形的所有位置信息在 canvas 中都是以 refOriginalPosition 为参考的相对位置,只有
2323
* refOriginalPosition 的值为 [0, 0] 时,图形的位置信息才是 canvas 绝对位置。
2424
* 图形的位置信息通常有:style.pointList,style.x,style.y。
@@ -27,7 +27,7 @@ export class ShapeParameters {
2727

2828
/**
2929
* @member {string} ShapeParameters.prototype.refDataID
30-
* @description 图形所关联数据的 ID(<{@link FeatureVector}> 的 id)。
30+
* @description 图形所关联数据的 ID(<{@link FeatureVector}> 的 ID)。
3131
*/
3232
this.refDataID = null;
3333

src/common/overlay/levelRenderer/Storage.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ export class Storage {
159159
* @function LevelRenderer.Storage.prototype.getShapeList
160160
* @description 返回所有图形的绘制队列。
161161
*
162-
* @param {boolean} [update=false] - 是否在返回前更新该数组。 详见:<LevelRenderer.Shape> updateShapeList。
162+
* @param {boolean} [update=false] - 是否在返回前更新该数组。详见:<LevelRenderer.Shape> updateShapeList。
163163
* @return {LevelRenderer.Shape} 图形。
164164
*/
165165
getShapeList(update) {
@@ -358,7 +358,7 @@ export class Storage {
358358
* @function LevelRenderer.Storage.prototype.delRoot
359359
* @description 删除指定的图形(Shape)或者组(Group)。
360360
*
361-
* @param {Array.<string>} elId - 删除图形(Shape)或者组(Group)的 id 数组。如果为空清空整个Storage。
361+
* @param {Array.<string>} elId - 删除图形(Shape)或者组(Group)的 ID 数组。如果为空清空整个Storage。
362362
*
363363
*/
364364
delRoot(elId) {

src/common/overlay/levelRenderer/Transformable.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,19 @@ export class Transformable {
1313
constructor() {
1414
/**
1515
* @member {Array.<number>} LevelRenderer.Transformable.prototype.position
16-
* @description 平移, 默认值:[0, 0]。
16+
* @description 平移,默认值:[0, 0]。
1717
*/
1818
this.position = [0, 0];
1919

2020
/**
2121
* @member {Array.<number>} LevelRenderer.Transformable.prototype.rotation
22-
* @description 旋转,可以通过数组二三项指定旋转的原点, 默认值:[0, 0, 0]。
22+
* @description 旋转,可以通过数组二三项指定旋转的原点,默认值:[0, 0, 0]。
2323
*/
2424
this.rotation = [0, 0, 0];
2525

2626
/**
2727
* @member {Array.<number>} LevelRenderer.Transformable.prototype.scale
28-
* @description 缩放,可以通过数组三四项指定缩放的原点, 默认值:[1, 1, 0, 0]。
28+
* @description 缩放,可以通过数组三四项指定缩放的原点,默认值:[1, 1, 0, 0]。
2929
*/
3030
this.scale = [1, 1, 0, 0];
3131

@@ -113,7 +113,7 @@ export class Transformable {
113113

114114
/**
115115
* @function LevelRenderer.Transformable.prototype.updateTransform
116-
* @description 判断是否需要有坐标变换,更新 needTransform 属性。如果有坐标变换, 则从 position, rotation, scale 以及父节点的 transform 计算出自身的 transform 矩阵
116+
* @description 判断是否需要有坐标变换,更新 needTransform 属性。如果有坐标变换则从 position, rotation, scale 以及父节点的 transform 计算出自身的 transform 矩阵
117117
*/
118118
updateTransform() {
119119
this.updateNeedTransform();

src/common/security/SecurityManager.js

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import { Credential } from '../commontypes/Credential';
1313
* > 使用说明:
1414
* > 创建任何一个服务之前调用 {@link SecurityManager.registerToken}或
1515
* > {@link SecurityManager.registerKey}注册凭据。
16-
* > 发送请求时根据 url 或者服务 id 获取相应的 key 或者 token 并自动添加到服务地址中。
16+
* > 发送请求时根据 URL 或者服务 ID 获取相应的 key 或者 token 并自动添加到服务地址中。
1717
* @usage
1818
*/
1919
export class SecurityManager {
@@ -57,7 +57,7 @@ export class SecurityManager {
5757
* @description 服务请求都会自动带上这个 token。
5858
* @function SecurityManager.registerToken
5959
* @param {string} url -服务器域名+端口:如http://localhost:8090。
60-
* @param {string} token - token
60+
* @param {string} token - token
6161
*/
6262
static registerToken(url, token) {
6363
this.tokens = this.tokens || {};
@@ -71,8 +71,8 @@ export class SecurityManager {
7171
/**
7272
* @description 注册 key,ids 为数组(存在一个 key 对应多个服务)。
7373
* @function SecurityManager.registerKey
74-
* @param {Array} ids - 可以是服务 id 数组或者 url 地址数组或者 webAPI 类型数组。
75-
* @param {string} key - key
74+
* @param {Array} ids - 可以是服务 ID 数组或者 URL 地址数组或者 webAPI 类型数组。
75+
* @param {string} key - key
7676
*/
7777
static registerKey(ids, key) {
7878
this.keys = this.keys || {};
@@ -99,10 +99,10 @@ export class SecurityManager {
9999
}
100100

101101
/**
102-
* @description 根据 Url 获取token。
102+
* @description 根据 URL 获取token。
103103
* @function SecurityManager.getToken
104104
* @param {string} url - 服务器域名+端口,如:http://localhost:8092。
105-
* @returns {string} token
105+
* @returns {string} token
106106
*/
107107
static getToken(url) {
108108
if (!url) {
@@ -114,10 +114,10 @@ export class SecurityManager {
114114
}
115115

116116
/**
117-
* @description 根据 Url 获取 key。
117+
* @description 根据 URL 获取 key。
118118
* @function SecurityManager.getKey
119-
* @param {string} id - id
120-
* @returns {string} key
119+
* @param {string} id - ID。
120+
* @returns {string} key
121121
*/
122122
static getKey(id) {
123123
this.keys = this.keys || {};
@@ -189,7 +189,7 @@ export class SecurityManager {
189189
/**
190190
* @description iPortal登录验证。
191191
* @function SecurityManager.loginiPortal
192-
* @param {string} url - iportal 首页地址,如:http://localhost:8092/iportal.
192+
* @param {string} url - iportal 首页地址,如:http://localhost:8092/iportal
193193
* @param {string} username - 用户名。
194194
* @param {string} password - 密码。
195195
* @returns {Promise} 包含 iPortal 登录请求结果的 Promise 对象。
@@ -215,7 +215,7 @@ export class SecurityManager {
215215
/**
216216
* @description iPortal 登出。
217217
* @function SecurityManager.logoutiPortal
218-
* @param {string} url - iportal 首页地址,如:http://localhost:8092/iportal.
218+
* @param {string} url - iportal 首页地址如:http://localhost:8092/iportal
219219
* @returns {Promise} 如果登出成功,返回 true;否则返回 false。
220220
*/
221221
static logoutiPortal(url) {
@@ -288,7 +288,7 @@ export class SecurityManager {
288288
/**
289289
* @description 清空令牌信息。
290290
* @function SecurityManager.destroyToken
291-
* @param {string} url - iportal 首页地址,如:http://localhost:8092/iportal.
291+
* @param {string} url - iportal 首页地址如:http://localhost:8092/iportal
292292
*/
293293
static destroyToken(url) {
294294
if (!url) {
@@ -321,8 +321,8 @@ export class SecurityManager {
321321
* @description 服务URL追加授权信息,授权信息需先通过SecurityManager.registerKey或SecurityManager.registerToken注册。
322322
* @version 10.1.2
323323
* @function SecurityManager.appendCredential
324-
* @param {string} url - 服务URL
325-
* @returns {string} 绑定了token或者key的服务URL
324+
* @param {string} url - 服务URL
325+
* @returns {string} 绑定了token或者key的服务URL
326326
*/
327327
static appendCredential(url) {
328328
var newUrl = url;

src/common/security/ServerInfo.js

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,38 +7,38 @@ import {ServerType} from '../REST';
77
/**
88
* @class ServerInfo
99
* @deprecatedclass SuperMap.ServerInfo
10-
* @classdesc 服务器信息(安全相关),包含服务器类型,服务地址,token服务地址等
10+
* @classdesc 服务器信息(安全相关),包含服务器类型,服务地址,token服务地址等
1111
* @category Security
12-
* @param {string} type - 服务器类型
12+
* @param {string} type - 服务器类型
1313
* @param {Object} options - 参数。
14-
* @param {string} options.server - 服务器地址,如:http://supermapiserver:8090/iserver
15-
* @param {string} [options.tokenServiceUrl] - 如:http://supermapiserver:8090/iserver/services/security/tokens.json
16-
* @param {string} [options.keyServiceUrl] - 如:http://supermapiserver:8092/web/mycontent/keys/register.json
14+
* @param {string} options.server - 服务器地址如:http://supermapiserver:8090/iserver
15+
* @param {string} [options.tokenServiceUrl] - 如:http://supermapiserver:8090/iserver/services/security/tokens.json
16+
* @param {string} [options.keyServiceUrl] - 如:http://supermapiserver:8092/web/mycontent/keys/register.json
1717
* @usage
1818
*/
1919
export class ServerInfo {
2020
constructor(type, options) {
2121
/**
2222
* @member {ServerType} ServerInfo.prototype.type
23-
* @description 服务器类型
23+
* @description 服务器类型
2424
*/
2525
this.type = type;
2626

2727
/**
2828
* @member {string} ServerInfo.prototype.server
29-
* @description 服务器地址
29+
* @description 服务器地址
3030
*/
3131
this.server = null;
3232

3333
/**
3434
* @member {string} [ServerInfo.prototype.tokenServiceUrl]
35-
* @description 如:http://supermapiserver:8090/iserver/services/security/tokens.json
35+
* @description 如:http://supermapiserver:8090/iserver/services/security/tokens.json
3636
*/
3737
this.tokenServiceUrl = null;
3838

3939
/**
4040
* @member {string} [ServerInfo.prototype.keyServiceUrl]
41-
* @description 如:http://supermapiserver:8092/web/mycontent/keys/register.json
41+
* @description 如:http://supermapiserver:8092/web/mycontent/keys/register.json
4242
*/
4343
this.keyServiceUrl = null;
4444

src/common/security/TokenServiceParameter.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import {ClientType} from '../REST';
1515
* @param {ClientType} [options.clientType='ClientType.NONE'] - token 申请的客户端标识类型。
1616
* @param {string} [options.ip] - clientType=IP 时,此为必选参数。
1717
* @param {string} [options.referer] -clientType=Referer 时,此为必选参数。如果按照指定 URL 的方式申请令牌,则设置相应的 URL。
18-
* @param {number} [options.expiration=60] - 申请令牌的有效期,从发布令牌的时间开始计算,单位为分钟。
18+
* @param {number} [options.expiration=60] - 申请令牌的有效期从发布令牌的时间开始计算单位为分钟。
1919
* @usage
2020
*
2121
*/
@@ -64,8 +64,8 @@ export class TokenServiceParameter {
6464

6565
/**
6666
* @function TokenServiceParameter.prototype.toJSON
67-
* @description 将所有信息转成 JSON 字符串
68-
* @returns {string} 参数的 JSON 字符串
67+
* @description 将所有信息转成 JSON 字符串
68+
* @returns {string} 参数的 JSON 字符串
6969
*/
7070
toJSON() {
7171
return {

0 commit comments

Comments
 (0)