[update]ol modulecategory review by xjj

Author: jinnanyang

src/common/control/TimeControlBase.js

@@ -7,6 +7,7 @@ import {Events} from '../commontypes/Events';
  * @class TimeControlBase
  * @deprecatedclass SuperMap.TimeControlBase
  * @classdesc 时间控制基类。
+ * @modulecategory Control
  * @category  Control
  * @param {Object} options - 可选参数。
  * @param {number} [options.speed=1] - 速度。不能小于 0，（每帧渲染的数据之间的间隔为1），设置越大速度越快。

src/common/control/TimeFlowControl.js

@@ -10,6 +10,7 @@ import {TimeControlBase} from './TimeControlBase';
  * @classdesc 时间管理类。此类只负责时间上的控制，具体执行的操作需要用户在初始化时的回调函数内部进行实现。
  * 如设置起始时间为 1000，结束时间是 2000，步长设置为 1，
  * 那么表示按照每次1年（可以通过 setSpeed 进行修改）的变化从公元 1000 年开始到公元 2000 年为止，默认每 1 秒会变化 1 次（通过 setFrequency 修改）
+ * @modulecategory Control
  * @extends {TimeControlBase}
  * @param {function} callback - 每次刷新回调函数。具体的效果需要用户在此回调函数里面实现。
  * @param {Object} options - 可选参数。

src/common/style/ThemeStyle.js

@@ -7,6 +7,7 @@ import {Util} from '../commontypes/Util';
  * @class ThemeStyle
  * @deprecatedclass SuperMap.ThemeStyle
  * @classdesc 客户端专题图风格类。
+ * @modulecategory Overlay
  * @category Visualization Theme
  * @param {Object} options - 可选参数。
  * @param {boolean} [options.fill=true] - 是否填充，不需要填充则设置为 false。如果 fill 与 stroke 同时为 false，将按 fill 与 stroke 的默认值渲染图层。

src/openlayers/control/ChangeTileVersion.js

@@ -9,6 +9,7 @@ import Control from 'ol/control/Control';
  * @aliasclass control.ChangeTileVersion
  * @category  Control
  * @classdesc 版本切换控件（目前仅支持 IE10 及以上）暂时不支持自定义位置。
+ * @modulecategory Control
  * @extends {ol.control.Control}
  * @param {Object} options -参数。
  * @param {string} [options.title='switch tile version'] - 提示信息。

src/openlayers/control/Logo.js

@@ -9,6 +9,7 @@ import Control from 'ol/control/Control';
  * @aliasclass control.Logo
  * @category  Control
  * @classdesc Logo控件。默认不显示，需手动添加控件。
+ * @modulecategory Control
  * @extends {ol.control.Control}
  * @example
  * var control = new Logo();

src/openlayers/control/ScaleLine.js

@@ -16,6 +16,7 @@ import AssertionError from 'ol/AssertionError';
  *      <p style="color: #ce4844">Notice</p>
  *      <p style="font-size: 13px">该功能继承 {@link ol.control.ScaleLine },与 {@link ol.control.ScaleLine } 功能完全相同。仅为修复 `openlayers` v4.6.5 版本中 WGS84 等地理坐标系比例尺数值错误的问题。
  * </div>
+ * @modulecategory Control
  * @extends {ol.control.ScaleLine}
  * @param {Object} options -参数。
  * @param {string} [options.className='ol-scale-line'] - CSS Class name.。

src/openlayers/mapping/BaiduMap.js

@@ -11,6 +11,7 @@ import { Util } from '../core/Util';
  * @browsernamespace ol.source
  * @category  ThirdPartyMap
  * @classdesc 百度地图图层源。
+ * @modulecategory Mapping
  * @param {Object} opt_options - 参数。
  * @param {string} [opt_options.url='http://online1.map.bdimg.com/onlinelabel/?qt=tile&x={x}&y={y}&z={z}&styles={styles}&udt=20170408'] - 服务地址。
  * @param {string} [opt_options.tileProxy] - 代理地址。

src/openlayers/mapping/ImageSuperMapRest.js

@@ -17,6 +17,7 @@ import { containsExtent, getCenter, getHeight, getWidth, getForViewAndSize } fro
  * @browsernamespace ol.source
  * @category iServer Map Tile
  * @classdesc SuperMap iServer Image 图层源。
