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

Use @api annotation instead of @todo api

Browse Source
This commit is contained in:
Tim Schaub
2014-07-05 15:41:14 -04:00
parent 297503e7c9
commit 4cf5ab4620
155 changed files with 759 additions and 757 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/ol/observable.js
View File

@@ -18,7 +18,7 @@ goog.require('goog.events.EventType');
* @extends {goog.events.EventTarget}
* @suppress {checkStructDictInheritance}
* @struct
* @todo api
* @api
*/
ol.Observable = function() {
@@ -37,7 +37,7 @@ goog.inherits(ol.Observable, goog.events.EventTarget);
/**
* Dispatches a `change` event.
* @fires change
* @todo api
* @api
*/
ol.Observable.prototype.dispatchChangeEvent = function() {
++this.revision_;
@@ -47,7 +47,7 @@ ol.Observable.prototype.dispatchChangeEvent = function() {
/**
* @return {number} Revision.
* @todo api
* @api
*/
ol.Observable.prototype.getRevision = function() {
return this.revision_;
@@ -60,7 +60,7 @@ ol.Observable.prototype.getRevision = function() {
* @param {function(?): ?} listener The listener function.
* @param {Object=} opt_this The object to use as `this` in `listener`.
* @return {goog.events.Key} Unique key for the listener.
* @todo api
* @api
*/
ol.Observable.prototype.on = function(type, listener, 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 {Object=} opt_this The object to use as `this` in `listener`.
* @return {goog.events.Key} Unique key for the listener.
* @todo api
* @api
*/
ol.Observable.prototype.once = function(type, listener, opt_this) {
return goog.events.listenOnce(this, type, listener, false, opt_this);
@@ -85,7 +85,7 @@ ol.Observable.prototype.once = function(type, listener, opt_this) {
* @param {string|Array.<string>} type The event type or array of event types.
* @param {function(?): ?} listener The listener function.
* @param {Object=} opt_this The object to use as `this` in `listener`.
* @todo api
* @api
*/
ol.Observable.prototype.un = function(type, listener, opt_this) {
goog.events.unlisten(this, type, listener, false, opt_this);
@@ -95,7 +95,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 api
* @api
*/
ol.Observable.prototype.unByKey = function(key) {
goog.events.unlistenByKey(key);