Add basic docs for scalelinecontrol

This commit is contained in:
Marc Jansen
2015-04-23 20:27:28 +02:00
parent 346ead1b55
commit 63a4a0c1d9
+3
View File
@@ -141,6 +141,7 @@ ol.control.ScaleLine.LEADING_DIGITS = [1, 2, 5];
/** /**
* Return the units to use in the scale line.
* @return {ol.control.ScaleLineUnits|undefined} The units to use in the scale * @return {ol.control.ScaleLineUnits|undefined} The units to use in the scale
* line. * line.
* @observable * @observable
@@ -153,6 +154,7 @@ ol.control.ScaleLine.prototype.getUnits = function() {
/** /**
* Update the scale line element.
* @param {ol.MapEvent} mapEvent Map event. * @param {ol.MapEvent} mapEvent Map event.
* @this {ol.control.ScaleLine} * @this {ol.control.ScaleLine}
* @api * @api
@@ -177,6 +179,7 @@ ol.control.ScaleLine.prototype.handleUnitsChanged_ = function() {
/** /**
* Set the units to use in the scale line.
* @param {ol.control.ScaleLineUnits} units The units to use in the scale line. * @param {ol.control.ScaleLineUnits} units The units to use in the scale line.
* @observable * @observable
* @api stable * @api stable