update comments

git-svn-id: http://svn.openlayers.org/trunk/openlayers@919 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
This commit is contained in:
euzuro
2006-07-07 16:58:23 +00:00
parent 8e2448413e
commit b0d9a997c1
+26 -4
View File
@@ -86,14 +86,16 @@ OpenLayers.Layer.Google.prototype = Object.extend( new OpenLayers.Layer(), {
this.map.events.register("addlayer", this, this.loadGMap); 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 * @type Boolean
*/ */
isBaseLayer: function() { isBaseLayer: function() {
return (this.gmap != null); 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 {OpenLayers.Bounds} bounds
* @param {Boolean} zoomChanged * @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() { 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 /** If we can't load the GMap, then display an error message to the
* user and tell them where to go for help. * user and tell them where to go for help.
*
* @private
*
*/ */
loadWarningMessage:function() { loadWarningMessage:function() {
@@ -230,7 +238,9 @@ OpenLayers.Layer.Google.prototype = Object.extend( new OpenLayers.Layer(), {
this.dragging = false; 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 * @private
* *
* @param {event} e * @param {event} e
@@ -247,6 +257,12 @@ OpenLayers.Layer.Google.prototype = Object.extend( new OpenLayers.Layer(), {
}, },
/********************************************************/
/* */
/* Baselayer Functions */
/* */
/********************************************************/
/** /**
* @param {OpenLayers.Pixel} viewPortPx * @param {OpenLayers.Pixel} viewPortPx
* *
@@ -364,6 +380,7 @@ OpenLayers.Layer.Google.prototype = Object.extend( new OpenLayers.Layer(), {
* @param {GLatLng} gLatLng * @param {GLatLng} gLatLng
* *
* @returns An OpenLayers.LonLat, translated from the passed in GLatLng * @returns An OpenLayers.LonLat, translated from the passed in GLatLng
* Returns null if null value is passed in
* @type OpenLayers.LonLat * @type OpenLayers.LonLat
*/ */
getOLLonLatFromGLatLng: function(gLatLng) { getOLLonLatFromGLatLng: function(gLatLng) {
@@ -378,6 +395,7 @@ OpenLayers.Layer.Google.prototype = Object.extend( new OpenLayers.Layer(), {
* @param {OpenLayers.LonLat} olLonLat * @param {OpenLayers.LonLat} olLonLat
* *
* @returns A GLatLng, translated from the passed in OpenLayers.LonLat * @returns A GLatLng, translated from the passed in OpenLayers.LonLat
* Returns null if null value is passed in
* @type GLatLng * @type GLatLng
*/ */
getGLatLngFromOLLonLat: function(olLonLat) { getGLatLngFromOLLonLat: function(olLonLat) {
@@ -397,6 +415,7 @@ OpenLayers.Layer.Google.prototype = Object.extend( new OpenLayers.Layer(), {
* @param {GPoint} gPoint * @param {GPoint} gPoint
* *
* @returns An OpenLayers.Pixel, translated from the passed in GPoint * @returns An OpenLayers.Pixel, translated from the passed in GPoint
* Returns null if null value is passed in
* @type OpenLayers.Pixel * @type OpenLayers.Pixel
*/ */
getOLPixelFromGPoint: function(gPoint) { getOLPixelFromGPoint: function(gPoint) {
@@ -411,6 +430,7 @@ OpenLayers.Layer.Google.prototype = Object.extend( new OpenLayers.Layer(), {
* @param {OpenLayers.Pixel} olPixel * @param {OpenLayers.Pixel} olPixel
* *
* @returns A GPoint, translated from the passed in OpenLayers.Pixel * @returns A GPoint, translated from the passed in OpenLayers.Pixel
* Returns null if null value is passed in
* @type GPoint * @type GPoint
*/ */
getGPointFromOLPixel: function(olPixel) { getGPointFromOLPixel: function(olPixel) {
@@ -429,6 +449,7 @@ OpenLayers.Layer.Google.prototype = Object.extend( new OpenLayers.Layer(), {
* @param {GLatLngBounds} gLatLngBounds * @param {GLatLngBounds} gLatLngBounds
* *
* @returns An OpenLayers.Bounds, translated from gLatLngBounds * @returns An OpenLayers.Bounds, translated from gLatLngBounds
* Returns null if null value is passed in
* @type OpenLayers.Bounds * @type OpenLayers.Bounds
*/ */
getOLBoundsFromGLatLngBounds: function(gLatLngBounds) { getOLBoundsFromGLatLngBounds: function(gLatLngBounds) {
@@ -448,6 +469,7 @@ OpenLayers.Layer.Google.prototype = Object.extend( new OpenLayers.Layer(), {
* @param {OpenLayers.Bounds} olBounds * @param {OpenLayers.Bounds} olBounds
* *
* @returns A GLatLngBounds, translated from olBounds * @returns A GLatLngBounds, translated from olBounds
* Returns null if null value is passed in
* @type GLatLngBounds * @type GLatLngBounds
*/ */
getGLatLngBoundsFromOLBounds: function(olBounds) { getGLatLngBoundsFromOLBounds: function(olBounds) {