【API】 新增部分接口 extends 标识 review by zongym

liqian7 · liqian7 · commit ea0a06d57409 · 2018-12-19T16:33:20.000+08:00
diff --git a/src/common/widgets/templates/AttributesPopContainer.js b/src/common/widgets/templates/AttributesPopContainer.js
@@ -12,6 +12,7 @@ import {PopContainer} from './PopContainer';
  * @param {string} options.id - 组件 dom 元素 id。
  * @param {Object} options.title - 属性弹框组件名称。
  * @param {Object} options.attributes - 组件需要显示的属性内容。
+ * @extends {SuperMap.Widgets.PopContainer}
  * @category Widgets Common
  */
 export class AttributesPopContainer extends PopContainer {
diff --git a/src/common/widgets/templates/CityTabsPage.js b/src/common/widgets/templates/CityTabsPage.js
@@ -13,6 +13,7 @@ import {Util} from '../../commontypes/Util';
  * @param {string} options.id - 组件 dom 元素 id。
  * @param {Object|Array.<string>} options.config - 城市名称配置列表，支持两种格式：{key1:{A:[],B:[]}, key2:{C:[],D:[]}} 或
  *                               ["成都市","北京市"]，用户可根据自己的项目需求进行配置
+ * @extends {SuperMap.Widgets.IndexTabsPageContainer}
  * @category Widgets Common
  */
 export class CityTabsPage extends IndexTabsPageContainer {
diff --git a/src/common/widgets/templates/CommonContainer.js b/src/common/widgets/templates/CommonContainer.js
@@ -12,6 +12,7 @@ import {TemplateBase} from './TemplateBase';
  * @param {string} options.id - 组件 dom 元素 id。
  * @param {string} options.title - 标题。
  * @category Widgets Common
+ * @extends {SuperMap.Widgets.TemplateBase}
  */
 export class CommonContainer extends TemplateBase {
     constructor(options) {
diff --git a/src/common/widgets/templates/DropDownBox.js b/src/common/widgets/templates/DropDownBox.js
@@ -17,6 +17,7 @@ import {TemplateBase} from './TemplateBase';
  * @param {string} [optionsArr.icon.className] - 下拉框图标类名。
  * @param {string} [optionsArr.icon.background] - 下拉框图标背景 url。
  * @category Widgets Common
+ * @extends {SuperMap.Widgets.TemplateBase}
  */
 export class DropDownBox extends TemplateBase {
     constructor(optionsArr) {
diff --git a/src/common/widgets/templates/IndexTabsPageContainer.js b/src/common/widgets/templates/IndexTabsPageContainer.js
@@ -11,6 +11,7 @@ import {TemplateBase} from './TemplateBase';
  * @param {Object} options - 可选参数。
  * @param {string} options.id - 组件 dom 元素 id。
  * @category Widgets Common
+ * @extends {SuperMap.Widgets.TemplateBase}
  */
 export class IndexTabsPageContainer extends TemplateBase {
     constructor(options) {
diff --git a/src/common/widgets/templates/NavTabsPage.js b/src/common/widgets/templates/NavTabsPage.js
@@ -11,6 +11,7 @@ import {TemplateBase} from './TemplateBase';
  * @param {Object} options - 组件配置参数。
  * @param {string} optionsArr.id - 组件 dom 元素 id。
  * @param {Array.<Object>} [options.tabs=[]] - 标签对象数组，形如：[{title: "",content: HTMLElement}]，初始时，传入则创建页面。
+ * @extends {SuperMap.Widgets.TemplateBase}
  * @category Widgets Common
  */
 //  todo 思考拆分的控件应该以哪种方式使用
diff --git a/src/common/widgets/templates/PaginationContainer.js b/src/common/widgets/templates/PaginationContainer.js
@@ -12,6 +12,7 @@ import {TemplateBase} from './TemplateBase';
  * @param {string} optionsArr.id - 组件 dom 元素 id。
  * @param {HTMLElement} options.contents - 页面填充的 DOM 元素对象。
  * @param {number} options.pageCounts - 页数。
+ * @extends {SuperMap.Widgets.TemplateBase}
  * @category Widgets Common
  */
 export class PaginationContainer extends TemplateBase {
diff --git a/src/common/widgets/templates/PopContainer.js b/src/common/widgets/templates/PopContainer.js
@@ -11,6 +11,7 @@ import {TemplateBase} from './TemplateBase';
  * @param {Object} options - 组件配置参数。
  * @param {string} options.id - 组件 dom 元素 id。
  * @param {string} options.title - 弹框组件名称。
+ * @extends {SuperMap.Widgets.TemplateBase}
  * @category Widgets Common
  */
 export class PopContainer extends TemplateBase {
diff --git a/src/common/widgets/templates/Select.js b/src/common/widgets/templates/Select.js
@@ -13,6 +13,7 @@ import {TemplateBase} from './TemplateBase';
  * @param {string} [options.labelName] - label 名称。
  * @param {Array.<string>} options.optionsArr - 需要创建的 option 数据数组。
  * @param {Function} [options.optionsClickCb] - option 点击事件回调函数。
+ * @extends {SuperMap.Widgets.TemplateBase}
  * @category Widgets Common
  */
 export class Select extends TemplateBase {
diff --git a/src/leaflet/services/MeasureService.js b/src/leaflet/services/MeasureService.js
@@ -24,6 +24,7 @@ import {MeasureMode, MeasureService as CommonMeasureService, MeasureParameters}
  * @param {string} [options.proxy] - 服务代理地址。
  * @param {SuperMap.ServerType} [options.serverType=SuperMap.ServerType.ISERVER] - 服务来源 iServer|iPortal|online。
  * @param {boolean} [options.withCredentials=false] - 请求是否携带 cookie。
+ * @extends {L.supermap.ServiceBase}
  */
 export var MeasureService = ServiceBase.extend({
 
diff --git a/src/leaflet/services/NetworkAnalystService.js b/src/leaflet/services/NetworkAnalystService.js
@@ -36,6 +36,7 @@ import {
  * @param {string} [options.proxy] - 服务代理地址。
  * @param {SuperMap.ServerType} [options.serverType=SuperMap.ServerType.ISERVER] - 服务来源 iServer|iPortal|online。
  * @param {boolean} [options.withCredentials=false] - 请求是否携带 cookie。
+ * @extends {L.supermap.ServiceBase}
  */
 export var NetworkAnalystService = ServiceBase.extend({
 
diff --git a/src/leaflet/services/ServiceBase.js b/src/leaflet/services/ServiceBase.js
@@ -14,6 +14,7 @@ import L from "leaflet";
  * @param {boolean} [options.withCredentials=false] - 请求是否携带 cookie。
  * @fires L.supermap.ServiceBase#initialized
  * @fires L.supermap.ServiceBase#destroy
+ * @extends {L.Evented}
  */
 export var ServiceBase = L.Evented.extend({
 
diff --git a/src/leaflet/services/SpatialAnalystService.js b/src/leaflet/services/SpatialAnalystService.js
@@ -40,6 +40,7 @@ import {
  * @param {string} [options.proxy] - 服务代理地址。
  * @param {SuperMap.ServerType} [options.serverType=SuperMap.ServerType.ISERVER] - 服务来源 iServer|iPortal|online。
  * @param {boolean} [options.withCredentials=false] - 请求是否携带 cookie。
+ * @extends {L.supermap.ServiceBase}
  */
 export var SpatialAnalystService = ServiceBase.extend({
 
diff --git a/src/leaflet/widgets/WidgetsViewBase.js b/src/leaflet/widgets/WidgetsViewBase.js
@@ -5,13 +5,15 @@ import L from "leaflet";
 import '../core/Base';
 
 /**
- * @class WidgetsViewBase
- * @classdesc lealfet 微件基类。
+ * @class L.supermap.widgets.WidgetsViewBase
+ * @classdesc Lealfet 微件基类。
+ * @category Widgets Common
  * @version 9.1.1
  * @param {Object} options - 参数。
  * @param {string} [options.position='topright'] - 微件在地图中显示的位置，包括：'topleft'，'topright'，'bottomleft' 和 'bottomright'，继承自 leaflet control。
  * @param {function} [options.style] - 设置图层点线面默认样式，点样式返回 maker 或者 circleMaker；线和面返回 L.path 样式。
  * @param {function} [options.onEachFeature] - 在创建和设置样式后，将为每个创建的要素调用一次的函数。用于将事件和弹出窗口附加到要素。默认情况下，对新创建的图层不执行任何操作。
+ * @extends {L.Control}
  */
 export var WidgetsViewBase = L.Control.extend({
     options: {
diff --git a/src/leaflet/widgets/clientcomputation/ClientComputationView.js b/src/leaflet/widgets/clientcomputation/ClientComputationView.js
@@ -19,6 +19,7 @@ import { CommonContainer, DropDownBox, Select, MessageBox, Lang } from '@superma
  * @fires L.supermap.widgets.clientComputation#analysisfailed
  * @fires L.supermap.widgets.clientComputation#layersremoved
  * @category Widgets ClientComputation
+ * @extends {L.supermap.widgets.widgetsViewBase}
  */
 export var ClientComputationView = WidgetsViewBase.extend({
 
diff --git a/src/leaflet/widgets/clientcomputation/ClientComputationViewModel.js b/src/leaflet/widgets/clientcomputation/ClientComputationViewModel.js
@@ -18,6 +18,7 @@ import {AttributesPopContainer} from '@supermap/iclient-common';
  * @fires L.supermap.widgets.clientComputationViewModel#analysissucceeded
  * @fires L.supermap.widgets.clientComputationViewModel#layerloaded
  * @fires L.supermap.widgets.clientComputationViewModel#layersremoved
+ * @extends {L.Evented}
  */
 export class ClientComputationViewModel extends L.Evented {
     initialize(workerUrl) {
diff --git a/src/leaflet/widgets/dataflow/DataFlowView.js b/src/leaflet/widgets/dataflow/DataFlowView.js
@@ -24,6 +24,7 @@ import {DataFlowViewModel} from './DataFlowViewModel';
                                             }`
  * @param {function} [options.onEachFeature] - 在创建和设置样式后，将为每个创建的要素调用一次的函数。用于将事件和弹出窗口附加到要素。默认情况下，对新创建的图层不执行任何操作。
  * @fires L.supermap.widgets.dataFlow#dataupdated
+ * @extends {L.supermap.widgets.widgetsViewBase}
  */
 export var DataFlowView = WidgetsViewBase.extend({
     initialize(options) {
diff --git a/src/leaflet/widgets/dataflow/DataFlowViewModel.js b/src/leaflet/widgets/dataflow/DataFlowViewModel.js
@@ -28,6 +28,7 @@ import {CommontypesConversion} from '../../core/CommontypesConversion';
  * @fires L.supermap.widgets.dataFlowViewModel#subscribesucceeded
  * @fires L.supermap.widgets.dataFlowViewModel#subscribefailed
  * @fires L.supermap.widgets.dataFlowViewModel#dataupdated
+ * @extends {L.Evented}
  */
 export var DataFlowViewModel = L.Evented.extend({
     options: {
diff --git a/src/leaflet/widgets/dataservicequery/DataServiceQueryView.js b/src/leaflet/widgets/dataservicequery/DataServiceQueryView.js
@@ -30,6 +30,7 @@ import {
  * @fires L.supermap.widgets.dataServiceQuery#getfeaturessucceeded
  * @fires L.supermap.widgets.dataServiceQuery#getfeaturesfailed
  * @category Widgets DataServiceQuery
+ * @extends {L.supermap.widgets.widgetsViewBase}
  */
 export var DataServiceQueryView = WidgetsViewBase.extend({
 
diff --git a/src/leaflet/widgets/dataservicequery/DataServiceQueryViewModel.js b/src/leaflet/widgets/dataservicequery/DataServiceQueryViewModel.js
@@ -14,6 +14,7 @@ import { GetFeaturesByIDsParameters, GetFeaturesBySQLParameters, GetFeaturesByBo
  * @param {string} dataserviceUrl - 数据服务地址。
  * @fires L.supermap.widgets.dataServiceQueryViewModel#getfeaturessucceeded
  * @fires L.supermap.widgets.dataServiceQueryViewModel#getfeaturesfailed
+ * @extends {L.Evented}
  */
 export class DataServiceQueryViewModel extends L.Evented {
 
diff --git a/src/leaflet/widgets/distributedanalysis/DistributedAnalysisModel.js b/src/leaflet/widgets/distributedanalysis/DistributedAnalysisModel.js
@@ -13,6 +13,7 @@ import { FetchRequest } from '@supermap/iclient-common';
  * @param {string} processingUrl - 分布式分析地址。
  * @fires L.supermap.widgets.DistributedAnalysisModel#datasetsloaded
  * @fires L.supermap.widgets.DistributedAnalysisModel#datasetinfoloaded
+ * @extends {L.Evented}
  */
 export class DistributedAnalysisModel extends L.Evented {
     
diff --git a/src/leaflet/widgets/distributedanalysis/DistributedAnalysisView.js b/src/leaflet/widgets/distributedanalysis/DistributedAnalysisView.js
@@ -18,6 +18,7 @@ import { CommonContainer, DropDownBox, Select, MessageBox, Lang, KernelDensityJo
  * @fires L.supermap.widgets.distributedAnalysis#analysissucceeded
  * @fires L.supermap.widgets.distributedAnalysis#analysisfailed
  * @fires L.supermap.widgets.distributedAnalysis#layersremoved
+ * @extends {L.supermap.widgets.widgetsViewBase}
  * @category Widgets DistributedAnalysis
  */
 export var DistributedAnalysisView = WidgetsViewBase.extend({
diff --git a/src/leaflet/widgets/distributedanalysis/DistributedAnalysisViewModel.js b/src/leaflet/widgets/distributedanalysis/DistributedAnalysisViewModel.js
@@ -18,6 +18,7 @@ import { ProcessingService } from '../../services/ProcessingService'
  * @fires L.supermap.widgets.distributedAnalysisViewModel#analysissucceeded
  * @fires L.supermap.widgets.distributedAnalysisViewModel#layerloaded
  * @fires L.supermap.widgets.distributedAnalysisViewModel#layersremoved
+ * @extends {L.Evented}
  */
 export class DistributedAnalysisViewModel extends L.Evented {
     initialize(processingUrl) {
diff --git a/src/leaflet/widgets/openfile/OpenFileView.js b/src/leaflet/widgets/openfile/OpenFileView.js
@@ -16,6 +16,7 @@ import {MessageBox, Lang} from '@supermap/iclient-common';
  * @param {function} [options.onEachFeature] - 在创建和设置样式后，将为每个创建的要素调用一次的函数。用于将事件和弹出窗口附加到要素。默认情况下，对新创建的图层不执行任何操作。
  * @fires L.supermap.widgets.openFile#openfilesucceeded
  * @fires L.supermap.widgets.openFile#openfilefailed
+ * @extends {L.supermap.widgets.widgetsViewBase}
  * @category Widgets OpenFile
  */
 export var OpenFileView = WidgetsViewBase.extend({
diff --git a/src/leaflet/widgets/openfile/OpenFileViewModel.js b/src/leaflet/widgets/openfile/OpenFileViewModel.js
@@ -20,6 +20,7 @@ import {
  * @fires L.supermap.widgets.openFileViewModel#errorfileformat
  * @fires L.supermap.widgets.openFileViewModel#openfilesucceeded
  * @fires L.supermap.widgets.openFileViewModel#openfilefailed
+ * @extends {L.Evented}
  */
 export var OpenFileViewModel = L.Evented.extend({
     initialize() {
diff --git a/src/leaflet/widgets/search/SearchView.js b/src/leaflet/widgets/search/SearchView.js
@@ -37,7 +37,7 @@ import {
  * @param {string} [options.position='topright'] - 微件在地图中显示的位置，包括：'topleft'，'topright'，'bottomleft' 和 'bottomright'，继承自 leaflet control。
  * @param {function} [options.style] - 设置图层点线面默认样式，点样式返回 maker 或者 circleMaker；线和面返回 L.path 样式。
  * @param {function} [options.onEachFeature] - 在创建和设置样式后，将为每个创建的要素调用一次的函数。用于将事件和弹出窗口附加到要素。默认情况下，对新创建的图层不执行任何操作。
- * @extends {L.Control}
+ * @extends {L.supermap.widgets.widgetsViewBase}
  * @fires L.supermap.widgets.search#searchlayersucceeded
  * @fires L.supermap.widgets.search#searchfailed
  * @fires L.supermap.widgets.search#geocodesucceeded
@@ -88,7 +88,7 @@ export var SearchView = WidgetsViewBase.extend({
     /**
      * @function L.supermap.widgets.search.prototype._initView
      * @description 创建地址匹配或图层要素查询微件。
-     * @override  //todo 复写的方法是否要加上 这个标签
+     * @override
      * @returns {HTMLElement}
      * @private
      */
diff --git a/src/leaflet/widgets/search/SearchViewModel.js b/src/leaflet/widgets/search/SearchViewModel.js
@@ -22,6 +22,7 @@ import {
  * @fires L.supermap.widgets.searchViewModel#searchlayersucceeded
  * @fires L.supermap.widgets.searchViewModel#searchfailed
  * @fires L.supermap.widgets.searchViewModel#geocodesucceeded
+ * @extends {L.Evented}
  */
 export var SearchViewModel = L.Evented.extend({
     options: {
