change the '@require:' to '@requires' so as to be compatible with JSDOC standards. put these directly inside the class definition comment block. update script to suggest this and update all source files to follow pattern. Caught a missing @requires in the EventPane.js file

git-svn-id: http://svn.openlayers.org/trunk/openlayers@1206 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf

lib/OpenLayers/BaseTypes.js

@@ -11,7 +11,9 @@
 
 
 /**
- * @class This class represents a screen coordinate, in x and y coordinates
+ * @class 
+ * 
+ * This class represents a screen coordinate, in x and y coordinates
  */
 OpenLayers.Pixel = Class.create();
 OpenLayers.Pixel.prototype = {
@@ -109,7 +111,9 @@ OpenLayers.Pixel.prototype = {
 
 
 /**
-* @class This class represents a width and height pair
+* @class 
+* 
+* This class represents a width and height pair
 */
 OpenLayers.Size = Class.create();
 OpenLayers.Size.prototype = {
@@ -188,7 +192,9 @@ OpenLayers.Size.prototype = {
 
 
 /**
-* @class This class represents a longitude and latitude pair
+* @class 
+* 
+* This class represents a longitude and latitude pair
 */
 OpenLayers.LonLat = Class.create();
 OpenLayers.LonLat.prototype = {
@@ -308,8 +314,10 @@ OpenLayers.LonLat.fromString = function(str) {
 
 
 /**
-* @class This class represents a bounding box. 
-*        Data stored as left, bottom, right, top floats
+* @class 
+* 
+* This class represents a bounding box. 
+* Data stored as left, bottom, right, top floats
 */
 OpenLayers.Bounds = Class.create();
 OpenLayers.Bounds.prototype = {

lib/OpenLayers/Control/KeyboardDefaults.js

@@ -1,10 +1,11 @@
 /* Copyright (c) 2006 MetaCarta, Inc., published under the BSD license.
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
-// @require: OpenLayers/Control.js
 
 /**
  * @class
+ * 
+ * @requires OpenLayers/Control.js
  */
 OpenLayers.Control.KeyboardDefaults = Class.create();
 OpenLayers.Control.KeyboardDefaults.prototype = 

lib/OpenLayers/Control/LayerSwitcher.js

@@ -2,11 +2,11 @@
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
 
-// @require: OpenLayers/Control.js
-
 /** 
-* @class
-*/
+ * @class
+ * 
+ * @requires OpenLayers/Control.js
+ */
 OpenLayers.Control.LayerSwitcher = Class.create();
 OpenLayers.Control.LayerSwitcher.prototype = 
   Object.extend( new OpenLayers.Control(), {

lib/OpenLayers/Control/LayerTabs.js

@@ -1,10 +1,12 @@
 /* Copyright (c) 2006 MetaCarta, Inc., published under the BSD license.
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
-// @require: OpenLayers/Control.js
+
 /** 
-* @class
-*/
+ * @class
+ * 
+ * @requires OpenLayers/Control.js
+ */
 OpenLayers.Control.LayerTabs = Class.create();
 
 /** color used in the UI to show a layer is active/displayed

lib/OpenLayers/Control/MouseDefaults.js

@@ -1,11 +1,11 @@
 /* Copyright (c) 2006 MetaCarta, Inc., published under the BSD license.
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
- 
-// @require: OpenLayers/Control.js
 
 /**
  * @class
+ * 
+ * @requires OpenLayers/Control.js
  */
 OpenLayers.Control.MouseDefaults = Class.create();
 OpenLayers.Control.MouseDefaults.prototype = 

lib/OpenLayers/Control/MouseToolbar.js

@@ -1,7 +1,12 @@
 /* Copyright (c) 2006 MetaCarta, Inc., published under the BSD license.
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
-// @require: OpenLayers/Control.js
+
+/**
+ * @class
+ * 
+ * @requires OpenLayers/Control.js
+ */
 OpenLayers.Control.MouseToolbar = Class.create();
 OpenLayers.Control.MouseToolbar.X = 6;
 OpenLayers.Control.MouseToolbar.Y = 300;

lib/OpenLayers/Control/PanZoom.js

@@ -1,12 +1,11 @@
 /* Copyright (c) 2006 MetaCarta, Inc., published under the BSD license.
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
-// @require: OpenLayers/Control.js
 
 /**
  * @class
  * 
- * default zoom/pan controls
+ * @requires OpenLayers/Control.js
  */
 OpenLayers.Control.PanZoom = Class.create();
 OpenLayers.Control.PanZoom.X = 4;

lib/OpenLayers/Control/PanZoomBar.js

@@ -1,11 +1,12 @@
 /* Copyright (c) 2006 MetaCarta, Inc., published under the BSD license.
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
-// @require: OpenLayers/Control/PanZoom.js
 
-//
-// default zoom/pan controls
-//
+/**
+ * @class 
+ * 
+ * @requires OpenLayers/Control/PanZoom.js
+ */
 OpenLayers.Control.PanZoomBar = Class.create();
 OpenLayers.Control.PanZoomBar.X = 4;
 OpenLayers.Control.PanZoomBar.Y = 4;

lib/OpenLayers/Control/Permalink.js

@@ -2,11 +2,10 @@
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
 
-// @require: OpenLayers/Control.js
-
-
 /**
  * @class
+ * 
+ * @requires OpenLayers/Control.js
  */
 OpenLayers.Control.Permalink = Class.create();
 OpenLayers.Control.Permalink.prototype = 

lib/OpenLayers/Control/Scale.js

@@ -2,10 +2,10 @@
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
 
-// @require: OpenLayers/Control.js
-
 /**
  * @class
+ * 
+ * @requires OpenLayers/Control.js
  */
 OpenLayers.Control.Scale = Class.create();
 OpenLayers.Control.Scale.prototype = 

lib/OpenLayers/Events.js

@@ -2,9 +2,9 @@
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
  
- /**
-  * @class
-  */
+/**
+ * @class
+ */
 OpenLayers.Events = Class.create();
 OpenLayers.Events.prototype = {
 

lib/OpenLayers/Feature.js

@@ -2,10 +2,9 @@
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
 
-// @require: OpenLayers/Util.js
-
 /**
  * @class
+ * 
  * @requires OpenLayers/Util.js
  */
 OpenLayers.Feature = Class.create();

lib/OpenLayers/Feature/WFS.js

@@ -2,11 +2,10 @@
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
 
-// @require: OpenLayers/Feature.js
-
 /**
- * @class
- * @require: OpenLayers/Feature.js
+ * @class
+ * 
+ * @requires OpenLayers/Feature.js
  */
 OpenLayers.Feature.WFS = Class.create();
 OpenLayers.Feature.WFS.prototype = 

lib/OpenLayers/Icon.js

@@ -1,9 +1,10 @@
 /* Copyright (c) 2006 MetaCarta, Inc., published under the BSD license.
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
+
 /**
-* @class
-*/
+ * @class
+ */
 OpenLayers.Icon = Class.create();
 OpenLayers.Icon.prototype = {
     

lib/OpenLayers/Layer.js

@@ -1,6 +1,7 @@
 /* Copyright (c) 2006 MetaCarta, Inc., published under the BSD license.
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
+
 /**
  * @class
  */

lib/OpenLayers/Layer/Boxes.js

@@ -1,11 +1,13 @@
 /* Copyright (c) 2006 MetaCarta, Inc., published under the BSD license.
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
-// @require: OpenLayers/Layer.js
-// @require: OpenLayers/Layer/Markers.js
+
 /**
-* @class
-*/
+ * @class
+ * 
+ * @requires OpenLayers/Layer.js
+ * @requires OpenLayers/Layer/Markers.js
+ */
 OpenLayers.Layer.Boxes = Class.create();
 OpenLayers.Layer.Boxes.prototype = 
     Object.extend( new OpenLayers.Layer.Markers(), {

lib/OpenLayers/Layer/EventPane.js

@@ -1,8 +1,11 @@
 /* Copyright (c) 2006 MetaCarta, Inc., published under the BSD license.
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
+
 /**
  * @class
+ * 
+ * @requires OpenLayers/Layer.js
  */
 OpenLayers.Layer.EventPane = Class.create();
 OpenLayers.Layer.EventPane.prototype = Object.extend(new OpenLayers.Layer, {

lib/OpenLayers/Layer/GeoRSS.js

@@ -1,11 +1,12 @@
 /* Copyright (c) 2006 MetaCarta, Inc., published under the BSD license.
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
-// @require: OpenLayers/Layer/Markers.js
 
 /**
-* @class
-*/
+ * @class
+ * 
+ * @requires OpenLayers/Layer/Markers.js
+ */
 OpenLayers.Layer.GeoRSS = Class.create();
 OpenLayers.Layer.GeoRSS.prototype = 
   Object.extend( new OpenLayers.Layer.Markers(), {

lib/OpenLayers/Layer/Google.js

@@ -2,9 +2,6 @@
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
 
-// @require: OpenLayers/Layer.js
-
-
 if (typeof GMap2 != "undefined") {
     
     /** Hack-on function because GMAPS does not give it to us
@@ -33,6 +30,8 @@ if (typeof GMap2 != "undefined") {
 
 /**
  * @class
+ * 
+ * @requires OpenLayers/Layer.js
  */
 OpenLayers.Layer.Google = Class.create();
 OpenLayers.Layer.Google.prototype =

lib/OpenLayers/Layer/Grid.js

@@ -2,10 +2,10 @@
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
 
-// @require: OpenLayers/Layer/HTTPRequest.js
-
 /**
  * @class
+ * 
+ * @requires OpenLayers/Layer/HTTPRequest.js
  */
 OpenLayers.Layer.Grid = Class.create();
 OpenLayers.Layer.Grid.prototype = 

lib/OpenLayers/Layer/HTTPRequest.js

@@ -2,10 +2,10 @@
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
 
-// @require: OpenLayers/Layer.js
-
 /**
  * @class
+ * 
+ * @requires OpenLayers/Layer.js
  */
 OpenLayers.Layer.HTTPRequest = Class.create();
 OpenLayers.Layer.HTTPRequest.prototype = 

lib/OpenLayers/Layer/KaMap.js

@@ -1,13 +1,13 @@
 /* Copyright (c) 2006 MetaCarta, Inc., published under the BSD license.
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
-// @require: OpenLayers/Layer/Grid.js
+
 /**
-* @class
-*/
+ * @class
+ * 
+ * @requires OpenLayers/Layer/Grid.js
+ */
 OpenLayers.Layer.KaMap = Class.create();
-
-
 OpenLayers.Layer.KaMap.prototype = 
   Object.extend( new OpenLayers.Layer.Grid(), {
 

lib/OpenLayers/Layer/Markers.js

@@ -1,10 +1,12 @@
 /* Copyright (c) 2006 MetaCarta, Inc., published under the BSD license.
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
-// @require: OpenLayers/Layer.js
+
 /**
-* @class
-*/
+ * @class
+ * 
+ * @requires OpenLayers/Layer.js
+ */
 OpenLayers.Layer.Markers = Class.create();
 OpenLayers.Layer.Markers.prototype = 
   Object.extend( new OpenLayers.Layer(), {

lib/OpenLayers/Layer/Text.js

@@ -1,11 +1,12 @@
 /* Copyright (c) 2006 MetaCarta, Inc., published under the BSD license.
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
-// @require: OpenLayers/Layer/Markers.js
 
 /**
-* @class
-*/
+ * @class
+ * 
+ * @requires OpenLayers/Layer/Markers.js
+ */
 OpenLayers.Layer.Text = Class.create();
 OpenLayers.Layer.Text.prototype = 
   Object.extend( new OpenLayers.Layer.Markers(), {

lib/OpenLayers/Layer/VirtualEarth.js

@@ -2,10 +2,10 @@
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
 
-// @require: OpenLayers/Layer.js
-
 /**
- * @class 
+ * @class 
+ * 
+ * @requires OpenLayers/Layer.js
  */
 OpenLayers.Layer.VirtualEarth = Class.create();
 OpenLayers.Layer.VirtualEarth.prototype = 

lib/OpenLayers/Layer/WFS.js

@@ -1,11 +1,13 @@
 /* Copyright (c) 2006 MetaCarta, Inc., published under the BSD license.
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
-// @require: OpenLayers/Layer/Grid.js
-// @require: OpenLayers/Layer/Markers.js
+
 /**
-* @class
-*/
+ * @class
+ * 
+ * @requires OpenLayers/Layer/Grid.js
+ * @requires OpenLayers/Layer/Markers.js
+ */
 OpenLayers.Layer.WFS = Class.create();
 OpenLayers.Layer.WFS.prototype = 
   Object.extend(new OpenLayers.Layer.Grid(),

lib/OpenLayers/Layer/WMS.js

@@ -1,10 +1,12 @@
 /* Copyright (c) 2006 MetaCarta, Inc., published under the BSD license.
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
-// @require: OpenLayers/Layer/Grid.js
+
 /**
-* @class
-*/
+ * @class
+ * 
+ * @requires OpenLayers/Layer/Grid.js
+ */
 OpenLayers.Layer.WMS = Class.create();
 OpenLayers.Layer.WMS.prototype = 
   Object.extend( new OpenLayers.Layer.Grid(), {

lib/OpenLayers/Layer/WMS/Untiled.js

@@ -2,11 +2,11 @@
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
  
-// @require: OpenLayers/Layer/HTTPRequest.js
-
 /**
-* @class
-*/
+ * @class
+ * 
+ * @requires OpenLayers/Layer/HTTPRequest.js
+ */
 OpenLayers.Layer.WMS.Untiled = Class.create();
 OpenLayers.Layer.WMS.Untiled.prototype = 
   Object.extend( new OpenLayers.Layer.HTTPRequest(), {

lib/OpenLayers/Layer/WorldWind.js

@@ -1,10 +1,12 @@
 /* Copyright (c) 2006 MetaCarta, Inc., published under the BSD license.
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
-// @require: OpenLayers/Layer/Grid.js
+
 /**
-* @class
-*/
+ * @class
+ * 
+ * @requires OpenLayers/Layer/Grid.js
+ */
 OpenLayers.Layer.WorldWind = Class.create();
 OpenLayers.Layer.WorldWind.prototype = 
   Object.extend( new OpenLayers.Layer.Grid(), {

lib/OpenLayers/Layer/Yahoo.js

@@ -1,13 +1,14 @@
 /* Copyright (c) 2006 MetaCarta, Inc., published under the BSD license.
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
-// @require: OpenLayers/Layer.js
-
+
 // load Yahoo map control script
 document.write("<script src='http://api.maps.yahoo.com/ajaxymap?v=3.0&appid=euzuro-openlayers'></script>");
 
 /**
- * @class
+ * @class
+ * 
+ * @requires OpenLayers/Layer.js
  */
 OpenLayers.Layer.Yahoo = Class.create();
 OpenLayers.Layer.Yahoo.prototype = Object.extend( new OpenLayers.Layer(), {

lib/OpenLayers/Map.js

@@ -2,11 +2,11 @@
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
 
-// @require: OpenLayers/Util.js
-// @require: OpenLayers/Events.js
-
 /**
  * @class
+ * 
+ * @requires OpenLayers/Util.js
+ * @requires OpenLayers/Events.js
  */
 OpenLayers.Map = Class.create();
 OpenLayers.Map.TILE_WIDTH = 256;

lib/OpenLayers/Marker.js

@@ -1,9 +1,10 @@
 /* Copyright (c) 2006 MetaCarta, Inc., published under the BSD license.
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
+
 /**
-* @class
-*/
+ * @class
+ */
 OpenLayers.Marker = Class.create();
 OpenLayers.Marker.prototype = {
     

lib/OpenLayers/Marker/Box.js

@@ -1,10 +1,12 @@
 /* Copyright (c) 2006 MetaCarta, Inc., published under the BSD license.
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
-// @require: OpenLayers/Marker.js
+
 /**
-* @class
-*/
+ * @class
+ * 
+ * @requires OpenLayers/Marker.js
+ */
 OpenLayers.Marker.Box = Class.create();
 OpenLayers.Marker.Box.prototype = Object.extend( new OpenLayers.Marker(), {
     /** @type OpenLayers.LonLat */

lib/OpenLayers/Popup.js

@@ -1,9 +1,10 @@
 /* Copyright (c) 2006 MetaCarta, Inc., published under the BSD license.
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
+
 /**
-* @class
-*/
+ * @class
+ */
 OpenLayers.Popup = Class.create();
 
 OpenLayers.Popup.count = 0;

lib/OpenLayers/Popup/Anchored.js

@@ -1,11 +1,12 @@
 /* Copyright (c) 2006 MetaCarta, Inc., published under the BSD license.
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
-// @require: OpenLayers/Popup.js
 
 /**
-* @class
-*/
+ * @class
+ * 
+ * @requires OpenLayers/Popup.js
+ */
 OpenLayers.Popup.Anchored = Class.create();
 OpenLayers.Popup.Anchored.prototype =
    Object.extend( new OpenLayers.Popup(), {

lib/OpenLayers/Popup/AnchoredBubble.js

@@ -1,11 +1,12 @@
 /* Copyright (c) 2006 MetaCarta, Inc., published under the BSD license.
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
-// @require: OpenLayers/Popup/Anchored.js
 
 /**
-* @class
-*/
+ * @class
+ * 
+ * @requires OpenLayers/Popup/Anchored.js
+ */
 OpenLayers.Popup.AnchoredBubble = Class.create();
 
 //Border space for the rico corners

lib/OpenLayers/Tile.js

@@ -1,10 +1,11 @@
 /* Copyright (c) 2006 MetaCarta, Inc., published under the BSD license.
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
+
 /*
- * OpenLayers.Tile 
- *
- * @class This is a class designed to designate a single tile, however
+ * @class 
+ * 
+ * This is a class designed to designate a single tile, however
  * it is explicitly designed to do relatively little. Tiles store information
  * about themselves -- such as the URL that they are related to, and their 
  * size - but do not add themselves to the layer div automatically, for 

lib/OpenLayers/Tile/Image.js

@@ -2,11 +2,11 @@
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
 
-// @require: OpenLayers/Tile.js
-
 /**
-* @class
-*/
+ * @class
+ * 
+ * @requires OpenLayers/Tile.js
+ */
 OpenLayers.Tile.Image = Class.create();
 OpenLayers.Tile.Image.prototype = 
   Object.extend( new OpenLayers.Tile(), {

lib/OpenLayers/Tile/WFS.js

@@ -1,10 +1,12 @@
 /* Copyright (c) 2006 MetaCarta, Inc., published under the BSD license.
  * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full
  * text of the license. */
-// @require: OpenLayers/Tile.js
+ 
 /**
-* @class
-*/
+ * @class
+ * 
+ * @requires OpenLayers/Tile.js
+ */
 OpenLayers.Tile.WFS = Class.create();
 OpenLayers.Tile.WFS.prototype = 
   Object.extend( new OpenLayers.Tile(), {

lib/OpenLayers/Util.js

@@ -3,8 +3,8 @@
  * text of the license. */
 
 /**
-* @class
-*/
+ * @class
+ */
 OpenLayers.Util = new Object();
 
 /**

tools/mergejs.py

@@ -7,11 +7,19 @@
 #
 # Dependencies are specified with a comment of the form:
 #
-#     // @require: <file path>
+#     // @requires <file path>
 #
 #  e.g.
 #
-#    // @require: Geo/DataSource.js
+#    // @requires Geo/DataSource.js
+#
+#  or (ideally) within a class comment definition
+#
+#     /**
+#      * @class
+#      *
+#      * @requires OpenLayers/Layer.js
+#      */
 #
 # This script should be executed like so:
 #
@@ -43,7 +51,7 @@ import sys
 
 SUFFIX_JAVASCRIPT = ".js"
 
-RE_REQUIRE = "@require: (.*)\n" # TODO: Ensure in comment?
+RE_REQUIRE = "@requires (.*)\n" # TODO: Ensure in comment?
 class SourceFile:
     """
     Represents a Javascript source code file.