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

Add @api stable annotations for ol.Observable

Browse Source
This commit is contained in:
Éric Lemoine
2014-08-19 12:24:15 +02:00
parent 711c4bbc8c
commit f3930d751e
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ol/observable.js
+5 -5
View File
@@ -18,7 +18,7 @@ goog.require('goog.events.EventType');
* @extends {goog.events.EventTarget} * @extends {goog.events.EventTarget}
* @suppress {checkStructDictInheritance} * @suppress {checkStructDictInheritance}
* @struct * @struct
* @api * @api stable
*/ */
ol.Observable = function() { ol.Observable = function() {
@@ -60,7 +60,7 @@ ol.Observable.prototype.getRevision = function() {
* @param {function(?): ?} listener The listener function. * @param {function(?): ?} listener The listener function.
* @param {Object=} opt_this The object to use as `this` in `listener`. * @param {Object=} opt_this The object to use as `this` in `listener`.
* @return {goog.events.Key} Unique key for the listener. * @return {goog.events.Key} Unique key for the listener.
* @api * @api stable
*/ */
ol.Observable.prototype.on = function(type, listener, opt_this) { ol.Observable.prototype.on = function(type, listener, opt_this) {
return goog.events.listen(this, type, listener, false, opt_this); return goog.events.listen(this, type, listener, false, opt_this);
@@ -73,7 +73,7 @@ ol.Observable.prototype.on = function(type, listener, opt_this) {
* @param {function(?): ?} listener The listener function. * @param {function(?): ?} listener The listener function.
* @param {Object=} opt_this The object to use as `this` in `listener`. * @param {Object=} opt_this The object to use as `this` in `listener`.
* @return {goog.events.Key} Unique key for the listener. * @return {goog.events.Key} Unique key for the listener.
* @api * @api stable
*/ */
ol.Observable.prototype.once = function(type, listener, opt_this) { ol.Observable.prototype.once = function(type, listener, opt_this) {
return goog.events.listenOnce(this, type, listener, false, opt_this); return goog.events.listenOnce(this, type, listener, false, opt_this);
@@ -86,7 +86,7 @@ ol.Observable.prototype.once = function(type, listener, opt_this) {
* @param {function(?): ?} listener The listener function. * @param {function(?): ?} listener The listener function.
* @param {Object=} opt_this The object which was used as `this` by the * @param {Object=} opt_this The object which was used as `this` by the
* `listener`. * `listener`.
* @api * @api stable
*/ */
ol.Observable.prototype.un = function(type, listener, opt_this) { ol.Observable.prototype.un = function(type, listener, opt_this) {
goog.events.unlisten(this, type, listener, false, opt_this); goog.events.unlisten(this, type, listener, false, opt_this);
@@ -96,7 +96,7 @@ ol.Observable.prototype.un = function(type, listener, opt_this) {
/** /**
* Removes an event listener using the key returned by `on()` or `once()`. * Removes an event listener using the key returned by `on()` or `once()`.
* @param {goog.events.Key} key Key. * @param {goog.events.Key} key Key.
* @api * @api stable
*/ */
ol.Observable.prototype.unByKey = function(key) { ol.Observable.prototype.unByKey = function(key) {
goog.events.unlistenByKey(key); goog.events.unlistenByKey(key);