Annotations for exports

This commit is contained in:
Tim Schaub
2014-04-08 13:40:35 -06:00
parent 457cfe851a
commit fb497f5288
243 changed files with 456 additions and 451 deletions

View File

@@ -26,6 +26,7 @@ goog.require('ol.geom.flat.simplify');
* @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) {
@@ -82,6 +83,7 @@ goog.inherits(ol.geom.MultiPolygon, ol.geom.SimpleGeometry);
/**
* @param {ol.geom.Polygon} polygon Polygon.
* @todo api
*/
ol.geom.MultiPolygon.prototype.appendPolygon = function(polygon) {
goog.asserts.assert(polygon.getLayout() == this.layout);
@@ -107,6 +109,7 @@ ol.geom.MultiPolygon.prototype.appendPolygon = function(polygon) {
/**
* @inheritDoc
* @todo api
*/
ol.geom.MultiPolygon.prototype.clone = function() {
var multiPolygon = new ol.geom.MultiPolygon(null);
@@ -148,6 +151,7 @@ ol.geom.MultiPolygon.prototype.containsXY = function(x, y) {
/**
* @return {number} Area.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiPolygon.prototype.getArea = function() {
return ol.geom.flat.area.linearRingss(
@@ -158,6 +162,7 @@ ol.geom.MultiPolygon.prototype.getArea = function() {
/**
* @return {ol.geom.RawMultiPolygon} Coordinates.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiPolygon.prototype.getCoordinates = function() {
return ol.geom.flat.inflate.coordinatesss(
@@ -191,6 +196,7 @@ ol.geom.MultiPolygon.prototype.getFlatInteriorPoints = function() {
/**
* @return {ol.geom.MultiPoint} Interior points.
* @todo api
*/
ol.geom.MultiPolygon.prototype.getInteriorPoints = function() {
var interiorPoints = new ol.geom.MultiPoint(null);
@@ -242,6 +248,7 @@ ol.geom.MultiPolygon.prototype.getSimplifiedGeometryInternal =
/**
* @param {number} index Index.
* @return {ol.geom.Polygon} Polygon.
* @todo api
*/
ol.geom.MultiPolygon.prototype.getPolygon = function(index) {
goog.asserts.assert(0 <= index && index < this.endss_.length);
@@ -273,6 +280,7 @@ ol.geom.MultiPolygon.prototype.getPolygon = function(index) {
/**
* @return {Array.<ol.geom.Polygon>} Polygons.
* @todo stability experimental
* @todo api
*/
ol.geom.MultiPolygon.prototype.getPolygons = function() {
var layout = this.layout;
@@ -301,6 +309,7 @@ ol.geom.MultiPolygon.prototype.getPolygons = function() {
/**
* @inheritDoc
* @todo api
*/
ol.geom.MultiPolygon.prototype.getType = function() {
return ol.geom.GeometryType.MULTI_POLYGON;
@@ -311,6 +320,7 @@ 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 =
function(coordinates, opt_layout) {