From f3d6fb87189cdd92325c5dd7558c5a43d921be25 Mon Sep 17 00:00:00 2001
From: euzuro <euzuro@metacarta.com>
Date: Wed, 9 Aug 2006 05:42:42 +0000
Subject: [PATCH] add JSDOC commenting and stub moveTo function in WFS tile

git-svn-id: http://svn.openlayers.org/trunk/openlayers@1147 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
---
 lib/OpenLayers/Layer/KaMap.js     | 10 +++++++++-
 lib/OpenLayers/Layer/WMS.js       |  8 ++++++++
 lib/OpenLayers/Layer/WorldWind.js |  8 ++++++++
 lib/OpenLayers/Tile.js            |  4 ++++
 lib/OpenLayers/Tile/Image.js      |  4 ++++
 lib/OpenLayers/Tile/WFS.js        |  7 +++++++
 6 files changed, 40 insertions(+), 1 deletion(-)

diff --git a/lib/OpenLayers/Layer/KaMap.js b/lib/OpenLayers/Layer/KaMap.js
index 8247ecaee9..9b7f14ebce 100644
--- a/lib/OpenLayers/Layer/KaMap.js
+++ b/lib/OpenLayers/Layer/KaMap.js
@@ -45,7 +45,15 @@ OpenLayers.Layer.KaMap.prototype =
         }
     },
 
-    getURL:function(bounds) {
+    /**
+     * @param {OpenLayers.Bounds} bounds
+     * 
+     * @returns A string with the layer's url and parameters and also the 
+     *           passed-in bounds and appropriate tile size specified as 
+     *           parameters
+     * @type String
+     */
+    getURL: function (bounds) {
         var zoom = this.map.getZoom();
         var maxRes = this.map.maxResolution;
         var mapRes = this.map.getResolution();
diff --git a/lib/OpenLayers/Layer/WMS.js b/lib/OpenLayers/Layer/WMS.js
index 71c0d97c3e..d170cd4016 100644
--- a/lib/OpenLayers/Layer/WMS.js
+++ b/lib/OpenLayers/Layer/WMS.js
@@ -84,6 +84,14 @@ OpenLayers.Layer.WMS.prototype =
         return obj;
     },    
     
+    /**
+     * @param {OpenLayers.Bounds} bounds
+     * 
+     * @returns A string with the layer's url and parameters and also the 
+     *           passed-in bounds and appropriate tile size specified as 
+     *           parameters
+     * @type String
+     */
     getURL: function (bounds) {
         return this.getFullRequestString(
                      {BBOX:bounds.toBBOX(),
diff --git a/lib/OpenLayers/Layer/WorldWind.js b/lib/OpenLayers/Layer/WorldWind.js
index c635f289a0..c60e71c3c5 100644
--- a/lib/OpenLayers/Layer/WorldWind.js
+++ b/lib/OpenLayers/Layer/WorldWind.js
@@ -60,6 +60,14 @@ OpenLayers.Layer.WorldWind.prototype =
         return zoom;
     },
 
+    /**
+     * @param {OpenLayers.Bounds} bounds
+     * 
+     * @returns A string with the layer's url and parameters and also the 
+     *           passed-in bounds and appropriate tile size specified as 
+     *           parameters
+     * @type String
+     */
     getURL: function (bounds) {
         var deg = this.lzd/Math.pow(2,this.getZoom());
         var x = Math.floor((bounds.left - extent.left)/deg);
diff --git a/lib/OpenLayers/Tile.js b/lib/OpenLayers/Tile.js
index f8f26f1c2d..1e2b1f9261 100644
--- a/lib/OpenLayers/Tile.js
+++ b/lib/OpenLayers/Tile.js
@@ -71,6 +71,10 @@ OpenLayers.Tile.prototype = {
         this.draw();
     },
 
+    /** 
+     * @param {OpenLayers.Bounds}
+     * @param {OpenLayers.pixel} position
+     */
     moveTo: function (bounds, position) {
         this.bounds = bounds.clone();
         this.position = position.clone();
diff --git a/lib/OpenLayers/Tile/Image.js b/lib/OpenLayers/Tile/Image.js
index 296e636aa1..7aa1a49aec 100644
--- a/lib/OpenLayers/Tile/Image.js
+++ b/lib/OpenLayers/Tile/Image.js
@@ -57,6 +57,10 @@ OpenLayers.Tile.Image.prototype =
         this.layer.div.appendChild(this.imgDiv);
     },
 
+    /** 
+     * @param {OpenLayers.Bounds}
+     * @param {OpenLayers.pixel} position
+     */
     moveTo: function (bounds, position) {
         this.url = this.layer.getURL(bounds);
         OpenLayers.Tile.prototype.moveTo.apply(this, arguments);
diff --git a/lib/OpenLayers/Tile/WFS.js b/lib/OpenLayers/Tile/WFS.js
index 1351dd345c..75b46e9fe7 100644
--- a/lib/OpenLayers/Tile/WFS.js
+++ b/lib/OpenLayers/Tile/WFS.js
@@ -49,6 +49,13 @@ OpenLayers.Tile.WFS.prototype =
         this.loadFeaturesForRegion(this.requestSuccess);        
     },
 
+    /** 
+     * @param {OpenLayers.Bounds}
+     * @param {OpenLayers.pixel} position
+     */
+    moveTo: function (bounds, position) {
+        OpenLayers.Tile.prototype.moveTo.apply(this, arguments);
+    },
     
     /** get the full request string from the ds and the tile params 
     *     and call the AJAX loadURL().