Add default stability level to docs of exported things.

This commit is contained in:
Paul Spencer
2013-10-24 17:07:02 -04:00
parent a13c5d30a2
commit bada596b45
108 changed files with 382 additions and 0 deletions

View File

@@ -21,6 +21,7 @@ goog.require('ol.sphere.NORMAL');
/**
* @enum {string}
* @todo stability experimental
*/
ol.control.ScaleLineProperty = {
UNITS: 'units'
@@ -29,6 +30,7 @@ ol.control.ScaleLineProperty = {
/**
* @enum {string}
* @todo stability experimental
*/
ol.control.ScaleLineUnits = {
DEGREES: 'degrees',
@@ -48,6 +50,7 @@ ol.control.ScaleLineUnits = {
* @constructor
* @extends {ol.control.Control}
* @param {ol.control.ScaleLineOptions=} opt_options Scale line options.
* @todo stability experimental
*/
ol.control.ScaleLine = function(opt_options) {
@@ -126,12 +129,14 @@ goog.inherits(ol.control.ScaleLine, ol.control.Control);
/**
* @const
* @type {Array.<number>}
* @todo stability experimental
*/
ol.control.ScaleLine.LEADING_DIGITS = [1, 2, 5];
/**
* @return {ol.control.ScaleLineUnits|undefined} units.
* @todo stability experimental
*/
ol.control.ScaleLine.prototype.getUnits = function() {
return /** @type {ol.control.ScaleLineUnits|undefined} */ (
@@ -167,6 +172,7 @@ ol.control.ScaleLine.prototype.handleUnitsChanged_ = function() {
/**
* @param {ol.control.ScaleLineUnits} units Units.
* @todo stability experimental
*/
ol.control.ScaleLine.prototype.setUnits = function(units) {
this.set(ol.control.ScaleLineProperty.UNITS, units);