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
+2 -14
View File
@@ -25,13 +25,13 @@ ol.source.VectorEventType = {
/**
* Triggered when a feature is added to the source.
* @event ol.source.VectorEvent#addfeature
* @todo stability experimental
* @todo api
*/
ADDFEATURE: 'addfeature',
/**
* Triggered when a feature is removed from the source.
* @event ol.source.VectorEvent#removefeature
* @todo stability experimental
* @todo api
*/
REMOVEFEATURE: 'removefeature'
};
@@ -43,7 +43,6 @@ ol.source.VectorEventType = {
* @extends {ol.source.Source}
* @fires {@link ol.source.VectorEvent} ol.source.VectorEvent
* @param {olx.source.VectorOptions=} opt_options Vector source options.
* @todo stability experimental
* @todo api
*/
ol.source.Vector = function(opt_options) {
@@ -86,7 +85,6 @@ goog.inherits(ol.source.Vector, ol.source.Source);
/**
* @param {ol.Feature} feature Feature.
* @todo stability experimental
* @todo api
*/
ol.source.Vector.prototype.addFeature = function(feature) {
@@ -125,7 +123,6 @@ ol.source.Vector.prototype.addFeatureInternal = function(feature) {
/**
* @param {Array.<ol.Feature>} features Features.
* @todo stability experimental
* @todo api
*/
ol.source.Vector.prototype.addFeatures = function(features) {
@@ -167,7 +164,6 @@ ol.source.Vector.prototype.clear = function() {
* @param {T=} opt_this The object to use as `this` in `f`.
* @return {S|undefined}
* @template T,S
* @todo stability experimental
* @todo api
*/
ol.source.Vector.prototype.forEachFeature = function(f, opt_this) {
@@ -203,7 +199,6 @@ ol.source.Vector.prototype.forEachFeatureAtCoordinate =
* @param {T=} opt_this The object to use as `this` in `f`.
* @return {S|undefined}
* @template T,S
* @todo stability experimental
* @todo api
*/
ol.source.Vector.prototype.forEachFeatureInExtent =
@@ -228,7 +223,6 @@ ol.source.Vector.prototype.forEachFeatureInExtentAtResolution =
/**
* @return {Array.<ol.Feature>} Features.
* @todo stability experimental
* @todo api
*/
ol.source.Vector.prototype.getFeatures = function() {
@@ -244,7 +238,6 @@ ol.source.Vector.prototype.getFeatures = function() {
/**
* @param {ol.Coordinate} coordinate Coordinate.
* @return {Array.<ol.Feature>} Features.
* @todo stability experimental
* @todo api
*/
ol.source.Vector.prototype.getFeaturesAtCoordinate = function(coordinate) {
@@ -268,7 +261,6 @@ ol.source.Vector.prototype.getFeaturesInExtent = function(extent) {
/**
* @param {ol.Coordinate} coordinate Coordinate.
* @return {ol.Feature} Closest feature.
* @todo stability experimental
* @todo api
*/
ol.source.Vector.prototype.getClosestFeatureToCoordinate =
@@ -315,7 +307,6 @@ ol.source.Vector.prototype.getClosestFeatureToCoordinate =
/**
* @return {ol.Extent} Extent.
* @todo stability experimental
* @todo api
*/
ol.source.Vector.prototype.getExtent = function() {
@@ -368,7 +359,6 @@ ol.source.Vector.prototype.loadFeatures = goog.nullFunction;
/**
* @param {ol.Feature} feature Feature.
* @todo stability experimental
* @todo api
*/
ol.source.Vector.prototype.removeFeature = function(feature) {
@@ -406,7 +396,6 @@ ol.source.Vector.prototype.removeFeatureInternal = function(feature) {
* @implements {oli.source.VectorEvent}
* @param {string} type Type.
* @param {ol.Feature=} opt_feature Feature.
* @todo stability experimental
*/
ol.source.VectorEvent = function(type, opt_feature) {
@@ -415,7 +404,6 @@ ol.source.VectorEvent = function(type, opt_feature) {
/**
* The feature being added or removed.
* @type {ol.Feature|undefined}
* @todo stability experimental
*/
this.feature = opt_feature;