+ * @modulecategory Mapping
  * @param {Object} options - 参数。
  * @param {string} options.url - 地图服务地址,例如: http://{ip}:{port}/iserver/services/map-world/rest/maps/World。
  * @param {ServerType} [options.serverType=SuperMap.ServerType.ISERVER] - 服务类型 ISERVER|IPORTAL|ONLINE。

src/openlayers/mapping/SuperMapCloud.js

@@ -9,6 +9,7 @@ import XYZ from 'ol/source/XYZ';
  * @browsernamespace ol.source
  * @category  ThirdPartyMap
  * @classdesc 超图云地图图层源。
+ * @modulecategory Mapping
  * @param {Object} opt_options - 参数。
  * @param {string} [opt_options.url='http://t2.dituhui.com/FileService/image?map={mapName}&type={type}&x={x}&y={y}&z={z}'] - 服务地址。
  * @param {string} [opt_options.tileProxy] - 代理地址。

src/openlayers/mapping/Tianditu.js

@@ -10,6 +10,7 @@ import WMTSTileGrid from 'ol/tilegrid/WMTS';
  * @browsernamespace ol.source
  * @category  ThirdPartyMap
  * @classdesc 天地图图层源。
+ * @modulecategory Mapping
  * @param {Object} opt_options - 参数。
  * @param {string} [opt_options.url='http://t{0-7}.tianditu.gov.cn/{layer}_{proj}/wmts?'] - 服务地址。
  * @param {string} opt_options.key - 天地图服务密钥。详见{@link http://lbs.tianditu.gov.cn/server/MapService.html}

src/openlayers/mapping/TileSuperMapRest.js

@@ -17,6 +17,7 @@ import TileGrid from 'ol/tilegrid/TileGrid';
  * @class TileSuperMapRest
  * @browsernamespace ol.source
  * @category iServer Map Tile
+ * @modulecategory Mapping
  * @classdesc SuperMap iServer TileImage 图层源。
  * @param {Object} options - 参数。
  * @param {string} options.url - 服务地址,例如: http://{ip}:{port}/iserver/services/map-world/rest/maps/World。

src/openlayers/mapping/WebMap.js

@@ -77,6 +77,7 @@ const dpiConfig = {
  * @class WebMap
  * @category  iPortal/Online Resources Map
  * @classdesc 对接 iPortal/Online 地图类
+ * @modulecategory Mapping
  * @param {Object} options - 参数
  * @param {string} [options.target='map'] - 地图容器id
  * @param {Object | string} [options.webMap] - webMap对象，或者是获取webMap的url地址。存在webMap，优先使用webMap, id的选项则会被忽略

src/openlayers/overlay/FGB.js

@@ -12,6 +12,7 @@ import GeoJSON from 'ol/format/GeoJSON';
  * @browsernamespace ol.source
  * @category Visualization FGB
  * @classdesc FGB 图层源，该图层源把 {@link FlatGeobuf} 格式解析为点线面要素。
+ * @modulecategory Overlay
  * @version 11.1.0
  * @param {Object} opt_options - 参数。
  * @param {string} opt_options.url - FGB 地址，例如：http://localhost:8090/iserver/services/xxx/rest/data/featureResults/newResourceId.fgb。

src/openlayers/overlay/Graph.js

@@ -14,6 +14,7 @@ import {
  * @browsernamespace ol.source
  * @category  Visualization Theme
  * @classdesc 统计专题图图层基类。
+ * @modulecategory Overlay
  * @param {string} chartsType - 图表类别。
  * @param {string} name - 图层名称。
  * @param {Object} opt_options - 参数。

src/openlayers/overlay/HeatMap.js

@@ -17,6 +17,7 @@ import Point from 'ol/geom/Point';
  * @class HeatMap
  * @browsernamespace ol.source
  * @classdesc 热力图层类。
+ * @modulecategory Overlay
  * @category Visualization HeatMap
  * @param {string} name - 图层名称。
  * @param {Object} options - 参数。

src/openlayers/overlay/Label.js

@@ -17,6 +17,7 @@ import Point from 'ol/geom/Point';
  * @browsernamespace ol.source
  * @category  Visualization Theme
  * @classdesc 标签专题图图层源。
+ * @modulecategory Overlay
  * @param {string} name - 名称。
  * @param {Object} opt_options - 参数。
  * @param {ol.Map} opt_options.map - 当前 Map 对象。

src/openlayers/overlay/Mapv.js

@@ -14,6 +14,7 @@ import ImageCanvasSource from 'ol/source/ImageCanvas';
  * @browsernamespace ol.source
  * @category  Visualization MapV
  * @classdesc MapV 图层源。
+ * @modulecategory Overlay
  * @param {Object} opt_options - 参数。
  * @param {ol.Map} opt_options.map - 当前 Map 对象。
  * @param {Mapv.DataSet} opt_options.dataSet - MapV 的数据集。

src/openlayers/overlay/RankSymbol.js

@@ -9,6 +9,7 @@ import {Graph} from './Graph';
  * @browsernamespace ol.source
  * @category  Visualization Theme
  * @classdesc 等级符号专题图图层源。
+ * @modulecategory Overlay
  * @param {string} name - 专题图层名。
  * @param {string} symbolType - 标志类型。
  * @param {Object} opt_options - 参数。

src/openlayers/overlay/Turf.js

@@ -11,6 +11,7 @@ import { Util } from '../core/Util';
  * @browsernamespace ol.source
  * @category  Visualization Turf
  * @classdesc Turf.js 图层源。
+ * @modulecategory Overlay
  * @param {Object} opt_options - 参数。
  * @extends {ol.source.Vector}
  * @usage

src/openlayers/overlay/Unique.js

@@ -11,6 +11,7 @@ import {GeoFeature} from './theme/GeoFeature';
  * @browsernamespace ol.source
  * @category  Visualization Theme
  * @classdesc 单值专题图图层源。
+ * @modulecategory Overlay
  * @param {string} name - 图层名称。
  * @param {Object} opt_options - 参数。
  * @param {ol.Map} opt_options.map - 当前 Map 对象。

src/openlayers/overlay/VectorTileSuperMapRest.js

@@ -22,6 +22,7 @@ import TileGrid from 'ol/tilegrid/TileGrid';
  * @browsernamespace ol.source
  * @category  Visualization VectorTile
  * @classdesc 矢量瓦片图层源。
+ * @modulecategory Overlay
  * @param {Object} options - 参数。
  * @param {(string|undefined)} options.url - 服务地址。
  * @param {(string|Object|undefined)} options.style - Mapbox Style JSON 对象或获取 Mapbox Style JSON 对象的 URL。当 `options.format` 为 {@link ol.format.MVT} 且 `options.source` 不为空时有效，优先级高于 `options.url`。

src/openlayers/overlay/graphic/CloverShape.js

@@ -10,6 +10,7 @@ import StrokeStyle from 'ol/style/Stroke';
  * @browsernamespace ol.style
  * @category  Visualization Graphic
  * @classdesc 三叶草要素风格。
+ * @modulecategory Overlay
  * @extends {ol.style.RegularShape}
  * @param {Object} options - 三叶草形要素风格参数。
  * @param {number} [options.angle=30] - 三叶草每个扇叶的圆心角，单位弧度。

src/openlayers/overlay/graphic/Graphic.js

@@ -12,6 +12,7 @@ import Style from 'ol/style/Style';
  * @aliasclass Graphic
  * @category  Visualization Graphic
  * @classdesc 高效率点图层点要素类。
+ * @modulecategory Overlay
  * @param {ol.geom.Point} geometry - 几何对象。
  * @param {Object} [attributes] - 要素属性。
  * @extends {ol.Object}

src/openlayers/overlay/graphic/HitCloverShape.js

@@ -10,6 +10,7 @@ import {
  * @browsernamespace ol.style
  * @category  Visualization Graphic
  * @classdesc 三叶草要素高亮风格。
+ * @modulecategory Overlay
  * @extends {CloverShape}
  * @param {Object} options - 三叶草形要素风格参数。
  * @param {number} options.sAngle - 扇叶起始角度。

src/openlayers/overlay/theme/Theme.js

@@ -20,6 +20,7 @@ import GeoJSON from 'ol/format/GeoJSON';
  * @browsernamespace ol.source
  * @category Visualization Theme
  * @classdesc 专题图基类。
+ * @modulecategory Overlay
  * @param {string} name - 专题图图层名称。
  * @param {Object} opt_option - 参数。
  * @param {ol.Map} opt_option.map - 当前 openlayers 的 Map 对象。

src/openlayers/overlay/theme/ThemeFeature.js

@@ -12,6 +12,7 @@ import GeoJSON from 'ol/format/GeoJSON';
  * @class ThemeFeature
  * @category Visualization Theme
  * @classdesc 专题图要素类。
+ * @modulecategory Overlay
  * @param {Object} geometry - 要量算的几何对象，支持 {@link ol.geom.Geometry} 和 GeometryGeoText 标签数组类型 geometry = [x,y,text]。
  * @param {Object} [attributes] - 属性。
  * @usage

src/openlayers/overlay/vectortile/MapboxStyles.js

@@ -20,6 +20,7 @@ import Text from 'ol/style/Text';
  *      <p style="font-size: 13px">该功能依赖 <a href='https://github.com/boundlessgeo/ol-mapbox-style'>ol-mapbox-style</a> 插件，请确认引入该插件。</p>
  *      `<script type="text/javascript" src="https://rawgit.com/boundlessgeo/ol-mapbox-style/v2.11.2-1/dist/olms.js"></script>`
  * </div>
+ * @modulecategory Overlay
  * @category  Visualization VectorTile
  * @param {Object} options - 参数。
  * @param {(string|undefined)} [options.url] - SuperMap iServer 地图服务地址，例如'http://localhost:8090/iserver/services/map-mvt-test/rest/maps/test'，与options.style互斥，优先级低于options.style。

src/openlayers/overlay/vectortile/VectorTileStyles.js

@@ -16,6 +16,7 @@ import Text from 'ol/style/Text';
 /**
  * @class VectorTileStyles
  * @classdesc 矢量瓦片风格。
+ * @modulecategory Overlay
  * @category  Visualization VectorTile
  * @param {Object} options - 交互时所需可选参数。
  * @extends {ol.Observable}

src/openlayers/services/AddressMatchService.js

@@ -8,6 +8,7 @@ import { Util as CommonUtil } from '@supermap/iclient-common/commontypes/Util';
  * @class AddressMatchService
  * @category  iServer AddressMatch
  * @classdesc 地址匹配服务。
+ * @modulecategory Services
  * @example
  *      new AddressMatchService(url,options)
  *      .code(function(result){

src/openlayers/services/ChartService.js

@@ -10,6 +10,7 @@ import { ChartService as CommonChartService } from '@supermap/iclient-common/iSe
  * @class ChartService
  * @category  iServer Map Chart
  * @classdesc 海图服务。
+ * @modulecategory Services
  * @extends {ServiceBase}
  * @example
  *      new ChartService(url).queryChart(param,function(result){

src/openlayers/services/DataFlowService.js

@@ -8,6 +8,7 @@ import { DataFlowService as DataFlow } from '@supermap/iclient-common/iServer/Da
  * @class DataFlowService
  * @category  iServer DataFlow
  * @classdesc 数据流服务。
+ * @modulecategory Services
  * @extends {ServiceBase}
  * @example
  *      new DataFlowService(url).queryChart(param,function(result){

src/openlayers/services/DatasetService.js

@@ -10,6 +10,7 @@ import { UpdateDatasetParameters } from '@supermap/iclient-common/iServer/Update
  * @class DatasetService
  * @category  iServer Data Dataset
  * @classdesc 数据集服务类。
+ * @modulecategory Services
  * @param {string} url - 服务地址。
  * @param {Object} options - 参数。
  * @param {string} [options.proxy] - 服务代理地址。

src/openlayers/services/DatasourceService.js

@@ -9,6 +9,7 @@ import { SetDatasourceParameters } from '@supermap/iclient-common/iServer/SetDat
  * @class DatasourceService
  * @category  iServer Data Datasource
  * @classdesc 数据源服务类。
+ * @modulecategory Services
  * @param {string} url - 服务地址。
  * @param {Object} options - 参数。
  * @param {string} [options.proxy] - 服务代理地址。