OpenLayers OpenLayers

Changeset 6833

Show
Ignore:
Timestamp:
04/09/08 12:52:08 (5 months ago)
Author:
tschaub
Message:

Fixing links in documentation. Other Natural Docs changes. (closes #1504)

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/openlayers/apidoc_config/Menu.txt

    r6542 r6833  
    7070      File: ArgParser  (no auto-title, OpenLayers/Control/ArgParser.js) 
    7171      File: Attribution  (no auto-title, OpenLayers/Control/Attribution.js) 
    72       File: Control.Button  (no auto-title, OpenLayers/Control/Button.js) 
     72      File: Button  (no auto-title, OpenLayers/Control/Button.js) 
    7373      File: DragFeature  (no auto-title, OpenLayers/Control/DragFeature.js) 
    7474      File: DragPan  (no auto-title, OpenLayers/Control/DragPan.js) 
    …… 
    105105      }  # Group: Feature 
    106106 
     107   Group: Filter  { 
     108 
     109      File: Filter  (no auto-title, OpenLayers/Filter.js) 
     110      File: Comparison  (no auto-title, OpenLayers/Filter/Comparison.js) 
     111      File: FeatureId  (no auto-title, OpenLayers/Filter/FeatureId.js) 
     112      File: Logical  (no auto-title, OpenLayers/Filter/Logical.js) 
     113      }  # Group: Filter 
     114 
    107115   Group: Format  { 
    108116 
    …… 
    114122      File: KML  (no auto-title, OpenLayers/Format/KML.js) 
    115123      File: OSM  (no auto-title, OpenLayers/Format/OSM.js) 
    116       File: SLD  (no auto-title, OpenLayers/Format/SLD.js) 
     124 
     125      Group: SLD  { 
     126 
     127         File: SLD  (no auto-title, OpenLayers/Format/SLD.js) 
     128         File: v1  (no auto-title, OpenLayers/Format/SLD/v1.js) 
     129         File: v1_0_0  (no auto-title, OpenLayers/Format/SLD/v1_0_0.js) 
     130         }  # Group: SLD 
     131 
    117132      File: Text  (no auto-title, OpenLayers/Format/Text.js) 
    118133      File: WFS  (no auto-title, OpenLayers/Format/WFS.js) 
    119134      File: WKT  (no auto-title, OpenLayers/Format/WKT.js) 
     135      File: XML  (no auto-title, OpenLayers/Format/XML.js) 
    120136 
    121137      Group: WMC  { 
    …… 
    127143         }  # Group: WMC 
    128144 
    129       File: XML  (no auto-title, OpenLayers/Format/XML.js) 
    130145      }  # Group: Format 
    131146 
    …… 
    143158      File: Polygon  (no auto-title, OpenLayers/Geometry/Polygon.js) 
    144159      File: Rectangle  (no auto-title, OpenLayers/Geometry/Rectangle.js) 
    145       File: Surface  (no auto-title, OpenLayers/Geometry/Surface.js) 
    146160      }  # Group: Geometry 
    147161 
    …… 
    167181 
    168182      File: Lang  (no auto-title, OpenLayers/Lang.js) 
     183      File: Lang["cs-CZ"]  (OpenLayers/Lang/cs-CZ.js) 
    169184      File: Lang["de"]  (no auto-title, OpenLayers/Lang/de.js) 
    170185      File: Lang["en"]  (no auto-title, OpenLayers/Lang/en.js) 
    …… 
    218233      File: Anchored  (no auto-title, OpenLayers/Popup/Anchored.js) 
    219234      File: AnchoredBubble  (no auto-title, OpenLayers/Popup/AnchoredBubble.js) 
     235      File: Framed  (OpenLayers/Popup/Framed.js) 
     236      File: FramedCloud  (OpenLayers/Popup/FramedCloud.js) 
    220237      }  # Group: Popup 
    221238 
    …… 
    230247      }  # Group: Renderer 
    231248 
    232    Group: Rule  { 
    233  
    234       File: Rule  (no auto-title, OpenLayers/Rule.js) 
    235       File: Comparison  (no auto-title, OpenLayers/Rule/Comparison.js) 
    236       File: FeatureId  (no auto-title, OpenLayers/Rule/FeatureId.js) 
    237       File: Logical  (no auto-title, OpenLayers/Rule/Logical.js) 
    238       }  # Group: Rule 
    239  
     249   File: Rule  (no auto-title, OpenLayers/Rule.js) 
    240250   File: Style  (no auto-title, OpenLayers/Style.js) 
    241251   File: StyleMap  (no auto-title, OpenLayers/StyleMap.js) 

  • trunk/openlayers/doc_config/Menu.txt

    r6542 r6833  
    7070      File: ArgParser  (no auto-title, OpenLayers/Control/ArgParser.js) 
    7171      File: Attribution  (no auto-title, OpenLayers/Control/Attribution.js) 
    72       File: Control.Button  (no auto-title, OpenLayers/Control/Button.js) 
     72      File: Button  (no auto-title, OpenLayers/Control/Button.js) 
    7373      File: DragFeature  (no auto-title, OpenLayers/Control/DragFeature.js) 
    7474      File: DragPan  (no auto-title, OpenLayers/Control/DragPan.js) 
    …… 
    105105      }  # Group: Feature 
    106106 
     107   Group: Filter  { 
     108 
     109      File: Filter  (no auto-title, OpenLayers/Filter.js) 
     110      File: Comparison  (no auto-title, OpenLayers/Filter/Comparison.js) 
     111      File: FeatureId  (no auto-title, OpenLayers/Filter/FeatureId.js) 
     112      File: Logical  (no auto-title, OpenLayers/Filter/Logical.js) 
     113      }  # Group: Filter 
     114 
    107115   Group: Format  { 
    108116 
    …… 
    114122      File: KML  (no auto-title, OpenLayers/Format/KML.js) 
    115123      File: OSM  (no auto-title, OpenLayers/Format/OSM.js) 
    116       File: SLD  (no auto-title, OpenLayers/Format/SLD.js) 
     124 
     125      Group: SLD  { 
     126 
     127         File: SLD  (no auto-title, OpenLayers/Format/SLD.js) 
     128         File: v1  (no auto-title, OpenLayers/Format/SLD/v1.js) 
     129         File: v1_0_0  (no auto-title, OpenLayers/Format/SLD/v1_0_0.js) 
     130         }  # Group: SLD 
     131 
    117132      File: Text  (no auto-title, OpenLayers/Format/Text.js) 
    118133      File: WFS  (no auto-title, OpenLayers/Format/WFS.js) 
    119134      File: WKT  (no auto-title, OpenLayers/Format/WKT.js) 
     135      File: XML  (no auto-title, OpenLayers/Format/XML.js) 
    120136 
    121137      Group: WMC  { 
    …… 
    127143         }  # Group: WMC 
    128144 
    129       File: XML  (no auto-title, OpenLayers/Format/XML.js) 
    130145      }  # Group: Format 
    131146 
    …… 
    143158      File: Polygon  (no auto-title, OpenLayers/Geometry/Polygon.js) 
    144159      File: Rectangle  (no auto-title, OpenLayers/Geometry/Rectangle.js) 
    145       File: Surface  (no auto-title, OpenLayers/Geometry/Surface.js) 
    146160      }  # Group: Geometry 
    147161 
    …… 
    167181 
    168182      File: Lang  (no auto-title, OpenLayers/Lang.js) 
     183      File: Lang["cs-CZ"]  (OpenLayers/Lang/cs-CZ.js) 
    169184      File: Lang["de"]  (no auto-title, OpenLayers/Lang/de.js) 
    170185      File: Lang["en"]  (no auto-title, OpenLayers/Lang/en.js) 
    …… 
    218233      File: Anchored  (no auto-title, OpenLayers/Popup/Anchored.js) 
    219234      File: AnchoredBubble  (no auto-title, OpenLayers/Popup/AnchoredBubble.js) 
     235      File: Framed  (OpenLayers/Popup/Framed.js) 
     236      File: FramedCloud  (OpenLayers/Popup/FramedCloud.js) 
    220237      }  # Group: Popup 
    221238 
    …… 
    230247      }  # Group: Renderer 
    231248 
    232    Group: Rule  { 
    233  
    234       File: Rule  (no auto-title, OpenLayers/Rule.js) 
    235       File: Comparison  (no auto-title, OpenLayers/Rule/Comparison.js) 
    236       File: FeatureId  (no auto-title, OpenLayers/Rule/FeatureId.js) 
    237       File: Logical  (no auto-title, OpenLayers/Rule/Logical.js) 
    238       }  # Group: Rule 
    239  
     249   File: Rule  (no auto-title, OpenLayers/Rule.js) 
    240250   File: Style  (no auto-title, OpenLayers/Style.js) 
    241251   File: StyleMap  (no auto-title, OpenLayers/StyleMap.js) 

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

    r6421 r6833  
    1919    /** 
    2020     * Property: left 
    21      * {Number} 
     21     * {Number} Minimum horizontal coordinate. 
    2222     */ 
    2323    left: null, 
    …… 
    2525    /** 
    2626     * Property: bottom 
    27      * {Number} 
     27     * {Number} Minimum vertical coordinate. 
    2828     */ 
    2929    bottom: null, 
    …… 
    3131    /** 
    3232     * Property: right 
    33      * {Number} 
     33     * {Number} Maximum horizontal coordinate. 
    3434     */ 
    3535    right: null, 
    …… 
    3737    /** 
    3838     * Property: top 
    39      * {Number} 
     39     * {Number} Maximum vertical coordinate. 
    4040     */ 
    4141    top: null,     
    …… 
    350350     * Parameters: 
    351351     * bounds - {<OpenLayers.Bounds>} 
    352      * inclusive - {<Boolean>} Whether or not to include the border.  Default 
     352     * inclusive - {Boolean} Whether or not to include the border.  Default 
    353353     *     is true. 
    354354     * 
    …… 
    385385     *  
    386386     * bounds - {<OpenLayers.Bounds>} 
    387      * partial - {<Boolean>} If true, only part of passed-in bounds needs be 
     387     * partial - {Boolean} If true, only part of passed-in bounds needs be 
    388388     *     within this bounds.  If false, the entire passed-in bounds must be 
    389389     *     within. Default is false 
    390      * inclusive - {<Boolean>} Whether or not to include the border. Default is 
     390     * inclusive - {Boolean} Whether or not to include the border. Default is 
    391391     *     true. 
    392392     * 

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

    r6727 r6833  
    104104    /**  
    105105     * Property: active  
    106      * {boolean} null 
     106     * {Boolean} The control is active. 
    107107     */ 
    108108    active: null, 

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

    r6492 r6833  
    3131    /** 
    3232     * Method: draw 
    33      * Creates a Drag handler, using <OpenLayers.Control.PanMap.panMap> and 
    34      * <OpenLayers.Control.PanMap.panMapDone> as callbacks. 
     33     * Creates a Drag handler, using <panMap> and 
     34     * <panMapDone> as callbacks. 
    3535     */     
    3636    draw: function() { 

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

    r6802 r6833  
    7373    /** 
    7474     * Property: selectControl 
    75      * {<OpenLayers.Control.Select>} 
     75     * {<OpenLayers.Control.SelectFeature>} 
    7676     */ 
    7777    selectControl: null, 
    …… 
    100100    /** 
    101101     * APIProperty: virtualStyle 
    102      * {<OpenLayers.Feature.Vector.Style>} 
     102     * {Object} A symbolizer to be used for virtual vertices. 
    103103     */ 
    104104    virtualStyle: null, 

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

    r5614 r6833  
    1111/** 
    1212 * Class: OpenLayers.Control.NavToolbar 
     13 *  
     14 * Inherits from: 
     15 *  - <OpenLayers.Control.Panel> 
    1316 */ 
    1417OpenLayers.Control.NavToolbar = OpenLayers.Class(OpenLayers.Control.Panel, { 

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

    r6427 r6833  
    1717 * 
    1818 * Inherits from: 
    19  *  - <OpenLayers.Control.Control> 
     19 *  - <OpenLayers.Control> 
    2020 */ 
    2121OpenLayers.Control.NavigationHistory = OpenLayers.Class(OpenLayers.Control, { 
    …… 
    3333    /** 
    3434     * APIProperty: previous 
    35      * {OpenLayers.Control} A button type control whose trigger method restores 
     35     * {<OpenLayers.Control>} A button type control whose trigger method restores 
    3636     *     the previous state managed by this control. 
    3737     */ 
    …… 
    4747    /** 
    4848     * APIProperty: next 
    49      * {OpenLayers.Control} A button type control whose trigger method restores 
     49     * {<OpenLayers.Control>} A button type control whose trigger method restores 
    5050     *     the next state managed by this control. 
    5151     */ 

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

    r5614 r6833  
    99 
    1010/** 
    11  * Class: OpenLayers.PanZoom 
     11 * Class: OpenLayers.Control.PanZoom 
    1212 *  
    1313 * Inherits from: 

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

    r6799 r6833  
    1313 * Inherits from: 
    1414 *  - <OpenLayers.Control.PanZoom> 
    15  *  - <OpenLayers.Control> 
    1615 */ 
    1716OpenLayers.Control.PanZoomBar = OpenLayers.Class(OpenLayers.Control.PanZoom, { 
    …… 
    5756 
    5857    /** 
    59      * Constructor: <OpenLayers.Control.PanZoomBar> 
     58     * Constructor: OpenLayers.Control.PanZoomBar 
    6059     */  
    6160    initialize: function() { 

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

    r6443 r6833  
    1616    /** 
    1717     * Property: controls 
    18      * Array({<OpenLayers.Control>}) 
     18     * {Array(<OpenLayers.Control>)} 
    1919     */ 
    2020    controls: null,     

  • trunk/openlayers/lib/OpenLayers/Filter/Comparison.js

    r6818 r6833  
    6969     * 
    7070     * Parameters: 
    71      * params  - {Object} Hash of parameters for this rule: 
    72      *              -  
    73      *              - value:  
    7471     * options - {Object} An optional object with properties to set on the 
    7572     *           rule 
    …… 
    205202     *  
    206203     * Returns: 
    207      * {boolean} 
     204     * {Boolean} 
    208205     */ 
    209206    binaryCompare: function(context, property, value) { 

  • trunk/openlayers/lib/OpenLayers/Filter/FeatureId.js

    r6818 r6833  
    2020    /**  
    2121     * APIProperty: fids 
    22      * {Array(<String>)} Feature Ids to evaluate this rule against. To be passed 
     22     * {Array(String)} Feature Ids to evaluate this rule against. To be passed 
    2323     * To be passed inside the params object. 
    2424     */ 
    …… 
    5151     *  
    5252     * Returns: 
    53      * {boolean} true if the rule applies, false if it does not 
     53     * {Boolean} true if the rule applies, false if it does not 
    5454     */ 
    5555    evaluate: function(feature) { 

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

    r6549 r6833  
    268268     *  
    269269     * Parameters:  
    270      * features - Array({<OpenLayers.Feature.Vector>}) List of features to serialize into a string. 
     270     * features - {Array(<OpenLayers.Feature.Vector>)} List of features to serialize into a string. 
    271271     */ 
    272272    write: function(features) { 

  • trunk/openlayers/lib/OpenLayers/Format/OSM.js

    r6748 r6833  
    284284     * 
    285285     * Parameters: 
    286      * features - Array({<OpenLayers.Feature.Vector>}) 
     286     * features - {Array(<OpenLayers.Feature.Vector>)} 
    287287     */ 
    288288    write: function(features) {  

  • trunk/openlayers/lib/OpenLayers/Geometry/MultiPoint.js

    r5614 r6833  
    3232     * 
    3333     * Parameters: 
    34      * components - Array({<OpenLayers.Geometry.Point>})  
     34     * components - {Array(<OpenLayers.Geometry.Point>)}  
    3535     * 
    3636     * Returns: 

  • trunk/openlayers/lib/OpenLayers/Geometry/Polygon.js

    r5614 r6833  
    3434     * 
    3535     * Parameters: 
    36      * components - Array({<OpenLayers.Geometry.LinearRing>})  
     36     * components - {Array(<OpenLayers.Geometry.LinearRing>)}  
    3737     */ 
    3838    initialize: function(components) { 

  • trunk/openlayers/lib/OpenLayers/Geometry/Surface.js

    r5614 r6833  
    77 */ 
    88 
    9 /** 
    10  * Class: OpenLayers.Geometry.Surface 
    11  */ 
    129OpenLayers.Geometry.Surface = OpenLayers.Class(OpenLayers.Geometry, { 
    1310 
    14     /** 
    15      * Constructor: OpenLayers.Geometry.Surface 
    16      * 
    17      */ 
    1811    initialize: function() { 
    1912        OpenLayers.Geometry.prototype.initialize.apply(this, arguments); 

  • trunk/openlayers/lib/OpenLayers/Handler/Click.js

    r6414 r6833  
    8080    /** 
    8181     * Property: timerId 
    82      * {Number} The id of the timeout waiting to clear the <delayedEvent>. 
     82     * {Number} The id of the timeout waiting to clear the <delayedCall>. 
    8383     */ 
    8484    timerId: null, 

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

    r6573 r6833  
    2727    /**  
    2828     * Property: features  
    29      * Array({<OpenLayers.Feature>})  
     29     * {Array(<OpenLayers.Feature>)}  
    3030     */ 
    3131    features: null, 

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

    r5614 r6833  
    1010/** 
    1111 * Class: OpenLayers.Layer.MapServer.Untiled 
    12  * Deprecated, to be removed in 3.0 - instead use OpenLayers.Layer.MapServer and  
    13  *     pass the option 'singleTile' as true. 
     12 * *Deprecated*.  To be removed in 3.0.  Instead use OpenLayers.Layer.MapServer 
     13 *     and pass the option 'singleTile' as true. 
    1414 *  
    1515 * Inherits from:  

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

    r5899 r6833  
    2424    /**  
    2525     * Property: markers  
    26      * Array({<OpenLayers.Marker>}) internal marker list  
     26     * {Array(<OpenLayers.Marker>)} internal marker list  
    2727     */ 
    2828    markers: null, 

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

    r6313 r6833  
    1414 *  
    1515 * Inherits from: 
    16  *  - <OpenLayers.Layers.EventPane> 
    17  *  - <OpenLayers.Layers.FixedZoomLevels> 
     16 *  - <OpenLayers.Layer.EventPane> 
     17 *  - <OpenLayers.Layer.FixedZoomLevels> 
    1818 */ 
    1919OpenLayers.Layer.MultiMap = OpenLayers.Class( 

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

    r6441 r6833  
    5151    /**  
    5252     * Property: features 
    53      * Array({<OpenLayers.Feature>})  
     53     * {Array(<OpenLayers.Feature>)}  
    5454     */ 
    5555    features: null, 

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

    r6413 r6833  
    8888    /**  
    8989     * APIProperty: features 
    90      * Array({<OpenLayers.Feature.Vector>})  
     90     * {Array(<OpenLayers.Feature.Vector>)}  
    9191     */ 
    9292    features: null, 
    …… 
    9494    /**  
    9595     * Property: selectedFeatures 
    96      * Array({<OpenLayers.Feature.Vector>})  
     96     * {Array(<OpenLayers.Feature.Vector>)}  
    9797     */ 
    9898    selectedFeatures: null, 
    …… 
    119119    /** 
    120120     * Property: renderers 
    121      * Array({String}) List of supported Renderer classes. Add to this list to 
     121     * {Array(String)} List of supported Renderer classes. Add to this list to 
    122122     * add support for additional renderers. This list is ordered: 
    123123     * the first renderer which returns true for the  'supported()' 

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

    r5614 r6833  
    1010/** 
    1111 * Class: OpenLayers.Layer.WMS.Untiled 
    12  * Deprecated, to be removed in 3.0 - instead use OpenLayers.Layer.WMS and  
     12 * *Deprecated*.  To be removed in 3.0.  Instead use OpenLayers.Layer.WMS and  
    1313 *     pass the option 'singleTile' as true. 
    1414 *  

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

    r6831 r6833  
    821821    * 
    822822    * Parameters: 
    823     * layers - Array({<OpenLayers.Layer>})  
     823    * layers - {Array(<OpenLayers.Layer>)}  
    824824    */     
    825825    addLayers: function (layers) { 

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

    r6818 r6833  
    123123     *  
    124124     * Returns: 
    125      * {boolean} true if the rule applies, false if it does not. 
     125     * {Boolean} true if the rule applies, false if it does not. 
    126126     * This rule is the default rule and always returns true. 
    127127     */ 

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

    r6748 r6833  
    4949    /**  
    5050     * Property: rules  
    51      * Array({<OpenLayers.Rule>})  
     51     * {Array(<OpenLayers.Rule>)} 
    5252     */ 
    5353    rules: null,