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
+18
View File
@@ -37,6 +37,7 @@ ol.extent.Relationship = {
* @param {Array.<ol.Coordinate>} coordinates Coordinates.
* @return {ol.Extent} Bounding extent.
* @todo stability experimental
* @todo api
*/
ol.extent.boundingExtent = function(coordinates) {
var extent = ol.extent.createEmpty();
@@ -72,6 +73,7 @@ ol.extent.boundingExtentXYs_ = function(xs, ys, opt_extent) {
* @param {number} value The amount by wich the extent should be buffered.
* @param {ol.Extent=} opt_extent Extent.
* @return {ol.Extent} Extent.
* @todo api
*/
ol.extent.buffer = function(extent, value, opt_extent) {
if (goog.isDef(opt_extent)) {
@@ -145,6 +147,7 @@ ol.extent.closestSquaredDistanceXY = function(extent, x, y) {
* @param {ol.Coordinate} coordinate Coordinate.
* @return {boolean} Contains.
* @todo stability experimental
* @todo api
*/
ol.extent.containsCoordinate = function(extent, coordinate) {
return extent[0] <= coordinate[0] && coordinate[0] <= extent[2] &&
@@ -159,6 +162,7 @@ ol.extent.containsCoordinate = function(extent, coordinate) {
* @param {ol.Extent} extent2 Extent 2.
* @return {boolean} Contains.
* @todo stability experimental
* @todo api
*/
ol.extent.containsExtent = function(extent1, extent2) {
return extent1[0] <= extent2[0] && extent2[2] <= extent1[2] &&
@@ -201,6 +205,7 @@ ol.extent.coordinateRelationship = function(extent, coordinate) {
/**
* @return {ol.Extent} Empty extent.
* @todo stability experimental
* @todo api
*/
ol.extent.createEmpty = function() {
return [Infinity, Infinity, -Infinity, -Infinity];
@@ -307,6 +312,7 @@ ol.extent.empty = function(extent) {
* @param {ol.Extent} extent2 Extent 2.
* @return {boolean} Equals.
* @todo stability experimental
* @todo api
*/
ol.extent.equals = function(extent1, extent2) {
return extent1[0] == extent2[0] && extent1[2] == extent2[2] &&
@@ -319,6 +325,7 @@ ol.extent.equals = function(extent1, extent2) {
* @param {ol.Extent} extent2 Extent 2.
* @return {ol.Extent} Extent.
* @todo stability experimental
* @todo api
*/
ol.extent.extend = function(extent1, extent2) {
if (extent2[0] < extent1[0]) {
@@ -430,6 +437,7 @@ ol.extent.getArea = function(extent) {
* @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Bottom left coordinate.
* @todo stability experimental
* @todo api
*/
ol.extent.getBottomLeft = function(extent) {
return [extent[0], extent[1]];
@@ -440,6 +448,7 @@ ol.extent.getBottomLeft = function(extent) {
* @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Bottom right coordinate.
* @todo stability experimental
* @todo api
*/
ol.extent.getBottomRight = function(extent) {
return [extent[2], extent[1]];
@@ -450,6 +459,7 @@ ol.extent.getBottomRight = function(extent) {
* @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Center.
* @todo stability experimental
* @todo api
*/
ol.extent.getCenter = function(extent) {
return [(extent[0] + extent[2]) / 2, (extent[1] + extent[3]) / 2];
@@ -504,6 +514,7 @@ ol.extent.getForView2DAndSize =
* @param {ol.Extent} extent Extent.
* @return {number} Height.
* @todo stability experimental
* @todo api
*/
ol.extent.getHeight = function(extent) {
return extent[3] - extent[1];
@@ -537,6 +548,7 @@ ol.extent.getMargin = function(extent) {
* @param {ol.Extent} extent Extent.
* @return {ol.Size} Size.
* @todo stability experimental
* @todo api
*/
ol.extent.getSize = function(extent) {
return [extent[2] - extent[0], extent[3] - extent[1]];
@@ -547,6 +559,7 @@ ol.extent.getSize = function(extent) {
* @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Top left coordinate.
* @todo stability experimental
* @todo api
*/
ol.extent.getTopLeft = function(extent) {
return [extent[0], extent[3]];
@@ -557,6 +570,7 @@ ol.extent.getTopLeft = function(extent) {
* @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Top right coordinate.
* @todo stability experimental
* @todo api
*/
ol.extent.getTopRight = function(extent) {
return [extent[2], extent[3]];
@@ -567,6 +581,7 @@ ol.extent.getTopRight = function(extent) {
* @param {ol.Extent} extent Extent.
* @return {number} Width.
* @todo stability experimental
* @todo api
*/
ol.extent.getWidth = function(extent) {
return extent[2] - extent[0];
@@ -578,6 +593,7 @@ ol.extent.getWidth = function(extent) {
* @param {ol.Extent} extent2 Extent.
* @return {boolean} Intersects.
* @todo stability experimental
* @todo api
*/
ol.extent.intersects = function(extent1, extent2) {
return extent1[0] <= extent2[2] &&
@@ -591,6 +607,7 @@ ol.extent.intersects = function(extent1, extent2) {
* @param {ol.Extent} extent Extent.
* @return {boolean} Is empty.
* @todo stability experimental
* @todo api
*/
ol.extent.isEmpty = function(extent) {
return extent[2] < extent[0] || extent[3] < extent[1];
@@ -728,6 +745,7 @@ ol.extent.touches = function(extent1, extent2) {
* @param {ol.Extent=} opt_extent Destination extent.
* @return {ol.Extent} Extent.
* @todo stability experimental
* @todo api
*/
ol.extent.transform = function(extent, transformFn, opt_extent) {
var coordinates = [