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

Get rid of stability annotations and document stability with api

Browse Source 
This change adds a stability value to the api annotation, with
'experimental' as default value.

enum, typedef and event annotations are never exportable, but
api annotations are needed there to make them appear in the
docs.

Nested typedefs are no longer inlined recursively, because the
resulting tables get too wide with the current template.
This commit is contained in:
Andreas Hocevar
2014-04-17 00:56:44 +02:00
committed by Tim Schaub
parent 29b643c7b0
commit fbdbbfb7a7
146 changed files with 506 additions and 764 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/ol/observable.js
View File

@@ -14,7 +14,6 @@ goog.require('goog.events.EventType');
* @extends {goog.events.EventTarget}
* @suppress {checkStructDictInheritance}
* @struct
* @todo stability experimental
* @todo api
*/
ol.Observable = function() {
@@ -35,7 +34,6 @@ goog.inherits(ol.Observable, goog.events.EventTarget);
* Dispatches a `change` event. Register a listener for this event to get
* notified of changes.
* @fires change
* @todo stability experimental
* @todo api
*/
ol.Observable.prototype.dispatchChangeEvent = function() {
@@ -58,7 +56,6 @@ 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 stability experimental
* @todo api
*/
ol.Observable.prototype.on = function(type, listener, opt_this) {
@@ -72,7 +69,6 @@ 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 stability experimental
* @todo api
*/
ol.Observable.prototype.once = function(type, listener, opt_this) {
@@ -85,7 +81,6 @@ 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 stability experimental
* @todo api
*/
ol.Observable.prototype.un = function(type, listener, opt_this) {
@@ -96,7 +91,6 @@ 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) {