[OpenLayers-Commits] r4247 - trunk/openlayers/lib/OpenLayers/Popup

[commits at openlayers.org]

Author: euzuro
Date: 2007-09-12 15:22:33 -0400 (Wed, 12 Sep 2007)
New Revision: 4247

Modified:
   trunk/openlayers/lib/OpenLayers/Popup/Anchored.js
Log:
coding standards -- mostly ND comment style corrections

Modified: trunk/openlayers/lib/OpenLayers/Popup/Anchored.js
===================================================================
--- trunk/openlayers/lib/OpenLayers/Popup/Anchored.js	2007-09-12 19:02:09 UTC (rev 4246)
+++ trunk/openlayers/lib/OpenLayers/Popup/Anchored.js	2007-09-12 19:22:33 UTC (rev 4247)
@@ -11,19 +11,19 @@
  * Inherits from:
  *  - <OpenLayers.Popup>
  */
-OpenLayers.Popup.Anchored = OpenLayers.Class(OpenLayers.Popup, {
+OpenLayers.Popup.Anchored = 
+  OpenLayers.Class(OpenLayers.Popup, {
 
     /** 
      * Parameter: relativePosition
-     * {String} Relative position of the popup ("lr", "ll", "tr", or "tl")
+     * {String} Relative position of the popup ("lr", "ll", "tr", or "tl").
      */
     relativePosition: null,
 
     /**
      * Parameter: anchor
-     * {Object} Object to which we'll anchor the popup. 
-     *          Must expose a 'size' (<OpenLayers.Size>) and 
-     *                        'offset' (<OpenLayers.Pixel>) 
+     * {Object} Object to which we'll anchor the popup. Must expose a 
+     *     'size' (<OpenLayers.Size>) and 'offset' (<OpenLayers.Pixel>).
      */
     anchor: null,
 
@@ -35,10 +35,8 @@
     * lonlat - {<OpenLayers.LonLat>}
     * size - {<OpenLayers.Size>}
     * contentHTML - {String}
-    * anchor - {Object} Object which must expose a 
-    *                         - 'size' (OpenLayers.Size) and 
-    *                         - 'offset' (OpenLayers.Pixel) 
-    *                         (this is generally an OpenLayers.Icon)
+    * anchor - {Object} Object which must expose a 'size' <OpenLayers.Size> 
+    *     and 'offset' <OpenLayers.Pixel> (generally an <OpenLayers.Icon>).
     * closeBox - {Boolean}
     */
     initialize:function(id, lonlat, size, contentHTML, anchor, closeBox) {
@@ -57,7 +55,7 @@
      * px - {<OpenLayers.Pixel>}
      * 
      * Returns: 
-     * {DOMElement} Reference to a div that contains the drawn popup
+     * {DOMElement} Reference to a div that contains the drawn popup.
      */
     draw: function(px) {
         if (px == null) {
@@ -80,7 +78,7 @@
      * 
      * Returns:
      * {String} The relative position ("br" "tr" "tl "bl") at which the popup
-     *          should be placed
+     *     should be placed.
      */
     calculateRelativePosition:function(px) {
         var lonlat = this.map.getLonLatFromLayerPx(px);        
@@ -96,9 +94,8 @@
      * 
      * Parameters:
      * px - {<OpenLayers.Pixel>}
-    */
+     */
     moveTo: function(px) {
-        
         var newPx = this.calculateNewPx(px);
         
         var newArguments = new Array(newPx);        
@@ -110,7 +107,7 @@
      * 
      * Parameters:
      * size - {<OpenLayers.Size>}
-    */
+     */
     setSize:function(size) { 
         OpenLayers.Popup.prototype.setSize.apply(this, arguments);
 
@@ -128,7 +125,7 @@
      * 
      * Returns:
      * {<OpenLayers.Pixel>} The the new px position of the popup on the screen
-     *                      relative to the passed-in px
+     *     relative to the passed-in px.
      */
     calculateNewPx:function(px) {
         var newPx = px.offset(this.anchor.offset);