Skip to content

Commit 4d30720

Browse files
xilanhuaweidapaoxilanhuaweidapao
committed
【API】 common下的jsdoc优化。 review by CMY
1 parent 28f080a commit 4d30720

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+1710
-2122
lines changed

‎src/common/control/TimeControlBase.js‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ import {Events} from '../commontypes/Events';
55
* @class SuperMap.TimeControlBase
66
* @classdesc 时间控制基类类。
77
* @category Control
8-
* @param options - {Object} 该类开放的可选属性。如：<br>
9-
* speed - {number}速度。不能小于0，默认为1（表示每帧渲染的数据之间的间隔为1），设置越大速度越快。<br>
10-
* startTime - {number}的起始时间，必须为数字，且小于等于endTime。如果不设置，初始化时为0，建议设置。<br>
11-
* endTime - {number}的结束时间，必须为数字，且大于等于startTime。如果不设置，初始化时以当前时间进行设置，建议设置。<br>
12-
* repeat - {boolean} 是否重复循环。默认为true。<br>
13-
* reverse - {boolean} 是否反向。默认为false。<br>
8+
* @param {Object} options - 该类开放的可选属性。
9+
* @param {number} [options.speed=1] - 速度。不能小于0，（每帧渲染的数据之间的间隔为1），设置越大速度越快。
10+
* @param {number} options.startTime - 的起始时间，必须为数字，且小于等于endTime。如果不设置，初始化时为0，建议设置。
11+
* @param {number} options.endTime - 的结束时间，必须为数字，且大于等于startTime。如果不设置，初始化时以当前时间进行设置，建议设置。
12+
* @param {boolean} [options.repeat=true] - 是否重复循环。
13+
* @param {boolean} [options.reverse=false] - 是否反向。
1414
*/
1515
export class TimeControlBase {
1616

@@ -22,73 +22,73 @@ export class TimeControlBase {
2222

2323

2424
/**
25-
* @member SuperMap.TimeControlBase.prototype.speed -{number}
25+
* @member {number} SuperMap.TimeControlBase.prototype.speed
2626
* @description 步长，必须为非负数，默认为1（表示前后两次渲染的数据之间的间隔为1）
2727
*/
2828
this.speed = (options.speed && options.speed >= 0) ? options.speed : 1;
2929

3030
/**
31-
* @member SuperMap.TimeControlBase.prototype.frequency -{number}
31+
* @member {number} SuperMap.TimeControlBase.prototype.frequency
3232
* @description 刷新频率(单位ms)，服务器刷新的时间间隔，默认为1s
3333
*/
3434
this.frequency = (options.speed && options.frequency >= 0) ? options.frequency : 1000;
3535

3636
/**
37-
* @member SuperMap.TimeControlBase.prototype.startTime -{number}
37+
* @member {number} SuperMap.TimeControlBase.prototype.startTime
3838
* @description 记录的起始时间，必须为数字，
3939
* 如果不设置，初始化时为0，建议设置
4040
*/
4141
this.startTime = (options.startTime && options.startTime != null) ? options.startTime : 0;
4242

4343
/**
44-
* @member SuperMap.TimeControlBase.prototype.endTime -{number}
44+
* @member {number} SuperMap.TimeControlBase.prototype.endTime
4545
* @description 记录的结束时间，必须为数字，
4646
* 如果不设置，初始化时以当前时间进行设置，建议设置
4747
*/
4848
this.endTime = (options.endTime && options.endTime != null && options.endTime >= me.startTime) ? options.endTime : +new Date();
4949

5050
/**
51-
* @member SuperMap.TimeControlBase.prototype.repeat -{boolean}
51+
* @member {boolean} SuperMap.TimeControlBase.prototype.repeat
5252
* @description 是否重复循环，默认为true。
5353
*/
5454
this.repeat = (options.repeat !== undefined) ? options.repeat : true;
5555

5656
/**
57-
* @member SuperMap.TimeControlBase.prototype.reverse -{boolean}
57+
* @member {boolean} SuperMap.TimeControlBase.prototype.reverse
5858
* @description 是否反向，默认为false。
5959
*/
6060
this.reverse = (options.reverse !== undefined) ? options.reverse : false;
6161

6262
/**
63-
* @member SuperMap.TimeControlBase.prototype.currentTime -{number}
63+
* @member {number} SuperMap.TimeControlBase.prototype.currentTime
6464
* @description 记录近期的时间，也就是当前帧运行到的时间。
6565
*/
6666
this.currentTime = null;
6767

6868
/**
69-
* @member SuperMap.TimeControlBase.prototype.oldTime -{number}
69+
* @member {number} SuperMap.TimeControlBase.prototype.oldTime
7070
* @description 记录上一帧的时间，也就是之前运行到的时间。
7171
*/
7272
this.oldTime = null;
7373

7474
/**
75-
* @member SuperMap.TimeControlBase.prototype.running -{boolean}
75+
* @member {boolean} SuperMap.TimeControlBase.prototype.running
7676
* @description 记录当前是否处于运行中，默认为false。
7777
*/
7878
this.running = false;
7979

8080

8181
/**
8282
* @private
83-
* @member SuperMap.TimeControlBase.prototype.EVENT_TYPES -{Array<string>}
83+
* @member {Array.<string>} SuperMap.TimeControlBase.prototype.EVENT_TYPES
8484
* @description 此类支持的事件类型。
8585
*
8686
*/
8787
this.EVENT_TYPES = ["start", "pause", "stop"];
8888

8989
/**
9090
* @private
91-
* @member SuperMap.TimeControlBase.prototype.events -{SuperMap.Events}
91+
* @member {SuperMap.Events} SuperMap.TimeControlBase.prototype.events
9292
* @description 事件
9393
*/
9494
me.events = new Events(this, null, this.EVENT_TYPES);
@@ -110,7 +110,7 @@ export class TimeControlBase {
110110

111111
/**
112112
* @function SuperMap.TimeControlBase.prototype.updateOptions
113-
* @param options - {Object} 设置参数得可选参数。设置步长，刷新频率、开始结束时间、是否循环、是否反向。
113+
* @param {Object} options - 设置参数得可选参数。设置步长，刷新频率、开始结束时间、是否循环、是否反向。
114114
*/
115115
updateOptions(options) {
116116
//设置步长，刷新频率、开始结束时间、是否循环、是否反向
@@ -206,7 +206,7 @@ export class TimeControlBase {
206206
/**
207207
* @function SuperMap.TimeControlBase.prototype.setSpeed
208208
* @description 设置步长。
209-
* @param speed - {number}步长，必须为非负数，默认为1
209+
* @param {number} speed - 步长，必须为非负数，默认为1
210210
* @return {boolean} true代表设置成功，false设置失败（speed小于0时失败）
211211
*/
212212
setSpeed(speed) {
@@ -232,7 +232,7 @@ export class TimeControlBase {
232232
/**
233233
* @function SuperMap.TimeControlBase.prototype.setFrequency
234234
* @description 设置刷新频率。
235-
* @param frequency - {number}刷新频率，单位为ms，默认为1s
235+
* @param {number} [frequency=1000] - 刷新频率，单位为ms。
236236
* @return {boolean} true代表设置成功，false设置失败（frequency小于0时失败）
237237
*/
238238
setFrequency(frequency) {
@@ -258,7 +258,7 @@ export class TimeControlBase {
258258
/**
259259
* @function SuperMap.TimeControlBase.prototype.setStartTime
260260
* @description 设置起始时间，设置完成后如果当前时间小于起始时间，则从起始时间开始
261-
* @param startTime - {number}需要设置的起始时间
261+
* @param {number} startTime - 需要设置的起始时间
262262
* @return {boolean} true代表设置成功，false设置失败（startTime 大于结束时间时失败）
263263
*/
264264
setStartTime(startTime) {
@@ -291,7 +291,7 @@ export class TimeControlBase {
291291
/**
292292
* @function SuperMap.TimeControlBase.prototype.setEndTime
293293
* @description 设置结束时间，设置完成后如果当前时间大于结束，则从起始时间开始
294-
* @param endTime - {number}需要设置的结束时间
294+
* @param {number} endTime - 需要设置的结束时间
295295
* @return {boolean} true代表设置成功，false设置失败（endTime 小于开始时间时失败）
296296
*/
297297
setEndTime(endTime) {
@@ -324,7 +324,7 @@ export class TimeControlBase {
324324
/**
325325
* @function SuperMap.TimeControlBase.prototype.setCurrentTime
326326
* @description 设置当前时间
327-
* @param currentTime - {number}需要设置的当前时间
327+
* @param {number} currentTime - 需要设置的当前时间
328328
* @return {boolean} true代表设置成功，false设置失败
329329
*/
330330
setCurrentTime(currentTime) {
@@ -354,7 +354,7 @@ export class TimeControlBase {
354354
/**
355355
* @function SuperMap.TimeControlBase.prototype.setRepeat
356356
* @description 设置是否重复循环
357-
* @param repeat - {boolean} 是否重复循环
357+
* @param {boolean} repeat - 是否重复循环
358358
*/
359359
setRepeat(repeat) {
360360
this.repeat = repeat;
@@ -374,7 +374,7 @@ export class TimeControlBase {
374374
/**
375375
* @function SuperMap.TimeControlBase.prototype.setReverse
376376
* @description 设置是否反向
377-
* @param reverse - {boolean} 是否反向
377+
* @param {boolean} reverse - 是否反向
378378
*/
379379
setReverse(reverse) {
380380
this.reverse = reverse;

‎src/common/control/TimeFlowControl.js‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@ import {TimeControlBase} from './TimeControlBase';
55
* @class SuperMap.TimeFlowControl
66
* @classdesc 时间管理类。
77
* @category Control
8-
* @description 此类只负责时间上的控制，具体执行的操作需要用户在初始化时的回调函数内部进行实现。<br>
8+
* @description 此类只负责时间上的控制，具体执行的操作需要用户在初始化时的回调函数内部进行实现。
99
* 如设置起始时间为1000，结束时间是2000，步长设置为1，
1010
* 那么表示按照每次1年（可以通过setSpeed进行修改）的变化从公元1000年开始到公元2000年为止，默认每1秒会1次(通过setFrequency修改)
1111
* @extends SuperMap.TimeControlBase
12-
* @param callback - {function} 每次刷新回调函数，必设属性。具体的效果需要用户在此回调函数里面实现。
13-
* @param options - {Object} 该类开放的可选属性。如：<br>
14-
* speed - {number}步长(单位ms)。不能小于0，默认为1（表示每次刷新的数据之间的间隔为1ms）。<br>
15-
* frequency - {number} 刷新频率(单位ms)，默认为1000ms。<br>
16-
* startTime - {number}起始时间，必须为数字，且小于等于endTime。如果不设置，初始化时为0，建议设置。<br>
17-
* endTime - {number}结束时间，必须为数字，且大于等于startTime。如果不设置，初始化时以当前时间进行设置，建议设置。<br>
18-
* repeat - {boolean} 是否重复循环。默认为true。<br>
19-
* reverse - {boolean} 是否反向。默认为false。
12+
* @param {function} callback - 每次刷新回调函数，必设属性。具体的效果需要用户在此回调函数里面实现。
13+
* @param {Object} options - 该类开放的可选属性。
14+
* @param {number} [options.speed=1] - 步长(单位ms)。不能小于0，（每次刷新的数据之间的间隔为1ms）。
15+
* @param {number} [options.frequency=1000] - 刷新频率(单位ms)，默认为1000ms。
16+
* @param {number} options.startTime - 起始时间，必须为数字，且小于等于endTime。如果不设置，初始化时为0，建议设置。
17+
* @param {number} options.endTime - 结束时间，必须为数字，且大于等于startTime。如果不设置，初始化时以当前时间进行设置，建议设置。
18+
* @param {boolean} [options.repeat=true] - 是否重复循环。默认为true。
19+
* @param {boolean} [options.reverse=false] - 是否反向。
2020
*/
2121
export class TimeFlowControl extends TimeControlBase {
2222

‎src/common/format/Format.js‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,29 @@ import {Util} from '../commontypes/Util';
55
* @class SuperMap.Format
66
* @classdesc 读写各种格式的格式类基类。其子类应该包含并实现read和write方法。
77
* @category BaseTypes Format
8-
* @param options - {Object} 可选参数。<br>
9-
* keepData - {boolean} 如果设置为true， data属性会指向被解析的对象（例如json或xml数据对象）。
8+
* @param {Object} options - 可选参数。
9+
* @param {boolean} options.keepData - 如果设置为true， data属性会指向被解析的对象（例如json或xml数据对象）。
1010
*/
1111
export class Format {
1212

1313

1414
constructor(options) {
1515
/**
16-
* @member SuperMap.Format.prototype.data - {Object}
16+
* @member {Object} SuperMap.Format.prototype.data
1717
* @description 当 <keepData> 属性设置为true，这是传递给<read>操作的要被解析的字符串。
1818
*/
1919
this.data = null;
2020

2121
/**
2222
* APIProperty: keepData
23-
* @member SuperMap.Format.prototype.keepData - {Object}
23+
* @member {Object} SuperMap.Format.prototype.keepData
2424
* @description 保持最近读到的数据的引用（通过 <data> 属性）。默认值是false。
2525
*/
2626
this.keepData = false;
2727

2828
Util.extend(this, options);
2929
/**
30-
* @member SuperMap.Format.prototype.options - {Object}
30+
* @member {Object} SuperMap.Format.prototype.options
3131
* @description 可选参数。
3232
*/
3333
this.options = options;
@@ -46,7 +46,7 @@ export class Format {
4646
/**
4747
* @function SuperMap.Format.prototype.read
4848
* @description 来从字符串中读取数据。
49-
* @param data - {string} 读取的数据。
49+
* @param {string} data - 读取的数据。
5050
*/
5151
read(data) { // eslint-disable-line no-unused-vars
5252
//用来从字符串中读取数据
@@ -55,7 +55,7 @@ export class Format {
5555
/**
5656
* @function SuperMap.Format.prototype.write
5757
* @description 将对象写成字符串。
58-
* @param object - {Object} 可序列化的对象。
58+
* @param {Object} object - 可序列化的对象。
5959
* @return {string} 对象被写成字符串。
6060
*/
6161
write(object) { // eslint-disable-line no-unused-vars

0 commit comments

Comments
 (0)