Add stability annotation to ol.geom.Polygon

This commit is contained in:
Tom Payne
2014-02-03 14:37:14 +01:00
parent e10bb6d3aa
commit 8f50d0f097

View File

@@ -15,6 +15,7 @@ goog.require('ol.geom.simplify');
* @extends {ol.geom.SimpleGeometry} * @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawPolygon} coordinates Coordinates. * @param {ol.geom.RawPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/ */
ol.geom.Polygon = function(coordinates, opt_layout) { ol.geom.Polygon = function(coordinates, opt_layout) {
@@ -110,6 +111,7 @@ ol.geom.Polygon.prototype.containsXY = function(x, y) {
/** /**
* @return {number} Area. * @return {number} Area.
* @todo stability experimental
*/ */
ol.geom.Polygon.prototype.getArea = function() { ol.geom.Polygon.prototype.getArea = function() {
return ol.geom.flat.linearRingsArea( return ol.geom.flat.linearRingsArea(
@@ -119,6 +121,7 @@ ol.geom.Polygon.prototype.getArea = function() {
/** /**
* @return {ol.geom.RawPolygon} Coordinates. * @return {ol.geom.RawPolygon} Coordinates.
* @todo stability experimental
*/ */
ol.geom.Polygon.prototype.getCoordinates = function() { ol.geom.Polygon.prototype.getCoordinates = function() {
return ol.geom.flat.inflateCoordinatess( return ol.geom.flat.inflateCoordinatess(
@@ -151,6 +154,7 @@ ol.geom.Polygon.prototype.getInteriorPoint = function() {
/** /**
* @return {Array.<ol.geom.LinearRing>} Linear rings. * @return {Array.<ol.geom.LinearRing>} Linear rings.
* @todo stability experimental
*/ */
ol.geom.Polygon.prototype.getLinearRings = function() { ol.geom.Polygon.prototype.getLinearRings = function() {
var layout = this.layout; var layout = this.layout;
@@ -219,6 +223,7 @@ ol.geom.Polygon.prototype.getType = function() {
/** /**
* @param {ol.geom.RawPolygon} coordinates Coordinates. * @param {ol.geom.RawPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout. * @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo stability experimental
*/ */
ol.geom.Polygon.prototype.setCoordinates = function(coordinates, opt_layout) { ol.geom.Polygon.prototype.setCoordinates = function(coordinates, opt_layout) {
if (goog.isNull(coordinates)) { if (goog.isNull(coordinates)) {