Add default stability level to docs of exported things.

This commit is contained in:
Paul Spencer
2013-10-24 17:07:02 -04:00
parent a13c5d30a2
commit bada596b45
108 changed files with 382 additions and 0 deletions

View File

@@ -10,6 +10,7 @@ goog.require('ol.TransformFunction');
/**
* An array of numbers representing an extent: `[minx, miny, maxx, maxy]`.
* @typedef {Array.<number>}
* @todo stability experimental
*/
ol.Extent;
@@ -19,6 +20,7 @@ ol.Extent;
*
* @param {Array.<ol.Coordinate>} coordinates Coordinates.
* @return {ol.Extent} Bounding extent.
* @todo stability experimental
*/
ol.extent.boundingExtent = function(coordinates) {
var extent = ol.extent.createEmpty();
@@ -37,6 +39,7 @@ ol.extent.boundingExtent = function(coordinates) {
* @param {ol.Extent=} opt_extent Destination extent.
* @private
* @return {ol.Extent} Extent.
* @todo stability experimental
*/
ol.extent.boundingExtentXYs_ = function(xs, ys, opt_extent) {
goog.asserts.assert(xs.length > 0);
@@ -54,6 +57,7 @@ ol.extent.boundingExtentXYs_ = function(xs, ys, opt_extent) {
*
* @param {ol.Extent} extent Extent to clone.
* @return {ol.Extent} The clone.
* @todo stability experimental
*/
ol.extent.clone = function(extent) {
return extent.slice();
@@ -66,6 +70,7 @@ ol.extent.clone = function(extent) {
* @param {ol.Extent} extent Extent.
* @param {ol.Coordinate} coordinate Coordinate.
* @return {boolean} Contains.
* @todo stability experimental
*/
ol.extent.containsCoordinate = function(extent, coordinate) {
return extent[0] <= coordinate[0] && coordinate[0] <= extent[2] &&
@@ -79,6 +84,7 @@ ol.extent.containsCoordinate = function(extent, coordinate) {
* @param {ol.Extent} extent1 Extent 1.
* @param {ol.Extent} extent2 Extent 2.
* @return {boolean} Contains.
* @todo stability experimental
*/
ol.extent.containsExtent = function(extent1, extent2) {
return extent1[0] <= extent2[0] && extent2[2] <= extent1[2] &&
@@ -88,6 +94,7 @@ ol.extent.containsExtent = function(extent1, extent2) {
/**
* @return {ol.Extent} Empty extent.
* @todo stability experimental
*/
ol.extent.createEmpty = function() {
return [Infinity, Infinity, -Infinity, -Infinity];
@@ -101,6 +108,7 @@ ol.extent.createEmpty = function() {
* @param {number} maxY Maximum Y.
* @param {ol.Extent=} opt_extent Destination extent.
* @return {ol.Extent} Extent.
* @todo stability experimental
*/
ol.extent.createOrUpdate = function(minX, maxX, minY, maxY, opt_extent) {
if (goog.isDef(opt_extent)) {
@@ -119,6 +127,7 @@ ol.extent.createOrUpdate = function(minX, maxX, minY, maxY, opt_extent) {
* Empties extent in place.
* @param {ol.Extent} extent Extent.
* @return {ol.Extent} Extent.
* @todo stability experimental
*/
ol.extent.empty = function(extent) {
extent[0] = extent[1] = Infinity;
@@ -131,6 +140,7 @@ ol.extent.empty = function(extent) {
* @param {ol.Extent} extent1 Extent 1.
* @param {ol.Extent} extent2 Extent 2.
* @return {boolean} Equals.
* @todo stability experimental
*/
ol.extent.equals = function(extent1, extent2) {
return extent1[0] == extent2[0] && extent1[2] == extent2[2] &&
@@ -141,6 +151,7 @@ ol.extent.equals = function(extent1, extent2) {
/**
* @param {ol.Extent} extent1 Extent 1.
* @param {ol.Extent} extent2 Extent 2.
* @todo stability experimental
*/
ol.extent.extend = function(extent1, extent2) {
if (extent2[0] < extent1[0]) {
@@ -161,6 +172,7 @@ ol.extent.extend = function(extent1, extent2) {
/**
* @param {ol.Extent} extent Extent.
* @param {ol.Coordinate} coordinate Coordinate.
* @todo stability experimental
*/
ol.extent.extendCoordinate = function(extent, coordinate) {
if (coordinate[0] < extent[0]) {
@@ -181,6 +193,7 @@ ol.extent.extendCoordinate = function(extent, coordinate) {
/**
* @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Bottom left coordinate.
* @todo stability experimental
*/
ol.extent.getBottomLeft = function(extent) {
return [extent[0], extent[1]];
@@ -190,6 +203,7 @@ ol.extent.getBottomLeft = function(extent) {
/**
* @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Bottom right coordinate.
* @todo stability experimental
*/
ol.extent.getBottomRight = function(extent) {
return [extent[2], extent[1]];
@@ -199,6 +213,7 @@ ol.extent.getBottomRight = function(extent) {
/**
* @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Center.
* @todo stability experimental
*/
ol.extent.getCenter = function(extent) {
return [(extent[0] + extent[2]) / 2, (extent[1] + extent[3]) / 2];
@@ -212,6 +227,7 @@ ol.extent.getCenter = function(extent) {
* @param {ol.Size} size Size.
* @param {ol.Extent=} opt_extent Destination extent.
* @return {ol.Extent} Extent.
* @todo stability experimental
*/
ol.extent.getForView2DAndSize =
function(center, resolution, rotation, size, opt_extent) {
@@ -237,6 +253,7 @@ ol.extent.getForView2DAndSize =
/**
* @param {ol.Extent} extent Extent.
* @return {number} Height.
* @todo stability experimental
*/
ol.extent.getHeight = function(extent) {
return extent[3] - extent[1];
@@ -246,6 +263,7 @@ ol.extent.getHeight = function(extent) {
/**
* @param {ol.Extent} extent Extent.
* @return {ol.Size} Size.
* @todo stability experimental
*/
ol.extent.getSize = function(extent) {
return [extent[2] - extent[0], extent[3] - extent[1]];
@@ -255,6 +273,7 @@ ol.extent.getSize = function(extent) {
/**
* @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Top left coordinate.
* @todo stability experimental
*/
ol.extent.getTopLeft = function(extent) {
return [extent[0], extent[3]];
@@ -264,6 +283,7 @@ ol.extent.getTopLeft = function(extent) {
/**
* @param {ol.Extent} extent Extent.
* @return {ol.Coordinate} Top right coordinate.
* @todo stability experimental
*/
ol.extent.getTopRight = function(extent) {
return [extent[2], extent[3]];
@@ -273,6 +293,7 @@ ol.extent.getTopRight = function(extent) {
/**
* @param {ol.Extent} extent Extent.
* @return {number} Width.
* @todo stability experimental
*/
ol.extent.getWidth = function(extent) {
return extent[2] - extent[0];
@@ -283,6 +304,7 @@ ol.extent.getWidth = function(extent) {
* @param {ol.Extent} extent1 Extent 1.
* @param {ol.Extent} extent2 Extent.
* @return {boolean} Intersects.
* @todo stability experimental
*/
ol.extent.intersects = function(extent1, extent2) {
return extent1[0] <= extent2[2] &&
@@ -295,6 +317,7 @@ ol.extent.intersects = function(extent1, extent2) {
/**
* @param {ol.Extent} extent Extent.
* @return {boolean} Is empty.
* @todo stability experimental
*/
ol.extent.isEmpty = function(extent) {
return extent[2] < extent[0] || extent[3] < extent[1];
@@ -305,6 +328,7 @@ ol.extent.isEmpty = function(extent) {
* @param {ol.Extent} extent Extent.
* @param {ol.Coordinate} coordinate Coordinate.
* @return {ol.Coordinate} Coordinate.
* @todo stability experimental
*/
ol.extent.normalize = function(extent, coordinate) {
return [
@@ -317,6 +341,7 @@ ol.extent.normalize = function(extent, coordinate) {
/**
* @param {ol.Extent} extent Extent.
* @param {number} value Value.
* @todo stability experimental
*/
ol.extent.scaleFromCenter = function(extent, value) {
var deltaX = ((extent[2] - extent[0]) / 2) * (value - 1);
@@ -332,6 +357,7 @@ ol.extent.scaleFromCenter = function(extent, value) {
* @param {ol.Extent} extent1 Extent 1.
* @param {ol.Extent} extent2 Extent 2.
* @return {boolean} Touches.
* @todo stability experimental
*/
ol.extent.touches = function(extent1, extent2) {
var intersects = ol.extent.intersects(extent1, extent2);
@@ -346,6 +372,7 @@ ol.extent.touches = function(extent1, extent2) {
* @param {ol.TransformFunction} transformFn Transform function.
* @param {ol.Extent=} opt_extent Destination extent.
* @return {ol.Extent} Extent.
* @todo stability experimental
*/
ol.extent.transform = function(extent, transformFn, opt_extent) {
var coordinates = [