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

Use @api annotation instead of @todo api

Browse Source
This commit is contained in:
Tim Schaub
2014-07-05 15:41:14 -04:00
parent 297503e7c9
commit 4cf5ab4620
155 changed files with 759 additions and 757 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ol/geom/circle.js
+9 -9
View File
@@ -17,7 +17,7 @@ goog.require('ol.geom.flat.deflate');
* @param {ol.geom.RawPoint} center Center.
* @param {number=} opt_radius Radius.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api
* @api
*/
ol.geom.Circle = function(center, opt_radius, opt_layout) {
goog.base(this);
@@ -30,7 +30,7 @@ goog.inherits(ol.geom.Circle, ol.geom.SimpleGeometry);
/**
* @inheritDoc
* @todo api
* @api
*/
ol.geom.Circle.prototype.clone = function() {
var circle = new ol.geom.Circle(null);
@@ -83,7 +83,7 @@ ol.geom.Circle.prototype.containsXY = function(x, y) {
/**
* @return {ol.geom.RawPoint} Center.
* @todo api
* @api
*/
ol.geom.Circle.prototype.getCenter = function() {
return this.flatCoordinates.slice(0, this.stride);
@@ -92,7 +92,7 @@ ol.geom.Circle.prototype.getCenter = function() {
/**
* @inheritDoc
* @todo api
* @api
*/
ol.geom.Circle.prototype.getExtent = function(opt_extent) {
if (this.extentRevision != this.getRevision()) {
@@ -111,7 +111,7 @@ ol.geom.Circle.prototype.getExtent = function(opt_extent) {
/**
* @return {number} Radius.
* @todo api
* @api
*/
ol.geom.Circle.prototype.getRadius = function() {
return Math.sqrt(this.getRadiusSquared_());
@@ -131,7 +131,7 @@ ol.geom.Circle.prototype.getRadiusSquared_ = function() {
/**
* @inheritDoc
* @todo api
* @api
*/
ol.geom.Circle.prototype.getType = function() {
return ol.geom.GeometryType.CIRCLE;
@@ -140,7 +140,7 @@ ol.geom.Circle.prototype.getType = function() {
/**
* @param {ol.geom.RawPoint} center Center.
* @todo api
* @api
*/
ol.geom.Circle.prototype.setCenter = function(center) {
var stride = this.stride;
@@ -160,7 +160,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 api
* @api
*/
ol.geom.Circle.prototype.setCenterAndRadius =
function(center, radius, opt_layout) {
@@ -199,7 +199,7 @@ ol.geom.Circle.prototype.setFlatCoordinates =
/**
* @param {number} radius Radius.
* @todo api
* @api
*/
ol.geom.Circle.prototype.setRadius = function(radius) {
goog.asserts.assert(!goog.isNull(this.flatCoordinates));
src/ol/geom/geometry.js
+14 -14
View File
@@ -12,7 +12,7 @@ goog.require('ol.proj');
* `'Polygon'`, `'MultiPoint'`, `'MultiLineString'`, `'MultiPolygon'`,
* `'GeometryCollection'`, `'Circle'`.
* @enum {string}
* @todo api
* @api
*/
ol.geom.GeometryType = {
POINT: 'Point',
@@ -32,7 +32,7 @@ ol.geom.GeometryType = {
* or measure ('M') coordinate is available. Supported values are `'XY'`,
* `'XYZ'`, `'XYM'`, `'XYZM'`.
* @enum {string}
* @todo api
* @api
*/
ol.geom.GeometryLayout = {
XY: 'XY',
@@ -52,7 +52,7 @@ ol.geom.GeometryLayout = {
* @constructor
* @extends {ol.Observable}
* @fires change Triggered when the geometry changes.
* @todo api
* @api
*/
ol.geom.Geometry = function() {
@@ -113,7 +113,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 api
* @api
*/
ol.geom.Geometry.prototype.getClosestPoint = function(point, opt_closestPoint) {
var closestPoint = goog.isDef(opt_closestPoint) ?
@@ -145,7 +145,7 @@ ol.geom.Geometry.prototype.containsXY = goog.functions.FALSE;
* @function
* @param {ol.Extent=} opt_extent Extent.
* @return {ol.Extent} extent Extent.
* @todo api
* @api
*/
ol.geom.Geometry.prototype.getExtent = goog.abstractMethod;
@@ -171,7 +171,7 @@ ol.geom.Geometry.prototype.getType = goog.abstractMethod;
* then use this function on the clone.
* @function
* @param {ol.TransformFunction} transformFn Transform.
* @todo api
* @api
*/
ol.geom.Geometry.prototype.applyTransform = goog.abstractMethod;
@@ -188,7 +188,7 @@ ol.geom.Geometry.prototype.applyTransform = goog.abstractMethod;
* string identifier or a {@link ol.proj.Projection} object.
* @return {ol.geom.Geometry} This geometry. Note that original geometry is
* modified in place.
* @todo api
* @api
*/
ol.geom.Geometry.prototype.transform = function(source, destination) {
this.applyTransform(ol.proj.getTransform(source, destination));
@@ -199,7 +199,7 @@ ol.geom.Geometry.prototype.transform = function(source, destination) {
/**
* Array representation of a point. Example: `[16, 48]`.
* @typedef {ol.Coordinate}
* @todo api
* @api
*/
ol.geom.RawPoint;
@@ -207,7 +207,7 @@ ol.geom.RawPoint;
/**
* Array representation of a linestring.
* @typedef {Array.<ol.Coordinate>}
* @todo api
* @api
*/
ol.geom.RawLineString;
@@ -215,7 +215,7 @@ ol.geom.RawLineString;
/**
* Array representation of a linear ring.
* @typedef {Array.<ol.Coordinate>}
* @todo api
* @api
*/
ol.geom.RawLinearRing;
@@ -223,7 +223,7 @@ ol.geom.RawLinearRing;
/**
* Array representation of a polygon.
* @typedef {Array.<ol.geom.RawLinearRing>}
* @todo api
* @api
*/
ol.geom.RawPolygon;
@@ -231,7 +231,7 @@ ol.geom.RawPolygon;
/**
* Array representation of a multipoint.
* @typedef {Array.<ol.geom.RawPoint>}
* @todo api
* @api
*/
ol.geom.RawMultiPoint;
@@ -239,7 +239,7 @@ ol.geom.RawMultiPoint;
/**
* Array representation of a multilinestring.
* @typedef {Array.<ol.geom.RawLineString>}
* @todo api
* @api
*/
ol.geom.RawMultiLineString;
@@ -247,6 +247,6 @@ ol.geom.RawMultiLineString;
/**
* Array representation of a multipolygon.
* @typedef {Array.<ol.geom.RawPolygon>}
* @todo api
* @api
*/
ol.geom.RawMultiPolygon;
src/ol/geom/geometrycollection.js
+7 -7
View File
@@ -18,7 +18,7 @@ goog.require('ol.geom.GeometryType');
* @constructor
* @extends {ol.geom.Geometry}
* @param {Array.<ol.geom.Geometry>=} opt_geometries Geometries.
* @todo api
* @api
*/
ol.geom.GeometryCollection = function(opt_geometries) {
@@ -84,7 +84,7 @@ ol.geom.GeometryCollection.prototype.listenGeometriesChange_ = function() {
/**
* @inheritDoc
* @todo api
* @api
*/
ol.geom.GeometryCollection.prototype.clone = function() {
var geometryCollection = new ol.geom.GeometryCollection(null);
@@ -129,7 +129,7 @@ ol.geom.GeometryCollection.prototype.containsXY = function(x, y) {
/**
* @inheritDoc
* @todo api
* @api
*/
ol.geom.GeometryCollection.prototype.getExtent = function(opt_extent) {
if (this.extentRevision != this.getRevision()) {
@@ -149,7 +149,7 @@ ol.geom.GeometryCollection.prototype.getExtent = function(opt_extent) {
/**
* @return {Array.<ol.geom.Geometry>} Geometries.
* @todo api
* @api
*/
ol.geom.GeometryCollection.prototype.getGeometries = function() {
return ol.geom.GeometryCollection.cloneGeometries_(this.geometries_);
@@ -166,7 +166,7 @@ ol.geom.GeometryCollection.prototype.getGeometriesArray = function() {
/**
* @inheritDoc
* @todo api
* @api
*/
ol.geom.GeometryCollection.prototype.getSimplifiedGeometry =
function(squaredTolerance) {
@@ -211,7 +211,7 @@ ol.geom.GeometryCollection.prototype.getSimplifiedGeometry =
/**
* @inheritDoc
* @todo api
* @api
*/
ol.geom.GeometryCollection.prototype.getType = function() {
return ol.geom.GeometryType.GEOMETRY_COLLECTION;
@@ -228,7 +228,7 @@ ol.geom.GeometryCollection.prototype.isEmpty = function() {
/**
* @param {Array.<ol.geom.Geometry>} geometries Geometries.
* @todo api
* @api
*/
ol.geom.GeometryCollection.prototype.setGeometries = function(geometries) {
this.setGeometriesArray(
src/ol/geom/linearring.js
+6 -6
View File
@@ -19,7 +19,7 @@ goog.require('ol.geom.flat.simplify');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawLinearRing} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api
* @api
*/
ol.geom.LinearRing = function(coordinates, opt_layout) {
@@ -46,7 +46,7 @@ goog.inherits(ol.geom.LinearRing, ol.geom.SimpleGeometry);
/**
* @inheritDoc
* @todo api
* @api
*/
ol.geom.LinearRing.prototype.clone = function() {
var linearRing = new ol.geom.LinearRing(null);
@@ -77,7 +77,7 @@ ol.geom.LinearRing.prototype.closestPointXY =
/**
* @return {number} Area.
* @todo api
* @api
*/
ol.geom.LinearRing.prototype.getArea = function() {
return ol.geom.flat.area.linearRing(
@@ -87,7 +87,7 @@ ol.geom.LinearRing.prototype.getArea = function() {
/**
* @return {ol.geom.RawLinearRing} Coordinates.
* @todo api
* @api
*/
ol.geom.LinearRing.prototype.getCoordinates = function() {
return ol.geom.flat.inflate.coordinates(
@@ -113,7 +113,7 @@ ol.geom.LinearRing.prototype.getSimplifiedGeometryInternal =
/**
* @inheritDoc
* @todo api
* @api
*/
ol.geom.LinearRing.prototype.getType = function() {
return ol.geom.GeometryType.LINEAR_RING;
@@ -123,7 +123,7 @@ ol.geom.LinearRing.prototype.getType = function() {
/**
* @param {ol.geom.RawLinearRing} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api
* @api
*/
ol.geom.LinearRing.prototype.setCoordinates =
function(coordinates, opt_layout) {
src/ol/geom/linestring.js
+8 -8
View File
@@ -22,7 +22,7 @@ goog.require('ol.geom.flat.simplify');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api
* @api
*/
ol.geom.LineString = function(coordinates, opt_layout) {
@@ -61,7 +61,7 @@ goog.inherits(ol.geom.LineString, ol.geom.SimpleGeometry);
/**
* @param {ol.Coordinate} coordinate Coordinate.
* @todo api
* @api
*/
ol.geom.LineString.prototype.appendCoordinate = function(coordinate) {
goog.asserts.assert(coordinate.length == this.stride);
@@ -76,7 +76,7 @@ ol.geom.LineString.prototype.appendCoordinate = function(coordinate) {
/**
* @inheritDoc
* @todo api
* @api
*/
ol.geom.LineString.prototype.clone = function() {
var lineString = new ol.geom.LineString(null);
@@ -117,7 +117,7 @@ ol.geom.LineString.prototype.closestPointXY =
* @param {number} m M.
* @param {boolean=} opt_extrapolate Extrapolate.
* @return {ol.Coordinate} Coordinate.
* @todo api
* @api
*/
ol.geom.LineString.prototype.getCoordinateAtM = function(m, opt_extrapolate) {
if (this.layout != ol.geom.GeometryLayout.XYM &&
@@ -132,7 +132,7 @@ ol.geom.LineString.prototype.getCoordinateAtM = function(m, opt_extrapolate) {
/**
* @return {ol.geom.RawLineString} Coordinates.
* @todo api
* @api
*/
ol.geom.LineString.prototype.getCoordinates = function() {
return ol.geom.flat.inflate.coordinates(
@@ -142,7 +142,7 @@ ol.geom.LineString.prototype.getCoordinates = function() {
/**
* @return {number} Length.
* @todo api
* @api
*/
ol.geom.LineString.prototype.getLength = function() {
return ol.geom.flat.length.lineString(
@@ -182,7 +182,7 @@ ol.geom.LineString.prototype.getSimplifiedGeometryInternal =
/**
* @inheritDoc
* @todo api
* @api
*/
ol.geom.LineString.prototype.getType = function() {
return ol.geom.GeometryType.LINE_STRING;
@@ -192,7 +192,7 @@ ol.geom.LineString.prototype.getType = function() {
/**
* @param {ol.geom.RawLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api
* @api
*/
ol.geom.LineString.prototype.setCoordinates =
function(coordinates, opt_layout) {
src/ol/geom/multilinestring.js
+9 -9
View File
@@ -22,7 +22,7 @@ goog.require('ol.geom.flat.simplify');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawMultiLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api
* @api
*/
ol.geom.MultiLineString = function(coordinates, opt_layout) {
@@ -55,7 +55,7 @@ goog.inherits(ol.geom.MultiLineString, ol.geom.SimpleGeometry);
/**
* @param {ol.geom.LineString} lineString LineString.
* @todo api
* @api
*/
ol.geom.MultiLineString.prototype.appendLineString = function(lineString) {
goog.asserts.assert(lineString.getLayout() == this.layout);
@@ -72,7 +72,7 @@ ol.geom.MultiLineString.prototype.appendLineString = function(lineString) {
/**
* @inheritDoc
* @todo api
* @api
*/
ol.geom.MultiLineString.prototype.clone = function() {
var multiLineString = new ol.geom.MultiLineString(null);
@@ -122,7 +122,7 @@ ol.geom.MultiLineString.prototype.closestPointXY =
* @param {boolean=} opt_extrapolate Extrapolate.
* @param {boolean=} opt_interpolate Interpolate.
* @return {ol.Coordinate} Coordinate.
* @todo api
* @api
*/
ol.geom.MultiLineString.prototype.getCoordinateAtM =
function(m, opt_extrapolate, opt_interpolate) {
@@ -140,7 +140,7 @@ ol.geom.MultiLineString.prototype.getCoordinateAtM =
/**
* @return {ol.geom.RawMultiLineString} Coordinates.
* @todo api
* @api
*/
ol.geom.MultiLineString.prototype.getCoordinates = function() {
return ol.geom.flat.inflate.coordinatess(
@@ -159,7 +159,7 @@ ol.geom.MultiLineString.prototype.getEnds = function() {
/**
* @param {number} index Index.
* @return {ol.geom.LineString} LineString.
* @todo api
* @api
*/
ol.geom.MultiLineString.prototype.getLineString = function(index) {
goog.asserts.assert(0 <= index && index < this.ends_.length);
@@ -175,7 +175,7 @@ ol.geom.MultiLineString.prototype.getLineString = function(index) {
/**
* @return {Array.<ol.geom.LineString>} LineStrings.
* @todo api
* @api
*/
ol.geom.MultiLineString.prototype.getLineStrings = function() {
var flatCoordinates = this.flatCoordinates;
@@ -236,7 +236,7 @@ ol.geom.MultiLineString.prototype.getSimplifiedGeometryInternal =
/**
* @inheritDoc
* @todo api
* @api
*/
ol.geom.MultiLineString.prototype.getType = function() {
return ol.geom.GeometryType.MULTI_LINE_STRING;
@@ -246,7 +246,7 @@ ol.geom.MultiLineString.prototype.getType = function() {
/**
* @param {ol.geom.RawMultiLineString} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api
* @api
*/
ol.geom.MultiLineString.prototype.setCoordinates =
function(coordinates, opt_layout) {
src/ol/geom/multipoint.js
+8 -8
View File
@@ -20,7 +20,7 @@ goog.require('ol.math');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawMultiPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api
* @api
*/
ol.geom.MultiPoint = function(coordinates, opt_layout) {
goog.base(this);
@@ -32,7 +32,7 @@ goog.inherits(ol.geom.MultiPoint, ol.geom.SimpleGeometry);
/**
* @param {ol.geom.Point} point Point.
* @todo api
* @api
*/
ol.geom.MultiPoint.prototype.appendPoint = function(point) {
goog.asserts.assert(point.getLayout() == this.layout);
@@ -47,7 +47,7 @@ ol.geom.MultiPoint.prototype.appendPoint = function(point) {
/**
* @inheritDoc
* @todo api
* @api
*/
ol.geom.MultiPoint.prototype.clone = function() {
var multiPoint = new ol.geom.MultiPoint(null);
@@ -85,7 +85,7 @@ ol.geom.MultiPoint.prototype.closestPointXY =
/**
* @return {ol.geom.RawMultiPoint} Coordinates.
* @todo api
* @api
*/
ol.geom.MultiPoint.prototype.getCoordinates = function() {
return ol.geom.flat.inflate.coordinates(
@@ -96,7 +96,7 @@ ol.geom.MultiPoint.prototype.getCoordinates = function() {
/**
* @param {number} index Index.
* @return {ol.geom.Point} Point.
* @todo api
* @api
*/
ol.geom.MultiPoint.prototype.getPoint = function(index) {
var n = goog.isNull(this.flatCoordinates) ?
@@ -114,7 +114,7 @@ ol.geom.MultiPoint.prototype.getPoint = function(index) {
/**
* @return {Array.<ol.geom.Point>} Points.
* @todo api
* @api
*/
ol.geom.MultiPoint.prototype.getPoints = function() {
var flatCoordinates = this.flatCoordinates;
@@ -134,7 +134,7 @@ ol.geom.MultiPoint.prototype.getPoints = function() {
/**
* @inheritDoc
* @todo api
* @api
*/
ol.geom.MultiPoint.prototype.getType = function() {
return ol.geom.GeometryType.MULTI_POINT;
@@ -144,7 +144,7 @@ ol.geom.MultiPoint.prototype.getType = function() {
/**
* @param {ol.geom.RawMultiPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api
* @api
*/
ol.geom.MultiPoint.prototype.setCoordinates =
function(coordinates, opt_layout) {
src/ol/geom/multipolygon.js
+10 -10
View File
@@ -27,7 +27,7 @@ goog.require('ol.geom.flat.simplify');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawMultiPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api
* @api
*/
ol.geom.MultiPolygon = function(coordinates, opt_layout) {
@@ -84,7 +84,7 @@ goog.inherits(ol.geom.MultiPolygon, ol.geom.SimpleGeometry);
/**
* @param {ol.geom.Polygon} polygon Polygon.
* @todo api
* @api
*/
ol.geom.MultiPolygon.prototype.appendPolygon = function(polygon) {
goog.asserts.assert(polygon.getLayout() == this.layout);
@@ -110,7 +110,7 @@ ol.geom.MultiPolygon.prototype.appendPolygon = function(polygon) {
/**
* @inheritDoc
* @todo api
* @api
*/
ol.geom.MultiPolygon.prototype.clone = function() {
var multiPolygon = new ol.geom.MultiPolygon(null);
@@ -151,7 +151,7 @@ ol.geom.MultiPolygon.prototype.containsXY = function(x, y) {
/**
* @return {number} Area.
* @todo api
* @api
*/
ol.geom.MultiPolygon.prototype.getArea = function() {
return ol.geom.flat.area.linearRingss(
@@ -161,7 +161,7 @@ ol.geom.MultiPolygon.prototype.getArea = function() {
/**
* @return {ol.geom.RawMultiPolygon} Coordinates.
* @todo api
* @api
*/
ol.geom.MultiPolygon.prototype.getCoordinates = function() {
return ol.geom.flat.inflate.coordinatesss(
@@ -195,7 +195,7 @@ ol.geom.MultiPolygon.prototype.getFlatInteriorPoints = function() {
/**
* @return {ol.geom.MultiPoint} Interior points.
* @todo api
* @api
*/
ol.geom.MultiPolygon.prototype.getInteriorPoints = function() {
var interiorPoints = new ol.geom.MultiPoint(null);
@@ -247,7 +247,7 @@ ol.geom.MultiPolygon.prototype.getSimplifiedGeometryInternal =
/**
* @param {number} index Index.
* @return {ol.geom.Polygon} Polygon.
* @todo api
* @api
*/
ol.geom.MultiPolygon.prototype.getPolygon = function(index) {
goog.asserts.assert(0 <= index && index < this.endss_.length);
@@ -278,7 +278,7 @@ ol.geom.MultiPolygon.prototype.getPolygon = function(index) {
/**
* @return {Array.<ol.geom.Polygon>} Polygons.
* @todo api
* @api
*/
ol.geom.MultiPolygon.prototype.getPolygons = function() {
var layout = this.layout;
@@ -307,7 +307,7 @@ ol.geom.MultiPolygon.prototype.getPolygons = function() {
/**
* @inheritDoc
* @todo api
* @api
*/
ol.geom.MultiPolygon.prototype.getType = function() {
return ol.geom.GeometryType.MULTI_POLYGON;
@@ -317,7 +317,7 @@ ol.geom.MultiPolygon.prototype.getType = function() {
/**
* @param {ol.geom.RawMultiPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api
* @api
*/
ol.geom.MultiPolygon.prototype.setCoordinates =
function(coordinates, opt_layout) {
src/ol/geom/point.js
+5 -5
View File
@@ -17,7 +17,7 @@ goog.require('ol.math');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api
* @api
*/
ol.geom.Point = function(coordinates, opt_layout) {
goog.base(this);
@@ -29,7 +29,7 @@ goog.inherits(ol.geom.Point, ol.geom.SimpleGeometry);
/**
* @inheritDoc
* @todo api
* @api
*/
ol.geom.Point.prototype.clone = function() {
var point = new ol.geom.Point(null);
@@ -62,7 +62,7 @@ ol.geom.Point.prototype.closestPointXY =
/**
* @return {ol.geom.RawPoint} Coordinates.
* @todo api
* @api
*/
ol.geom.Point.prototype.getCoordinates = function() {
return this.flatCoordinates.slice();
@@ -85,7 +85,7 @@ ol.geom.Point.prototype.getExtent = function(opt_extent) {
/**
* @inheritDoc
* @todo api
* @api
*/
ol.geom.Point.prototype.getType = function() {
return ol.geom.GeometryType.POINT;
@@ -95,7 +95,7 @@ ol.geom.Point.prototype.getType = function() {
/**
* @param {ol.geom.RawPoint} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api
* @api
*/
ol.geom.Point.prototype.setCoordinates = function(coordinates, opt_layout) {
if (goog.isNull(coordinates)) {
src/ol/geom/polygon.js
+11 -11
View File
@@ -27,7 +27,7 @@ goog.require('ol.geom.flat.simplify');
* @extends {ol.geom.SimpleGeometry}
* @param {ol.geom.RawPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api
* @api
*/
ol.geom.Polygon = function(coordinates, opt_layout) {
@@ -84,7 +84,7 @@ goog.inherits(ol.geom.Polygon, ol.geom.SimpleGeometry);
/**
* @param {ol.geom.LinearRing} linearRing Linear ring.
* @todo api
* @api
*/
ol.geom.Polygon.prototype.appendLinearRing = function(linearRing) {
goog.asserts.assert(linearRing.getLayout() == this.layout);
@@ -100,7 +100,7 @@ ol.geom.Polygon.prototype.appendLinearRing = function(linearRing) {
/**
* @inheritDoc
* @todo api
* @api
*/
ol.geom.Polygon.prototype.clone = function() {
var polygon = new ol.geom.Polygon(null);
@@ -141,7 +141,7 @@ ol.geom.Polygon.prototype.containsXY = function(x, y) {
/**
* @return {number} Area.
* @todo api
* @api
*/
ol.geom.Polygon.prototype.getArea = function() {
return ol.geom.flat.area.linearRings(
@@ -151,7 +151,7 @@ ol.geom.Polygon.prototype.getArea = function() {
/**
* @return {ol.geom.RawPolygon} Coordinates.
* @todo api
* @api
*/
ol.geom.Polygon.prototype.getCoordinates = function() {
return ol.geom.flat.inflate.coordinatess(
@@ -184,7 +184,7 @@ ol.geom.Polygon.prototype.getFlatInteriorPoint = function() {
/**
* @return {ol.geom.Point} Interior point.
* @todo api
* @api
*/
ol.geom.Polygon.prototype.getInteriorPoint = function() {
return new ol.geom.Point(this.getFlatInteriorPoint());
@@ -194,7 +194,7 @@ ol.geom.Polygon.prototype.getInteriorPoint = function() {
/**
* @param {number} index Index.
* @return {ol.geom.LinearRing} Linear ring.
* @todo api
* @api
*/
ol.geom.Polygon.prototype.getLinearRing = function(index) {
goog.asserts.assert(0 <= index && index < this.ends_.length);
@@ -210,7 +210,7 @@ ol.geom.Polygon.prototype.getLinearRing = function(index) {
/**
* @return {Array.<ol.geom.LinearRing>} Linear rings.
* @todo api
* @api
*/
ol.geom.Polygon.prototype.getLinearRings = function() {
var layout = this.layout;
@@ -271,7 +271,7 @@ ol.geom.Polygon.prototype.getSimplifiedGeometryInternal =
/**
* @inheritDoc
* @todo api
* @api
*/
ol.geom.Polygon.prototype.getType = function() {
return ol.geom.GeometryType.POLYGON;
@@ -281,7 +281,7 @@ ol.geom.Polygon.prototype.getType = function() {
/**
* @param {ol.geom.RawPolygon} coordinates Coordinates.
* @param {ol.geom.GeometryLayout=} opt_layout Layout.
* @todo api
* @api
*/
ol.geom.Polygon.prototype.setCoordinates = function(coordinates, opt_layout) {
if (goog.isNull(coordinates)) {
@@ -326,7 +326,7 @@ ol.geom.Polygon.prototype.setFlatCoordinates =
* @param {number} radius Radius.
* @param {number=} opt_n Optional number of points. Default is `32`.
* @return {ol.geom.Polygon} Circle geometry.
* @todo api
* @api
*/
ol.geom.Polygon.circular = function(sphere, center, radius, opt_n) {
var n = goog.isDef(opt_n) ? opt_n : 32;
src/ol/geom/simplegeometry.js
+6 -6
View File
@@ -16,7 +16,7 @@ goog.require('ol.geom.flat.transform');
*
* @constructor
* @extends {ol.geom.Geometry}
* @todo api
* @api
*/
ol.geom.SimpleGeometry = function() {
@@ -90,7 +90,7 @@ ol.geom.SimpleGeometry.prototype.containsXY = goog.functions.FALSE;
/**
* @inheritDoc
* @todo api
* @api
*/
ol.geom.SimpleGeometry.prototype.getExtent = function(opt_extent) {
if (this.extentRevision != this.getRevision()) {
@@ -106,7 +106,7 @@ ol.geom.SimpleGeometry.prototype.getExtent = function(opt_extent) {
/**
* @return {ol.Coordinate} First coordinate.
* @todo api
* @api
*/
ol.geom.SimpleGeometry.prototype.getFirstCoordinate = function() {
return this.flatCoordinates.slice(0, this.stride);
@@ -123,7 +123,7 @@ ol.geom.SimpleGeometry.prototype.getFlatCoordinates = function() {
/**
* @return {ol.Coordinate} Last point.
* @todo api
* @api
*/
ol.geom.SimpleGeometry.prototype.getLastCoordinate = function() {
return this.flatCoordinates.slice(this.flatCoordinates.length - this.stride);
@@ -132,7 +132,7 @@ ol.geom.SimpleGeometry.prototype.getLastCoordinate = function() {
/**
* @return {ol.geom.GeometryLayout} Layout.
* @todo api
* @api
*/
ol.geom.SimpleGeometry.prototype.getLayout = function() {
return this.layout;
@@ -141,7 +141,7 @@ ol.geom.SimpleGeometry.prototype.getLayout = function() {
/**
* @inheritDoc
* @todo api
* @api
*/
ol.geom.SimpleGeometry.prototype.getSimplifiedGeometry =
function(squaredTolerance) {