【API】jsdoc优化

chenmeiyiSupermap · chenmeiyiSupermap · commit 362dc556573a · 2018-06-29T09:02:10.000+08:00
diff --git a/src/common/iServer/InterpolationDensityAnalystParameters.js b/src/common/iServer/InterpolationDensityAnalystParameters.js
@@ -7,17 +7,17 @@ import {InterpolationAnalystParameters} from './InterpolationAnalystParameters';
  * @category iServer SpatialAnalyst InterpolationAnalyst
  * @classdesc 点密度差值分析参数类。
  * @param {Object} options - 参数。</br>
- *        {(SuperMap.Bounds|L.Bounds|ol.extent)} options.bounds - 插值分析的范围，用于确定结果栅格数据集的范围。</br>
- *        {number} [options.searchRadius=0] - 查找半径，即参与运算点的查找范围，与点数据集单位相同。</br>
- *        {string} options.zValueFieldName - 存储用于进行插值分析的字段名称，插值分析不支持文本类型的字段。当插值分析类型( SuperMap.InterpolationAnalystType)为 dataset 时，必设参数。</br>
- *        {number} [options.zValueScale=1] - 用于进行插值分析值的缩放比率。</br>
- *        {number} options.resolution - 插值结果栅格数据集的分辨率，即一个像元所代表的实地距离，与点数据集单位相同。</br>
- *        {SuperMap.FilterParameter} options.filterQueryParameter - 属性过滤条件。</br>
- *        {string} options.outputDatasetName - 插值分析结果数据集的名称。必设参数</br>
- *        {string} options.outputDatasourceName - 插值分析结果数据源的名称。必设参数</br>
- *        {string} options.pixelFormat - 指定结果栅格数据集存储的像素格式。</br>
- *        {string} options.dataset - 用来做插值分析的数据源中数据集的名称，该名称用形如"数据集名称@数据源别名"形式来表示。当插值分析类型( SuperMap.InterpolationAnalystType)为 dataset 时，必设参数。</br>
- *        {Array.<SuperMap.Geometry.Point|L.LatLng|L.Point|ol.geom.Point>} options.inputPoints - 用于做插值分析的离散点集合。当插值分析类型（ SuperMap.InterpolationAnalystType）为 geometry 时，必设参数。
+ * @param {(SuperMap.Bounds|L.Bounds|ol.extent)} options.bounds - 插值分析的范围，用于确定结果栅格数据集的范围。</br>
+ * @param {number} [options.searchRadius=0] - 查找半径，即参与运算点的查找范围，与点数据集单位相同。</br>
+ * @param {string} options.zValueFieldName - 存储用于进行插值分析的字段名称，插值分析不支持文本类型的字段。当插值分析类型( SuperMap.InterpolationAnalystType)为 dataset 时，必设参数。</br>
+ * @param {number} [options.zValueScale=1] - 用于进行插值分析值的缩放比率。</br>
+ * @param {number} options.resolution - 插值结果栅格数据集的分辨率，即一个像元所代表的实地距离，与点数据集单位相同。</br>
+ * @param {SuperMap.FilterParameter} options.filterQueryParameter - 属性过滤条件。</br>
+ * @param {string} options.outputDatasetName - 插值分析结果数据集的名称。必设参数</br>
+ * @param {string} options.outputDatasourceName - 插值分析结果数据源的名称。必设参数</br>
+ * @param {string} options.pixelFormat - 指定结果栅格数据集存储的像素格式。</br>
+ * @param {string} options.dataset - 用来做插值分析的数据源中数据集的名称，该名称用形如"数据集名称@数据源别名"形式来表示。当插值分析类型( SuperMap.InterpolationAnalystType)为 dataset 时，必设参数。</br>
+ * @param {Array.<SuperMap.Geometry.Point|L.LatLng|L.Point|ol.geom.Point>} options.inputPoints - 用于做插值分析的离散点集合。当插值分析类型（ SuperMap.InterpolationAnalystType）为 geometry 时，必设参数。
  * @extends {SuperMap.InterpolationAnalystParameters}
  * @example
  * var myInterpolationDensityAnalystParameters = new SuperMap.InterpolationDensityAnalystParameters({
diff --git a/src/common/overlay/Bar.js b/src/common/overlay/Bar.js
@@ -58,7 +58,6 @@ import './feature/Line';
  * @param {Array.<string>} fields - data 属性中的参与此图表生成的属性字段名称，必设参数。
  * @param {SuperMap.Feature.Theme.Bar.setting} setting - 图表配置对象，必设参数。
  * @param {SuperMap.LonLat} lonlat - 专题要素地理位置。默认为 data 指代的地理要素 Bounds 中心。
- * @return {SuperMap.Feature.Theme.Bar} 返回一个柱状图表对象。
  */
 export class Bar extends Graph {
 
diff --git a/src/common/overlay/Bar3D.js b/src/common/overlay/Bar3D.js
@@ -14,7 +14,6 @@ import {Graph} from './Graph';
  * @param {Array.<string>} fields - data 中的参与此图表生成的字段名称，必设参数。
  * @param {SuperMap.Feature.Theme.Bar3D.setting} setting - 图表配置对象，必设参数。
  * @param {SuperMap.LonLat} lonlat - 专题要素地理位置。默认为 data 指代的地理要素 Bounds 中心。
- * @return {SuperMap.Feature.Theme.Bar3D} 返回一个三维柱状图表对象。
  *
  
  *
diff --git a/src/common/overlay/Circle.js b/src/common/overlay/Circle.js
@@ -14,7 +14,6 @@ import {RankSymbol} from './RankSymbol';
  * @param {Array.<string>} fields - data 中的参与此图表生成的字段名称，必设参数。
  * @param {SuperMap.Feature.Theme.Circle.setting} setting - 图表配置对象，必设参数。
  * @param {SuperMap.LonLat} lonlat - 专题要素地理位置。默认为 data 指代的地理要素 Bounds 中心。
- * @return {SuperMap.Feature.Theme.Circle} 返回一个圆图。
  */
 export class Circle extends RankSymbol {
 
diff --git a/src/common/overlay/Graph.js b/src/common/overlay/Graph.js
@@ -17,7 +17,6 @@ import {ShapeFactory} from './feature/ShapeFactory';
  * @param {Array.<string>} fields - data 中的参与此图表生成的字段名称，必设参数。
  * @param {Object} setting - 图表配置对象，必设参数。
  * @param {SuperMap.LonLat} lonlat - 专题要素地理位置。默认为 data 指代的地理要素 Bounds 中心。
- * @return {SuperMap.Feature.Theme.Graph} 返回一个统计专题要素。
  */
 export class Graph extends Theme {
 
diff --git a/src/common/overlay/Line.js b/src/common/overlay/Line.js
@@ -52,7 +52,6 @@ import {Graph} from './Graph';
  * @param {Array.<string>} fields - data 中的参与此图表生成的字段名称，必设参数。
  * @param {SuperMap.Feature.Theme.Line.setting} setting - 图表配置对象，必设参数。
  * @param {SuperMap.LonLat} lonlat - 专题要素地理位置。默认为 data 指代的地理要素 Bounds 中心。
- * @return {SuperMap.Feature.Theme.Line} 返回一个折线图。
  */
 export class Line extends Graph {
     /**
diff --git a/src/common/overlay/Ring.js b/src/common/overlay/Ring.js
@@ -51,8 +51,8 @@ import {Graph} from './Graph';
  *  }
  * ]
  * @param {Object} sectorHoverStyle - 环状图扇形 hover 状态时的样式，sectorHoverAble 为 true 时有效。
- * @param {Object} sectorHoverAble - 是否允许环状图扇形使用 hover 状态，默认允许。同时设置 sectorHoverAble 和 sectorClickAble 为 false，可以直接屏蔽环状图扇形对专题图层事件的响应。
- * @param {Object} sectorClickAble - 是否允许环状图扇形被点击，默认允许。同时设置 sectorHoverAble 和 sectorClickAble 为 false，可以直接屏蔽环状图扇形对专题图层事件的响应。
+ * @param {boolean} sectorHoverAble - 是否允许环状图扇形使用 hover 状态，默认允许。同时设置 sectorHoverAble 和 sectorClickAble 为 false，可以直接屏蔽环状图扇形对专题图层事件的响应。
+ * @param {boolean} sectorClickAble - 是否允许环状图扇形被点击，默认允许。同时设置 sectorHoverAble 和 sectorClickAble 为 false，可以直接屏蔽环状图扇形对专题图层事件的响应。
  *
  * @extends {SuperMap.Feature.Theme.Graph}
  */
diff --git a/src/common/overlay/feature/ShapeFactory.js b/src/common/overlay/feature/ShapeFactory.js
@@ -21,18 +21,16 @@ import {Util} from '../../commontypes/Util';
  * @class  SuperMap.Feature.ShapeFactory
  * @category Visualization Theme
  * @classdesc 图形工厂类。
- *
- * 目前支持创建的图形有：
- * 用于统计专题图：
- * 点 - 参数对象： <SuperMap.Feature.ShapeParameters.Point>
- * 线 - 参数对象： <SuperMap.Feature.ShapeParameters.Line>
- * 面 - 参数对象： <SuperMap.Feature.ShapeParameters.Polygon>
- * 矩形 - 参数对象： <SuperMap.Feature.ShapeParameters.Rectangle>
- * 扇形 - 参数对象： <SuperMap.Feature.ShapeParameters.Sector>
- * 标签 - 参数对象： <SuperMap.Feature.ShapeParameters.Label>
- * 图片 - 参数对象： <SuperMap.Feature.ShapeParameters.Image>
- *
- * 用于符号专题图：
+ * 目前支持创建的图形有：<br>
+ * 用于统计专题图：<br>
+ * 点 - 参数对象 <{@link SuperMap.Feature.ShapeParameters.Point}> <br>
+ * 线 - 参数对象 <{@link SuperMap.Feature.ShapeParameters.Line}> <br>
+ * 面 - 参数对象 <{@link SuperMap.Feature.ShapeParameters.Polygon}> <br>
+ * 矩形 - 参数对象 <{@link SuperMap.Feature.ShapeParameters.Rectangle}> <br>
+ * 扇形 - 参数对象 <{@link SuperMap.Feature.ShapeParameters.Sector}> <br>
+ * 标签 - 参数对象 <{@link SuperMap.Feature.ShapeParameters.Label}> <br>
+ * 图片 - 参数对象 <{@link SuperMap.Feature.ShapeParameters.Image}> <br>
+ * 用于符号专题图：<br>
  * 圆形 -  参数对象：<{@link SuperMap.Feature.ShapeParameters.Cilcle}>
  */
 export class ShapeFactory {
diff --git a/src/openlayers/overlay/RankSymbol.js b/src/openlayers/overlay/RankSymbol.js
@@ -21,16 +21,14 @@ import {Graph} from './Graph';
  * @param {string} opt_options.themeFields - 指定创建专题图字段。 <br>
  * @param {boolean} [opt_options.isOverLay=true] - 是否进行压盖处理，如果设为 true，图表绘制过程中将隐藏对已在图层中绘制的图表产生压盖的图表。<br>
  * @param {string} opt_options.chartsType - 图表类型。目前可用："Bar", "Line", "Pie"。<br>
- * @param {Object} opt_options.chartsSetting - 各类型图表的 chartsSetting 对象可设属性请参考具体图表模型类的注释中对 chartsSetting 对象可设属性的描述。chartsSetting 对象通常都具有以下 5 个基础可设属性：<br>
- *  * width - {number} 专题要素（图表）宽度，必设参数。
- *  * height - {number} 专题要素（图表）高度，必设参数。
- *  * codomain - {Array.<number>} 值域，长度为 2 的一维数组，第一个元素表示值域下限，第二个元素表示值域上限，必设参数。
- *  * XOffset - {number} 专题要素（图表）在 X 方向上的偏移值，单位像素。
- *  * YOffset - {number} 专题要素（图表）在 Y 方向上的偏移值，单位像素。
- *  * dataViewBoxParameter - {Array.<number>} 数据视图框 dataViewBox 参数，
- *  它是指图表框 chartBox （由图表位置、图表宽度、图表高度构成的图表范围框）在左、下，右，上四个方向上的内偏距值，长度为 4 的一维数组。
- *  * decimalNumber - {number} 数据值数组 dataValues 元素值小数位数，数据的小数位处理参数，取值范围：[0, 16]。
- *  如果不设置此参数，在取数据值时不对数据做小数位处理。
+ * @param {Object} opt_options.chartsSetting - 各类型图表的 chartsSetting 对象可设属性请参考具体图表模型类的注释中对 chartsSetting 对象可设属性的描述。chartsSetting 对象通常都具有以下几个基础可设属性：<br>
+ * @param {number} opt_options.chartsSetting.width - 专题要素（图表）宽度，必设参数。
+ * @param {number} opt_options.chartsSetting.height - 专题要素（图表）高度，必设参数。
+ * @param {Array.<number>} opt_options.chartsSetting.codomain - 值域，长度为 2 的一维数组，第一个元素表示值域下限，第二个元素表示值域上限，必设参数。
+ * @param {number} opt_options.chartsSetting.XOffset - 专题要素（图表）在 X 方向上的偏移值，单位像素。
+ * @param {number} opt_options.chartsSetting.YOffset - 专题要素（图表）在 Y 方向上的偏移值，单位像素。
+ * @param {Array.<number>} opt_options.chartsSetting.dataViewBoxParameter - 数据视图框 dataViewBox 参数，它是指图表框 chartBox（由图表位置、图表宽度、图表高度构成的图表范围框）在左、下，右，上四个方向上的内偏距值，长度为 4 的一维数组。
+ * @param {number} opt_options.chartsSetting.decimalNumber - 数据值数组 dataValues 元素值小数位数，数据的小数位处理参数，取值范围：[0, 16]。如果不设置此参数，在取数据值时不对数据做小数位处理。
  * @extends {ol.source.Graph}
  */
 export class RankSymbol extends Graph {

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,6 @@ import {Graph} from './Graph';`
`14`	`14`	`* @param {Array.<string>} fields - data 中的参与此图表生成的字段名称，必设参数。`
`15`	`15`	`* @param {SuperMap.Feature.Theme.Bar3D.setting} setting - 图表配置对象，必设参数。`
`16`	`16`	`* @param {SuperMap.LonLat} lonlat - 专题要素地理位置。默认为 data 指代的地理要素 Bounds 中心。`
`17`		`- * @return {SuperMap.Feature.Theme.Bar3D} 返回一个三维柱状图表对象。`
`18`	`17`	`*`
`19`	`18`
`20`	`19`	`*`