From 3d73171521174810c0de5e2e60d4bf4bb017b2e5 Mon Sep 17 00:00:00 2001
From: euzuro <euzuro@metacarta.com>
Date: Thu, 5 Jul 2007 17:33:29 +0000
Subject: [PATCH] move all nd comments for CLASS_NAME back to jsdoc style. my
 personal opinion is that we should get rid of this comment entirely... but
 that's something that can be debated. so long as they are all the same, it
 makes it easier to do a global replace when a decision is reached

git-svn-id: http://svn.openlayers.org/trunk/openlayers@3587 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
---
 lib/OpenLayers/Console.js                  | 4 +---
 lib/OpenLayers/Control/OverviewMap.js      | 5 +----
 lib/OpenLayers/Format.js                   | 5 +----
 lib/OpenLayers/Geometry/Collection.js      | 5 +----
 lib/OpenLayers/Geometry/LineString.js      | 5 +----
 lib/OpenLayers/Geometry/MultiLineString.js | 5 +----
 lib/OpenLayers/Geometry/MultiPoint.js      | 5 +----
 lib/OpenLayers/Geometry/MultiPolygon.js    | 5 +----
 lib/OpenLayers/Geometry/Point.js           | 4 +---
 lib/OpenLayers/Geometry/Polygon.js         | 5 +----
 lib/OpenLayers/Handler/Path.js             | 5 +----
 lib/OpenLayers/Handler/Point.js            | 5 +----
 lib/OpenLayers/Layer/EventPane.js          | 5 +----
 lib/OpenLayers/Layer/Grid.js               | 5 +----
 lib/OpenLayers/Layer/Image.js              | 5 +----
 lib/OpenLayers/Layer/MapServer.js          | 6 ++----
 lib/OpenLayers/Layer/Vector.js             | 5 +----
 lib/OpenLayers/Tile/Image.js               | 5 +----
 lib/OpenLayers/Tile/WFS.js                 | 5 +----
 19 files changed, 20 insertions(+), 74 deletions(-)

diff --git a/lib/OpenLayers/Console.js b/lib/OpenLayers/Console.js
index 4f52ff0242..021b183f9a 100644
--- a/lib/OpenLayers/Console.js
+++ b/lib/OpenLayers/Console.js
@@ -201,9 +201,7 @@ OpenLayers.Console = {
      */
     count: function() {},
 
-    /**
-     * Constant: CLASS_NAME
-     */
+    /** @final @type String */
     CLASS_NAME: "OpenLayers.Console"
 };
 
diff --git a/lib/OpenLayers/Control/OverviewMap.js b/lib/OpenLayers/Control/OverviewMap.js
index c9fbe300f7..f1211b10ce 100644
--- a/lib/OpenLayers/Control/OverviewMap.js
+++ b/lib/OpenLayers/Control/OverviewMap.js
@@ -683,10 +683,7 @@ OpenLayers.Control.OverviewMap.prototype =
         return px;
     },
 
-    /**
-     * Constant: CLASS_NAME
-     * {String} Name of this class
-     */
+    /** @final @type String */
     CLASS_NAME: 'OpenLayers.Control.OverviewMap'
     
 });
diff --git a/lib/OpenLayers/Format.js b/lib/OpenLayers/Format.js
index a24f8c9fb9..8df8abf178 100644
--- a/lib/OpenLayers/Format.js
+++ b/lib/OpenLayers/Format.js
@@ -56,10 +56,7 @@ OpenLayers.Format.prototype = {
         alert("Write not implemented.");
     },
 
-    /**
-     * Constant: CLASS_NAME
-     * {String} OpenLayers.Format
-     */
+    /** @final @type String */
     CLASS_NAME: "OpenLayers.Format"
 
 };     
diff --git a/lib/OpenLayers/Geometry/Collection.js b/lib/OpenLayers/Geometry/Collection.js
index c395757d83..0209d09fb3 100644
--- a/lib/OpenLayers/Geometry/Collection.js
+++ b/lib/OpenLayers/Geometry/Collection.js
@@ -273,9 +273,6 @@ OpenLayers.Geometry.Collection.prototype =
         return equivalent;
     },
 
-    /**
-     * Constant: CLASS_NAME
-     * {String} Name of class.
-     */
+    /** @final @type String */
     CLASS_NAME: "OpenLayers.Geometry.Collection"
 });
diff --git a/lib/OpenLayers/Geometry/LineString.js b/lib/OpenLayers/Geometry/LineString.js
index dfd549c0a3..105b82de7f 100644
--- a/lib/OpenLayers/Geometry/LineString.js
+++ b/lib/OpenLayers/Geometry/LineString.js
@@ -44,9 +44,6 @@ OpenLayers.Geometry.LineString.prototype =
         }
     },
        
