Remove 'struct' jsdoc tags, code indentation

This commit is contained in:
Frederic Junod
2018-07-18 09:07:19 +02:00
parent b4e0d4c188
commit 65b306891b
26 changed files with 248 additions and 278 deletions

View File

@@ -9,7 +9,6 @@
* Base class for WFS GetFeature filters. * Base class for WFS GetFeature filters.
* *
* @abstract * @abstract
* @struct
*/ */
class Filter { class Filter {
/** /**

View File

@@ -5,7 +5,6 @@
/** /**
* Context for drawing geometries. A vector context is available on render * Context for drawing geometries. A vector context is available on render
* events and does not need to be constructed directly. * events and does not need to be constructed directly.
* @struct
* @api * @api
*/ */
class VectorContext { class VectorContext {
@@ -45,8 +44,7 @@ class VectorContext {
drawFeature(feature, style) {} drawFeature(feature, style) {}
/** /**
* @param {module:ol/geom/GeometryCollection} geometryCollectionGeometry Geometry * @param {module:ol/geom/GeometryCollection} geometryCollectionGeometry Geometry collection.
* collection.
* @param {module:ol/Feature} feature Feature. * @param {module:ol/Feature} feature Feature.
*/ */
drawGeometryCollection(geometryCollectionGeometry, feature) {} drawGeometryCollection(geometryCollectionGeometry, feature) {}

View File

@@ -12,7 +12,6 @@ class CanvasImageReplay extends CanvasReplay {
* @param {number} pixelRatio Pixel ratio. * @param {number} pixelRatio Pixel ratio.
* @param {boolean} overlaps The replay can have overlapping geometries. * @param {boolean} overlaps The replay can have overlapping geometries.
* @param {?} declutterTree Declutter tree. * @param {?} declutterTree Declutter tree.
* @struct
*/ */
constructor(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree) { constructor(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree) {
super(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree); super(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree);

View File

@@ -31,7 +31,6 @@ class CanvasImmediateRenderer extends VectorContext {
* @param {module:ol/extent~Extent} extent Extent. * @param {module:ol/extent~Extent} extent Extent.
* @param {module:ol/transform~Transform} transform Transform. * @param {module:ol/transform~Transform} transform Transform.
* @param {number} viewRotation View rotation. * @param {number} viewRotation View rotation.
* @struct
*/ */
constructor(context, pixelRatio, extent, transform, viewRotation) { constructor(context, pixelRatio, extent, transform, viewRotation) {
super(); super();

View File

@@ -12,7 +12,6 @@ class CanvasLineStringReplay extends CanvasReplay {
* @param {number} pixelRatio Pixel ratio. * @param {number} pixelRatio Pixel ratio.
* @param {boolean} overlaps The replay can have overlapping geometries. * @param {boolean} overlaps The replay can have overlapping geometries.
* @param {?} declutterTree Declutter tree. * @param {?} declutterTree Declutter tree.
* @struct
*/ */
constructor(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree) { constructor(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree) {
super(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree); super(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree);

View File

@@ -18,7 +18,6 @@ class CanvasPolygonReplay extends CanvasReplay {
* @param {number} pixelRatio Pixel ratio. * @param {number} pixelRatio Pixel ratio.
* @param {boolean} overlaps The replay can have overlapping geometries. * @param {boolean} overlaps The replay can have overlapping geometries.
* @param {?} declutterTree Declutter tree. * @param {?} declutterTree Declutter tree.
* @struct
*/ */
constructor(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree) { constructor(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree) {
super(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree); super(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree);

View File

@@ -49,7 +49,6 @@ class CanvasReplay extends VectorContext {
* @param {number} pixelRatio Pixel ratio. * @param {number} pixelRatio Pixel ratio.
* @param {boolean} overlaps The replay can have overlapping geometries. * @param {boolean} overlaps The replay can have overlapping geometries.
* @param {?} declutterTree Declutter tree. * @param {?} declutterTree Declutter tree.
* @struct
*/ */
constructor(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree) { constructor(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree) {
super(); super();

View File

@@ -40,10 +40,8 @@ class CanvasReplayGroup extends ReplayGroup {
* @param {number} resolution Resolution. * @param {number} resolution Resolution.
* @param {number} pixelRatio Pixel ratio. * @param {number} pixelRatio Pixel ratio.
* @param {boolean} overlaps The replay group can have overlapping geometries. * @param {boolean} overlaps The replay group can have overlapping geometries.
* @param {?} declutterTree Declutter tree * @param {?} declutterTree Declutter tree for declutter processing in postrender.
* for declutter processing in postrender.
* @param {number=} opt_renderBuffer Optional rendering buffer. * @param {number=} opt_renderBuffer Optional rendering buffer.
* @struct
*/ */
constructor( constructor(
tolerance, tolerance,

View File

@@ -22,7 +22,6 @@ class CanvasTextReplay extends CanvasReplay {
* @param {number} pixelRatio Pixel ratio. * @param {number} pixelRatio Pixel ratio.
* @param {boolean} overlaps The replay can have overlapping geometries. * @param {boolean} overlaps The replay can have overlapping geometries.
* @param {?} declutterTree Declutter tree. * @param {?} declutterTree Declutter tree.
* @struct
*/ */
constructor(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree) { constructor(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree) {
super(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree); super(tolerance, maxExtent, resolution, pixelRatio, overlaps, declutterTree);

View File

@@ -19,7 +19,6 @@ class WebGLCircleReplay extends WebGLReplay {
/** /**
* @param {number} tolerance Tolerance. * @param {number} tolerance Tolerance.
* @param {module:ol/extent~Extent} maxExtent Max extent. * @param {module:ol/extent~Extent} maxExtent Max extent.
* @struct
*/ */
constructor(tolerance, maxExtent) { constructor(tolerance, maxExtent) {
super(tolerance, maxExtent); super(tolerance, maxExtent);

View File

@@ -9,7 +9,6 @@ class WebGLImageReplay extends WebGLTextureReplay {
/** /**
* @param {number} tolerance Tolerance. * @param {number} tolerance Tolerance.
* @param {module:ol/extent~Extent} maxExtent Max extent. * @param {module:ol/extent~Extent} maxExtent Max extent.
* @struct
*/ */
constructor(tolerance, maxExtent) { constructor(tolerance, maxExtent) {
super(tolerance, maxExtent); super(tolerance, maxExtent);

View File

@@ -17,7 +17,6 @@ class WebGLImmediateRenderer extends VectorContext {
* @param {module:ol/size~Size} size Size. * @param {module:ol/size~Size} size Size.
* @param {module:ol/extent~Extent} extent Extent. * @param {module:ol/extent~Extent} extent Extent.
* @param {number} pixelRatio Pixel ratio. * @param {number} pixelRatio Pixel ratio.
* @struct
*/ */
constructor(context, center, resolution, rotation, size, extent, pixelRatio) { constructor(context, center, resolution, rotation, size, extent, pixelRatio) {
super(); super();

View File

@@ -39,7 +39,6 @@ class WebGLLineStringReplay extends WebGLReplay {
/** /**
* @param {number} tolerance Tolerance. * @param {number} tolerance Tolerance.
* @param {module:ol/extent~Extent} maxExtent Max extent. * @param {module:ol/extent~Extent} maxExtent Max extent.
* @struct
*/ */
constructor(tolerance, maxExtent) { constructor(tolerance, maxExtent) {
super(tolerance, maxExtent); super(tolerance, maxExtent);

View File

@@ -40,7 +40,6 @@ class WebGLPolygonReplay extends WebGLReplay {
/** /**
* @param {number} tolerance Tolerance. * @param {number} tolerance Tolerance.
* @param {module:ol/extent~Extent} maxExtent Max extent. * @param {module:ol/extent~Extent} maxExtent Max extent.
* @struct
*/ */
constructor(tolerance, maxExtent) { constructor(tolerance, maxExtent) {
super(tolerance, maxExtent); super(tolerance, maxExtent);

View File

@@ -19,7 +19,6 @@ class WebGLReplay extends VectorContext {
/** /**
* @param {number} tolerance Tolerance. * @param {number} tolerance Tolerance.
* @param {module:ol/extent~Extent} maxExtent Max extent. * @param {module:ol/extent~Extent} maxExtent Max extent.
* @struct
*/ */
constructor(tolerance, maxExtent) { constructor(tolerance, maxExtent) {
super(); super();
@@ -186,8 +185,7 @@ class WebGLReplay extends VectorContext {
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features to skip. * @param {Object.<string, boolean>} skippedFeaturesHash Ids of features to skip.
* @param {function((module:ol/Feature|module:ol/render/Feature)): T|undefined} featureCallback Feature callback. * @param {function((module:ol/Feature|module:ol/render/Feature)): T|undefined} featureCallback Feature callback.
* @param {boolean} oneByOne Draw features one-by-one for the hit-detecion. * @param {boolean} oneByOne Draw features one-by-one for the hit-detecion.
* @param {module:ol/extent~Extent=} opt_hitExtent Hit extent: Only features intersecting * @param {module:ol/extent~Extent=} opt_hitExtent Hit extent: Only features intersecting this extent are checked.
* this extent are checked.
* @return {T|undefined} Callback result. * @return {T|undefined} Callback result.
* @template T * @template T
*/ */
@@ -235,8 +233,7 @@ class WebGLReplay extends VectorContext {
* @param {Object.<string, boolean>} skippedFeaturesHash Ids of features to skip. * @param {Object.<string, boolean>} skippedFeaturesHash Ids of features to skip.
* @param {function((module:ol/Feature|module:ol/render/Feature)): T|undefined} featureCallback Feature callback. * @param {function((module:ol/Feature|module:ol/render/Feature)): T|undefined} featureCallback Feature callback.
* @param {boolean} oneByOne Draw features one-by-one for the hit-detecion. * @param {boolean} oneByOne Draw features one-by-one for the hit-detecion.
* @param {module:ol/extent~Extent=} opt_hitExtent Hit extent: Only features intersecting * @param {module:ol/extent~Extent=} opt_hitExtent Hit extent: Only features intersecting this extent are checked.
* this extent are checked.
* @return {T|undefined} Callback result. * @return {T|undefined} Callback result.
* @template T * @template T
*/ */

View File

@@ -37,7 +37,6 @@ class WebGLReplayGroup extends ReplayGroup {
* @param {number} tolerance Tolerance. * @param {number} tolerance Tolerance.
* @param {module:ol/extent~Extent} maxExtent Max extent. * @param {module:ol/extent~Extent} maxExtent Max extent.
* @param {number=} opt_renderBuffer Render buffer. * @param {number=} opt_renderBuffer Render buffer.
* @struct
*/ */
constructor(tolerance, maxExtent, opt_renderBuffer) { constructor(tolerance, maxExtent, opt_renderBuffer) {
super(); super();

View File

@@ -26,7 +26,6 @@ class WebGLTextReplay extends WebGLTextureReplay {
/** /**
* @param {number} tolerance Tolerance. * @param {number} tolerance Tolerance.
* @param {module:ol/extent~Extent} maxExtent Max extent. * @param {module:ol/extent~Extent} maxExtent Max extent.
* @struct
*/ */
constructor(tolerance, maxExtent) { constructor(tolerance, maxExtent) {
super(tolerance, maxExtent); super(tolerance, maxExtent);

View File

@@ -14,7 +14,6 @@ class WebGLTextureReplay extends WebGLReplay {
/** /**
* @param {number} tolerance Tolerance. * @param {number} tolerance Tolerance.
* @param {module:ol/extent~Extent} maxExtent Max extent. * @param {module:ol/extent~Extent} maxExtent Max extent.
* @struct
*/ */
constructor(tolerance, maxExtent) { constructor(tolerance, maxExtent) {
super(tolerance, maxExtent); super(tolerance, maxExtent);

View File

@@ -14,7 +14,6 @@ class LayerRenderer extends Observable {
/** /**
* @param {module:ol/layer/Layer} layer Layer. * @param {module:ol/layer/Layer} layer Layer.
* @struct
*/ */
constructor(layer) { constructor(layer) {

View File

@@ -16,7 +16,6 @@ class MapRenderer extends Disposable {
/** /**
* @param {module:ol/PluggableMap} map Map. * @param {module:ol/PluggableMap} map Map.
* @struct
*/ */
constructor(map) { constructor(map) {
super(); super();

View File

@@ -24,7 +24,6 @@ class LRUCache extends EventTarget {
* items from the cache is the responsibility of the user. * items from the cache is the responsibility of the user.
* *
* @fires module:ol/events/Event~Event * @fires module:ol/events/Event~Event
* @struct
* @template T * @template T
* @param {number=} opt_highWaterMark High water mark. * @param {number=} opt_highWaterMark High water mark.
*/ */

View File

@@ -23,7 +23,6 @@ class PriorityQueue {
* *
* @param {function(T): number} priorityFunction Priority function. * @param {function(T): number} priorityFunction Priority function.
* @param {function(T): string} keyFunction Key function. * @param {function(T): string} keyFunction Key function.
* @struct
* @template T * @template T
*/ */
constructor(priorityFunction, keyFunction) { constructor(priorityFunction, keyFunction) {

View File

@@ -22,7 +22,6 @@ class RBush {
* *
* @param {number=} opt_maxEntries Max entries. * @param {number=} opt_maxEntries Max entries.
* @see https://github.com/mourner/rbush * @see https://github.com/mourner/rbush
* @struct
* @template T * @template T
*/ */
constructor(opt_maxEntries) { constructor(opt_maxEntries) {

View File

@@ -31,7 +31,6 @@ class Atlas {
* managed with the bin packing algorithm described in: * managed with the bin packing algorithm described in:
* http://www.blackpawn.com/texts/lightmaps/ * http://www.blackpawn.com/texts/lightmaps/
* *
* @struct
* @param {number} size The size in pixels of the sprite image. * @param {number} size The size in pixels of the sprite image.
* @param {number} space The space in pixels between images. * @param {number} space The space in pixels between images.
* Because texture coordinates are float values, the edges of * Because texture coordinates are float values, the edges of

View File

@@ -54,7 +54,6 @@ class AtlasManager {
* If an application uses many images or very large images, it is recommended * If an application uses many images or very large images, it is recommended
* to set a higher `size` value to avoid the creation of too many atlases. * to set a higher `size` value to avoid the creation of too many atlases.
* *
* @struct
* @api * @api
* @param {module:ol/style/AtlasManager~Options=} opt_options Options. * @param {module:ol/style/AtlasManager~Options=} opt_options Options.
*/ */

View File

@@ -51,7 +51,6 @@ class WMTSTileGrid extends TileGrid {
* Set the grid pattern for sources accessing WMTS tiled-image servers. * Set the grid pattern for sources accessing WMTS tiled-image servers.
* *
* @param {module:ol/tilegrid/WMTS~Options} options WMTS options. * @param {module:ol/tilegrid/WMTS~Options} options WMTS options.
* @struct
* @api * @api
*/ */
constructor(options) { constructor(options) {