From c1b8c8dd60514f9978db1e251e5c74158b3702ef Mon Sep 17 00:00:00 2001 From: euzuro Date: Mon, 14 Aug 2006 23:05:05 +0000 Subject: [PATCH] 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 | 18 +++++++++++++----- lib/OpenLayers/Control/KeyboardDefaults.js | 3 ++- lib/OpenLayers/Control/LayerSwitcher.js | 8 ++++---- lib/OpenLayers/Control/LayerTabs.js | 8 +++++--- lib/OpenLayers/Control/MouseDefaults.js | 4 ++-- lib/OpenLayers/Control/MouseToolbar.js | 7 ++++++- lib/OpenLayers/Control/PanZoom.js | 3 +-- lib/OpenLayers/Control/PanZoomBar.js | 9 +++++---- lib/OpenLayers/Control/Permalink.js | 5 ++--- lib/OpenLayers/Control/Scale.js | 4 ++-- lib/OpenLayers/Events.js | 6 +++--- lib/OpenLayers/Feature.js | 3 +-- lib/OpenLayers/Feature/WFS.js | 7 +++---- lib/OpenLayers/Icon.js | 5 +++-- lib/OpenLayers/Layer.js | 1 + lib/OpenLayers/Layer/Boxes.js | 10 ++++++---- lib/OpenLayers/Layer/EventPane.js | 3 +++ lib/OpenLayers/Layer/GeoRSS.js | 7 ++++--- lib/OpenLayers/Layer/Google.js | 5 ++--- lib/OpenLayers/Layer/Grid.js | 4 ++-- lib/OpenLayers/Layer/HTTPRequest.js | 4 ++-- lib/OpenLayers/Layer/KaMap.js | 10 +++++----- lib/OpenLayers/Layer/Markers.js | 8 +++++--- lib/OpenLayers/Layer/Text.js | 7 ++++--- lib/OpenLayers/Layer/VirtualEarth.js | 6 +++--- lib/OpenLayers/Layer/WFS.js | 10 ++++++---- lib/OpenLayers/Layer/WMS.js | 8 +++++--- lib/OpenLayers/Layer/WMS/Untiled.js | 8 ++++---- lib/OpenLayers/Layer/WorldWind.js | 8 +++++--- lib/OpenLayers/Layer/Yahoo.js | 7 ++++--- lib/OpenLayers/Map.js | 6 +++--- lib/OpenLayers/Marker.js | 5 +++-- lib/OpenLayers/Marker/Box.js | 8 +++++--- lib/OpenLayers/Popup.js | 5 +++-- lib/OpenLayers/Popup/Anchored.js | 7 ++++--- lib/OpenLayers/Popup/AnchoredBubble.js | 7 ++++--- lib/OpenLayers/Tile.js | 7 ++++--- lib/OpenLayers/Tile/Image.js | 8 ++++---- lib/OpenLayers/Tile/WFS.js | 8 +++++--- lib/OpenLayers/Util.js | 4 ++-- tools/mergejs.py | 14 +++++++++++--- 41 files changed, 161 insertions(+), 114 deletions(-) diff --git a/lib/OpenLayers/BaseTypes.js b/lib/OpenLayers/BaseTypes.js index aa89a4ec15..d06d2b5a77 100644 --- a/lib/OpenLayers/BaseTypes.js +++ b/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 = { diff --git a/lib/OpenLayers/Control/KeyboardDefaults.js b/lib/OpenLayers/Control/KeyboardDefaults.js index 44031eb8ce..ac2ec1e877 100644 --- a/lib/OpenLayers/Control/KeyboardDefaults.js +++ b/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 = diff --git a/lib/OpenLayers/Control/LayerSwitcher.js b/lib/OpenLayers/Control/LayerSwitcher.js index 795ca33ac3..68c334cdcb 100644 --- a/lib/OpenLayers/Control/LayerSwitcher.js +++ b/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(), { diff --git a/lib/OpenLayers/Control/LayerTabs.js b/lib/OpenLayers/Control/LayerTabs.js index 4ae68f58b6..911d91876c 100644 --- a/lib/OpenLayers/Control/LayerTabs.js +++ b/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 diff --git a/lib/OpenLayers/Control/MouseDefaults.js b/lib/OpenLayers/Control/MouseDefaults.js index 432bc207f2..2c360056c1 100644 --- a/lib/OpenLayers/Control/MouseDefaults.js +++ b/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 = diff --git a/lib/OpenLayers/Control/MouseToolbar.js b/lib/OpenLayers/Control/MouseToolbar.js index da66443456..e03e0652b4 100644 --- a/lib/OpenLayers/Control/MouseToolbar.js +++ b/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; diff --git a/lib/OpenLayers/Control/PanZoom.js b/lib/OpenLayers/Control/PanZoom.js index a0391e3f6d..2f18cf3238 100644 --- a/lib/OpenLayers/Control/PanZoom.js +++ b/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; diff --git a/lib/OpenLayers/Control/PanZoomBar.js b/lib/OpenLayers/Control/PanZoomBar.js index f633139fa8..8a7e01de43 100644 --- a/lib/OpenLayers/Control/PanZoomBar.js +++ b/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; diff --git a/lib/OpenLayers/Control/Permalink.js b/lib/OpenLayers/Control/Permalink.js index 78ceae0fcd..0c7feb1202 100644 --- a/lib/OpenLayers/Control/Permalink.js +++ b/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 = diff --git a/lib/OpenLayers/Control/Scale.js b/lib/OpenLayers/Control/Scale.js index 9bf1dadd7e..d3688e8ae2 100644 --- a/lib/OpenLayers/Control/Scale.js +++ b/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 = diff --git a/lib/OpenLayers/Events.js b/lib/OpenLayers/Events.js index a722a615d9..92e7782517 100644 --- a/lib/OpenLayers/Events.js +++ b/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 = { diff --git a/lib/OpenLayers/Feature.js b/lib/OpenLayers/Feature.js index 1268ecc3e1..b56e79eebd 100644 --- a/lib/OpenLayers/Feature.js +++ b/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(); diff --git a/lib/OpenLayers/Feature/WFS.js b/lib/OpenLayers/Feature/WFS.js index f201d20c6b..c92469f6be 100644 --- a/lib/OpenLayers/Feature/WFS.js +++ b/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 = diff --git a/lib/OpenLayers/Icon.js b/lib/OpenLayers/Icon.js index bcd5f8b73f..d8341f9307 100644 --- a/lib/OpenLayers/Icon.js +++ b/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 = { diff --git a/lib/OpenLayers/Layer.js b/lib/OpenLayers/Layer.js index f939e30eed..b2c3ec7819 100644 --- a/lib/OpenLayers/Layer.js +++ b/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 */ diff --git a/lib/OpenLayers/Layer/Boxes.js b/lib/OpenLayers/Layer/Boxes.js index 009a86d724..073befb19f 100644 --- a/lib/OpenLayers/Layer/Boxes.js +++ b/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(), { diff --git a/lib/OpenLayers/Layer/EventPane.js b/lib/OpenLayers/Layer/EventPane.js index 5c49086351..23e1c2e363 100644 --- a/lib/OpenLayers/Layer/EventPane.js +++ b/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, { diff --git a/lib/OpenLayers/Layer/GeoRSS.js b/lib/OpenLayers/Layer/GeoRSS.js index 1b0d78b745..c9a6285a9b 100644 --- a/lib/OpenLayers/Layer/GeoRSS.js +++ b/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(), { diff --git a/lib/OpenLayers/Layer/Google.js b/lib/OpenLayers/Layer/Google.js index e7017da932..245acf8ea3 100644 --- a/lib/OpenLayers/Layer/Google.js +++ b/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 = diff --git a/lib/OpenLayers/Layer/Grid.js b/lib/OpenLayers/Layer/Grid.js index 54355b64ef..90e493ee7b 100644 --- a/lib/OpenLayers/Layer/Grid.js +++ b/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 = diff --git a/lib/OpenLayers/Layer/HTTPRequest.js b/lib/OpenLayers/Layer/HTTPRequest.js index 97e6271f86..921d2c6c9b 100644 --- a/lib/OpenLayers/Layer/HTTPRequest.js +++ b/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 = diff --git a/lib/OpenLayers/Layer/KaMap.js b/lib/OpenLayers/Layer/KaMap.js index 26cf3774cb..b1c7448fa8 100644 --- a/lib/OpenLayers/Layer/KaMap.js +++ b/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(), { diff --git a/lib/OpenLayers/Layer/Markers.js b/lib/OpenLayers/Layer/Markers.js index 4bb540872e..4382456ad7 100644 --- a/lib/OpenLayers/Layer/Markers.js +++ b/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(), { diff --git a/lib/OpenLayers/Layer/Text.js b/lib/OpenLayers/Layer/Text.js index 0386b03657..6fb4adfc85 100644 --- a/lib/OpenLayers/Layer/Text.js +++ b/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(), { diff --git a/lib/OpenLayers/Layer/VirtualEarth.js b/lib/OpenLayers/Layer/VirtualEarth.js index 6bba4b0a09..eee9db1fe8 100644 --- a/lib/OpenLayers/Layer/VirtualEarth.js +++ b/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 = diff --git a/lib/OpenLayers/Layer/WFS.js b/lib/OpenLayers/Layer/WFS.js index 7a0ae968b4..d7a6641d81 100644 --- a/lib/OpenLayers/Layer/WFS.js +++ b/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(), diff --git a/lib/OpenLayers/Layer/WMS.js b/lib/OpenLayers/Layer/WMS.js index d170cd4016..9ec9ac6a77 100644 --- a/lib/OpenLayers/Layer/WMS.js +++ b/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(), { diff --git a/lib/OpenLayers/Layer/WMS/Untiled.js b/lib/OpenLayers/Layer/WMS/Untiled.js index 41c30a9a1f..0d56800406 100644 --- a/lib/OpenLayers/Layer/WMS/Untiled.js +++ b/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(), { diff --git a/lib/OpenLayers/Layer/WorldWind.js b/lib/OpenLayers/Layer/WorldWind.js index c60e71c3c5..b6dc73f064 100644 --- a/lib/OpenLayers/Layer/WorldWind.js +++ b/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(), { diff --git a/lib/OpenLayers/Layer/Yahoo.js b/lib/OpenLayers/Layer/Yahoo.js index 68c73359ee..dd2cbd961b 100644 --- a/lib/OpenLayers/Layer/Yahoo.js +++ b/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(""); /** - * @class + * @class + * + * @requires OpenLayers/Layer.js */ OpenLayers.Layer.Yahoo = Class.create(); OpenLayers.Layer.Yahoo.prototype = Object.extend( new OpenLayers.Layer(), { diff --git a/lib/OpenLayers/Map.js b/lib/OpenLayers/Map.js index 60fcc82275..6c24bcae43 100644 --- a/lib/OpenLayers/Map.js +++ b/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; diff --git a/lib/OpenLayers/Marker.js b/lib/OpenLayers/Marker.js index 1add7a4a09..292a1576e7 100644 --- a/lib/OpenLayers/Marker.js +++ b/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 = { diff --git a/lib/OpenLayers/Marker/Box.js b/lib/OpenLayers/Marker/Box.js index 66edc64839..d772c31936 100644 --- a/lib/OpenLayers/Marker/Box.js +++ b/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 */ diff --git a/lib/OpenLayers/Popup.js b/lib/OpenLayers/Popup.js index 2fcfaf2c0d..adaa52a43c 100644 --- a/lib/OpenLayers/Popup.js +++ b/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; diff --git a/lib/OpenLayers/Popup/Anchored.js b/lib/OpenLayers/Popup/Anchored.js index 90db91279c..f98345f605 100644 --- a/lib/OpenLayers/Popup/Anchored.js +++ b/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(), { diff --git a/lib/OpenLayers/Popup/AnchoredBubble.js b/lib/OpenLayers/Popup/AnchoredBubble.js index a06aab489c..0960f68b28 100644 --- a/lib/OpenLayers/Popup/AnchoredBubble.js +++ b/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 diff --git a/lib/OpenLayers/Tile.js b/lib/OpenLayers/Tile.js index 0a6fe7f8ff..abc893ac50 100644 --- a/lib/OpenLayers/Tile.js +++ b/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 diff --git a/lib/OpenLayers/Tile/Image.js b/lib/OpenLayers/Tile/Image.js index fb89d61e70..8087182405 100644 --- a/lib/OpenLayers/Tile/Image.js +++ b/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(), { diff --git a/lib/OpenLayers/Tile/WFS.js b/lib/OpenLayers/Tile/WFS.js index cf38e67c40..3cdc6338b6 100644 --- a/lib/OpenLayers/Tile/WFS.js +++ b/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(), { diff --git a/lib/OpenLayers/Util.js b/lib/OpenLayers/Util.js index 82d5861aeb..9ebb1ebb26 100644 --- a/lib/OpenLayers/Util.js +++ b/lib/OpenLayers/Util.js @@ -3,8 +3,8 @@ * text of the license. */ /** -* @class -*/ + * @class + */ OpenLayers.Util = new Object(); /** diff --git a/tools/mergejs.py b/tools/mergejs.py index 8366453d94..29104a0e99 100755 --- a/tools/mergejs.py +++ b/tools/mergejs.py @@ -7,11 +7,19 @@ # # Dependencies are specified with a comment of the form: # -# // @require: +# // @requires # # 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.