-    /**
-     * Constant: CLASS_NAME
-     * {String} Name of class.
-     */
+    /** @final @type String */
     CLASS_NAME: "OpenLayers.Geometry.LineString"
 });
diff --git a/lib/OpenLayers/Geometry/MultiLineString.js b/lib/OpenLayers/Geometry/MultiLineString.js
index b225f5bdde..2de8e32db1 100644
--- a/lib/OpenLayers/Geometry/MultiLineString.js
+++ b/lib/OpenLayers/Geometry/MultiLineString.js
@@ -38,9 +38,6 @@ OpenLayers.Geometry.MultiLineString.prototype =
                                                                   arguments);        
     },
 
-    /**
-     * Constant: CLASS_NAME
-     * {String} Name of class.
-     */
+    /** @final @type String */
     CLASS_NAME: "OpenLayers.Geometry.MultiLineString"
 });
diff --git a/lib/OpenLayers/Geometry/MultiPoint.js b/lib/OpenLayers/Geometry/MultiPoint.js
index e5eaeb8457..5bcad22f89 100644
--- a/lib/OpenLayers/Geometry/MultiPoint.js
+++ b/lib/OpenLayers/Geometry/MultiPoint.js
@@ -63,9 +63,6 @@ OpenLayers.Geometry.MultiPoint.prototype =
         this.removeComponent(point);
     },
 
-    /**
-     * Constant: CLASS_NAME
-     * {String} Name of class.
-     */
+    /** @final @type String */
     CLASS_NAME: "OpenLayers.Geometry.MultiPoint"
 });
diff --git a/lib/OpenLayers/Geometry/MultiPolygon.js b/lib/OpenLayers/Geometry/MultiPolygon.js
index 42be693e6c..6adce94430 100644
--- a/lib/OpenLayers/Geometry/MultiPolygon.js
+++ b/lib/OpenLayers/Geometry/MultiPolygon.js
@@ -39,9 +39,6 @@ OpenLayers.Geometry.MultiPolygon.prototype =
                                                                   arguments);
     },
     
-    /**
-     * Constant: CLASS_NAME
-     * {String} Name of class.
-     */
+    /** @final @type String */
     CLASS_NAME: "OpenLayers.Geometry.MultiPolygon"
 });
diff --git a/lib/OpenLayers/Geometry/Point.js b/lib/OpenLayers/Geometry/Point.js
index 62e4829abb..d5aa27ffbe 100644
--- a/lib/OpenLayers/Geometry/Point.js
+++ b/lib/OpenLayers/Geometry/Point.js
@@ -132,8 +132,6 @@ OpenLayers.Geometry.Point.prototype =
         this.y = this.y + y;
     },
 
-    /** Constant: CLASS_NAME
-     * {String} Name of this class
-     */
+    /** @final @type String */
     CLASS_NAME: "OpenLayers.Geometry.Point"
 });
diff --git a/lib/OpenLayers/Geometry/Polygon.js b/lib/OpenLayers/Geometry/Polygon.js
index e015b9eb3c..745791994f 100644
--- a/lib/OpenLayers/Geometry/Polygon.js
+++ b/lib/OpenLayers/Geometry/Polygon.js
@@ -58,9 +58,6 @@ OpenLayers.Geometry.Polygon.prototype =
         return area;
     },
 
-    /**
-     * Constant: CLASS_NAME
-     * {String} Name of class.
-     */
+    /** @final @type String */
     CLASS_NAME: "OpenLayers.Geometry.Polygon"
 });
diff --git a/lib/OpenLayers/Handler/Path.js b/lib/OpenLayers/Handler/Path.js
index ad3a3fbeb6..b4d3bde5a6 100644
--- a/lib/OpenLayers/Handler/Path.js
+++ b/lib/OpenLayers/Handler/Path.js
@@ -240,9 +240,6 @@ OpenLayers.Handler.Path.prototype =
         return false;
     },
     
-    /**
-     * Constant: CLASS_NAME
-     * {String} Name of class.
-     */
+    /** @final @type String */
     CLASS_NAME: "OpenLayers.Handler.Path"
 });
diff --git a/lib/OpenLayers/Handler/Point.js b/lib/OpenLayers/Handler/Point.js
index 203cc3aadc..e96c5b22cf 100644
--- a/lib/OpenLayers/Handler/Point.js
+++ b/lib/OpenLayers/Handler/Point.js
@@ -263,9 +263,6 @@ OpenLayers.Handler.Point.prototype =
         }
     },
 
