Skip to content

Commit a05a72c

Browse files
committed
根据jsdoc尝试完善部分注释 commit by wuzhuorui review by zhurongchang
1 parent c424a4a commit a05a72c

File tree

111 files changed

+2649
-2676
lines changed

Some content is hidden

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

111 files changed

+2649
-2676
lines changed

src/common/format/Format.js

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
1-
/**
1+
/*
22
* Class: SuperMap.Format
33
* 读写各种格式的格式类基类。其子类应该包含并实现read和write方法。
44
*/
55
var SuperMap = require('../SuperMap');
66
SuperMap.Format = SuperMap.Class({
7+
/**
8+
* @class SuperMap.Format
9+
* @constructs SuperMap.SuperMap.Format
10+
* @classdesc
11+
* 读写各种格式的格式类基类。其子类应该包含并实现read和write方法。
12+
* @extends {SuperMap}
13+
* @api
14+
*/
715

816
/**
917
* Property: options
@@ -60,20 +68,30 @@ SuperMap.Format = SuperMap.Class({
6068
* Returns:
6169
* 返回 <SuperMap.Format> 实例。
6270
*/
71+
72+
/**
73+
* @method SuperMap.Format.initialize
74+
* @param options - {Object} 选项对象,其属性会被直接设置到format实例。
75+
* Allowed options properties:</br>
76+
* datasetNames - {Array(String)} 数据集集合中的数据集名称列表。</br>
77+
* returnContent - {<SuperMap.FilterParameter>} 是否直接返回查询结果。</br>
78+
* fromIndex - {Integer} 查询结果的最小索引号。</br>
79+
* toIndex - {Integer} 查询结果的最大索引号。</br>
80+
*/
6381
initialize: function (options) {
6482
SuperMap.Util.extend(this, options);
6583
this.options = options;
6684
},
6785

68-
/**
86+
/*
6987
* APIMethod: destroy
7088
* 销毁该格式类,释放相关资源。
7189
*/
7290
destroy: function () {
7391
//用来销毁该格式类,释放相关资源
7492
},
7593

76-
/**
94+
/*
7795
* Method: read
7896
* Read data from a string, and return an object whose type depends on the
7997
* subclass.
@@ -88,7 +106,7 @@ SuperMap.Format = SuperMap.Class({
88106
//用来从字符串中读取数据
89107
},
90108

91-
/**
109+
/*
92110
* Method: write
93111
* Accept an object, and return a string.
94112
*

0 commit comments

Comments
 (0)