Add abstract tag at class level

This commit is contained in:
Frederic Junod
2016-12-16 15:42:53 +01:00
committed by Guillaume Beraudo
parent 2e63590791
commit 546fc97cd4
26 changed files with 26 additions and 0 deletions

View File

@@ -15,6 +15,7 @@ goog.require('ol.proj');
* file formats. See the documentation for each format for more details. * file formats. See the documentation for each format for more details.
* *
* @constructor * @constructor
* @abstract
* @api stable * @api stable
*/ */
ol.format.Feature = function() { ol.format.Feature = function() {

View File

@@ -31,6 +31,7 @@ goog.require('ol.xml');
* ol.format.GML3. * ol.format.GML3.
* *
* @constructor * @constructor
* @abstract
* @param {olx.format.GMLOptions=} opt_options * @param {olx.format.GMLOptions=} opt_options
* Optional configuration object. * Optional configuration object.
* @extends {ol.format.XMLFeature} * @extends {ol.format.XMLFeature}

View File

@@ -12,6 +12,7 @@ goog.require('ol.format.FormatType');
* Base class for JSON feature formats. * Base class for JSON feature formats.
* *
* @constructor * @constructor
* @abstract
* @extends {ol.format.Feature} * @extends {ol.format.Feature}
*/ */
ol.format.JSONFeature = function() { ol.format.JSONFeature = function() {

View File

@@ -12,6 +12,7 @@ goog.require('ol.format.FormatType');
* Base class for text feature formats. * Base class for text feature formats.
* *
* @constructor * @constructor
* @abstract
* @extends {ol.format.Feature} * @extends {ol.format.Feature}
*/ */
ol.format.TextFeature = function() { ol.format.TextFeature = function() {

View File

@@ -8,6 +8,7 @@ goog.require('ol.xml');
* Generic format for reading non-feature XML data * Generic format for reading non-feature XML data
* *
* @constructor * @constructor
* @abstract
* @struct * @struct
*/ */
ol.format.XML = function() { ol.format.XML = function() {

View File

@@ -14,6 +14,7 @@ goog.require('ol.xml');
* Base class for XML feature formats. * Base class for XML feature formats.
* *
* @constructor * @constructor
* @abstract
* @extends {ol.format.Feature} * @extends {ol.format.Feature}
*/ */
ol.format.XMLFeature = function() { ol.format.XMLFeature = function() {

View File

@@ -17,6 +17,7 @@ goog.require('ol.proj');
* generic `change` event on your geometry instance. * generic `change` event on your geometry instance.
* *
* @constructor * @constructor
* @abstract
* @extends {ol.Object} * @extends {ol.Object}
* @api stable * @api stable
*/ */

View File

@@ -15,6 +15,7 @@ goog.require('ol.obj');
* in apps, as cannot be rendered. * in apps, as cannot be rendered.
* *
* @constructor * @constructor
* @abstract
* @extends {ol.geom.Geometry} * @extends {ol.geom.Geometry}
* @api stable * @api stable
*/ */

View File

@@ -7,6 +7,7 @@ goog.require('ol.events.EventType');
/** /**
* @constructor * @constructor
* @abstract
* @extends {ol.events.EventTarget} * @extends {ol.events.EventTarget}
* @param {ol.Extent} extent Extent. * @param {ol.Extent} extent Extent.
* @param {number|undefined} resolution Resolution. * @param {number|undefined} resolution Resolution.

View File

@@ -16,6 +16,7 @@ goog.require('ol.obj');
* is observable, and has get/set accessors. * is observable, and has get/set accessors.
* *
* @constructor * @constructor
* @abstract
* @extends {ol.Object} * @extends {ol.Object}
* @param {olx.layer.BaseOptions} options Layer options. * @param {olx.layer.BaseOptions} options Layer options.
* @api stable * @api stable

View File

@@ -27,6 +27,7 @@ goog.require('ol.source.State');
* A generic `change` event is fired when the state of the source changes. * A generic `change` event is fired when the state of the source changes.
* *
* @constructor * @constructor
* @abstract
* @extends {ol.layer.Base} * @extends {ol.layer.Base}
* @fires ol.render.Event * @fires ol.render.Event
* @param {olx.layer.LayerOptions} options Layer options. * @param {olx.layer.LayerOptions} options Layer options.

View File

@@ -4,6 +4,7 @@ goog.provide('ol.render.ReplayGroup');
/** /**
* Base class for replay groups. * Base class for replay groups.
* @constructor * @constructor
* @abstract
*/ */
ol.render.ReplayGroup = function() {}; ol.render.ReplayGroup = function() {};

View File

@@ -5,6 +5,7 @@ goog.provide('ol.render.VectorContext');
* 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.
* @constructor * @constructor
* @abstract
* @struct * @struct
* @api * @api
*/ */

View File

@@ -12,6 +12,7 @@ if (ol.ENABLE_WEBGL) {
/** /**
* @constructor * @constructor
* @abstract
* @extends {ol.render.VectorContext} * @extends {ol.render.VectorContext}
* @param {number} tolerance Tolerance. * @param {number} tolerance Tolerance.
* @param {ol.Extent} maxExtent Max extent. * @param {ol.Extent} maxExtent Max extent.

View File

@@ -7,6 +7,7 @@ if (ol.ENABLE_WEBGL) {
/** /**
* @constructor * @constructor
* @abstract
* @param {number} tolerance Tolerance. * @param {number} tolerance Tolerance.
* @param {ol.Extent} maxExtent Max extent. * @param {ol.Extent} maxExtent Max extent.
* @struct * @struct

View File

@@ -9,6 +9,7 @@ goog.require('ol.transform');
/** /**
* @constructor * @constructor
* @abstract
* @extends {ol.renderer.canvas.Layer} * @extends {ol.renderer.canvas.Layer}
* @param {ol.layer.Layer} layer Layer. * @param {ol.layer.Layer} layer Layer.
*/ */

View File

@@ -13,6 +13,7 @@ goog.require('ol.transform');
/** /**
* @constructor * @constructor
* @abstract
* @extends {ol.renderer.Layer} * @extends {ol.renderer.Layer}
* @param {ol.layer.Layer} layer Layer. * @param {ol.layer.Layer} layer Layer.
*/ */

View File

@@ -13,6 +13,7 @@ goog.require('ol.transform');
/** /**
* @constructor * @constructor
* @abstract
* @extends {ol.Disposable} * @extends {ol.Disposable}
* @param {Element} container Container. * @param {Element} container Container.
* @param {ol.Map} map Map. * @param {ol.Map} map Map.

View File

@@ -17,6 +17,7 @@ if (ol.ENABLE_WEBGL) {
/** /**
* @constructor * @constructor
* @abstract
* @extends {ol.renderer.Layer} * @extends {ol.renderer.Layer}
* @param {ol.renderer.webgl.Map} mapRenderer Map renderer. * @param {ol.renderer.webgl.Map} mapRenderer Map renderer.
* @param {ol.layer.Layer} layer Layer. * @param {ol.layer.Layer} layer Layer.

View File

@@ -17,6 +17,7 @@ goog.require('ol.source.Source');
* Base class for sources providing a single image. * Base class for sources providing a single image.
* *
* @constructor * @constructor
* @abstract
* @extends {ol.source.Source} * @extends {ol.source.Source}
* @param {ol.SourceImageOptions} options Single image source options. * @param {ol.SourceImageOptions} options Single image source options.
* @api * @api

View File

@@ -16,6 +16,7 @@ goog.require('ol.source.State');
* A generic `change` event is triggered when the state of the source changes. * A generic `change` event is triggered when the state of the source changes.
* *
* @constructor * @constructor
* @abstract
* @extends {ol.Object} * @extends {ol.Object}
* @param {ol.SourceSourceOptions} options Source options. * @param {ol.SourceSourceOptions} options Source options.
* @api stable * @api stable

View File

@@ -18,6 +18,7 @@ goog.require('ol.tilegrid');
* Base class for sources providing images divided into a tile grid. * Base class for sources providing images divided into a tile grid.
* *
* @constructor * @constructor
* @abstract
* @extends {ol.source.Source} * @extends {ol.source.Source}
* @param {ol.SourceTileOptions} options Tile source options. * @param {ol.SourceTileOptions} options Tile source options.
* @api * @api

View File

@@ -12,6 +12,7 @@ goog.require('ol.source.TileEventType');
* Base class for sources providing tiles divided into a tile grid over http. * Base class for sources providing tiles divided into a tile grid over http.
* *
* @constructor * @constructor
* @abstract
* @fires ol.source.Tile.Event * @fires ol.source.Tile.Event
* @extends {ol.source.Tile} * @extends {ol.source.Tile}
* @param {ol.SourceUrlTileOptions} options Image tile options. * @param {ol.SourceUrlTileOptions} options Image tile options.

View File

@@ -8,6 +8,7 @@ goog.provide('ol.style.Image');
* {@link ol.style.RegularShape}. * {@link ol.style.RegularShape}.
* *
* @constructor * @constructor
* @abstract
* @param {ol.StyleImageOptions} options Options. * @param {ol.StyleImageOptions} options Options.
* @api * @api
*/ */

View File

@@ -11,6 +11,7 @@ goog.require('ol.events.EventType');
* Base class for tiles. * Base class for tiles.
* *
* @constructor * @constructor
* @abstract
* @extends {ol.events.EventTarget} * @extends {ol.events.EventTarget}
* @param {ol.TileCoord} tileCoord Tile coordinate. * @param {ol.TileCoord} tileCoord Tile coordinate.
* @param {ol.TileState} state State. * @param {ol.TileState} state State.

View File

@@ -8,6 +8,7 @@ if (ol.ENABLE_WEBGL) {
/** /**
* @constructor * @constructor
* @abstract
* @param {string} source Source. * @param {string} source Source.
* @struct * @struct
*/ */