Merge pull request #2552 from elemoine/apistable

Add @api stable annotations for the ol.layer namespace

src/ol/layer/imagelayer.js

@@ -16,7 +16,7 @@ goog.require('ol.layer.Layer');
  * @extends {ol.layer.Layer}
  * @fires ol.render.Event
  * @param {olx.layer.LayerOptions} options Layer options.
- * @api
+ * @api stable
  */
 ol.layer.Image = function(options) {
   goog.base(this, options);

src/ol/layer/layer.js

@@ -22,7 +22,7 @@ goog.require('ol.source.Source');
  * @fires ol.render.Event
  * @fires change Triggered when the state of the source changes.
  * @param {olx.layer.LayerOptions} options Layer options.
- * @api
+ * @api stable
  */
 ol.layer.Layer = function(options) {
 
@@ -80,7 +80,7 @@ ol.layer.Layer.prototype.getLayerStatesArray = function(opt_states) {
 
 /**
  * @return {ol.source.Source} Source.
- * @api
+ * @api stable
  */
 ol.layer.Layer.prototype.getSource = function() {
   return this.source_;

src/ol/layer/layerbase.js

@@ -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);

src/ol/layer/layergroup.js

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

src/ol/layer/tilelayer.js

@@ -25,7 +25,7 @@ ol.layer.TileProperty = {
  * @extends {ol.layer.Layer}
  * @fires ol.render.Event
  * @param {olx.layer.TileOptions} options Tile layer options.
- * @api
+ * @api stable
  */
 ol.layer.Tile = function(options) {
   goog.base(this, options);
@@ -37,6 +37,7 @@ goog.inherits(ol.layer.Tile, ol.layer.Layer);
 /**
  * @return {number|undefined} The level to preload tiles up to.
  * @observable
+ * @api
  */
 ol.layer.Tile.prototype.getPreload = function() {
   return /** @type {number|undefined} */ (
@@ -51,6 +52,7 @@ goog.exportProperty(
 /**
  * @param {number} preload The level to preload tiles up to.
  * @observable
+ * @api
  */
 ol.layer.Tile.prototype.setPreload = function(preload) {
   this.set(ol.layer.TileProperty.PRELOAD, preload);
@@ -63,6 +65,8 @@ goog.exportProperty(
 
 /**
  * @return {boolean|undefined} Use interim tiles on error.
+ * @observable
+ * @api
  */
 ol.layer.Tile.prototype.getUseInterimTilesOnError = function() {
   return /** @type {boolean|undefined} */ (
@@ -76,6 +80,8 @@ goog.exportProperty(
 
 /**
  * @param {boolean|undefined} useInterimTilesOnError Use interim tiles on error.
+ * @observable
+ * @api
  */
 ol.layer.Tile.prototype.setUseInterimTilesOnError =
     function(useInterimTilesOnError) {

src/ol/layer/vectorlayer.js

@@ -25,7 +25,7 @@ ol.layer.VectorProperty = {
  * @extends {ol.layer.Layer}
  * @fires ol.render.Event
  * @param {olx.layer.VectorOptions=} opt_options Options.
- * @api
+ * @api stable
  */
 ol.layer.Vector = function(opt_options) {
 
@@ -73,7 +73,7 @@ ol.layer.Vector.prototype.getRenderOrder = function() {
  * option at construction or to the `setStyle` method.
  * @return {ol.style.Style|Array.<ol.style.Style>|ol.style.StyleFunction}
  *     Layer style.
- * @api
+ * @api stable
  */
 ol.layer.Vector.prototype.getStyle = function() {
   return this.style_;
@@ -83,7 +83,7 @@ ol.layer.Vector.prototype.getStyle = function() {
 /**
  * Get the style function.
  * @return {ol.style.StyleFunction|undefined} Layer style function.
- * @api
+ * @api stable
  */
 ol.layer.Vector.prototype.getStyleFunction = function() {
   return this.styleFunction_;
@@ -105,7 +105,7 @@ ol.layer.Vector.prototype.setRenderOrder = function(renderOrder) {
  * an array of styles.
  * @param {ol.style.Style|Array.<ol.style.Style>|ol.style.StyleFunction} style
  *     Layer style.
- * @api
+ * @api stable
  */
 ol.layer.Vector.prototype.setStyle = function(style) {
   this.style_ = style;