diff --git a/lib/OpenLayers/Layer/Google.js b/lib/OpenLayers/Layer/Google.js index a491086c1a..19f3acfbc6 100644 --- a/lib/OpenLayers/Layer/Google.js +++ b/lib/OpenLayers/Layer/Google.js @@ -86,14 +86,16 @@ OpenLayers.Layer.Google.prototype = Object.extend( new OpenLayers.Layer(), { this.map.events.register("addlayer", this, this.loadGMap); }, - /** Google layer is always a base class. + /** Google layer is a base class if the GMap loaded correctly. * @type Boolean */ isBaseLayer: function() { return (this.gmap != null); }, - /** + /** Assuming we are not dragging (in which case GMaps moving itself) + * we need to move the gmap to the new center/zoom + * * @param {OpenLayers.Bounds} bounds * @param {Boolean} zoomChanged */ @@ -122,7 +124,10 @@ OpenLayers.Layer.Google.prototype = Object.extend( new OpenLayers.Layer(), { } }, - /** + /** Load the GMap and register appropriate event listeners. If we can't + * load GMap2, then display a warning message. + * + * @private * */ loadGMap:function() { @@ -170,6 +175,9 @@ OpenLayers.Layer.Google.prototype = Object.extend( new OpenLayers.Layer(), { /** If we can't load the GMap, then display an error message to the * user and tell them where to go for help. + * + * @private + * */ loadWarningMessage:function() { @@ -230,7 +238,9 @@ OpenLayers.Layer.Google.prototype = Object.extend( new OpenLayers.Layer(), { this.dragging = false; }, - /** + /** When GMap recenters itself (when user doubleclicks or draggs it) we + * need to update our Map -- and all the other layers + * * @private * * @param {event} e @@ -247,6 +257,12 @@ OpenLayers.Layer.Google.prototype = Object.extend( new OpenLayers.Layer(), { }, + /********************************************************/ + /* */ + /* Baselayer Functions */ + /* */ + /********************************************************/ + /** * @param {OpenLayers.Pixel} viewPortPx * @@ -364,6 +380,7 @@ OpenLayers.Layer.Google.prototype = Object.extend( new OpenLayers.Layer(), { * @param {GLatLng} gLatLng * * @returns An OpenLayers.LonLat, translated from the passed in GLatLng + * Returns null if null value is passed in * @type OpenLayers.LonLat */ getOLLonLatFromGLatLng: function(gLatLng) { @@ -378,6 +395,7 @@ OpenLayers.Layer.Google.prototype = Object.extend( new OpenLayers.Layer(), { * @param {OpenLayers.LonLat} olLonLat * * @returns A GLatLng, translated from the passed in OpenLayers.LonLat + * Returns null if null value is passed in * @type GLatLng */ getGLatLngFromOLLonLat: function(olLonLat) { @@ -397,6 +415,7 @@ OpenLayers.Layer.Google.prototype = Object.extend( new OpenLayers.Layer(), { * @param {GPoint} gPoint * * @returns An OpenLayers.Pixel, translated from the passed in GPoint + * Returns null if null value is passed in * @type OpenLayers.Pixel */ getOLPixelFromGPoint: function(gPoint) { @@ -411,6 +430,7 @@ OpenLayers.Layer.Google.prototype = Object.extend( new OpenLayers.Layer(), { * @param {OpenLayers.Pixel} olPixel * * @returns A GPoint, translated from the passed in OpenLayers.Pixel + * Returns null if null value is passed in * @type GPoint */ getGPointFromOLPixel: function(olPixel) { @@ -429,6 +449,7 @@ OpenLayers.Layer.Google.prototype = Object.extend( new OpenLayers.Layer(), { * @param {GLatLngBounds} gLatLngBounds * * @returns An OpenLayers.Bounds, translated from gLatLngBounds + * Returns null if null value is passed in * @type OpenLayers.Bounds */ getOLBoundsFromGLatLngBounds: function(gLatLngBounds) { @@ -448,6 +469,7 @@ OpenLayers.Layer.Google.prototype = Object.extend( new OpenLayers.Layer(), { * @param {OpenLayers.Bounds} olBounds * * @returns A GLatLngBounds, translated from olBounds + * Returns null if null value is passed in * @type GLatLngBounds */ getGLatLngBoundsFromOLBounds: function(olBounds) { @@ -463,4 +485,4 @@ OpenLayers.Layer.Google.prototype = Object.extend( new OpenLayers.Layer(), { /** @final @type String */ CLASS_NAME: "OpenLayers.Layer.Google" -}); +}); \ No newline at end of file