From 690ed1ed8e2253df0d7a45b52c7728c6645ca1de Mon Sep 17 00:00:00 2001 From: Bruno Binet Date: Tue, 17 Sep 2013 17:02:38 +0200 Subject: [PATCH] Improve doc for minResolution and maxResolution --- src/objectliterals.jsdoc | 30 ++++++++++++++++++++---------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/src/objectliterals.jsdoc b/src/objectliterals.jsdoc index 2d39523825..1d9fb7aa7f 100644 --- a/src/objectliterals.jsdoc +++ b/src/objectliterals.jsdoc @@ -337,8 +337,10 @@ * @property {number|undefined} opacity Opacity. * @property {number|undefined} saturation Saturation. * @property {boolean|undefined} visible Visibility. - * @property {number|undefined} minResolution MinResolution. - * @property {number|undefined} maxResolution MaxResolution. + * @property {number|undefined} minResolution The minimum resolution + * (inclusive) at which this layer will be visible. + * @property {number|undefined} maxResolution The maximum resolution + * (exclusive) below which this layer will be visible. */ /** @@ -350,8 +352,10 @@ * @property {number|undefined} saturation Saturation. * @property {ol.source.Source} source Source for this layer. * @property {boolean|undefined} visible Visibility. Default is true (visible). - * @property {number|undefined} minResolution MinResolution. - * @property {number|undefined} maxResolution MaxResolution. + * @property {number|undefined} minResolution The minimum resolution + * (inclusive) at which this layer will be visible. + * @property {number|undefined} maxResolution The maximum resolution + * (exclusive) below which this layer will be visible. */ /** @@ -362,8 +366,10 @@ * @property {number|undefined} opacity Opacity. * @property {number|undefined} saturation Saturation. * @property {boolean|undefined} visible Visibility. - * @property {number|undefined} minResolution MinResolution. - * @property {number|undefined} maxResolution MaxResolution. + * @property {number|undefined} minResolution The minimum resolution + * (inclusive) at which this layer will be visible. + * @property {number|undefined} maxResolution The maximum resolution + * (exclusive) below which this layer will be visible. * @property {Array.|ol.Collection|undefined} layers Child layers. */ @@ -377,8 +383,10 @@ * @property {number|undefined} saturation Saturation. * @property {ol.source.Source} source Source for this layer. * @property {boolean|undefined} visible Visibility. Default is true (visible). - * @property {number|undefined} minResolution MinResolution. - * @property {number|undefined} maxResolution MaxResolution. + * @property {number|undefined} minResolution The minimum resolution + * (inclusive) at which this layer will be visible. + * @property {number|undefined} maxResolution The maximum resolution + * (exclusive) below which this layer will be visible. */ /** @@ -391,8 +399,10 @@ * @property {ol.source.Source} source Source for this layer. * @property {ol.style.Style|undefined} style Style. * @property {boolean|undefined} visible Visibility. Default is true (visible). - * @property {number|undefined} minResolution MinResolution. - * @property {number|undefined} maxResolution MaxResolution. + * @property {number|undefined} minResolution The minimum resolution + * (inclusive) at which this layer will be visible. + * @property {number|undefined} maxResolution The maximum resolution + * (exclusive) below which this layer will be visible. */ /**