Add @api stable annotations to ol.layer.Group

This commit is contained in:
Éric Lemoine
2014-08-18 17:25:53 +02:00
parent 15487d1ce9
commit e50ba2172f
2 changed files with 10 additions and 8 deletions

View File

@@ -2534,6 +2534,7 @@ olx.layer.GroupOptions.prototype.hue;
/** /**
* Opacity (0, 1). Default is `1`. * Opacity (0, 1). Default is `1`.
* @type {number|undefined} * @type {number|undefined}
* @api stable
*/ */
olx.layer.GroupOptions.prototype.opacity; olx.layer.GroupOptions.prototype.opacity;
@@ -2541,6 +2542,7 @@ olx.layer.GroupOptions.prototype.opacity;
/** /**
* Saturation. Default is `1`. * Saturation. Default is `1`.
* @type {number|undefined} * @type {number|undefined}
* @api
*/ */
olx.layer.GroupOptions.prototype.saturation; olx.layer.GroupOptions.prototype.saturation;
@@ -2548,7 +2550,7 @@ olx.layer.GroupOptions.prototype.saturation;
/** /**
* Visibility. Default is `true`. * Visibility. Default is `true`.
* @type {boolean|undefined} * @type {boolean|undefined}
* @api * @api stable
*/ */
olx.layer.GroupOptions.prototype.visible; olx.layer.GroupOptions.prototype.visible;
@@ -2557,7 +2559,7 @@ olx.layer.GroupOptions.prototype.visible;
* The bounding extent for layer rendering. The layer will not be rendered * The bounding extent for layer rendering. The layer will not be rendered
* outside of this extent. * outside of this extent.
* @type {ol.Extent|undefined} * @type {ol.Extent|undefined}
* @api * @api stable
*/ */
olx.layer.GroupOptions.prototype.extent; olx.layer.GroupOptions.prototype.extent;
@@ -2565,7 +2567,7 @@ olx.layer.GroupOptions.prototype.extent;
/** /**
* The minimum resolution (inclusive) at which this layer will be visible. * The minimum resolution (inclusive) at which this layer will be visible.
* @type {number|undefined} * @type {number|undefined}
* @api * @api stable
*/ */
olx.layer.GroupOptions.prototype.minResolution; olx.layer.GroupOptions.prototype.minResolution;
@@ -2573,7 +2575,7 @@ olx.layer.GroupOptions.prototype.minResolution;
/** /**
* The maximum resolution (exclusive) below which this layer will be visible. * The maximum resolution (exclusive) below which this layer will be visible.
* @type {number|undefined} * @type {number|undefined}
* @api * @api stable
*/ */
olx.layer.GroupOptions.prototype.maxResolution; olx.layer.GroupOptions.prototype.maxResolution;
@@ -2581,7 +2583,7 @@ olx.layer.GroupOptions.prototype.maxResolution;
/** /**
* Child layers. * Child layers.
* @type {Array.<ol.layer.Base>|ol.Collection.<ol.layer.Base>|undefined} * @type {Array.<ol.layer.Base>|ol.Collection.<ol.layer.Base>|undefined}
* @api * @api stable
*/ */
olx.layer.GroupOptions.prototype.layers; olx.layer.GroupOptions.prototype.layers;

View File

@@ -33,7 +33,7 @@ ol.layer.GroupProperty = {
* @extends {ol.layer.Base} * @extends {ol.layer.Base}
* @fires change Triggered when the group/Collection changes. * @fires change Triggered when the group/Collection changes.
* @param {olx.layer.GroupOptions=} opt_options Layer options. * @param {olx.layer.GroupOptions=} opt_options Layer options.
* @api * @api stable
*/ */
ol.layer.Group = function(opt_options) { ol.layer.Group = function(opt_options) {
@@ -148,7 +148,7 @@ ol.layer.Group.prototype.handleLayersRemove_ = function(collectionEvent) {
* @return {ol.Collection.<ol.layer.Base>|undefined} Collection of * @return {ol.Collection.<ol.layer.Base>|undefined} Collection of
* {@link ol.layer.Layer layers} that are part of this group. * {@link ol.layer.Layer layers} that are part of this group.
* @observable * @observable
* @api * @api stable
*/ */
ol.layer.Group.prototype.getLayers = function() { ol.layer.Group.prototype.getLayers = function() {
return /** @type {ol.Collection.<ol.layer.Base>|undefined} */ (this.get( return /** @type {ol.Collection.<ol.layer.Base>|undefined} */ (this.get(
@@ -164,7 +164,7 @@ goog.exportProperty(
* @param {ol.Collection.<ol.layer.Base>|undefined} layers Collection of * @param {ol.Collection.<ol.layer.Base>|undefined} layers Collection of
* {@link ol.layer.Layer layers} that are part of this group. * {@link ol.layer.Layer layers} that are part of this group.
* @observable * @observable
* @api * @api stable
*/ */
ol.layer.Group.prototype.setLayers = function(layers) { ol.layer.Group.prototype.setLayers = function(layers) {
this.set(ol.layer.GroupProperty.LAYERS, layers); this.set(ol.layer.GroupProperty.LAYERS, layers);