-    /**
-     * Constant: CLASS_NAME
-     * {String} Name of class.
-     */
+    /** @final @type String */
     CLASS_NAME: "OpenLayers.Handler.Point"
 });
diff --git a/lib/OpenLayers/Layer/EventPane.js b/lib/OpenLayers/Layer/EventPane.js
index 4a408f5a7e..5ab6d48790 100644
--- a/lib/OpenLayers/Layer/EventPane.js
+++ b/lib/OpenLayers/Layer/EventPane.js
@@ -361,9 +361,6 @@ OpenLayers.Layer.EventPane.prototype =
         return moPixel;
     },
 
-    /**
-     * Constant: CLASS_NAME
-     * {String} Name of this class
-     */
+    /** @final @type String */
     CLASS_NAME: "OpenLayers.Layer.EventPane"
 });
diff --git a/lib/OpenLayers/Layer/Grid.js b/lib/OpenLayers/Layer/Grid.js
index a0bcfb3c42..b1905ad73c 100644
--- a/lib/OpenLayers/Layer/Grid.js
+++ b/lib/OpenLayers/Layer/Grid.js
@@ -465,9 +465,6 @@ OpenLayers.Layer.Grid.prototype =
         }
     },
     
-    /**
-     * Constant: CLASS_NAME
-     * {String} Name of this class
-     */
+    /** @final @type String */
     CLASS_NAME: "OpenLayers.Layer.Grid"
 });
diff --git a/lib/OpenLayers/Layer/Image.js b/lib/OpenLayers/Layer/Image.js
index acb60c94f2..018da00d3e 100644
--- a/lib/OpenLayers/Layer/Image.js
+++ b/lib/OpenLayers/Layer/Image.js
@@ -204,9 +204,6 @@ OpenLayers.Layer.Image.prototype =
         return this.url;
     },
         
-    /**
-     * Constant: CLASS_NAME
-     * {String} OpenLayers.Layer.Image
-     */
+    /** @final @type String */
     CLASS_NAME: "OpenLayers.Layer.Image"
 });
diff --git a/lib/OpenLayers/Layer/MapServer.js b/lib/OpenLayers/Layer/MapServer.js
index c448ccb9e9..d0392a0adb 100644
--- a/lib/OpenLayers/Layer/MapServer.js
+++ b/lib/OpenLayers/Layer/MapServer.js
@@ -200,9 +200,7 @@ OpenLayers.Layer.MapServer.prototype =
         }
         return requestString;
     },
-    /**
-     * Constant: CLASS_NAME
-     * {String} OpenLayers.Layer.MapServer
-     */
+
+    /** @final @type String */
     CLASS_NAME: "OpenLayers.Layer.MapServer"
 });
diff --git a/lib/OpenLayers/Layer/Vector.js b/lib/OpenLayers/Layer/Vector.js
index 925926c2a2..50397566dc 100644
--- a/lib/OpenLayers/Layer/Vector.js
+++ b/lib/OpenLayers/Layer/Vector.js
@@ -431,9 +431,6 @@ OpenLayers.Layer.Vector.prototype =
     preFeatureInsert: function(feature) {
     },
 
-    /**
-     * Constant: CLASS_NAME
-     * {String} 'OpenLayers.Layer.Vector'
-     */
+    /** @final @type String */
     CLASS_NAME: "OpenLayers.Layer.Vector"
 });
diff --git a/lib/OpenLayers/Tile/Image.js b/lib/OpenLayers/Tile/Image.js
index 8e9b391bdc..ccb6e8827a 100644
--- a/lib/OpenLayers/Tile/Image.js
+++ b/lib/OpenLayers/Tile/Image.js
@@ -232,10 +232,7 @@ OpenLayers.Tile.Image.prototype =
         }
     },
 
-    /**
-     * Constant: CLASS_NAME
-     * {String} Name of class.
-     */
+    /** @final @type String */
     CLASS_NAME: "OpenLayers.Tile.Image"
   }
 );
diff --git a/lib/OpenLayers/Tile/WFS.js b/lib/OpenLayers/Tile/WFS.js
index 5dd1965158..a712761ff8 100644
--- a/lib/OpenLayers/Tile/WFS.js
+++ b/lib/OpenLayers/Tile/WFS.js
@@ -148,10 +148,7 @@ OpenLayers.Tile.WFS.prototype =
         }
     },
     
-    /**
-     * Constant: CLASS_NAME
-     * {String} Name of class.
-     */
+    /** @final @type String */
     CLASS_NAME: "OpenLayers.Tile.WFS"
   }
 );