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
+10 -9
View File
@@ -7,8 +7,11 @@ goog.require('ol.Observable');
/**
* The geometry type. One of `'Point'`, `'LineString'`, `'LinearRing'`,
* `'Polygon'`, `'MultiPoint'`, `'MultiLineString'`, `'MultiPolygon'`,
* `'GeometryCollection'`, `'Circle'`.
* @enum {string}
* @todo stability experimental
* @todo api
*/
ol.geom.GeometryType = {
POINT: 'Point',
@@ -24,8 +27,11 @@ ol.geom.GeometryType = {
/**
* The coordinate layout for geometries, indicating whether a 3rd or 4th z ('Z')
* or measure ('M') coordinate is available. Supported values are `'XY'`,
* `'XYZ'`, `'XYM'`, `'XYZM'`.
* @enum {string}
* @todo stability experimental
* @todo api
*/
ol.geom.GeometryLayout = {
XY: 'XY',
@@ -39,7 +45,6 @@ ol.geom.GeometryLayout = {
/**
* @constructor
* @extends {ol.Observable}
* @todo stability experimental
* @todo api
*/
ol.geom.Geometry = function() {
@@ -83,7 +88,6 @@ goog.inherits(ol.geom.Geometry, ol.Observable);
/**
* @function
* @return {ol.geom.Geometry} Clone.
* @todo stability experimental
*/
ol.geom.Geometry.prototype.clone = goog.abstractMethod;
@@ -102,7 +106,6 @@ ol.geom.Geometry.prototype.closestPointXY = goog.abstractMethod;
* @param {ol.Coordinate} point Point.
* @param {ol.Coordinate=} opt_closestPoint Closest point.
* @return {ol.Coordinate} Closest point.
* @todo stability experimental
* @todo api
*/
ol.geom.Geometry.prototype.getClosestPoint = function(point, opt_closestPoint) {
@@ -131,10 +134,11 @@ ol.geom.Geometry.prototype.containsXY = goog.functions.FALSE;
/**
* Get the extent of the geometry.
* @function
* @param {ol.Extent=} opt_extent Extent.
* @return {ol.Extent} extent Extent.
* @todo stability experimental
* @todo api
*/
ol.geom.Geometry.prototype.getExtent = goog.abstractMethod;
@@ -143,7 +147,6 @@ ol.geom.Geometry.prototype.getExtent = goog.abstractMethod;
* @function
* @param {number} squaredTolerance Squared tolerance.
* @return {ol.geom.Geometry} Simplified geometry.
* @todo stability experimental
*/
ol.geom.Geometry.prototype.getSimplifiedGeometry = goog.abstractMethod;
@@ -151,7 +154,6 @@ ol.geom.Geometry.prototype.getSimplifiedGeometry = goog.abstractMethod;
/**
* @function
* @return {ol.geom.GeometryType} Geometry type.
* @todo stability experimental
*/
ol.geom.Geometry.prototype.getType = goog.abstractMethod;
@@ -159,7 +161,6 @@ ol.geom.Geometry.prototype.getType = goog.abstractMethod;
/**
* @function
* @param {ol.TransformFunction} transformFn Transform.
* @todo stability experimental
*/
ol.geom.Geometry.prototype.transform = goog.abstractMethod;