Skip to content

Commit eb384a1

Browse files
committed
[fix]补充参数描述 修正链接格式 review by qiw
1 parent e5d71e8 commit eb384a1

File tree

9 files changed

+71
-60
lines changed

9 files changed

+71
-60
lines changed

build/jsdocs/leaflet/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ SuperMap iClient for Leaflet 是一套基于Leaflet的云GIS网络客户端开
2727
<table><tr>
2828
<th width="33.3%">可视化</th><th width="33.3%">地图</th><th width="33.3%">投影</th>
2929
</tr><tr>
30-
<td><p>丰富的可视化效果,矢量瓦片、客户端专题图、开源可视化库[ECharts](https://echarts.baidu.com/),[MapV](https://mapv.baidu.com/)</p>
30+
<td><p>丰富的可视化效果,矢量瓦片、客户端专题图、开源可视化库 <a href="https://echarts.baidu.com/">ECharts</a>,<a href="https://mapv.baidu.com/">MapV</a></p>
3131
<a href="TiledVectorLayer.html">TiledVectorLayer</a><br>
3232
<a href="GraphicLayer.html">GraphicLayer</a><br>
3333
<a href="DataFlowLayer.html">DataFlowLayer</a><br>

build/jsdocs/openlayers/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ SuperMap iClient for OpenLayers 是一套基于OpenLayers的云GIS网络客户
2727
<table><tr>
2828
<th width="33.3%">可视化</th><th width="33.3%">地图</th><th width="33.3%"></th>
2929
</tr><tr>
30-
<td><p>丰富的可视化效果,矢量瓦片、客户端专题图、开源可视化库[ECharts](https://echarts.baidu.com/),[MapV](https://mapv.baidu.com/)</p>
30+
<td><p>丰富的可视化效果,矢量瓦片、客户端专题图、开源可视化库 <a href="https://echarts.baidu.com/">ECharts</a>,<a href="https://mapv.baidu.com/">MapV</a></p>
3131
<a href="VectorTileSuperMapRest.html">VectorTileSuperMapRest</a><br>
3232
<a href="Graphic.html">Graphic</a><br>
3333
<a href="DataFlow.html">DataFlow</a><br>

src/common/REST.js

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -76,31 +76,31 @@ var ServerType = {
7676
* ```
7777
*/
7878
var GeometryType = {
79-
/** LINE */
79+
/** 线几何对象类型。 */
8080
LINE: "LINE",
81-
/** LINEM */
81+
/** 路由对象。 */
8282
LINEM: "LINEM",
83-
/** POINT */
83+
/** 点几何对象类型。 */
8484
POINT: "POINT",
85-
/** REGION */
85+
/** 面几何对象类型。 */
8686
REGION: "REGION",
87-
/** POINTEPS */
87+
/** EPS点几何对象。 */
8888
POINTEPS: "POINTEPS",
89-
/** LINEEPS */
89+
/** EPS线几何对象。 */
9090
LINEEPS: "LINEEPS",
91-
/** REGIONEPS */
91+
/** EPS面几何对象。 */
9292
REGIONEPS: "REGIONEPS",
93-
/** ELLIPSE */
93+
/** 椭圆。 */
9494
ELLIPSE: "ELLIPSE",
95-
/** CIRCLE */
95+
/** 圆。 */
9696
CIRCLE: "CIRCLE",
97-
/** TEXT */
97+
/** 文本几何对象类型。 */
9898
TEXT: "TEXT",
99-
/** RECTANGLE */
99+
/** 矩形。 */
100100
RECTANGLE: "RECTANGLE",
101-
/** UNKNOWN */
101+
/** 未定义。 */
102102
UNKNOWN: "UNKNOWN",
103-
/** GEOCOMPOUND */
103+
/** 复合几何对象类型。 */
104104
GEOCOMPOUND:"GEOCOMPOUND"
105105
};
106106

@@ -982,9 +982,9 @@ var TurnType = {
982982
* ```
983983
*/
984984
var BufferEndType = {
985-
/** FLAT */
985+
/** 平头缓冲。 */
986986
FLAT: "FLAT",
987-
/** ROUND */
987+
/** 圆头缓冲。 */
988988
ROUND: "ROUND"
989989
};
990990
/**
@@ -2145,61 +2145,61 @@ var EntityType = {
21452145
* ```
21462146
*/
21472147
var DataItemType = {
2148-
/** geojson数据。 */
2148+
/** geojson 数据。 */
21492149
GEOJSON: "GEOJSON",
2150-
/** UGCV5_MVT */
2150+
/** UGCV5_MVT */
21512151
UGCV5_MVT: "UGCV5_MVT",
21522152
/** json数据。 */
21532153
JSON: "JSON",
2154-
/** AUDIO */
2154+
/** 音频文件。 */
21552155
AUDIO: "AUDIO",
2156-
/** COLOR */
2156+
/** Color 颜色。 */
21572157
COLOR: "COLOR",
2158-
/** COLORSCHEME */
2158+
/** ColorScheme 颜色方案。 */
21592159
COLORSCHEME: "COLORSCHEME",
2160-
/** CSV */
2160+
/** CSV 数据。 */
21612161
CSV: "CSV",
2162-
/** EXCEL */
2162+
/** EXCEL 数据。 */
21632163
EXCEL: "EXCEL",
2164-
/** FILLSYMBOL */
2164+
/** FillSymbol 填充符号库。 */
21652165
FILLSYMBOL: "FILLSYMBOL",
2166-
/** IMAGE */
2166+
/** 图片类型。 */
21672167
IMAGE: "IMAGE",
2168-
/** LAYERTEMPLATE */
2168+
/** LayerTemplate 图层模板。 */
21692169
LAYERTEMPLATE: "LAYERTEMPLATE",
2170-
/** LAYOUTTEMPLATE */
2170+
/** LayoutTemplate 布局模板。 */
21712171
LAYOUTTEMPLATE: "LAYOUTTEMPLATE",
2172-
/** LINESYMBOL */
2172+
/** LineSymbol 线符号库。 */
21732173
LINESYMBOL: "LINESYMBOL",
2174-
/** MAPTEMPLATE */
2174+
/** MapTemplate 地图模板。 */
21752175
MAPTEMPLATE: "MAPTEMPLATE",
2176-
/** MARKERSYMBOL */
2176+
/** MarkerSymbol 点符号库。 */
21772177
MARKERSYMBOL: "MARKERSYMBOL",
2178-
/** MBTILES */
2178+
/** MBTILES */
21792179
MBTILES: "MBTILES",
2180-
/** PHOTOS */
2180+
/** 照片。 */
21812181
PHOTOS: "PHOTOS",
2182-
/** SHP */
2182+
/** SHP 空间数据。 */
21832183
SHP: "SHP",
2184-
/** SMTILES */
2184+
/** SMTILES */
21852185
SMTILES: "SMTILES",
2186-
/** SVTILES */
2186+
/** SVTILES */
21872187
SVTILES: "SVTILES",
2188-
/** THEMETEMPLATE */
2188+
/** ThemeTemplate 专题图模板。 */
21892189
THEMETEMPLATE: "THEMETEMPLATE",
2190-
/** TPK */
2190+
/** TPK */
21912191
TPK: "TPK",
2192-
/** UDB */
2192+
/** UDB 数据源。 */
21932193
UDB: "UDB",
2194-
/** UGCV5 */
2194+
/** UGCV5 */
21952195
UGCV5: "UGCV5",
2196-
/** UNKNOWN */
2196+
/** 其他类型(普通文件)。 */
21972197
UNKNOWN: "UNKNOWN",
2198-
/** VIDEO */
2198+
/** 视频文件。 */
21992199
VIDEO: "VIDEO",
2200-
/** WORKENVIRONMENT */
2200+
/** WorkEnviroment 工作环境。 */
22012201
WORKENVIRONMENT: "WORKENVIRONMENT",
2202-
/** WORKSPACE */
2202+
/** 工作空间。 */
22032203
WORKSPACE: "WORKSPACE"
22042204
}
22052205

src/common/iServer/ImageRenderingRule.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,10 @@ ImageRenderingRule.DisplayMode = {
216216
* @type {string}
217217
*/
218218
ImageRenderingRule.InterpolationMode = {
219+
/** 最邻近插值模式。 */
219220
NEARESTNEIGHBOR: 'NEARESTNEIGHBOR',
221+
/** 高质量的双线性插值模式。 */
220222
HIGHQUALITYBILINEAR: 'HIGHQUALITYBILINEAR',
223+
/** 默认插值模式。 */
221224
DEFAULT: 'DEFAULT'
222225
};

src/common/iServer/ImageStretchOption.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,14 @@ export default class ImageStretchOption {
109109
* @type {string}
110110
*/
111111
ImageStretchOption.StretchType = {
112+
/** 无拉伸。 */
112113
NONE: 'NONE',
114+
/** 高斯拉伸。 */
113115
GAUSSIAN: 'GAUSSIAN',
116+
/** 百分比截断拉伸。 */
114117
PERCENTCLIP: 'PERCENTCLIP',
118+
/** 最值拉伸。 */
115119
MINIMUMMAXIMUM: 'MINIMUMMAXIMUM',
120+
/** 标准差拉伸。 */
116121
STANDARDDEVIATION: 'STANDARDDEVIATION'
117122
};

src/common/iServer/Sortby.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,8 @@ export default class Sortby {
6969
* @type {string}
7070
*/
7171
Sortby.Direction = {
72+
/** 升序。 */
7273
ASC: 'ASC',
74+
/** 降序。 */
7375
DESC: 'DESC'
7476
};

src/common/online/OnlineResources.js

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -55,25 +55,25 @@ var ServiceStatus = {
5555
* ```
5656
*/
5757
var DataItemOrderBy = {
58-
/** FILENAME */
58+
/** 文件名。 */
5959
FILENAME: "FILENAME",
60-
/** ID */
60+
/** ID */
6161
ID: "ID",
62-
/** LASTMODIFIEDTIME */
62+
/** 最后修改时间。 */
6363
LASTMODIFIEDTIME: "LASTMODIFIEDTIME",
64-
/** NICKNAME */
64+
/** 作者昵称。 */
6565
NICKNAME: "NICKNAME",
66-
/** SERVICESTATUS */
66+
/** SERVICESTATUS */
6767
SERVICESTATUS: "SERVICESTATUS",
68-
/** SIZE */
68+
/** 大小。 */
6969
SIZE: "SIZE",
70-
/** STATUS */
70+
/** 状态。 */
7171
STATUS: "STATUS",
72-
/** TYPE */
72+
/** 类型。 */
7373
TYPE: "TYPE",
74-
/** UPDATETIME */
74+
/** 更新时间。 */
7575
UPDATETIME: "UPDATETIME",
76-
/** USERNAME */
76+
/** 作者名。 */
7777
USERNAME: "USERNAME"
7878
};
7979

@@ -96,15 +96,15 @@ var DataItemOrderBy = {
9696
* ```
9797
*/
9898
var FilterField = {
99-
/** LINKPAGE */
99+
/** 服务地址。 */
100100
LINKPAGE: "LINKPAGE",
101-
/** MAPTITLE */
101+
/** 服务中包含的地图的名称。 */
102102
MAPTITLE: "MAPTITLE",
103-
/** NICKNAME */
103+
/** 服务创建者昵称。 */
104104
NICKNAME: "NICKNAME",
105-
/** RESTITLE */
105+
/** 服务名称。 */
106106
RESTITLE: "RESTITLE",
107-
/** USERNAME */
107+
/** 服务创建者用户名。 */
108108
USERNAME: "USERNAME"
109109
};
110110
export {

src/leaflet/components/ComponentsViewBase.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ export var ComponentsViewBase = L.Control.extend({
6767

6868
/**
6969
* @function ComponentsViewBase.prototype.on
70+
* @description 事件绑定。
7071
* @param {string} eventType - 监听的事件类型。
7172
* @param {function} callback - 监听事件的回调函数。
7273
*/

src/mapboxgl/overlay/ThreeLayer.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ const {
3030
* @param {Object} options - 初始化参数。
3131
* @param {Object} options.threeOptions - threejs 渲染器初始化参数对象。参数内容详见:
3232
* {@link THREE.WebGLRenderer}
33-
* THREE.CanvasRenderer
33+
* {@link THREE.CanvasRenderer}。
3434
*
3535
* @extends {mapboxgl.Evented}
3636
* @fires ThreeLayer#render

0 commit comments

Comments
 (0)