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

@@ -37,6 +37,7 @@ ol.ObjectProperty = {
* @constructor
* @extends {goog.events.EventTarget}
* @param {Object.<string, *>=} opt_values Values.
* @todo stability experimental
*/
ol.Object = function(opt_values) {
goog.base(this);
@@ -142,6 +143,7 @@ ol.Object.getSetterName = function(key) {
* @param {string} key Key.
* @param {ol.Object} target Target.
* @param {string=} opt_targetKey Target key.
* @todo stability experimental
*/
ol.Object.prototype.bindTo =
function(key, target, opt_targetKey) {
@@ -162,6 +164,7 @@ ol.Object.prototype.bindTo =
* Gets a value.
* @param {string} key Key.
* @return {*} Value.
* @todo stability experimental
*/
ol.Object.prototype.get = function(key) {
var value;
@@ -200,6 +203,7 @@ ol.Object.prototype.getKeys = function() {
* objects that are bound to the object's property as well as the object
* that it is bound to.
* @param {string} key Key.
* @todo stability experimental
*/
ol.Object.prototype.notify = function(key) {
var accessors = ol.Object.getAccessors(this);
@@ -232,6 +236,7 @@ ol.Object.prototype.notifyInternal_ = function(key) {
* @param {Object=} opt_scope Object is whose scope to call
* the listener.
* @return {goog.events.Key} Unique key for the listener.
* @todo stability experimental
*/
ol.Object.prototype.on = function(type, listener, opt_scope) {
return goog.events.listen(this, type, listener, false, opt_scope);
@@ -245,6 +250,7 @@ ol.Object.prototype.on = function(type, listener, opt_scope) {
* @param {Object=} opt_scope Object is whose scope to call
* the listener.
* @return {goog.events.Key} Unique key for the listener.
* @todo stability experimental
*/
ol.Object.prototype.once = function(type, listener, opt_scope) {
return goog.events.listenOnce(this, type, listener, false, opt_scope);
@@ -255,6 +261,7 @@ ol.Object.prototype.once = function(type, listener, opt_scope) {
* Sets a value.
* @param {string} key Key.
* @param {*} value Value.
* @todo stability experimental
*/
ol.Object.prototype.set = function(key, value) {
var accessors = ol.Object.getAccessors(this);
@@ -278,6 +285,7 @@ ol.Object.prototype.set = function(key, value) {
/**
* Sets a collection of key-value pairs.
* @param {Object.<string, *>} values Values.
* @todo stability experimental
*/
ol.Object.prototype.setValues = function(values) {
var key, value, setterName;
@@ -297,6 +305,7 @@ ol.Object.prototype.setValues = function(values) {
* Removes a binding. Unbinding will set the unbound property to the current
* value. The object will not be notified, as the value has not changed.
* @param {string} key Key.
* @todo stability experimental
*/
ol.Object.prototype.unbind = function(key) {
var listeners = ol.Object.getListeners(this);
@@ -318,6 +327,7 @@ ol.Object.prototype.unbind = function(key) {
* @param {Function} listener The listener function.
* @param {Object=} opt_scope Object is whose scope to call
* the listener.
* @todo stability experimental
*/
ol.Object.prototype.un = function(type, listener, opt_scope) {
goog.events.unlisten(this, type, listener, false, opt_scope);
@@ -328,6 +338,7 @@ ol.Object.prototype.un = function(type, listener, opt_scope) {
* Removes an event listener which was added with listen() by the key returned
* by on().
* @param {?number} key Key.
* @todo stability experimental
*/
ol.Object.prototype.unByKey = function(key) {
goog.events.unlistenByKey(key);
@@ -336,6 +347,7 @@ ol.Object.prototype.unByKey = function(key) {
/**
* Removes all bindings.
* @todo stability experimental
*/
ol.Object.prototype.unbindAll = function() {
for (var key in ol.Object.getListeners(this)) {