Get rid of stability annotations and document stability with api
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:
committed by
Tim Schaub
parent
29b643c7b0
commit
fbdbbfb7a7
+2
-12
@@ -23,13 +23,13 @@ ol.ObjectEventType = {
|
||||
/**
|
||||
* Triggered before a property is changed.
|
||||
* @event ol.ObjectEvent#beforepropertychange
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
BEFOREPROPERTYCHANGE: 'beforepropertychange',
|
||||
/**
|
||||
* Triggered when a property is changed.
|
||||
* @event ol.ObjectEvent#propertychange
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
PROPERTYCHANGE: 'propertychange'
|
||||
};
|
||||
@@ -63,7 +63,6 @@ goog.inherits(ol.ObjectEvent, goog.events.Event);
|
||||
* @constructor
|
||||
* @param {ol.Object} target
|
||||
* @param {string} key
|
||||
* @todo stability experimental
|
||||
*/
|
||||
ol.ObjectAccessor = function(target, key) {
|
||||
|
||||
@@ -110,7 +109,6 @@ ol.ObjectAccessor.prototype.transform = function(from, to) {
|
||||
* @extends {ol.Observable}
|
||||
* @param {Object.<string, *>=} opt_values Values.
|
||||
* @fires {@link ol.ObjectEvent} ol.ObjectEvent
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.Object = function(opt_values) {
|
||||
@@ -244,7 +242,6 @@ ol.Object.getSetterName = function(key) {
|
||||
* @param {ol.Object} target Target.
|
||||
* @param {string=} opt_targetKey Target key.
|
||||
* @return {ol.ObjectAccessor}
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.Object.prototype.bindTo = function(key, target, opt_targetKey) {
|
||||
@@ -302,7 +299,6 @@ ol.Object.prototype.createBeforeChangeListener_ = function(key, targetKey) {
|
||||
* Gets a value.
|
||||
* @param {string} key Key name.
|
||||
* @return {*} Value.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.Object.prototype.get = function(key) {
|
||||
@@ -363,7 +359,6 @@ ol.Object.prototype.getKeys = function() {
|
||||
/**
|
||||
* Get an object of all property names and values.
|
||||
* @return {Object.<string, *>} Object.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.Object.prototype.getProperties = function() {
|
||||
@@ -384,7 +379,6 @@ ol.Object.prototype.getProperties = function() {
|
||||
* objects that are bound to the object's property as well as the object
|
||||
* that it is bound to.
|
||||
* @param {string} key Key name.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.Object.prototype.notify = function(key) {
|
||||
@@ -416,7 +410,6 @@ ol.Object.prototype.notifyInternal_ = function(key) {
|
||||
* Sets a value.
|
||||
* @param {string} key Key name.
|
||||
* @param {*} value Value.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.Object.prototype.set = function(key, value) {
|
||||
@@ -446,7 +439,6 @@ ol.Object.prototype.set = function(key, value) {
|
||||
/**
|
||||
* Sets a collection of key-value pairs.
|
||||
* @param {Object.<string, *>} values Values.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.Object.prototype.setValues = function(values) {
|
||||
@@ -461,7 +453,6 @@ 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 name.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.Object.prototype.unbind = function(key) {
|
||||
@@ -486,7 +477,6 @@ ol.Object.prototype.unbind = function(key) {
|
||||
|
||||
/**
|
||||
* Removes all bindings.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.Object.prototype.unbindAll = function() {
|
||||
|
||||
Reference in New Issue
Block a user