Skip to content

Commit 28f080a

Browse files
chenmeiyiSupermapchenmeiyiSupermap
committed
【API】jsdoc优化
1 parent 44c5ef4 commit 28f080a

Some content is hidden

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

54 files changed

+1676
-2317
lines changed

‎src/common/commontypes/BaseTypes.js‎

Lines changed: 33 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
* @description In addition to the mandatory C and P parameters, an arbitrary number of
88
* objects can be passed, which will extend C.
99
* @memberOf SuperMap
10-
* @param C - {Object} the class that inherits
11-
* @param P - {Object} the superclass to inherit from
10+
* @param {Object} C - the class that inherits
11+
* @param {Object} P - the superclass to inherit from
1212
*/
1313
SuperMap.inherit = function (C, P) {
1414
var F = function () {
@@ -29,7 +29,7 @@ SuperMap.inherit = function (C, P) {
2929
/**
3030
* @description 实现多重继承
3131
* @memberOf SuperMap
32-
* @param ...mixins {Class|Object}继承的类
32+
* @param {Class|Object} ...mixins - 继承的类
3333
*/
3434
SuperMap.mixin = function (...mixins) {
3535

@@ -80,27 +80,27 @@ export var StringExt = SuperMap.String = {
8080

8181
/**
8282
* @description 判断目标字符串是否以指定的子字符串开头.
83-
* @param str - {string} 目标字符串.
84-
* @param sub - {string} 查找的子字符串.
85-
* @returns {Boolean} 目标字符串以指定的子字符串开头,则返回true;否则返回false.
83+
* @param {string} str - 目标字符串.
84+
* @param {string} sub - 查找的子字符串.
85+
* @returns {boolean} 目标字符串以指定的子字符串开头，则返回true；否则返回false。
8686
*/
8787
startsWith: function (str, sub) {
8888
return (str.indexOf(sub) == 0);
8989
},
9090

9191
/**
9292
* @description 判断目标字符串是否包含指定的子字符串.
93-
* @param str - {string} 目标字符串.
94-
* @param sub - {string} 查找的子字符串.
95-
* @returns {Boolean} 目标字符串中包含指定的子字符串,则返回true;否则返回false.
93+
* @param {string} str - 目标字符串.
94+
* @param {string} sub - 查找的子字符串.
95+
* @returns {boolean} 目标字符串中包含指定的子字符串,则返回true；否则返回false.
9696
*/
9797
contains: function (str, sub) {
9898
return (str.indexOf(sub) != -1);
9999
},
100100

101101
/**
102102
* @description 删除一个字符串的开头和结尾处的所有空白字符.
103-
* @param str - {string} (可能)存在空白字符填塞的字符串.
103+
* @param {string} str - (可能)存在空白字符填塞的字符串.
104104
* @returns {string} 删除开头和结尾处空白字符后的字符串.
105105
*/
106106
trim: function (str) {
@@ -111,7 +111,7 @@ export var StringExt = SuperMap.String = {
111111
* @description 骆驼式("-")连字符的字符串处理.
112112
* 例如: "chicken-head" becomes "chickenHead",
113113
* "-chicken-head" becomes "ChickenHead".
114-
* @param str - {string} 要处理的字符串,原始内容不应被修改.
114+
* @param {string} str - 要处理的字符串,原始内容不应被修改.
115115
* @returns {string}
116116
*/
117117
camelize: function (str) {
@@ -155,9 +155,9 @@ export var StringExt = SuperMap.String = {
155155
* args = null;
156156
* 返回值:"${a.b}"
157157
* (end)
158-
* @param template - {string} 带标记的字符串将要被替换.参数 template 格式为"${token}",此处的 token 标记会替换为 context["token"] 属性的值
159-
* @param context - {Object} 带有属性的可选对象的属性用于匹配格式化字符串中的标记.如果该参数为空,将使用 window 对象.
160-
* @param args - {Array} 可选参数传递给在context对象上找到的函数.
158+
* @param {string} template - 带标记的字符串将要被替换.参数 template 格式为"${token}",此处的 token 标记会替换为 context["token"] 属性的值
159+
* @param {Object} context - 带有属性的可选对象的属性用于匹配格式化字符串中的标记.如果该参数为空,将使用 window 对象.
160+
* @param {Array} args - 可选参数传递给在context对象上找到的函数.
161161
* @returns {string} 从 context 对象属性中替换字符串标记位的字符串.
162162
*/
163163
format: function (template, context, args) {
@@ -225,16 +225,15 @@ export var StringExt = SuperMap.String = {
225225
* SuperMap.String.isNumeric("4") // true
226226
* SuperMap.String.isNumeric(" 4 ") // false
227227
* (end)
228-
* @returns {Boolean} 字符串包含唯一的数值,返回true;否则返回false.
228+
* @returns {boolean} 字符串包含唯一的数值,返回true;否则返回false.
229229
*/
230230
isNumeric: function (value) {
231231
return SuperMap.String.numberRegEx.test(value);
232232
},
233233

234234
/**
235235
* @description 把一个看似数值型的字符串转化为一个数值.
236-
*
237-
* @returns {number|string} 如果能转换为数值则返回数值,否则返回字符串本身.
236+
* @returns {(number|string)} 如果能转换为数值则返回数值,否则返回字符串本身.
238237
*/
239238
numericIf: function (value) {
240239
return SuperMap.String.isNumeric(value) ? parseFloat(value) : value;
@@ -266,8 +265,8 @@ export var NumberExt = SuperMap.Number = {
266265

267266
/**
268267
* @description 限制浮点数的有效数字位数.
269-
* @param num - {number}
270-
* @param sig - {integer}
268+
* @param {number} num - 浮点数
269+
* @param {integer} sig - 有效位数
271270
* @returns {number} 将数字四舍五入到指定数量的有效位数.
272271
*/
273272
limitSigDigs: function (num, sig) {
@@ -280,10 +279,10 @@ export var NumberExt = SuperMap.Number = {
280279

281280
/**
282281
* @description 数字格式化输出.
283-
* @param num - {number}
284-
* @param dec - {integer} 数字的小数部分四舍五入到指定的位数.默认为 0. 设置为null值时小数部分不变.
285-
* @param tsep - {string} 千位分隔符. 默认为",".
286-
* @param dsep - {string} 小数点分隔符. 默认为".".
282+
* @param {number} num - 数字
283+
* @param {integer} dec - 数字的小数部分四舍五入到指定的位数.默认为 0. 设置为null值时小数部分不变.
284+
* @param {string} tsep - 千位分隔符. 默认为",".
285+
* @param {string} dsep - 小数点分隔符. 默认为".".
287286
* @returns {string} 数字格式化后的字符串.
288287
*/
289288
format: function (num, dec, tsep, dsep) {
@@ -329,7 +328,7 @@ if (!Number.prototype.limitSigDigs) {
329328
/**
330329
* APIMethod: Number.limitSigDigs
331330
* 限制浮点数的有效数字位数.
332-
* @param sig - {integer}
331+
* @param {integer} sig -有效位数
333332
* @returns {integer} 将数字四舍五入到指定数量的有效位数.
334333
* 如果传入值为 null、0、或者是负数, 返回值 0
335334
*/
@@ -347,8 +346,8 @@ if (!Number.prototype.limitSigDigs) {
347346
export var FunctionExt = SuperMap.Function = {
348347
/**
349348
* @description 绑定函数到对象.方便创建this的作用域.
350-
* @param func - {function} 输入函数.
351-
* @param object - {Object} 对象绑定到输入函数(作为输入函数的this对象).
349+
* @param {function} func - 输入函数.
350+
* @param {Object} object - 对象绑定到输入函数(作为输入函数的this对象).
352351
* @returns {function} object参数作为func函数的this对象.
353352
*/
354353
bind: function (func, object) {
@@ -366,8 +365,8 @@ export var FunctionExt = SuperMap.Function = {
366365

367366
/**
368367
* @description 绑定函数到对象,在调用该函数时配置并使用事件对象作为第一个参数.
369-
* @param func - {function} 用于监听事件的函数.
370-
* @param object - {Object} this 对象的引用.
368+
* @param {function} func - 用于监听事件的函数.
369+
* @param {Object} object - this 对象的引用.
371370
* @returns {function}
372371
*/
373372
bindAsEventListener: function (func, object) {
@@ -380,7 +379,7 @@ export var FunctionExt = SuperMap.Function = {
380379
* @description 该函数仅仅返回false.该函数主要是避免在IE8以下浏览中DOM事件句柄的匿名函数问题.
381380
* @example
382381
* document.onclick = SuperMap.Function.False;
383-
* @returns {Boolean}
382+
* @returns {boolean}
384383
*/
385384
False: function () {
386385
return false;
@@ -390,7 +389,7 @@ export var FunctionExt = SuperMap.Function = {
390389
* @description 该函数仅仅返回true.该函数主要是避免在IE8以下浏览中DOM事件句柄的匿名函数问题.
391390
* @example
392391
* document.onclick = SuperMap.Function.True;
393-
* @returns {Boolean}
392+
* @returns {boolean}
394393
*/
395394
True: function () {
396395
return true;
@@ -416,12 +415,12 @@ export var ArrayExt = SuperMap.Array = {
416415
/**
417416
* @description 过滤数组.提供了ECMA-262标准中Array.prototype.filter函数的扩展.
418417
* @see {@link http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/filter}
419-
* @param array - {Array} 要过滤的数组..
420-
* @param callback - {function} 数组中的每一个元素调用该函数.<br>
418+
* @param {Array} array - 要过滤的数组.
419+
* @param {function} callback - 数组中的每一个元素调用该函数.<br>
421420
* 如果函数的返回值为true,该元素将包含在返回的数组中.该函数有三个参数: 数组中的元素,元素的索引,数组自身.<br>
422421
* 如果设置了可选参数caller,在调用callback时,使用可选参数caller设置为callback的参数.<br>
423-
* @param caller - {Object} 在调用callback时,使用可选参数caller设置为callback的参数.
424-
* @returns {Array} callback函数返回true时的元素将作为返回数组中的元素.
422+
* @param {Object} caller - 在调用callback时，使用可选参数caller设置为callback的参数。
423+
* @returns {Array} callback函数返回true时的元素将作为返回数组中的元素。
425424
*/
426425
filter: function (array, callback, caller) {
427426
var selected = [];

‎src/common/commontypes/Bounds.js‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -29,31 +29,31 @@ export class Bounds {
2929
left = left[0];
3030
}
3131
/**
32-
* @member SuperMap.Bounds.prototype.left - {number}
32+
* @member {number} SuperMap.Bounds.prototype.left
3333
* @description 最小的水平坐标系。
3434
*/
3535
this.left = left != null ? Util.toFloat(left) : this.left;
3636

3737
/**
38-
* @member SuperMap.Bounds.prototype.bottom - {number}
38+
* @member {number} SuperMap.Bounds.prototype.bottom
3939
* @description 最小的垂直坐标系。
4040
*/
4141
this.bottom = bottom != null ? Util.toFloat(bottom) : this.bottom;
4242

4343
/**
44-
* @member SuperMap.Bounds.prototype.right - {number}
44+
* @member {number} SuperMap.Bounds.prototype.right
4545
* @description 最大的水平坐标系。
4646
*/
4747
this.right = right != null ? Util.toFloat(right) : this.right;
4848

4949
/**
50-
* @member SuperMap.Bounds.prototype.top - {number}
50+
* @member {number} SuperMap.Bounds.prototype.top
5151
* @description 最大的垂直坐标系。
5252
*/
5353
this.top = top != null ? Util.toFloat(top) : this.top;
5454

5555
/**
56-
* @member SuperMap.Bounds.prototype.centerLonLat - {SuperMap.LonLat}
56+
* @member {SuperMap.LonLat} SuperMap.Bounds.prototype.centerLonLat
5757
* @description bounds的地图空间的中心点。用 getCenterLonLat() 获得。
5858
*/
5959
this.centerLonLat = null;
@@ -80,7 +80,7 @@ export class Bounds {
8080
* var bounds1 = new SuperMap.Bounds(-180,-90,180,90);
8181
* var bounds2 = new SuperMap.Bounds(-180,-90,180,90);
8282
* var isEquals = bounds1.equals(bounds2);
83-
* @param bounds - {SuperMap.Bounds} 需要进行计较的 bounds。
83+
* @param {SuperMap.Bounds} bounds - 需要进行计较的 bounds。
8484
* @returns {boolean} 如果 bounds 对象的边和传入的 bounds 一致则返回true,不一致或传入的 bounds 参数为NULL则返回false。
8585
*/
8686
equals(bounds) {
@@ -456,7 +456,7 @@ export class Bounds {
456456
* new SuperMap.Bounds(-170,-90,120,80)
457457
* );
458458
* @param {SuperMap.Bounds} bounds - 目标边界。
459-
* @param {Object} options - 可选参数。<br>
459+
* @param {Object} options - 参数。<br>
460460
* @param {boolean} options.inclusive - 边缘重合也看成相交，默认为true。如果是false，
461461
* 两个边界范围没有重叠部分仅仅是在边缘相接（重合），
462462
* 这种情况被认为没有相交。<br>
@@ -535,9 +535,9 @@ export class Bounds {
535535
* new SuperMap.Bounds(-170,-90,100,80),true,true
536536
* );
537537
* @param {SuperMap.Bounds} bounds - 目标边界。
538-
* @param {boolean} partial - 目标边界的任意部分都包含在当前边界中则被认为是包含关系。默认为false，
539-
* 如果设为false，整个目标边界全部被包含在当前边界范围内。
540-
* @param {boolean} inclusive - 边缘共享被视为包含。默认为true。
538+
* @param {boolean} [partial=false] - 目标边界的任意部分都包含在当前边界中则被认为是包含关系。
539+
* 如果设为false，整个目标边界全部被包含在当前边界范围内。
540+
* @param {boolean} [inclusive=true] - 边缘共享被视为包含。
541541
* @returns {boolean} 传入的边界被当前边界包含。
542542
*/
543543
containsBounds(bounds, partial, inclusive) {
@@ -589,8 +589,8 @@ export class Bounds {
589589
* var newBounds = bounds.wrapDateLine(maxExtent);
590590
* @param {SuperMap.Bounds} maxExtent - 最大的边界范围（一般是全球范围）。
591591
* @param {Object} options - 可选选项参数。<br>
592-
* @param {float} options.leftTolerance - left允许的误差。默认为0。<br>
593-
* @param {float} options.rightTolerance - right允许的误差。默认为0。
592+
* @param {float} [options.leftTolerance=0] - left允许的误差。<br>
593+
* @param {float} [options.rightTolerance=0] - right允许的误差。
594594
* @returns {SuperMap.Bounds} 克隆当前边界。如果当前边界完全在最大范围之外此函数则返回一个不同值的边界，
595595
* 若落在最大边界的左边，则给当前的bounds值加上最大范围的宽度，即向右移动，
596596
* 若落在右边，则向左移动，即给当前的bounds值加上负的最大范围的宽度。
@@ -686,7 +686,7 @@ export class Bounds {
686686
* @description 通过边界框数组创建Bounds。
687687
* @example
688688
* var bounds = SuperMap.Bounds.fromArray([-180,-90,100,80]);
689-
* @param {Array.<float>} bbox - 边界值数组。 (e.g. <i>[5,42,10,45]</i>)
689+
* @param {Array.<float>} bbox - 边界值数组。(e.g. <i>[5,42,10,45]</i>)
690690
* @param {boolean} reverseAxisOrder - 是否是反转轴顺序。如果设为true，则倒转顺序（bottom,left,top,right）,否则按正常轴顺序（left,bottom,right,top）。
691691
* @returns {SuperMap.Bounds} 返回根据传入的数组创建的新的边界对象。
692692
*/

‎src/common/commontypes/Credential.js‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
* 需要使用用户名和密码在："http://localhost:8090/iserver/services/security/tokens"下申请value <br>
77
* 获得形如："2OMwGmcNlrP2ixqv1Mk4BuQMybOGfLOrljruX6VcYMDQKc58Sl9nMHsqQaqeBx44jRvKSjkmpZKK1L596y7skQ.."的value<br>
88
* 目前支持的功能包括：地图服务、专题图、量算、查询、公交换乘、空间分析、网络分析，不支持轮询功能。
9-
* @param value - {string} 访问受安全限制的服务时用于通过安全认证的验证信息。
10-
* @param name - {string} 验证信息前缀，name=value部分的name部分，默认为“token”。
9+
* @param {string} value - 访问受安全限制的服务时用于通过安全认证的验证信息。
10+
* @param {string} name - 验证信息前缀，name=value部分的name部分，默认为“token”。
1111
* @example
1212
* var pixcel = new SuperMap.Credential("valueString","token");
1313
* pixcel.destroy();
@@ -18,14 +18,14 @@ export class Credential {
1818
constructor(value, name) {
1919

2020
/**
21-
* @member SuperMap.Bounds.prototype.value -{string}
21+
* @member {string} SuperMap.Bounds.prototype.value
2222
* @description 访问受安全限制的服务时用于通过安全认证的验证信息。
2323
*/
2424
this.value = value ? value : "";
2525

2626
/**
27-
* @member SuperMap.Bounds.prototype.name -{string}
28-
* @description 验证信息前缀，name=value部分的name部分，默认为“token”。
27+
* @member {string} [SuperMap.Bounds.prototype.name="token"]
28+
* @description 验证信息前缀，name=value部分的name部分。
2929
*/
3030
this.name = name ? name : "token";
3131
this.CLASS_NAME = "SuperMap.Credential";

‎src/common/commontypes/Date.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export var DateExt = SuperMap.Date = {
1212
* @description 生成代表一个具体的日期字符串，该日期遵循ISO 8601标准(详情查看{@link http://tools.ietf.org/html/rfc3339})。
1313
* @example
1414
* var dateString = SuperMap.Date.toISOString(new Date());
15-
* @param date - {Date} 日期对象。
15+
* @param {Date} date - 日期对象。
1616
* @returns {string} 一个代表日期的字符串。(例如 "2010-08-07T16:58:23.123Z")。
1717
*/
1818
toISOString: (function () {
@@ -56,7 +56,7 @@ export var DateExt = SuperMap.Date = {
5656
* @description 从一个字符串生成一个日期对象。
5757
* @example
5858
* var date = SuperMap.Date.parse("2010-08-07");
59-
* @param str - {string} 代表日期的字符串。(例如： "2010", "2010-08", "2010-08-07", "2010-08-07T16:58:23.123Z","2010-08-07T11:58:23.123-06").
59+
* @param {string} str - 代表日期的字符串。(例如： "2010", "2010-08", "2010-08-07", "2010-08-07T16:58:23.123Z","2010-08-07T11:58:23.123-06").
6060
* @returns {Date} 日期对象，如果字符串无法被解析，则返回一个无效的日期。(例如 isNaN(date.getTime())).
6161
*/
6262
parse: function (str) {

0 commit comments

Comments
 (0)