Skip to content

Commit 3dd2f74

Browse files
wuzhuorui5wuzhuorui5
committed
修改openlayer的部分注释，整理注释变量类型的大小写 reviewby zhurc
1 parent 81c3fdb commit 3dd2f74

File tree

157 files changed

+1895
-1403
lines changed

Some content is hidden

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

157 files changed

+1895
-1403
lines changed

‎build/jsdocs/openlayers/docs.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
"disqus":"",
88
"tags": {
99
"allowUnknownTags": true,
10-
"linkdoc-openlayers":"https://openlayers.org/en/latest/apidoc/"
10+
"linkdoc-openlayers":"https://openlayers.org/en/latest/apidoc/",
11+
"linkdoc-htmlExtension":true
1112
},
1213
"source": {
1314
"includePattern": ".+\\.js?$",

‎dist/iclient9-openlayers.js‎

Lines changed: 1276 additions & 745 deletions
Large diffs are not rendered by default.

‎dist/iclient9-openlayers.min.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/classic/overlay/mapv/MapVRenderer.js‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ export default class MapVRenderer extends MapVBaseLayer {
3535
/**
3636
* @function SuperMap.MapVRenderer.prototype.clickEvent
3737
* @description 点击事件
38-
* @param e - {object} 触发对象
38+
* @param e - {Object} 触发对象
3939
*/
4040
clickEvent(e) {
4141
var pixel = e.layerPoint;
@@ -45,7 +45,7 @@ export default class MapVRenderer extends MapVBaseLayer {
4545
/**
4646
* @function SuperMap.MapVRenderer.prototype.mousemoveEvent
4747
* @description 鼠标移动事件
48-
* @param e - {object} 触发对象
48+
* @param e - {Object} 触发对象
4949
*/
5050
mousemoveEvent(e) {
5151
var pixel = e.layerPoint;
@@ -55,7 +55,7 @@ export default class MapVRenderer extends MapVBaseLayer {
5555
/**
5656
* @function SuperMap.MapVRenderer.prototype.bindEvent
5757
* @description 绑定鼠标移动和鼠标点击事件
58-
* @param e - {object} 触发对象
58+
* @param e - {Object} 触发对象
5959
*/
6060
bindEvent(e) {
6161
var map = this.map;
@@ -73,7 +73,7 @@ export default class MapVRenderer extends MapVBaseLayer {
7373
/**
7474
* @function SuperMap.MapVRenderer.prototype.unbindEvent
7575
* @description 解绑鼠标移动和鼠标滑动触发的事件
76-
* @param e - {object} 触发对象
76+
* @param e - {Object} 触发对象
7777
*/
7878
unbindEvent(e) {
7979
var map = this.map;
@@ -300,7 +300,7 @@ export default class MapVRenderer extends MapVBaseLayer {
300300
/**
301301
* @function SuperMap.MapVRenderer.prototype.clear
302302
* @description 清除环境
303-
* @param context - {object} 当前环境
303+
* @param context - {Object} 当前环境
304304
*/
305305
clear(context) {
306306
context && context.clearRect && context.clearRect(0, 0, context.canvas.width, context.canvas.height);

‎src/classic/services/AddressMatchService.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import CommonAddressMatchService from '../../common/iServer/AddressMatchService'
77
* @classdesc 地址匹配服务，包括正向匹配和反向匹配。
88
* @extends SuperMap.REST.CommonServiceBase
99
* @param url - {string} 服务地址
10-
* @param options - {object} 地址匹配服务可选参数
10+
* @param options - {Object} 地址匹配服务可选参数
1111
*/
1212
export class AddressMatchService extends CommonServiceBase {
1313

‎src/common/control/TimeControlBase.js‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ export default class TimeControlBase {
5959

6060
/**
6161
* @member SuperMap.TimeControlBase.prototype.running -{boolean}
62-
* @description 记录当前是否处于中，默认为false。
62+
* @description 记录当前是否处于运行中，默认为false。
6363
*/
6464
running = false;
6565

@@ -71,7 +71,7 @@ export default class TimeControlBase {
7171

7272
/*
7373
* Constant: EVENT_TYPES
74-
* {Array(String)}
74+
* {Array<String>}
7575
* 此类支持的事件类型。
7676
*
7777
*/
@@ -227,7 +227,7 @@ export default class TimeControlBase {
227227
/**
228228
* @function SuperMap.TimeControlBase.prototype.getSpeed
229229
* @description 获取步长。
230-
* @return {Number} 返回当前的步长
230+
* @return {number} 返回当前的步长
231231
*/
232232
getSpeed() {
233233
return this.speed;
@@ -253,7 +253,7 @@ export default class TimeControlBase {
253253
/**
254254
* @function SuperMap.TimeControlBase.prototype.getFrequency
255255
* @description 获取刷新频率。
256-
* @return {Number} 返回当前的刷新频率
256+
* @return {number} 返回当前的刷新频率
257257
*/
258258
getFrequency() {
259259
return this.frequency;
@@ -286,7 +286,7 @@ export default class TimeControlBase {
286286
/**
287287
* @function SuperMap.TimeControlBase.prototype.getStartTime
288288
* @description 获取起始时间
289-
* @return {Number} 返回当前的起始时间
289+
* @return {number} 返回当前的起始时间
290290
*/
291291
getStartTime() {
292292
return this.startTime;
@@ -319,7 +319,7 @@ export default class TimeControlBase {
319319
/**
320320
* @function SuperMap.TimeControlBase.prototype.getEndTime
321321
* @description 获取结束时间
322-
* @return {Number} 返回当前的结束时间
322+
* @return {number} 返回当前的结束时间
323323
*/
324324
getEndTime() {
325325
return this.endTime;
@@ -349,7 +349,7 @@ export default class TimeControlBase {
349349
/**
350350
* @function SuperMap.TimeControlBase.prototype.getCurrentTime
351351
* @description 获取当前时间
352-
* @return {Number} 返回当前时间
352+
* @return {number} 返回当前时间
353353
*/
354354
getCurrentTime() {
355355
return this.currentTime;

‎src/common/control/TimeFlowControl.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import SuperMap from '../SuperMap';
22
import TimeControlBase from './TimeControlBase';
33

44
/**
5-
* @class SuperMap.TimeControl
5+
* @class SuperMap.TimeFlowControl
66
* @classdesc 时间管理类。<br>
77
* 此类只负责时间上的控制，具体执行的操作需要用户在初始化时的回调函数内部进行实现。<br>
88
* 如设置起始时间为1000，结束时间是2000，步长设置为1，
@@ -11,7 +11,7 @@ import TimeControlBase from './TimeControlBase';
1111
* @param callback - {Function} 每次刷新回调函数，必设属性。具体的效果需要用户在此回调函数里面实现。
1212
* @param options - {Object} 该类开放的可选属性。如：<br>
1313
* speed - {number}步长(单位ms)。不能小于0，默认为1（表示每次刷新的数据之间的间隔为1ms）。<br>
14-
* frequency - {Number} 刷新频率(单位ms)，默认为1000ms。<br>
14+
* frequency - {number} 刷新频率(单位ms)，默认为1000ms。<br>
1515
* startTime - {number}起始时间，必须为数字，且小于等于endTime。如果不设置，初始化时为0，建议设置。<br>
1616
* endTime - {number}结束时间，必须为数字，且大于等于startTime。如果不设置，初始化时以当前时间进行设置，建议设置。<br>
1717
* repeat - {boolean} 是否重复循环。默认为true。<br>
@@ -121,7 +121,7 @@ export default class TimeFlowControl extends TimeControlBase {
121121

122122

123123
/**
124-
* @function SuperMap.TimeControl.prototype.tick
124+
* @function SuperMap.TimeFlowControl.prototype.tick
125125
* @description 定时刷新
126126
*/
127127
tick() {

‎src/common/format/Format.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ export default class Format {
7575
* @function SuperMap.Format.prototype.write
7676
* @description Accept an object, and return a string.
7777
* @param object - {Object} Object to be serialized
78-
* @return {String} A string representation of the object.
78+
* @return {string} A string representation of the object.
7979
*/
8080
write(object) {
8181
//用来写字符串

‎src/common/format/GeoJSON.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -361,7 +361,7 @@ export default class GeoJSON extends JSONFormat {
361361
* @description 序列化一个要素对象，几何对象，要素对象数组为一个GeoJSON字符串。
362362
* @param obj - {Object} 一个 <SuperMap.Feature.Vector> 对象，一个 <SuperMap.Geometry> 对象或者一个要素对象数组。
363363
* @param pretty - {boolean} 是否使用换行和缩进来控制输出。默认值为false。
364-
* @return {String} 一个GeoJSON字符串，它表示了输入的几何对象，要素对象，或者要素对象数组。
364+
* @return {string} 一个GeoJSON字符串，它表示了输入的几何对象，要素对象，或者要素对象数组。
365365
*/
366366
write(obj, pretty) {
367367
var geojson = {
@@ -531,7 +531,7 @@ export default class GeoJSON extends JSONFormat {
531531
/**
532532
* @function SuperMap.Format.GeoJSON.extract.linestring
533533
* @description 从一个线对象中返回一个坐标组数组。
534-
* @param linestring - {SuperMap.Geometry.LineString} 线对象。
534+
* @param linestring - {SuperMap.Geometry.Linestring} 线对象。
535535
* @return {Array} 一个表示线对象的坐标组数组。
536536
*/
537537
'linestring': function (linestring) {
@@ -545,7 +545,7 @@ export default class GeoJSON extends JSONFormat {
545545
/**
546546
* @function SuperMap.Format.GeoJSON.extract.multilinestring
547547
* @description 从一个多线对象中返回一个线数组。
548-
* @param multilinestring - {SuperMap.Geometry.MultiLineString} 多线对象
548+
* @param multilinestring - {SuperMap.Geometry.MultiLinestring} 多线对象
549549
*
550550
* @return {Array} 一个表示多线的线数组。
551551
*/

‎src/common/format/JSON.js‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ export default class JSONFormat extends Format {
7676
* @function SuperMap.Format.JSON.prototype.write
7777
* @description 序列化一个对象到一个符合JSON格式的字符串。
7878
* @param value - {string} 需要被序列化的对象，数组，字符串，数字，布尔值。
79-
* @return {String} 符合JSON格式的字符串。
79+
* @return {string} 符合JSON格式的字符串。
8080
*/
8181
write(value, pretty) {
8282
this.pretty = !!pretty;
@@ -97,7 +97,7 @@ export default class JSONFormat extends Format {
9797
/**
9898
* @function SuperMap.Format.JSON.prototype.writeIndent
9999
* @description 根据缩进级别输出一个缩进字符串。
100-
* @return {String} 一个适当的缩进字符串。
100+
* @return {string} 一个适当的缩进字符串。
101101
*/
102102
writeIndent() {
103103
var pieces = [];
@@ -112,7 +112,7 @@ export default class JSONFormat extends Format {
112112
/**
113113
* @function SuperMap.Format.JSON.prototype.writeNewline
114114
* @description 在格式化输出模式情况下输出代表新一行的字符串。
115-
* @return {String} 代表新的一行的字符串。
115+
* @return {string} 代表新的一行的字符串。
116116
*/
117117
writeNewline() {
118118
return (this.pretty) ? this.newline : '';
@@ -121,7 +121,7 @@ export default class JSONFormat extends Format {
121121
/**
122122
* @function SuperMap.Format.JSON.prototype.writeSpace
123123
* @description 在格式化输出模式情况下输出一个代表空格的字符串。
124-
* @return {String} A space.
124+
* @return {string} A space.
125125
*/
126126
writeSpace() {
127127
return (this.pretty) ? this.space : '';
@@ -137,7 +137,7 @@ export default class JSONFormat extends Format {
137137
* @function SuperMap.Format.JSON.serialize.object
138138
* @description Transform an object into a JSON string.
139139
* @param object - {Object} The object to be serialized.
140-
* @return {String} A JSON string representing the object.
140+
* @return {string} A JSON string representing the object.
141141
*/
142142
'object': function (object) {
143143
// three special objects that we want to treat differently
@@ -182,7 +182,7 @@ export default class JSONFormat extends Format {
182182
* @function SuperMap.Format.JSON.serialize.array
183183
* @description Transform an array into a JSON string.
184184
* @param array - {Array} The array to be serialized
185-
* @return {String} A JSON string representing the array.
185+
* @return {string} A JSON string representing the array.
186186
*/
187187
'array': function (array) {
188188
var json;
@@ -210,7 +210,7 @@ export default class JSONFormat extends Format {
210210
* @function SuperMap.Format.JSON.serialize.string
211211
* @description Transform a string into a JSON string.
212212
* @param string - {string} The string to be serialized
213-
* @return {String} A JSON string representing the string.
213+
* @return {string} A JSON string representing the string.
214214
*/
215215
'string': function (string) {
216216
// If the string contains no control characters, no quote characters, and no
@@ -245,7 +245,7 @@ export default class JSONFormat extends Format {
245245
* @function SuperMap.Format.JSON.serialize.number
246246
* @description Transform a number into a JSON string.
247247
* @param number - {number}The number to be serialized.
248-
* @return {String} A JSON string representing the number.
248+
* @return {string} A JSON string representing the number.
249249
*/
250250
'number': function (number) {
251251
return isFinite(number) ? String(number) : "null";
@@ -255,7 +255,7 @@ export default class JSONFormat extends Format {
255255
* @function SuperMap.Format.JSON.serialize.boolean
256256
* @description Transform a boolean into a JSON string.
257257
* @param bool - {boolean} The boolean to be serialized.
258-
* @return {String} A JSON string representing the boolean.
258+
* @return {string} A JSON string representing the boolean.
259259
*/
260260
'boolean': function (bool) {
261261
return String(bool);
@@ -265,7 +265,7 @@ export default class JSONFormat extends Format {
265265
* @function SuperMap.Format.JSON.serialize.object
266266
* @description Transform a date into a JSON string.
267267
* @param date - {Date} The date to be serialized.
268-
* @return {String} A JSON string representing the date.
268+
* @return {string} A JSON string representing the date.
269269
*/
270270
'date': function (date) {
271271
function format(number) {

0 commit comments

Comments
 (0)