Google v3 docs amendment

kochizufan · May 21, 2012 · 1193e17 · 1193e17
1 parent 95164d8
commit 1193e17
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 5 deletions.
diff --git a/lib/OpenLayers/Layer/EventPane.js b/lib/OpenLayers/Layer/EventPane.js
@@ -13,8 +13,7 @@
  * Class: OpenLayers.Layer.EventPane
  * Base class for 3rd party layers, providing a DOM element which isolates
  * the 3rd-party layer from mouse events.
- * Originally used by Yahoo, Virtual Earth and Google layers, but now
- * only used by Google.
+ * Only used by Google layers.
  *
  * Automatically instantiated by the Google constructor, and not usually instantiated directly.
  *

diff --git a/lib/OpenLayers/Layer/Google/v3.js b/lib/OpenLayers/Layer/Google/v3.js
@@ -14,16 +14,19 @@
  * Mixin providing functionality specific to the Google Maps API v3.
  * 
  * To use this layer, you must include the GMaps v3 API in your html.
+ * 
  * Because OpenLayers needs to control mouse events, it isolates the GMaps mapObject
  * (the DOM elements provided by Google) using the EventPane.
  * However, because the Terms of Use require some of those elements,
  * such as the links to Google's terms, to be clickable, these elements have 
  * to be moved up to OpenLayers' container div. There is however no easy way
  * to identify these, and the logic (see the repositionMapElements function
  * in the source) may need to be changed if Google changes them.
- * Because of this, a given OpenLayers release can only guarantee support for the current 'frozen' Google release
- * (see https://developers.google.com/maps/documentation/javascript/basics#Versioning
- * for Google's current release cycle).
+ * These elements are not part of the published API and can be changed at any time,
+ * so a given OpenLayers release can only guarantee support for the 'frozen'
+ * Google release at the time of the OpenLayers release. See
+ * https://developers.google.com/maps/documentation/javascript/basics#Versioning
+ * for Google's current release cycle.
  * 
  * For this reason, it's recommended that production code specifically loads 
  * the current frozen version, for example:
@@ -35,6 +38,12 @@
  * but that development code should use the latest 'nightly' version, so that any
  * problems can be dealt with as soon as they arise, and before they affect the production, 'frozen', code.
  * 
+ * Note, however, that frozen versions are retired as part of Google's release
+ * cycle, and once this happens, you will get the next version, in the example above, 3.8 once 3.7 is retired.
+ * 
+ * This version supports 3.7.
+ * 
+ * 
  * Note that this layer configures the google.maps.map object with the
  * "disableDefaultUI" option set to true. Using UI controls that the Google
  * Maps API provides is not supported by the OpenLayers API.