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
src/ol/geom/circle.js
-6
View File
@@ -14,7 +14,6 @@ goog.require('ol.geom.flat.deflate');
* @param {ol.geom.RawPoint} center Center.
* @param {number=} opt_radius Radius.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.Circle = function(center, opt_radius, opt_layout) {
@@ -81,7 +80,6 @@ ol.geom.Circle.prototype.containsXY = function(x, y) {
/**
* @return {ol.geom.RawPoint} Center.
* @todo stability experimental
* @todo api
*/
ol.geom.Circle.prototype.getCenter = function() {
@@ -110,7 +108,6 @@ ol.geom.Circle.prototype.getExtent = function(opt_extent) {
/**
* @return {number} Radius.
* @todo stability experimental
* @todo api
*/
ol.geom.Circle.prototype.getRadius = function() {
@@ -149,7 +146,6 @@ ol.geom.Circle.prototype.getType = function() {
/**
* @param {ol.geom.RawPoint} center Center.
* @todo stability experimental
* @todo api
*/
ol.geom.Circle.prototype.setCenter = function(center) {
@@ -170,7 +166,6 @@ ol.geom.Circle.prototype.setCenter = function(center) {
* @param {ol.geom.RawPoint} center Center.
* @param {number} radius Radius.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.Circle.prototype.setCenterAndRadius =
@@ -210,7 +205,6 @@ ol.geom.Circle.prototype.setFlatCoordinates =
/**
* @param {number} radius Radius.
* @todo stability experimental
* @todo api
*/
ol.geom.Circle.prototype.setRadius = function(radius) {
src/ol/geom/geometry.js
+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;
src/ol/geom/geometrycollection.js
-3
View File
@@ -15,7 +15,6 @@ goog.require('ol.geom.GeometryType');
* @constructor
* @extends {ol.geom.Geometry}
* @param {Array.<ol.geom.Geometry>=} opt_geometries Geometries.
* @todo stability experimental
* @todo api
*/
ol.geom.GeometryCollection = function(opt_geometries) {
@@ -147,7 +146,6 @@ ol.geom.GeometryCollection.prototype.getExtent = function(opt_extent) {
/**
* @return {Array.<ol.geom.Geometry>} Geometries.
* @todo stability experimental
* @todo api
*/
ol.geom.GeometryCollection.prototype.getGeometries = function() {
@@ -227,7 +225,6 @@ ol.geom.GeometryCollection.prototype.isEmpty = function() {
/**
* @param {Array.<ol.geom.Geometry>} geometries Geometries.
* @todo stability experimental
* @todo api
*/
ol.geom.GeometryCollection.prototype.setGeometries = function(geometries) {
src/ol/geom/linearring.js
-4
View File
@@ -16,7 +16,6 @@ goog.require('ol.geom.flat.simplify');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawLinearRing} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.LinearRing = function(coordinates, opt_layout) {
@@ -75,7 +74,6 @@ ol.geom.LinearRing.prototype.closestPointXY =
/**
* @return {number} Area.
* @todo stability experimental
* @todo api
*/
ol.geom.LinearRing.prototype.getArea = function() {
@@ -86,7 +84,6 @@ ol.geom.LinearRing.prototype.getArea = function() {
/**
* @return {ol.geom.RawLinearRing} Coordinates.
* @todo stability experimental
* @todo api
*/
ol.geom.LinearRing.prototype.getCoordinates = function() {
@@ -123,7 +120,6 @@ ol.geom.LinearRing.prototype.getType = function() {
/**
* @param {ol.geom.RawLinearRing} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.LinearRing.prototype.setCoordinates =
src/ol/geom/linestring.js
-6
View File
@@ -20,7 +20,6 @@ goog.require('ol.geom.flat.simplify');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.LineString = function(coordinates, opt_layout) {
@@ -60,7 +59,6 @@ goog.inherits(ol.geom.LineString, ol.geom.SimpleGeometry);
/**
* @param {ol.Coordinate} coordinate Coordinate.
* @todo stability experimental
* @todo api
*/
ol.geom.LineString.prototype.appendCoordinate = function(coordinate) {
@@ -117,7 +115,6 @@ ol.geom.LineString.prototype.closestPointXY =
* @param {number} m M.
* @param {boolean=} opt_extrapolate Extrapolate.
* @return {ol.Coordinate} Coordinate.
* @todo stability experimental
* @todo api
*/
ol.geom.LineString.prototype.getCoordinateAtM = function(m, opt_extrapolate) {
@@ -133,7 +130,6 @@ ol.geom.LineString.prototype.getCoordinateAtM = function(m, opt_extrapolate) {
/**
* @return {ol.geom.RawLineString} Coordinates.
* @todo stability experimental
* @todo api
*/
ol.geom.LineString.prototype.getCoordinates = function() {
@@ -144,7 +140,6 @@ ol.geom.LineString.prototype.getCoordinates = function() {
/**
* @return {number} Length.
* @todo stability experimental
* @todo api
*/
ol.geom.LineString.prototype.getLength = function() {
@@ -195,7 +190,6 @@ ol.geom.LineString.prototype.getType = function() {
/**
* @param {ol.geom.RawLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.LineString.prototype.setCoordinates =
src/ol/geom/multilinestring.js
-7
View File
@@ -20,7 +20,6 @@ goog.require('ol.geom.flat.simplify');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawMultiLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiLineString = function(coordinates, opt_layout) {
@@ -54,7 +53,6 @@ goog.inherits(ol.geom.MultiLineString, ol.geom.SimpleGeometry);
/**
* @param {ol.geom.LineString} lineString LineString.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiLineString.prototype.appendLineString = function(lineString) {
@@ -122,7 +120,6 @@ ol.geom.MultiLineString.prototype.closestPointXY =
* @param {boolean=} opt_extrapolate Extrapolate.
* @param {boolean=} opt_interpolate Interpolate.
* @return {ol.Coordinate} Coordinate.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiLineString.prototype.getCoordinateAtM =
@@ -141,7 +138,6 @@ ol.geom.MultiLineString.prototype.getCoordinateAtM =
/**
* @return {ol.geom.RawMultiLineString} Coordinates.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiLineString.prototype.getCoordinates = function() {
@@ -161,7 +157,6 @@ ol.geom.MultiLineString.prototype.getEnds = function() {
/**
* @param {number} index Index.
* @return {ol.geom.LineString} LineString.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiLineString.prototype.getLineString = function(index) {
@@ -178,7 +173,6 @@ ol.geom.MultiLineString.prototype.getLineString = function(index) {
/**
* @return {Array.<ol.geom.LineString>} LineStrings.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiLineString.prototype.getLineStrings = function() {
@@ -250,7 +244,6 @@ ol.geom.MultiLineString.prototype.getType = function() {
/**
* @param {ol.geom.RawMultiLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiLineString.prototype.setCoordinates =
src/ol/geom/multipoint.js
-6
View File
@@ -18,7 +18,6 @@ goog.require('ol.math');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawMultiPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiPoint = function(coordinates, opt_layout) {
@@ -31,7 +30,6 @@ goog.inherits(ol.geom.MultiPoint, ol.geom.SimpleGeometry);
/**
* @param {ol.geom.Point} point Point.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiPoint.prototype.appendPoint = function(point) {
@@ -85,7 +83,6 @@ ol.geom.MultiPoint.prototype.closestPointXY =
/**
* @return {ol.geom.RawMultiPoint} Coordinates.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiPoint.prototype.getCoordinates = function() {
@@ -97,7 +94,6 @@ ol.geom.MultiPoint.prototype.getCoordinates = function() {
/**
* @param {number} index Index.
* @return {ol.geom.Point} Point.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiPoint.prototype.getPoint = function(index) {
@@ -116,7 +112,6 @@ ol.geom.MultiPoint.prototype.getPoint = function(index) {
/**
* @return {Array.<ol.geom.Point>} Points.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiPoint.prototype.getPoints = function() {
@@ -147,7 +142,6 @@ ol.geom.MultiPoint.prototype.getType = function() {
/**
* @param {ol.geom.RawMultiPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiPoint.prototype.setCoordinates =
src/ol/geom/multipolygon.js
-8
View File
@@ -25,7 +25,6 @@ goog.require('ol.geom.flat.simplify');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawMultiPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiPolygon = function(coordinates, opt_layout) {
@@ -83,7 +82,6 @@ goog.inherits(ol.geom.MultiPolygon, ol.geom.SimpleGeometry);
/**
* @param {ol.geom.Polygon} polygon Polygon.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiPolygon.prototype.appendPolygon = function(polygon) {
@@ -151,7 +149,6 @@ ol.geom.MultiPolygon.prototype.containsXY = function(x, y) {
/**
* @return {number} Area.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiPolygon.prototype.getArea = function() {
@@ -162,7 +159,6 @@ ol.geom.MultiPolygon.prototype.getArea = function() {
/**
* @return {ol.geom.RawMultiPolygon} Coordinates.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiPolygon.prototype.getCoordinates = function() {
@@ -197,7 +193,6 @@ ol.geom.MultiPolygon.prototype.getFlatInteriorPoints = function() {
/**
* @return {ol.geom.MultiPoint} Interior points.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiPolygon.prototype.getInteriorPoints = function() {
@@ -250,7 +245,6 @@ ol.geom.MultiPolygon.prototype.getSimplifiedGeometryInternal =
/**
* @param {number} index Index.
* @return {ol.geom.Polygon} Polygon.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiPolygon.prototype.getPolygon = function(index) {
@@ -282,7 +276,6 @@ ol.geom.MultiPolygon.prototype.getPolygon = function(index) {
/**
* @return {Array.<ol.geom.Polygon>} Polygons.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiPolygon.prototype.getPolygons = function() {
@@ -322,7 +315,6 @@ ol.geom.MultiPolygon.prototype.getType = function() {
/**
* @param {ol.geom.RawMultiPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiPolygon.prototype.setCoordinates =
src/ol/geom/point.js
-3
View File
@@ -14,7 +14,6 @@ goog.require('ol.math');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.Point = function(coordinates, opt_layout) {
@@ -60,7 +59,6 @@ ol.geom.Point.prototype.closestPointXY =
/**
* @return {ol.geom.RawPoint} Coordinates.
* @todo stability experimental
* @todo api
*/
ol.geom.Point.prototype.getCoordinates = function() {
@@ -94,7 +92,6 @@ ol.geom.Point.prototype.getType = function() {
/**
* @param {ol.geom.RawPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.Point.prototype.setCoordinates = function(coordinates, opt_layout) {
src/ol/geom/polygon.js
-8
View File
@@ -24,7 +24,6 @@ goog.require('ol.geom.flat.simplify');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout|string=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.Polygon = function(coordinates, opt_layout) {
@@ -82,7 +81,6 @@ goog.inherits(ol.geom.Polygon, ol.geom.SimpleGeometry);
/**
* @param {ol.geom.LinearRing} linearRing Linear ring.
* @todo stability experimental
* @todo api
*/
ol.geom.Polygon.prototype.appendLinearRing = function(linearRing) {
@@ -140,7 +138,6 @@ ol.geom.Polygon.prototype.containsXY = function(x, y) {
/**
* @return {number} Area.
* @todo stability experimental
* @todo api
*/
ol.geom.Polygon.prototype.getArea = function() {
@@ -151,7 +148,6 @@ ol.geom.Polygon.prototype.getArea = function() {
/**
* @return {ol.geom.RawPolygon} Coordinates.
* @todo stability experimental
* @todo api
*/
ol.geom.Polygon.prototype.getCoordinates = function() {
@@ -185,7 +181,6 @@ ol.geom.Polygon.prototype.getFlatInteriorPoint = function() {
/**
* @return {ol.geom.Point} Interior point.
* @todo stability experimental
* @todo api
*/
ol.geom.Polygon.prototype.getInteriorPoint = function() {
@@ -196,7 +191,6 @@ ol.geom.Polygon.prototype.getInteriorPoint = function() {
/**
* @param {number} index Index.
* @return {ol.geom.LinearRing} Linear ring.
* @todo stability experimental
* @todo api
*/
ol.geom.Polygon.prototype.getLinearRing = function(index) {
@@ -213,7 +207,6 @@ ol.geom.Polygon.prototype.getLinearRing = function(index) {
/**
* @return {Array.<ol.geom.LinearRing>} Linear rings.
* @todo stability experimental
* @todo api
*/
ol.geom.Polygon.prototype.getLinearRings = function() {
@@ -285,7 +278,6 @@ ol.geom.Polygon.prototype.getType = function() {
/**
* @param {ol.geom.RawPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.Polygon.prototype.setCoordinates = function(coordinates, opt_layout) {
src/ol/geom/simplegeometry.js
-4
View File
@@ -12,7 +12,6 @@ goog.require('ol.geom.flat.transform');
/**
* @constructor
* @extends {ol.geom.Geometry}
* @todo stability experimental
* @todo api
*/
ol.geom.SimpleGeometry = function() {
@@ -103,7 +102,6 @@ ol.geom.SimpleGeometry.prototype.getExtent = function(opt_extent) {
/**
* @return {ol.Coordinate} First coordinate.
* @todo stability experimental
* @todo api
*/
ol.geom.SimpleGeometry.prototype.getFirstCoordinate = function() {
@@ -121,7 +119,6 @@ ol.geom.SimpleGeometry.prototype.getFlatCoordinates = function() {
/**
* @return {ol.Coordinate} Last point.
* @todo stability experimental
* @todo api
*/
ol.geom.SimpleGeometry.prototype.getLastCoordinate = function() {
@@ -131,7 +128,6 @@ ol.geom.SimpleGeometry.prototype.getLastCoordinate = function() {
/**
* @return {ol.geom.GeometryLayout} Layout.
* @todo stability experimental
* @todo api
*/
ol.geom.SimpleGeometry.prototype.getLayout = function() {