OpenLayers OpenLayers

Changeset 1206

Show
Ignore:
Timestamp:
08/14/06 19:05:05 (2 years ago)
Author:
euzuro
Message:

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

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/openlayers/lib/OpenLayers/BaseTypes.js

    r1205 r1206  
    1212 
    1313/** 
    14  * @class This class represents a screen coordinate, in x and y coordinates 
     14 * @class  
     15 *  
     16 * This class represents a screen coordinate, in x and y coordinates 
    1517 */ 
    1618OpenLayers.Pixel = Class.create(); 
    …… 
    110112 
    111113/** 
    112 * @class This class represents a width and height pair 
     114* @class  
     115*  
     116* This class represents a width and height pair 
    113117*/ 
    114118OpenLayers.Size = Class.create(); 
    …… 
    189193 
    190194/** 
    191 * @class This class represents a longitude and latitude pair 
     195* @class  
     196*  
     197* This class represents a longitude and latitude pair 
    192198*/ 
    193199OpenLayers.LonLat = Class.create(); 
    …… 
    309315 
    310316/** 
    311 * @class This class represents a bounding box.  
    312 *        Data stored as left, bottom, right, top floats 
     317* @class  
     318*  
     319* This class represents a bounding box.  
     320* Data stored as left, bottom, right, top floats 
    313321*/ 
    314322OpenLayers.Bounds = Class.create(); 

  • trunk/openlayers/lib/OpenLayers/Control/KeyboardDefaults.js

    r806 r1206  
    22 * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full 
    33 * text of the license. */ 
    4 // @require: OpenLayers/Control.js 
    54 
    65/** 
    76 * @class 
     7 *  
     8 * @requires OpenLayers/Control.js 
    89 */ 
    910OpenLayers.Control.KeyboardDefaults = Class.create(); 

  • trunk/openlayers/lib/OpenLayers/Control/LayerSwitcher.js

    r1172 r1206  
    33 * text of the license. */ 
    44 
    5 // @require: OpenLayers/Control.js 
    6  
    75/**  
    8 * @class 
    9 */ 
     6 * @class 
     7 *  
     8 * @requires OpenLayers/Control.js 
     9 */ 
    1010OpenLayers.Control.LayerSwitcher = Class.create(); 
    1111OpenLayers.Control.LayerSwitcher.prototype =  

  • trunk/openlayers/lib/OpenLayers/Control/LayerTabs.js

    r1142 r1206  
    22 * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full 
    33 * text of the license. */ 
    4 // @require: OpenLayers/Control.js 
     4 
    55/**  
    6 * @class 
    7 */ 
     6 * @class 
     7 *  
     8 * @requires OpenLayers/Control.js 
     9 */ 
    810OpenLayers.Control.LayerTabs = Class.create(); 
    911 

  • trunk/openlayers/lib/OpenLayers/Control/MouseDefaults.js

    r1012 r1206  
    22 * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full 
    33 * text of the license. */ 
    4   
    5 // @require: OpenLayers/Control.js 
    64 
    75/** 
    86 * @class 
     7 *  
     8 * @requires OpenLayers/Control.js 
    99 */ 
    1010OpenLayers.Control.MouseDefaults = Class.create(); 

  • trunk/openlayers/lib/OpenLayers/Control/MouseToolbar.js

    r1136 r1206  
    22 * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full 
    33 * text of the license. */ 
    4 // @require: OpenLayers/Control.js 
     4 
     5/** 
     6 * @class 
     7 *  
     8 * @requires OpenLayers/Control.js 
     9 */ 
    510OpenLayers.Control.MouseToolbar = Class.create(); 
    611OpenLayers.Control.MouseToolbar.X = 6; 

  • trunk/openlayers/lib/OpenLayers/Control/PanZoom.js

    r1142 r1206  
    22 * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full 
    33 * text of the license. */ 
    4 // @require: OpenLayers/Control.js 
    54 
    65/** 
    76 * @class 
    87 *  
    9  * default zoom/pan controls 
     8 * @requires OpenLayers/Control.js 
    109 */ 
    1110OpenLayers.Control.PanZoom = Class.create(); 

  • trunk/openlayers/lib/OpenLayers/Control/PanZoomBar.js

    r961 r1206  
    22 * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full 
    33 * text of the license. */ 
    4 // @require: OpenLayers/Control/PanZoom.js 
    5  
    6 // 
    7 // default zoom/pan controls 
    8 // 
     4 
     5/** 
     6 * @class  
     7 *  
     8 * @requires OpenLayers/Control/PanZoom.js 
     9 */ 
    910OpenLayers.Control.PanZoomBar = Class.create(); 
    1011OpenLayers.Control.PanZoomBar.X = 4; 

  • trunk/openlayers/lib/OpenLayers/Control/Permalink.js

    r922 r1206  
    33 * text of the license. */ 
    44 
    5 // @require: OpenLayers/Control.js 
    6  
    7  
    85/** 
    96 * @class 
     7 *  
     8 * @requires OpenLayers/Control.js 
    109 */ 
    1110OpenLayers.Control.Permalink = Class.create(); 

  • trunk/openlayers/lib/OpenLayers/Control/Scale.js

    r1159 r1206  
    33 * text of the license. */ 
    44 
    5 // @require: OpenLayers/Control.js 
    6  
    75/** 
    86 * @class 
     7 *  
     8 * @requires OpenLayers/Control.js 
    99 */ 
    1010OpenLayers.Control.Scale = Class.create(); 

  • trunk/openlayers/lib/OpenLayers/Events.js

    r1192 r1206  
    33 * text of the license. */ 
    44  
    5  /** 
    6   * @class 
    7   */ 
     5/** 
     6 * @class 
     7 */ 
    88OpenLayers.Events = Class.create(); 
    99OpenLayers.Events.prototype = { 

  • trunk/openlayers/lib/OpenLayers/Feature.js

    r1205 r1206  
    33 * text of the license. */ 
    44 
    5 // @require: OpenLayers/Util.js 
    6  
    75/** 
    86 * @class 
     7 *  
    98 * @requires OpenLayers/Util.js 
    109 */ 

  • trunk/openlayers/lib/OpenLayers/Feature/WFS.js

    r1186 r1206  
    33 * text of the license. */ 
    44 
    5 // @require: OpenLayers/Feature.js 
    6  
    75/** 
    86 * @class 
    9  * @require: OpenLayers/Feature.js 
     7 *  
     8 * @requires OpenLayers/Feature.js 
    109 */ 
    1110OpenLayers.Feature.WFS = Class.create(); 

  • trunk/openlayers/lib/OpenLayers/Icon.js

    r1096 r1206  
    22 * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full 
    33 * text of the license. */ 
     4 
    45/** 
    5 * @class 
    6 */ 
     6 * @class 
     7 */ 
    78OpenLayers.Icon = Class.create(); 
    89OpenLayers.Icon.prototype = { 

  • trunk/openlayers/lib/OpenLayers/Layer.js

    r1202 r1206  
    22 * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full 
    33 * text of the license. */ 
     4 
    45/** 
    56 * @class 

  • trunk/openlayers/lib/OpenLayers/Layer/Boxes.js

    r1096 r1206  
    22 * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full 
    33 * text of the license. */ 
    4 // @require: OpenLayers/Layer.js 
    5 // @require: OpenLayers/Layer/Markers.js 
     4 
    65/** 
    7 * @class 
    8 */ 
     6 * @class 
     7 *  
     8 * @requires OpenLayers/Layer.js 
     9 * @requires OpenLayers/Layer/Markers.js 
     10 */ 
    911OpenLayers.Layer.Boxes = Class.create(); 
    1012OpenLayers.Layer.Boxes.prototype =  

  • trunk/openlayers/lib/OpenLayers/Layer/EventPane.js

    r1193 r1206  
    22 * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full 
    33 * text of the license. */ 
     4 
    45/** 
    56 * @class 
     7 *  
     8 * @requires OpenLayers/Layer.js 
    69 */ 
    710OpenLayers.Layer.EventPane = Class.create(); 

  • trunk/openlayers/lib/OpenLayers/Layer/GeoRSS.js

    r1136 r1206  
    22 * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full 
    33 * text of the license. */ 
    4 // @require: OpenLayers/Layer/Markers.js 
    54 
    65/** 
    7 * @class 
    8 */ 
     6 * @class 
     7 *  
     8 * @requires OpenLayers/Layer/Markers.js 
     9 */ 
    910OpenLayers.Layer.GeoRSS = Class.create(); 
    1011OpenLayers.Layer.GeoRSS.prototype =  

  • trunk/openlayers/lib/OpenLayers/Layer/Google.js

    r1195 r1206  
    22 * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full 
    33 * text of the license. */ 
    4  
    5 // @require: OpenLayers/Layer.js 
    6  
    74 
    85if (typeof GMap2 != "undefined") { 
    …… 
    3431/** 
    3532 * @class 
     33 *  
     34 * @requires OpenLayers/Layer.js 
    3635 */ 
    3736OpenLayers.Layer.Google = Class.create(); 

  • trunk/openlayers/lib/OpenLayers/Layer/Grid.js

    r1205 r1206  
    33 * text of the license. */ 
    44 
    5 // @require: OpenLayers/Layer/HTTPRequest.js 
    6  
    75/** 
    86 * @class 
     7 *  
     8 * @requires OpenLayers/Layer/HTTPRequest.js 
    99 */ 
    1010OpenLayers.Layer.Grid = Class.create(); 

  • trunk/openlayers/lib/OpenLayers/Layer/HTTPRequest.js

    r1205 r1206  
    33 * text of the license. */ 
    44 
    5 // @require: OpenLayers/Layer.js 
    6  
    75/** 
    86 * @class 
     7 *  
     8 * @requires OpenLayers/Layer.js 
    99 */ 
    1010OpenLayers.Layer.HTTPRequest = Class.create(); 

  • trunk/openlayers/lib/OpenLayers/Layer/KaMap.js

    r1161 r1206  
    22 * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full 
    33 * text of the license. */ 
    4 // @require: OpenLayers/Layer/Grid.js 
     4 
    55/** 
    6 * @class 
    7 */ 
     6 * @class 
     7 *  
     8 * @requires OpenLayers/Layer/Grid.js 
     9 */ 
    810OpenLayers.Layer.KaMap = Class.create(); 
    9  
    10  
    1111OpenLayers.Layer.KaMap.prototype =  
    1212  Object.extend( new OpenLayers.Layer.Grid(), { 

  • trunk/openlayers/lib/OpenLayers/Layer/Markers.js

    r1144 r1206  
    22 * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full 
    33 * text of the license. */ 
    4 // @require: OpenLayers/Layer.js 
     4 
    55/** 
    6 * @class 
    7 */ 
     6 * @class 
     7 *  
     8 * @requires OpenLayers/Layer.js 
     9 */ 
    810OpenLayers.Layer.Markers = Class.create(); 
    911OpenLayers.Layer.Markers.prototype =  

  • trunk/openlayers/lib/OpenLayers/Layer/Text.js

    r1144 r1206  
    22 * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full 
    33 * text of the license. */ 
    4 // @require: OpenLayers/Layer/Markers.js 
    54 
    65/** 
    7 * @class 
    8 */ 
     6 * @class 
     7 *  
     8 * @requires OpenLayers/Layer/Markers.js 
     9 */ 
    910OpenLayers.Layer.Text = Class.create(); 
    1011OpenLayers.Layer.Text.prototype =  

  • trunk/openlayers/lib/OpenLayers/Layer/VirtualEarth.js

    r1143 r1206  
    33 * text of the license. */ 
    44 
    5 // @require: OpenLayers/Layer.js 
    6  
    75/** 
    86 * @class  
     7 *  
     8 * @requires OpenLayers/Layer.js 
    99 */ 
    1010OpenLayers.Layer.VirtualEarth = Class.create(); 

  • trunk/openlayers/lib/OpenLayers/Layer/WFS.js

    r1154 r1206  
    22 * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full 
    33 * text of the license. */ 
    4 // @require: OpenLayers/Layer/Grid.js 
    5 // @require: OpenLayers/Layer/Markers.js 
     4 
    65/** 
    7 * @class 
    8 */ 
     6 * @class 
     7 *  
     8 * @requires OpenLayers/Layer/Grid.js 
     9 * @requires OpenLayers/Layer/Markers.js 
     10 */ 
    911OpenLayers.Layer.WFS = Class.create(); 
    1012OpenLayers.Layer.WFS.prototype =  

  • trunk/openlayers/lib/OpenLayers/Layer/WMS.js

    r1147 r1206  
    22 * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full 
    33 * text of the license. */ 
    4 // @require: OpenLayers/Layer/Grid.js 
     4 
    55/** 
    6 * @class 
    7 */ 
     6 * @class 
     7 *  
     8 * @requires OpenLayers/Layer/Grid.js 
     9 */ 
    810OpenLayers.Layer.WMS = Class.create(); 
    911OpenLayers.Layer.WMS.prototype =  

  • trunk/openlayers/lib/OpenLayers/Layer/WMS/Untiled.js

    r1144 r1206  
    33 * text of the license. */ 
    44  
    5 // @require: OpenLayers/Layer/HTTPRequest.js 
    6  
    75/** 
    8 * @class 
    9 */ 
     6 * @class 
     7 *  
     8 * @requires OpenLayers/Layer/HTTPRequest.js 
     9 */ 
    1010OpenLayers.Layer.WMS.Untiled = Class.create(); 
    1111OpenLayers.Layer.WMS.Untiled.prototype =  

  • trunk/openlayers/lib/OpenLayers/Layer/WorldWind.js

    r1147 r1206  
    22 * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full 
    33 * text of the license. */ 
    4 // @require: OpenLayers/Layer/Grid.js 
     4 
    55/** 
    6 * @class 
    7 */ 
     6 * @class 
     7 *  
     8 * @requires OpenLayers/Layer/Grid.js 
     9 */ 
    810OpenLayers.Layer.WorldWind = Class.create(); 
    911OpenLayers.Layer.WorldWind.prototype =  

  • trunk/openlayers/lib/OpenLayers/Layer/Yahoo.js

    r1142 r1206  
    22 * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full 
    33 * text of the license. */ 
    4 // @require: OpenLayers/Layer.js 
    54 
    65// load Yahoo map control script 
    …… 
    98/** 
    109 * @class 
     10 *  
     11 * @requires OpenLayers/Layer.js 
    1112 */ 
    1213OpenLayers.Layer.Yahoo = Class.create(); 

  • trunk/openlayers/lib/OpenLayers/Map.js

    r1205 r1206  
    33 * text of the license. */ 
    44 
    5 // @require: OpenLayers/Util.js 
    6 // @require: OpenLayers/Events.js 
    7  
    85/** 
    96 * @class 
     7 *  
     8 * @requires OpenLayers/Util.js 
     9 * @requires OpenLayers/Events.js 
    1010 */ 
    1111OpenLayers.Map = Class.create(); 

  • trunk/openlayers/lib/OpenLayers/Marker.js

    r1096 r1206  
    22 * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full 
    33 * text of the license. */ 
     4 
    45/** 
    5 * @class 
    6 */ 
     6 * @class 
     7 */ 
    78OpenLayers.Marker = Class.create(); 
    89OpenLayers.Marker.prototype = { 

  • trunk/openlayers/lib/OpenLayers/Marker/Box.js

    r1096 r1206  
    22 * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full 
    33 * text of the license. */ 
    4 // @require: OpenLayers/Marker.js 
     4 
    55/** 
    6 * @class 
    7 */ 
     6 * @class 
     7 *  
     8 * @requires OpenLayers/Marker.js 
     9 */ 
    810OpenLayers.Marker.Box = Class.create(); 
    911OpenLayers.Marker.Box.prototype = Object.extend( new OpenLayers.Marker(), { 

  • trunk/openlayers/lib/OpenLayers/Popup.js

    r1187 r1206  
    22 * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full 
    33 * text of the license. */ 
     4 
    45/** 
    5 * @class 
    6 */ 
     6 * @class 
     7 */ 
    78OpenLayers.Popup = Class.create(); 
    89 

  • trunk/openlayers/lib/OpenLayers/Popup/Anchored.js

    r657 r1206  
    22 * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full 
    33 * text of the license. */ 
    4 // @require: OpenLayers/Popup.js 
    54 
    65/** 
    7 * @class 
    8 */ 
     6 * @class 
     7 *  
     8 * @requires OpenLayers/Popup.js 
     9 */ 
    910OpenLayers.Popup.Anchored = Class.create(); 
    1011OpenLayers.Popup.Anchored.prototype = 

  • trunk/openlayers/lib/OpenLayers/Popup/AnchoredBubble.js

    r961 r1206  
    22 * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full 
    33 * text of the license. */ 
    4 // @require: OpenLayers/Popup/Anchored.js 
    54 
    65/** 
    7 * @class 
    8 */ 
     6 * @class 
     7 *  
     8 * @requires OpenLayers/Popup/Anchored.js 
     9 */ 
    910OpenLayers.Popup.AnchoredBubble = Class.create(); 
    1011 

  • trunk/openlayers/lib/OpenLayers/Tile.js

    r1198 r1206  
    22 * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full 
    33 * text of the license. */ 
     4 
    45/* 
    5  * OpenLayers.Tile  
    6  * 
    7  * @class This is a class designed to designate a single tile, however 
     6 * @class  
     7 *  
     8 * This is a class designed to designate a single tile, however 
    89 * it is explicitly designed to do relatively little. Tiles store information 
    910 * about themselves -- such as the URL that they are related to, and their  

  • trunk/openlayers/lib/OpenLayers/Tile/Image.js

    r1198 r1206  
    33 * text of the license. */ 
    44 
    5 // @require: OpenLayers/Tile.js 
    6  
    75/** 
    8 * @class 
    9 */ 
     6 * @class 
     7 *  
     8 * @requires OpenLayers/Tile.js 
     9 */ 
    1010OpenLayers.Tile.Image = Class.create(); 
    1111OpenLayers.Tile.Image.prototype =  

  • trunk/openlayers/lib/OpenLayers/Tile/WFS.js

    r1198 r1206  
    22 * See http://svn.openlayers.org/trunk/openlayers/license.txt for the full 
    33 * text of the license. */ 
    4 // @require: OpenLayers/Tile.js 
     4  
    55/** 
    6 * @class 
    7 */ 
     6 * @class 
     7 *  
     8 * @requires OpenLayers/Tile.js 
     9 */ 
    810OpenLayers.Tile.WFS = Class.create(); 
    911OpenLayers.Tile.WFS.prototype =  

  • trunk/openlayers/lib/OpenLayers/Util.js

    r1205 r1206  
    44 
    55/** 
    6 * @class 
    7 */ 
     6 * @class 
     7 */ 
    88OpenLayers.Util = new Object(); 
    99 

  • trunk/openlayers/tools/mergejs.py

    r839 r1206  
    88# Dependencies are specified with a comment of the form: 
    99# 
    10 #     // @require: <file path> 
     10#     // @requires <file path> 
    1111# 
    1212#  e.g. 
    1313# 
    14 #    // @require: Geo/DataSource.js 
     14#    // @requires Geo/DataSource.js 
     15# 
     16#  or (ideally) within a class comment definition 
     17# 
     18#     /** 
     19#      * @class 
     20#      * 
     21#      * @requires OpenLayers/Layer.js 
     22#      */ 
    1523# 
    1624# This script should be executed like so: 
    …… 
    4452SUFFIX_JAVASCRIPT = ".js" 
    4553 
    46 RE_REQUIRE = "@require: (.*)\n" # TODO: Ensure in comment? 
     54RE_REQUIRE = "@requires (.*)\n" # TODO: Ensure in comment? 
    4755class SourceFile: 
    4856    """