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

View File

@@ -380,7 +380,6 @@ ol.render.canvas.Immediate.prototype.drawRings_ =
*
* @param {number} zIndex Z index.
* @param {function(ol.render.canvas.Immediate)} callback Callback.
* @todo stability experimental
* @todo api
*/
ol.render.canvas.Immediate.prototype.drawAsync = function(zIndex, callback) {
@@ -400,7 +399,6 @@ ol.render.canvas.Immediate.prototype.drawAsync = function(zIndex, callback) {
*
* @param {ol.geom.Circle} circleGeometry Circle geometry.
* @param {Object} data Opaque data object,
* @todo stability experimental
* @todo api
*/
ol.render.canvas.Immediate.prototype.drawCircleGeometry =
@@ -446,7 +444,6 @@ ol.render.canvas.Immediate.prototype.drawCircleGeometry =
*
* @param {ol.Feature} feature Feature.
* @param {ol.style.Style} style Style.
* @todo stability experimental
* @todo api
*/
ol.render.canvas.Immediate.prototype.drawFeature = function(feature, style) {
@@ -499,7 +496,6 @@ ol.render.canvas.Immediate.prototype.drawGeometryCollectionGeometry =
*
* @param {ol.geom.Point} pointGeometry Point geometry.
* @param {Object} data Opaque data object.
* @todo stability experimental
* @todo api
*/
ol.render.canvas.Immediate.prototype.drawPointGeometry =
@@ -521,7 +517,6 @@ ol.render.canvas.Immediate.prototype.drawPointGeometry =
*
* @param {ol.geom.MultiPoint} multiPointGeometry MultiPoint geometry.
* @param {Object} data Opaque data object.
* @todo stability experimental
* @todo api
*/
ol.render.canvas.Immediate.prototype.drawMultiPointGeometry =
@@ -543,7 +538,6 @@ ol.render.canvas.Immediate.prototype.drawMultiPointGeometry =
*
* @param {ol.geom.LineString} lineStringGeometry Line string geometry.
* @param {Object} data Opaque data object.
* @todo stability experimental
* @todo api
*/
ol.render.canvas.Immediate.prototype.drawLineStringGeometry =
@@ -574,7 +568,6 @@ ol.render.canvas.Immediate.prototype.drawLineStringGeometry =
* @param {ol.geom.MultiLineString} multiLineStringGeometry
* MultiLineString geometry.
* @param {Object} data Opaque data object.
* @todo stability experimental
* @todo api
*/
ol.render.canvas.Immediate.prototype.drawMultiLineStringGeometry =
@@ -611,7 +604,6 @@ ol.render.canvas.Immediate.prototype.drawMultiLineStringGeometry =
*
* @param {ol.geom.Polygon} polygonGeometry Polygon geometry.
* @param {Object} data Opaque data object.
* @todo stability experimental
* @todo api
*/
ol.render.canvas.Immediate.prototype.drawPolygonGeometry =
@@ -651,7 +643,6 @@ ol.render.canvas.Immediate.prototype.drawPolygonGeometry =
* uses the current style.
* @param {ol.geom.MultiPolygon} multiPolygonGeometry MultiPolygon geometry.
* @param {Object} data Opaque data object.
* @todo stability experimental
* @todo api
*/
ol.render.canvas.Immediate.prototype.drawMultiPolygonGeometry =
@@ -827,7 +818,6 @@ ol.render.canvas.Immediate.prototype.setContextTextState_ =
*
* @param {ol.style.Fill} fillStyle Fill style.
* @param {ol.style.Stroke} strokeStyle Stroke style.
* @todo stability experimental
* @todo api
*/
ol.render.canvas.Immediate.prototype.setFillStrokeStyle =
@@ -873,7 +863,6 @@ ol.render.canvas.Immediate.prototype.setFillStrokeStyle =
* the image style.
*
* @param {ol.style.Image} imageStyle Image style.
* @todo stability experimental
* @todo api
*/
ol.render.canvas.Immediate.prototype.setImageStyle = function(imageStyle) {
@@ -913,7 +902,6 @@ ol.render.canvas.Immediate.prototype.setImageStyle = function(imageStyle) {
* remove the text style.
*
* @param {ol.style.Text} textStyle Text style.
* @todo stability experimental
* @todo api
*/
ol.render.canvas.Immediate.prototype.setTextStyle = function(textStyle) {

View File

@@ -8,7 +8,6 @@ goog.provide('ol.render.IVectorContext');
* VectorContext interface. Currently implemented by
* {@link ol.render.canvas.Immediate}
* @interface
* @todo stability experimental
*/
ol.render.IVectorContext = function() {
};

View File

@@ -11,17 +11,17 @@ goog.require('ol.render.IVectorContext');
ol.render.EventType = {
/**
* @event ol.render.Event#postcompose
* @todo stability experimental
* @todo api
*/
POSTCOMPOSE: 'postcompose',
/**
* @event ol.render.Event#precompose
* @todo stability experimental
* @todo api
*/
PRECOMPOSE: 'precompose',
/**
* @event ol.render.Event#render
* @todo stability experimental
* @todo api
*/
RENDER: 'render'
};
@@ -47,13 +47,11 @@ ol.render.Event = function(
/**
* @type {ol.render.IVectorContext|undefined}
* @todo stability experimental
*/
this.vectorContext = opt_vectorContext;
/**
* @type {oli.FrameState|undefined}
* @todo stability experimental
*/
this.frameState = opt_frameState;
@@ -61,7 +59,6 @@ ol.render.Event = function(
* Canvas context. Only available when a Canvas renderer is used,
* null otherwise.
* @type {CanvasRenderingContext2D|null|undefined}
* @todo stability experimental
*/
this.context = opt_context;
@@ -69,7 +66,6 @@ ol.render.Event = function(
* WebGL context. Only available when a WebGL renderer is used, null
* otherwise.
* @type {ol.webgl.Context|null|undefined}
* @todo stability experimental
*/
this.glContext = opt_glContext;