Add @api stable annotations for ol.control.ScaleLine

This commit is contained in:
Éric Lemoine
2014-08-19 16:52:40 +02:00
parent 975e81a041
commit d8afc96aa3
2 changed files with 5 additions and 5 deletions

View File

@@ -942,7 +942,7 @@ olx.control.MousePositionOptions.prototype.undefinedHTML;
* minWidth: (number|undefined),
* target: (Element|undefined),
* units: (ol.control.ScaleLineUnits|string|undefined)}}
* @api
* @api stable
*/
olx.control.ScaleLineOptions;

View File

@@ -29,7 +29,7 @@ ol.control.ScaleLineProperty = {
* Units for the scale line. Supported values are `'degrees'`, `'imperial'`,
* `'nautical'`, `'metric'`, `'us'`.
* @enum {string}
* @api
* @api stable
*/
ol.control.ScaleLineUnits = {
DEGREES: 'degrees',
@@ -53,7 +53,7 @@ ol.control.ScaleLineUnits = {
* @constructor
* @extends {ol.control.Control}
* @param {olx.control.ScaleLineOptions=} opt_options Scale line options.
* @api
* @api stable
*/
ol.control.ScaleLine = function(opt_options) {
@@ -141,7 +141,7 @@ ol.control.ScaleLine.LEADING_DIGITS = [1, 2, 5];
* @return {ol.control.ScaleLineUnits|undefined} The units to use in the scale
* line.
* @observable
* @api
* @api stable
*/
ol.control.ScaleLine.prototype.getUnits = function() {
return /** @type {ol.control.ScaleLineUnits|undefined} */ (
@@ -178,7 +178,7 @@ ol.control.ScaleLine.prototype.handleUnitsChanged_ = function() {
/**
* @param {ol.control.ScaleLineUnits} units The units to use in the scale line.
* @observable
* @api
* @api stable
*/
ol.control.ScaleLine.prototype.setUnits = function(units) {
this.set(ol.control.ScaleLineProperty.UNITS, units);