ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Get rid of stability annotations and document stability with api

Browse Source 
This change adds a stability value to the api annotation, with
'experimental' as default value.

enum, typedef and event annotations are never exportable, but
api annotations are needed there to make them appear in the
docs.

Nested typedefs are no longer inlined recursively, because the
resulting tables get too wide with the current template.
This commit is contained in:
Andreas Hocevar
2014-04-17 00:56:44 +02:00
committed by Tim Schaub
parent 29b643c7b0
commit fbdbbfb7a7
146 changed files with 506 additions and 764 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/ol/layer/heatmaplayer.js
View File

@@ -25,7 +25,6 @@ ol.layer.HeatmapLayerProperty = {
* @extends {ol.layer.Vector}
* @fires {@link ol.render.Event} ol.render.Event
* @param {olx.layer.HeatmapOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.layer.Heatmap = function(opt_options) {

1
src/ol/layer/imagelayer.js
View File

@@ -9,7 +9,6 @@ goog.require('ol.layer.Layer');
* @extends {ol.layer.Layer}
* @fires {@link ol.render.Event} ol.render.Event
* @param {olx.layer.LayerOptions} options Layer options.
* @todo stability experimental
* @todo api
*/
ol.layer.Image = function(options) {

2
src/ol/layer/layer.js
View File

@@ -22,7 +22,6 @@ goog.require('ol.source.Source');
* @todo observable visible {boolean} the visiblity of the layer
* @todo observable maxResolution {number} the maximum resolution of the layer
* @todo observable minResolution {number} the minimum resolution of the layer
* @todo stability experimental
* @todo api
*/
ol.layer.Layer = function(options) {
@@ -67,7 +66,6 @@ ol.layer.Layer.prototype.getLayerStatesArray = function(opt_states) {
/**
* @return {ol.source.Source} Source.
* @todo stability experimental
* @todo api
*/
ol.layer.Layer.prototype.getSource = function() {

32
src/ol/layer/layerbase.js
View File

@@ -79,7 +79,7 @@ goog.inherits(ol.layer.Base, ol.Object);
/**
* @return {number|undefined} Brightness.
* @todo stability experimental
* @todo api
*/
ol.layer.Base.prototype.getBrightness = function() {
return /** @type {number|undefined} */ (
@@ -93,7 +93,7 @@ goog.exportProperty(
/**
* @return {number|undefined} Contrast.
* @todo stability experimental
* @todo api
*/
ol.layer.Base.prototype.getContrast = function() {
return /** @type {number|undefined} */ (
@@ -107,7 +107,7 @@ goog.exportProperty(
/**
* @return {number|undefined} Hue.
* @todo stability experimental
* @todo api
*/
ol.layer.Base.prototype.getHue = function() {
return /** @type {number|undefined} */ (this.get(ol.layer.LayerProperty.HUE));
@@ -164,7 +164,7 @@ ol.layer.Base.prototype.getLayerStatesArray = goog.abstractMethod;
/**
* @return {number|undefined} MaxResolution.
* @todo stability experimental
* @todo api
*/
ol.layer.Base.prototype.getMaxResolution = function() {
return /** @type {number|undefined} */ (
@@ -178,7 +178,7 @@ goog.exportProperty(
/**
* @return {number|undefined} MinResolution.
* @todo stability experimental
* @todo api
*/
ol.layer.Base.prototype.getMinResolution = function() {
return /** @type {number|undefined} */ (
@@ -192,7 +192,7 @@ goog.exportProperty(
/**
* @return {number|undefined} Opacity.
* @todo stability experimental
* @todo api
*/
ol.layer.Base.prototype.getOpacity = function() {
return /** @type {number|undefined} */ (
@@ -206,7 +206,7 @@ goog.exportProperty(
/**
* @return {number|undefined} Saturation.
* @todo stability experimental
* @todo api
*/
ol.layer.Base.prototype.getSaturation = function() {
return /** @type {number|undefined} */ (
@@ -226,7 +226,7 @@ ol.layer.Base.prototype.getSourceState = goog.abstractMethod;
/**
* @return {boolean|undefined} Visible.
* @todo stability experimental
* @todo api
*/
ol.layer.Base.prototype.getVisible = function() {
return /** @type {boolean|undefined} */ (
@@ -257,7 +257,7 @@ goog.exportProperty(
* [3] https://www.w3.org/Bugs/Public/show_bug.cgi?id=15647
*
* @param {number|undefined} brightness Brightness.
* @todo stability experimental
* @todo api
*/
ol.layer.Base.prototype.setBrightness = function(brightness) {
this.set(ol.layer.LayerProperty.BRIGHTNESS, brightness);
@@ -274,7 +274,7 @@ goog.exportProperty(
* linear multipliers on the effect (and values over 1 are permitted).
*
* @param {number|undefined} contrast Contrast.
* @todo stability experimental
* @todo api
*/
ol.layer.Base.prototype.setContrast = function(contrast) {
this.set(ol.layer.LayerProperty.CONTRAST, contrast);
@@ -289,7 +289,7 @@ goog.exportProperty(
* Apply a hue-rotation to the layer. A value of 0 will leave the hue
* unchanged. Other values are radians around the color circle.
* @param {number|undefined} hue Hue.
* @todo stability experimental
* @todo api
*/
ol.layer.Base.prototype.setHue = function(hue) {
this.set(ol.layer.LayerProperty.HUE, hue);
@@ -302,7 +302,7 @@ goog.exportProperty(
/**
* @param {number|undefined} maxResolution MaxResolution.
* @todo stability experimental
* @todo api
*/
ol.layer.Base.prototype.setMaxResolution = function(maxResolution) {
this.set(ol.layer.LayerProperty.MAX_RESOLUTION, maxResolution);
@@ -315,7 +315,7 @@ goog.exportProperty(
/**
* @param {number|undefined} minResolution MinResolution.
* @todo stability experimental
* @todo api
*/
ol.layer.Base.prototype.setMinResolution = function(minResolution) {
this.set(ol.layer.LayerProperty.MIN_RESOLUTION, minResolution);
@@ -328,7 +328,7 @@ goog.exportProperty(
/**
* @param {number|undefined} opacity Opacity.
* @todo stability experimental
* @todo api
*/
ol.layer.Base.prototype.setOpacity = function(opacity) {
this.set(ol.layer.LayerProperty.OPACITY, opacity);
@@ -346,7 +346,7 @@ goog.exportProperty(
* permitted).
*
* @param {number|undefined} saturation Saturation.
* @todo stability experimental
* @todo api
*/
ol.layer.Base.prototype.setSaturation = function(saturation) {
this.set(ol.layer.LayerProperty.SATURATION, saturation);
@@ -359,7 +359,7 @@ goog.exportProperty(
/**
* @param {boolean|undefined} visible Visible.
* @todo stability experimental
* @todo api
*/
ol.layer.Base.prototype.setVisible = function(visible) {
this.set(ol.layer.LayerProperty.VISIBLE, visible);

3
src/ol/layer/layergroup.js
View File

@@ -30,7 +30,6 @@ ol.layer.GroupProperty = {
* @param {olx.layer.GroupOptions=} opt_options Layer options.
* @todo observable layers {ol.Collection} collection of {@link ol.layer} layers
* that are part of this group
* @todo stability experimental
* @todo api
*/
ol.layer.Group = function(opt_options) {
@@ -144,7 +143,6 @@ ol.layer.Group.prototype.handleLayersRemove_ = function(collectionEvent) {
/**
* @return {ol.Collection|undefined} Collection of layers.
* @todo stability experimental
*/
ol.layer.Group.prototype.getLayers = function() {
return /** @type {ol.Collection|undefined} */ (this.get(
@@ -158,7 +156,6 @@ goog.exportProperty(
/**
* @param {ol.Collection|undefined} layers Collection of layers.
* @todo stability experimental
*/
ol.layer.Group.prototype.setLayers = function(layers) {
this.set(ol.layer.GroupProperty.LAYERS, layers);

1
src/ol/layer/tilelayer.js
View File

@@ -19,7 +19,6 @@ ol.layer.TileProperty = {
* @fires {@link ol.render.Event} ol.render.Event
* @param {olx.layer.TileOptions} options Tile layer options.
* @todo observable preload {number} the level to preload tiles up to
* @todo stability experimental
* @todo api
*/
ol.layer.Tile = function(options) {

4
src/ol/layer/vectorlayer.js
View File

@@ -21,7 +21,6 @@ ol.layer.VectorProperty = {
* @extends {ol.layer.Layer}
* @fires {@link ol.render.Event} ol.render.Event
* @param {olx.layer.VectorOptions=} opt_options Options.
* @todo stability experimental
* @todo api
*/
ol.layer.Vector = function(opt_options) {
@@ -71,7 +70,6 @@ ol.layer.Vector.prototype.getRenderOrder = function() {
* option at construction or to the `setStyle` method.
* @return {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction}
* Layer style.
* @todo stability experimental
* @todo api
*/
ol.layer.Vector.prototype.getStyle = function() {
@@ -82,7 +80,6 @@ ol.layer.Vector.prototype.getStyle = function() {
/**
* Get the style function.
* @return {ol.feature.StyleFunction|undefined} Layer style function.
* @todo stability experimental
* @todo api
*/
ol.layer.Vector.prototype.getStyleFunction = function() {
@@ -105,7 +102,6 @@ ol.layer.Vector.prototype.setRenderOrder = function(renderOrder) {
* an array of styles.
* @param {ol.style.Style|Array.<ol.style.Style>|ol.feature.StyleFunction} style
* Layer style.
* @todo stability experimental
* @todo api
*/
ol.layer.Vector.prototype.setStyle = function(style) {