ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #1626 from twpayne/api-stability

Browse Source 
Add @todo stability experimental to many classes and methods
This commit is contained in:
Tom Payne
2014-02-03 06:47:43 -08:00
parent 88f0f99fa3 6f0947a697
commit 8731766f63
33 changed files with 110 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ol/geom/circle.js
+6
View File
@@ -14,6 +14,7 @@ goog.require('ol.geom.flat');
* @param {ol.geom.RawPoint} center Center.
* @param {number=} opt_radius Radius.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.Circle = function(center, opt_radius, opt_layout) {
goog.base(this);
@@ -77,6 +78,7 @@ ol.geom.Circle.prototype.containsXY = function(x, y) {
/**
* @return {ol.geom.RawPoint} Center.
* @todo stability experimental
*/
ol.geom.Circle.prototype.getCenter = function() {
return this.flatCoordinates.slice(0, this.stride);
@@ -103,6 +105,7 @@ ol.geom.Circle.prototype.getExtent = function(opt_extent) {
/**
* @return {number} Radius.
* @todo stability experimental
*/
ol.geom.Circle.prototype.getRadius = function() {
return Math.sqrt(this.getRadiusSquared_());
@@ -138,6 +141,7 @@ ol.geom.Circle.prototype.getType = function() {
/**
* @param {ol.geom.RawPoint} center Center.
* @todo stability experimental
*/
ol.geom.Circle.prototype.setCenter = function(center) {
var stride = this.stride;
@@ -157,6 +161,7 @@ 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
*/
ol.geom.Circle.prototype.setCenterAndRadius =
function(center, radius, opt_layout) {
@@ -195,6 +200,7 @@ ol.geom.Circle.prototype.setFlatCoordinates =
/**
* @param {number} radius Radius.
* @todo stability experimental
*/
ol.geom.Circle.prototype.setRadius = function(radius) {
goog.asserts.assert(!goog.isNull(this.flatCoordinates));
src/ol/geom/geometry.js
+7
View File
@@ -37,6 +37,7 @@ ol.geom.GeometryLayout = {
/**
* @constructor
* @extends {ol.Observable}
* @todo stability experimental
*/
ol.geom.Geometry = function() {
@@ -78,6 +79,7 @@ goog.inherits(ol.geom.Geometry, ol.Observable);
/**
* @return {ol.geom.Geometry} Clone.
* @todo stability experimental
*/
ol.geom.Geometry.prototype.clone = goog.abstractMethod;
@@ -96,6 +98,7 @@ 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
*/
ol.geom.Geometry.prototype.getClosestPoint = function(point, opt_closestPoint) {
var closestPoint = goog.isDef(opt_closestPoint) ?
@@ -108,6 +111,7 @@ ol.geom.Geometry.prototype.getClosestPoint = function(point, opt_closestPoint) {
/**
* @param {ol.Coordinate} coordinate Coordinate.
* @return {boolean} Contains coordinate.
* @todo stability experimental
*/
ol.geom.Geometry.prototype.containsCoordinate = function(coordinate) {
return this.containsXY(coordinate[0], coordinate[1]);
@@ -125,6 +129,7 @@ ol.geom.Geometry.prototype.containsXY = goog.functions.FALSE;
/**
* @param {ol.Extent=} opt_extent Extent.
* @return {ol.Extent} extent Extent.
* @todo stability experimental
*/
ol.geom.Geometry.prototype.getExtent = goog.abstractMethod;
@@ -138,12 +143,14 @@ ol.geom.Geometry.prototype.getSimplifiedGeometry = goog.abstractMethod;
/**
* @return {ol.geom.GeometryType} Geometry type.
* @todo stability experimental
*/
ol.geom.Geometry.prototype.getType = goog.abstractMethod;
/**
* @param {ol.TransformFunction} transformFn Transform.
* @todo stability experimental
*/
ol.geom.Geometry.prototype.transform = goog.abstractMethod;
src/ol/geom/geometrycollection.js
+4
View File
@@ -13,6 +13,7 @@ goog.require('ol.geom.GeometryType');
* @constructor
* @extends {ol.geom.Geometry}
* @param {Array.<ol.geom.Geometry>=} opt_geometries Geometries.
* @todo stability experimental
*/
ol.geom.GeometryCollection = function(opt_geometries) {
@@ -108,6 +109,7 @@ ol.geom.GeometryCollection.prototype.getExtent = function(opt_extent) {
/**
* @return {Array.<ol.geom.Geometry>} Geometries.
* @todo stability experimental
*/
ol.geom.GeometryCollection.prototype.getGeometries = function() {
return ol.geom.GeometryCollection.cloneGeometries_(this.geometries_);
@@ -176,6 +178,7 @@ ol.geom.GeometryCollection.prototype.getType = function() {
/**
* @return {boolean} Is empty.
* @todo stability experimental
*/
ol.geom.GeometryCollection.prototype.isEmpty = function() {
return goog.array.isEmpty(this.geometries_);
@@ -184,6 +187,7 @@ ol.geom.GeometryCollection.prototype.isEmpty = function() {
/**
* @param {Array.<ol.geom.Geometry>} geometries Geometries.
* @todo stability experimental
*/
ol.geom.GeometryCollection.prototype.setGeometries = function(geometries) {
this.setGeometriesArray(
src/ol/geom/linearring.js
+4
View File
@@ -14,6 +14,7 @@ goog.require('ol.geom.simplify');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawLinearRing} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.LinearRing = function(coordinates, opt_layout) {
@@ -69,6 +70,7 @@ ol.geom.LinearRing.prototype.closestPointXY =
/**
* @return {number} Area.
* @todo stability experimental
*/
ol.geom.LinearRing.prototype.getArea = function() {
return ol.geom.flat.linearRingArea(
@@ -78,6 +80,7 @@ ol.geom.LinearRing.prototype.getArea = function() {
/**
* @return {ol.geom.RawLinearRing} Coordinates.
* @todo stability experimental
*/
ol.geom.LinearRing.prototype.getCoordinates = function() {
return ol.geom.flat.inflateCoordinates(
@@ -112,6 +115,7 @@ ol.geom.LinearRing.prototype.getType = function() {
/**
* @param {ol.geom.RawLinearRing} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.LinearRing.prototype.setCoordinates =
function(coordinates, opt_layout) {
src/ol/geom/linestring.js
+4
View File
@@ -14,6 +14,7 @@ goog.require('ol.geom.simplify');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.LineString = function(coordinates, opt_layout) {
@@ -69,6 +70,7 @@ ol.geom.LineString.prototype.closestPointXY =
/**
* @return {ol.geom.RawLineString} Coordinates.
* @todo stability experimental
*/
ol.geom.LineString.prototype.getCoordinates = function() {
return ol.geom.flat.inflateCoordinates(
@@ -78,6 +80,7 @@ ol.geom.LineString.prototype.getCoordinates = function() {
/**
* @return {number} Length.
* @todo stability experimental
*/
ol.geom.LineString.prototype.getLength = function() {
return ol.geom.flat.lineStringLength(
@@ -112,6 +115,7 @@ ol.geom.LineString.prototype.getType = function() {
/**
* @param {ol.geom.RawLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.LineString.prototype.setCoordinates =
function(coordinates, opt_layout) {
src/ol/geom/multilinestring.js
+5
View File
@@ -17,6 +17,7 @@ goog.require('ol.geom.simplify');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawMultiLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.MultiLineString = function(coordinates, opt_layout) {
@@ -79,6 +80,7 @@ ol.geom.MultiLineString.prototype.closestPointXY =
/**
* @return {ol.geom.RawMultiLineString} Coordinates.
* @todo stability experimental
*/
ol.geom.MultiLineString.prototype.getCoordinates = function() {
return ol.geom.flat.inflateCoordinatess(
@@ -96,6 +98,7 @@ ol.geom.MultiLineString.prototype.getEnds = function() {
/**
* @return {Array.<ol.geom.LineString>} LineStrings.
* @todo stability experimental
*/
ol.geom.MultiLineString.prototype.getLineStrings = function() {
// FIXME we should construct the line strings from the flat coordinates
@@ -137,6 +140,7 @@ ol.geom.MultiLineString.prototype.getType = function() {
/**
* @param {ol.geom.RawMultiLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.MultiLineString.prototype.setCoordinates =
function(coordinates, opt_layout) {
@@ -170,6 +174,7 @@ ol.geom.MultiLineString.prototype.setFlatCoordinates =
/**
* @param {Array.<ol.geom.LineString>} lineStrings LineStrings.
* @todo stability experimental
*/
ol.geom.MultiLineString.prototype.setLineStrings = function(lineStrings) {
var layout = ol.geom.GeometryLayout.XY;
src/ol/geom/multipoint.js
+4
View File
@@ -13,6 +13,7 @@ goog.require('ol.geom.flat');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawMultiPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.MultiPoint = function(coordinates, opt_layout) {
goog.base(this);
@@ -60,6 +61,7 @@ ol.geom.MultiPoint.prototype.closestPointXY =
/**
* @return {ol.geom.RawMultiPoint} Coordinates.
* @todo stability experimental
*/
ol.geom.MultiPoint.prototype.getCoordinates = function() {
return ol.geom.flat.inflateCoordinates(
@@ -69,6 +71,7 @@ ol.geom.MultiPoint.prototype.getCoordinates = function() {
/**
* @return {Array.<ol.geom.Point>} Points.
* @todo stability experimental
*/
ol.geom.MultiPoint.prototype.getPoints = function() {
// FIXME we should construct the points from the flat coordinates
@@ -93,6 +96,7 @@ ol.geom.MultiPoint.prototype.getType = function() {
/**
* @param {ol.geom.RawMultiPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.MultiPoint.prototype.setCoordinates =
function(coordinates, opt_layout) {
src/ol/geom/multipolygon.js
+5
View File
@@ -15,6 +15,7 @@ goog.require('ol.geom.simplify');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawMultiPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.MultiPolygon = function(coordinates, opt_layout) {
@@ -110,6 +111,7 @@ ol.geom.MultiPolygon.prototype.containsXY = function(x, y) {
/**
* @return {number} Area.
* @todo stability experimental
*/
ol.geom.MultiPolygon.prototype.getArea = function() {
return ol.geom.flat.linearRingssArea(
@@ -119,6 +121,7 @@ ol.geom.MultiPolygon.prototype.getArea = function() {
/**
* @return {ol.geom.RawMultiPolygon} Coordinates.
* @todo stability experimental
*/
ol.geom.MultiPolygon.prototype.getCoordinates = function() {
return ol.geom.flat.inflateCoordinatesss(
@@ -189,6 +192,7 @@ ol.geom.MultiPolygon.prototype.getSimplifiedGeometryInternal =
/**
* @return {Array.<ol.geom.Polygon>} Polygons.
* @todo stability experimental
*/
ol.geom.MultiPolygon.prototype.getPolygons = function() {
var layout = this.layout;
@@ -221,6 +225,7 @@ ol.geom.MultiPolygon.prototype.getType = function() {
/**
* @param {ol.geom.RawMultiPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.MultiPolygon.prototype.setCoordinates =
function(coordinates, opt_layout) {
src/ol/geom/point.js
+3
View File
@@ -13,6 +13,7 @@ goog.require('ol.geom.flat');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.Point = function(coordinates, opt_layout) {
goog.base(this);
@@ -55,6 +56,7 @@ ol.geom.Point.prototype.closestPointXY =
/**
* @return {ol.geom.RawPoint} Coordinates.
* @todo stability experimental
*/
ol.geom.Point.prototype.getCoordinates = function() {
return this.flatCoordinates.slice();
@@ -86,6 +88,7 @@ ol.geom.Point.prototype.getType = function() {
/**
* @param {ol.geom.RawPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.Point.prototype.setCoordinates = function(coordinates, opt_layout) {
if (goog.isNull(coordinates)) {
src/ol/geom/polygon.js
+5
View File
@@ -15,6 +15,7 @@ goog.require('ol.geom.simplify');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.Polygon = function(coordinates, opt_layout) {
@@ -110,6 +111,7 @@ ol.geom.Polygon.prototype.containsXY = function(x, y) {
/**
* @return {number} Area.
* @todo stability experimental
*/
ol.geom.Polygon.prototype.getArea = function() {
return ol.geom.flat.linearRingsArea(
@@ -119,6 +121,7 @@ ol.geom.Polygon.prototype.getArea = function() {
/**
* @return {ol.geom.RawPolygon} Coordinates.
* @todo stability experimental
*/
ol.geom.Polygon.prototype.getCoordinates = function() {
return ol.geom.flat.inflateCoordinatess(
@@ -151,6 +154,7 @@ ol.geom.Polygon.prototype.getInteriorPoint = function() {
/**
* @return {Array.<ol.geom.LinearRing>} Linear rings.
* @todo stability experimental
*/
ol.geom.Polygon.prototype.getLinearRings = function() {
var layout = this.layout;
@@ -219,6 +223,7 @@ ol.geom.Polygon.prototype.getType = function() {
/**
* @param {ol.geom.RawPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/
ol.geom.Polygon.prototype.setCoordinates = function(coordinates, opt_layout) {
if (goog.isNull(coordinates)) {
src/ol/geom/simplegeometry.js
+2
View File
@@ -12,6 +12,7 @@ goog.require('ol.geom.flat');
/**
* @constructor
* @extends {ol.geom.Geometry}
* @todo stability experimental
*/
ol.geom.SimpleGeometry = function() {
@@ -107,6 +108,7 @@ ol.geom.SimpleGeometry.prototype.getFlatCoordinates = function() {
/**
* @return {ol.geom.GeometryLayout} Layout.
* @todo stability experimental
*/
ol.geom.SimpleGeometry.prototype.getLayout = function() {
return this.layout;