better doc strings for Layer.resolution

2012-01-04 08:47:55 +01:00
parent 0ef4c8dd5b
commit d64bbe1cfc
1 changed files with 5 additions and 3 deletions
--- a/lib/OpenLayers/Layer.js
+++ b/lib/OpenLayers/Layer.js
@@ -268,9 +268,11 @@ OpenLayers.Layer = OpenLayers.Class({
    
    /**
     * Property: resolution
-     * {Float} Current resolution that the layer is drawn in. Used by
-     * subclasses to determine whether the zoom has changed when calling
-     * <moveTo>.
+     * {Float} Current resolution that the layer is drawn in. This is
+     *     used to determine whether the zoom has changed when calling
+     *     <moveTo> from <redraw>. Subclasses may set this.resolution to
+     *     null prior to calling redraw to force passing zoomChanged
+     *     true to moveTo.
     */
    resolution: null,