Add @api stable annotations to ol.layer.Base

This commit is contained in:
Éric Lemoine
2014-08-18 17:24:32 +02:00
parent 807ddccecf
commit efc32b14df
2 changed files with 15 additions and 14 deletions

View File

@@ -2348,7 +2348,7 @@ olx.layer.BaseOptions.prototype.hue;
/**
* Opacity (0, 1). Default is `1`.
* @type {number|undefined}
* @api
* @api stable
*/
olx.layer.BaseOptions.prototype.opacity;
@@ -2364,7 +2364,7 @@ olx.layer.BaseOptions.prototype.saturation;
/**
* Visibility. Default is `true`.
* @type {boolean|undefined}
* @api
* @api stable
*/
olx.layer.BaseOptions.prototype.visible;
@@ -2373,7 +2373,7 @@ olx.layer.BaseOptions.prototype.visible;
* The bounding extent for layer rendering. The layer will not be rendered
* outside of this extent.
* @type {ol.Extent|undefined}
* @api
* @api stable
*/
olx.layer.BaseOptions.prototype.extent;
@@ -2381,7 +2381,7 @@ olx.layer.BaseOptions.prototype.extent;
/**
* The minimum resolution (inclusive) at which this layer will be visible.
* @type {number|undefined}
* @api
* @api stable
*/
olx.layer.BaseOptions.prototype.minResolution;
@@ -2389,6 +2389,7 @@ olx.layer.BaseOptions.prototype.minResolution;
/**
* The maximum resolution (exclusive) below which this layer will be visible.
* @type {number|undefined}
* @api stable
*/
olx.layer.BaseOptions.prototype.maxResolution;

View File

@@ -181,7 +181,7 @@ ol.layer.Base.prototype.getLayerStatesArray = goog.abstractMethod;
/**
* @return {ol.Extent|undefined} The layer extent.
* @observable
* @api
* @api stable
*/
ol.layer.Base.prototype.getExtent = function() {
return /** @type {ol.Extent|undefined} */ (
@@ -196,7 +196,7 @@ goog.exportProperty(
/**
* @return {number|undefined} The maximum resolution of the layer.
* @observable
* @api
* @api stable
*/
ol.layer.Base.prototype.getMaxResolution = function() {
return /** @type {number|undefined} */ (
@@ -211,7 +211,7 @@ goog.exportProperty(
/**
* @return {number|undefined} The minimum resolution of the layer.
* @observable
* @api
* @api stable
*/
ol.layer.Base.prototype.getMinResolution = function() {
return /** @type {number|undefined} */ (
@@ -226,7 +226,7 @@ goog.exportProperty(
/**
* @return {number|undefined} The opacity of the layer.
* @observable
* @api
* @api stable
*/
ol.layer.Base.prototype.getOpacity = function() {
return /** @type {number|undefined} */ (
@@ -262,7 +262,7 @@ ol.layer.Base.prototype.getSourceState = goog.abstractMethod;
/**
* @return {boolean|undefined} The visiblity of the layer.
* @observable
* @api
* @api stable
*/
ol.layer.Base.prototype.getVisible = function() {
return /** @type {boolean|undefined} */ (
@@ -344,7 +344,7 @@ goog.exportProperty(
* will be visible at all extents.
* @param {ol.Extent|undefined} extent The extent of the layer.
* @observable
* @api
* @api stable
*/
ol.layer.Base.prototype.setExtent = function(extent) {
this.set(ol.layer.LayerProperty.EXTENT, extent);
@@ -358,7 +358,7 @@ goog.exportProperty(
/**
* @param {number|undefined} maxResolution The maximum resolution of the layer.
* @observable
* @api
* @api stable
*/
ol.layer.Base.prototype.setMaxResolution = function(maxResolution) {
this.set(ol.layer.LayerProperty.MAX_RESOLUTION, maxResolution);
@@ -372,7 +372,7 @@ goog.exportProperty(
/**
* @param {number|undefined} minResolution The minimum resolution of the layer.
* @observable
* @api
* @api stable
*/
ol.layer.Base.prototype.setMinResolution = function(minResolution) {
this.set(ol.layer.LayerProperty.MIN_RESOLUTION, minResolution);
@@ -386,7 +386,7 @@ goog.exportProperty(
/**
* @param {number|undefined} opacity The opacity of the layer.
* @observable
* @api
* @api stable
*/
ol.layer.Base.prototype.setOpacity = function(opacity) {
this.set(ol.layer.LayerProperty.OPACITY, opacity);
@@ -419,7 +419,7 @@ goog.exportProperty(
/**
* @param {boolean|undefined} visible The visiblity of the layer.
* @observable
* @api
* @api stable
*/
ol.layer.Base.prototype.setVisible = function(visible) {
this.set(ol.layer.LayerProperty.VISIBLE, visible);