Get rid of stability annotations and document stability with api

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
+16 -16
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);