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
@@ -31,7 +31,6 @@ ol.dom.InputProperty = {
|
||||
* @param {Element} target Target element.
|
||||
* @todo observable value {string} the value of the Input
|
||||
* @todo observable checked {boolean} the checked state of the Input
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.dom.Input = function(target) {
|
||||
@@ -60,7 +59,7 @@ goog.inherits(ol.dom.Input, ol.Object);
|
||||
/**
|
||||
* If the input is a checkbox, return whether or not the checbox is checked.
|
||||
* @return {boolean|undefined} checked.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.dom.Input.prototype.getChecked = function() {
|
||||
return /** @type {boolean} */ (this.get(ol.dom.InputProperty.CHECKED));
|
||||
@@ -74,7 +73,7 @@ goog.exportProperty(
|
||||
/**
|
||||
* Get the value of the input.
|
||||
* @return {string|undefined} input value.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.dom.Input.prototype.getValue = function() {
|
||||
return /** @type {string} */ (this.get(ol.dom.InputProperty.VALUE));
|
||||
@@ -88,7 +87,7 @@ goog.exportProperty(
|
||||
/**
|
||||
* Sets the value of the input.
|
||||
* @param {string} value Value.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.dom.Input.prototype.setValue = function(value) {
|
||||
this.set(ol.dom.InputProperty.VALUE, value);
|
||||
@@ -102,7 +101,7 @@ goog.exportProperty(
|
||||
/**
|
||||
* Set whether or not a checkbox is checked.
|
||||
* @param {boolean} checked Checked.
|
||||
* @todo stability experimental
|
||||
* @todo api
|
||||
*/
|
||||
ol.dom.Input.prototype.setChecked = function(checked) {
|
||||
this.set(ol.dom.InputProperty.CHECKED, checked);
|
||||
|
||||
Reference in New Issue
Block a user