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

View File

@@ -15,6 +15,7 @@ goog.require('goog.events.EventType');
* @suppress {checkStructDictInheritance}
* @struct
* @todo stability experimental
* @todo api
*/
ol.Observable = function() {
@@ -35,6 +36,7 @@ goog.inherits(ol.Observable, goog.events.EventTarget);
* notified of changes.
* @fires change
* @todo stability experimental
* @todo api
*/
ol.Observable.prototype.dispatchChangeEvent = function() {
++this.revision_;
@@ -58,6 +60,7 @@ ol.Observable.prototype.getRevision = function() {
* @param {Object=} opt_this The object to use as `this` in `listener`.
* @return {goog.events.Key} Unique key for the listener.
* @todo stability experimental
* @todo api
*/
ol.Observable.prototype.on = function(type, listener, opt_this) {
return goog.events.listen(this, type, listener, false, opt_this);
@@ -71,6 +74,7 @@ ol.Observable.prototype.on = function(type, listener, opt_this) {
* @param {Object=} opt_this The object to use as `this` in `listener`.
* @return {goog.events.Key} Unique key for the listener.
* @todo stability experimental
* @todo api
*/
ol.Observable.prototype.once = function(type, listener, opt_this) {
return goog.events.listenOnce(this, type, listener, false, opt_this);
@@ -83,6 +87,7 @@ ol.Observable.prototype.once = function(type, listener, opt_this) {
* @param {function(?): ?} listener The listener function.
* @param {Object=} opt_this The object to use as `this` in `listener`.
* @todo stability experimental
* @todo api
*/
ol.Observable.prototype.un = function(type, listener, opt_this) {
goog.events.unlisten(this, type, listener, false, opt_this);
@@ -93,6 +98,7 @@ ol.Observable.prototype.un = function(type, listener, opt_this) {
* Removes an event listener using the key returned by `on()` or `once()`.
* @param {goog.events.Key} key Key.
* @todo stability experimental
* @todo api
*/
ol.Observable.prototype.unByKey = function(key) {
goog.events.unlistenByKey(key);