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

@@ -66,6 +66,7 @@ ol.CollectionProperty = {
* @constructor
* @extends {ol.Object}
* @param {Array=} opt_array Array.
* @todo stability experimental
*/
ol.Collection = function(opt_array) {
@@ -85,6 +86,7 @@ goog.inherits(ol.Collection, ol.Object);
/**
* Remove all elements from the collection.
* @todo stability experimental
*/
ol.Collection.prototype.clear = function() {
while (this.getLength() > 0) {
@@ -96,6 +98,7 @@ ol.Collection.prototype.clear = function() {
/**
* @param {Array} arr Array.
* @return {ol.Collection} This collection.
* @todo stability experimental
*/
ol.Collection.prototype.extend = function(arr) {
var i, ii;
@@ -113,6 +116,7 @@ ol.Collection.prototype.extend = function(arr) {
* value is ignored.
* @param {Object=} opt_obj The object to be used as the value of 'this'
* within f.
* @todo stability experimental
*/
ol.Collection.prototype.forEach = function(f, opt_obj) {
goog.array.forEach(this.array_, f, opt_obj);
@@ -125,6 +129,7 @@ ol.Collection.prototype.forEach = function(f, opt_obj) {
* collection's "length" property won't be in sync with the actual length
* of the array.
* @return {Array} Array.
* @todo stability experimental
*/
ol.Collection.prototype.getArray = function() {
return this.array_;
@@ -135,6 +140,7 @@ ol.Collection.prototype.getArray = function() {
* Get the element at the provided index.
* @param {number} index Index.
* @return {*} Element.
* @todo stability experimental
*/
ol.Collection.prototype.getAt = function(index) {
return this.array_[index];
@@ -144,6 +150,7 @@ ol.Collection.prototype.getAt = function(index) {
/**
* Get the length of this collection.
* @return {number} Length.
* @todo stability experimental
*/
ol.Collection.prototype.getLength = function() {
return /** @type {number} */ (this.get(ol.CollectionProperty.LENGTH));
@@ -154,6 +161,7 @@ ol.Collection.prototype.getLength = function() {
* Insert an element at the provided index.
* @param {number} index Index.
* @param {*} elem Element.
* @todo stability experimental
*/
ol.Collection.prototype.insertAt = function(index, elem) {
goog.array.insertAt(this.array_, elem, index);
@@ -166,6 +174,7 @@ ol.Collection.prototype.insertAt = function(index, elem) {
/**
* Remove the last element of the collection.
* @return {*} Element.
* @todo stability experimental
*/
ol.Collection.prototype.pop = function() {
return this.removeAt(this.getLength() - 1);
@@ -176,6 +185,7 @@ ol.Collection.prototype.pop = function() {
* Insert the provided element at the end of the collection.
* @param {*} elem Element.
* @return {number} Length.
* @todo stability experimental
*/
ol.Collection.prototype.push = function(elem) {
var n = this.array_.length;
@@ -188,6 +198,7 @@ ol.Collection.prototype.push = function(elem) {
* Removes the first occurence of elem from the collection.
* @param {*} elem Element.
* @return {*} The removed element or undefined if elem was not found.
* @todo stability experimental
*/
ol.Collection.prototype.remove = function(elem) {
var arr = this.array_;
@@ -205,6 +216,7 @@ ol.Collection.prototype.remove = function(elem) {
* Remove the element at the provided index.
* @param {number} index Index.
* @return {*} Value.
* @todo stability experimental
*/
ol.Collection.prototype.removeAt = function(index) {
var prev = this.array_[index];
@@ -220,6 +232,7 @@ ol.Collection.prototype.removeAt = function(index) {
* Set the element at the provided index.
* @param {number} index Index.
* @param {*} elem Element.
* @todo stability experimental
*/
ol.Collection.prototype.setAt = function(index, elem) {
var n = this.getLength();