OpenLayers OpenLayers

Changeset 5289

Show
Ignore:
Timestamp:
11/27/07 13:20:18 (9 months ago)
Author:
tschaub
Message:

adding doc comments to text layer - tidying up doc menus

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/openlayers/apidoc_config/Menu.txt

    r4223 r5289  
    5151   Group: Control  { 
    5252 
    53       File: Control  (no auto-title, OpenLayers/Control.js) 
     53      File: Control  (OpenLayers/Control.js) 
    5454      File: ArgParser  (no auto-title, OpenLayers/Control/ArgParser.js) 
    55       File: ZoomToMaxExtent  (no auto-title, OpenLayers/Control/ZoomToMaxExtent.js) 
    56       File: OverviewMap  (no auto-title, OpenLayers/Control/OverviewMap.js) 
     55      File: Attribution  (no auto-title, OpenLayers/Control/Attribution.js) 
    5756      File: DragFeature  (no auto-title, OpenLayers/Control/DragFeature.js) 
    5857      File: DragPan  (no auto-title, OpenLayers/Control/DragPan.js) 
    …… 
    6160      File: KeyboardDefaults  (no auto-title, OpenLayers/Control/KeyboardDefaults.js) 
    6261      File: LayerSwitcher  (no auto-title, OpenLayers/Control/LayerSwitcher.js) 
     62      File: ModifyFeature  (no auto-title, OpenLayers/Control/ModifyFeature.js) 
    6363      File: MouseDefaults  (no auto-title, OpenLayers/Control/MouseDefaults.js) 
    6464      File: MousePosition  (no auto-title, OpenLayers/Control/MousePosition.js) 
    …… 
    6666      File: Navigation  (no auto-title, OpenLayers/Control/Navigation.js) 
    6767      File: NavToolbar  (no auto-title, OpenLayers/Control/NavToolbar.js) 
     68      File: OverviewMap  (no auto-title, OpenLayers/Control/OverviewMap.js) 
    6869      File: Panel  (no auto-title, OpenLayers/Control/Panel.js) 
     70      File: PanZoom  (no auto-title, OpenLayers/Control/PanZoom.js) 
    6971      File: PanZoomBar  (no auto-title, OpenLayers/Control/PanZoomBar.js) 
    7072      File: Permalink  (no auto-title, OpenLayers/Control/Permalink.js) 
    …… 
    7274      File: SelectFeature  (no auto-title, OpenLayers/Control/SelectFeature.js) 
    7375      File: ZoomBox  (no auto-title, OpenLayers/Control/ZoomBox.js) 
    74       File: PanZoom  (OpenLayers/Control/PanZoom.js) 
     76      File: ZoomToMaxExtent  (no auto-title, OpenLayers/Control/ZoomToMaxExtent.js) 
    7577      }  # Group: Control 
    7678 
    …… 
    7981   Group: Feature  { 
    8082 
    81       File: Feature  (no auto-title, OpenLayers/Feature.js) 
     83      File: Feature  (OpenLayers/Feature.js) 
     84      File: Vector  (no auto-title, OpenLayers/Feature/Vector.js) 
    8285      File: WFS  (no auto-title, OpenLayers/Feature/WFS.js) 
    83       File: Vector  (no auto-title, OpenLayers/Feature/Vector.js) 
    8486      }  # Group: Feature 
    8587 

  • trunk/openlayers/doc_config/Menu.txt

    r4223 r5289  
    5353      File: Control  (OpenLayers/Control.js) 
    5454      File: ArgParser  (no auto-title, OpenLayers/Control/ArgParser.js) 
    55       File: ZoomToMaxExtent  (no auto-title, OpenLayers/Control/ZoomToMaxExtent.js) 
    56       File: OverviewMap  (no auto-title, OpenLayers/Control/OverviewMap.js) 
     55      File: Attribution  (no auto-title, OpenLayers/Control/Attribution.js) 
    5756      File: DragFeature  (no auto-title, OpenLayers/Control/DragFeature.js) 
    5857      File: DragPan  (no auto-title, OpenLayers/Control/DragPan.js) 
    …… 
    6160      File: KeyboardDefaults  (no auto-title, OpenLayers/Control/KeyboardDefaults.js) 
    6261      File: LayerSwitcher  (no auto-title, OpenLayers/Control/LayerSwitcher.js) 
     62      File: ModifyFeature  (no auto-title, OpenLayers/Control/ModifyFeature.js) 
    6363      File: MouseDefaults  (no auto-title, OpenLayers/Control/MouseDefaults.js) 
    6464      File: MousePosition  (no auto-title, OpenLayers/Control/MousePosition.js) 
    …… 
    6666      File: Navigation  (no auto-title, OpenLayers/Control/Navigation.js) 
    6767      File: NavToolbar  (no auto-title, OpenLayers/Control/NavToolbar.js) 
     68      File: OverviewMap  (no auto-title, OpenLayers/Control/OverviewMap.js) 
    6869      File: Panel  (no auto-title, OpenLayers/Control/Panel.js) 
     70      File: PanZoom  (no auto-title, OpenLayers/Control/PanZoom.js) 
    6971      File: PanZoomBar  (no auto-title, OpenLayers/Control/PanZoomBar.js) 
    7072      File: Permalink  (no auto-title, OpenLayers/Control/Permalink.js) 
    …… 
    7274      File: SelectFeature  (no auto-title, OpenLayers/Control/SelectFeature.js) 
    7375      File: ZoomBox  (no auto-title, OpenLayers/Control/ZoomBox.js) 
    74       File: PanZoom  (no auto-title, OpenLayers/Control/PanZoom.js) 
     76      File: ZoomToMaxExtent  (no auto-title, OpenLayers/Control/ZoomToMaxExtent.js) 
    7577      }  # Group: Control 
    7678 
    …… 
    8082 
    8183      File: Feature  (OpenLayers/Feature.js) 
     84      File: Vector  (no auto-title, OpenLayers/Feature/Vector.js) 
    8285      File: WFS  (no auto-title, OpenLayers/Feature/WFS.js) 
    83       File: Vector  (no auto-title, OpenLayers/Feature/Vector.js) 
    8486      }  # Group: Feature 
    8587 

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

    r5028 r5289  
    99 * 
    1010 * Class: OpenLayers.Layer.Text 
    11  * Tab seperated values file parsing code which creates a markers layer.   
    12  * 
    13  * Inherits from; 
     11 * This layer creates markers given data in a text file.  The <location> 
     12 *     property of the layer (specified as a property of the options argument 
     13 *     in the <OpenLayers.Layer.Text> constructor) points to a tab delimited 
     14 *     file with data used to create markers. 
     15 * 
     16 * The first row of the data file should be a header line with the column names 
     17 *     of the data. Each column should be delimited by a tab space. The 
     18 *     possible columns are: 
     19 *      - *point* lat,lon of the point where a marker is to be placed 
     20 *      - *lat*  Latitude of the point where a marker is to be placed 
     21 *      - *lon*  Longitude of the point where a marker is to be placed 
     22 *      - *iconURL* URL of marker icon to use. 
     23 *      - *iconSize* Size of Icon to use. 
     24 *      - *iconOffset* Where the top-left corner of the icon is to be placed 
     25 *            relative to the latitude and longitude of the point. 
     26 *      - *title* The text of the 'title' is placed inside an 'h2' marker 
     27 *            inside a popup, which opens when the marker is clicked. 
     28 *      - *description* The text of the 'description' is placed below the h2 
     29 *            in the popup. this can be plain text or HTML. 
     30 * 
     31 * Example text file: 
     32 * (code) 
     33 * lat  lon title   description iconSize    iconOffset  icon 
     34 * 10   20  title   description 21,25       -10,-25     http://www.openlayers.org/dev/img/marker.png 
     35 * (end) 
     36 * 
     37 * Inherits from: 
    1438 *  - <OpenLayers.Layer.Markers> 
    1539 */ 
    …… 
    1842    /** 
    1943     * APIProperty: location  
    20      * {String} store url of text file - this should be specified in the  
    21      *   "options" hashtable. Can not be changed once passed in.  
     44     * {String} URL of text file.  Must be specified in the "options" argument 
     45     *   of the constructor. Can not be changed once passed in.  
    2246     */ 
    2347    location:null, 
    …… 
    3660 
    3761    /** 
    38     * Constructor: OpenLayers.Layer.Text 
    39     * Create a text layer. 
    40     *  
    41     * Parameters: 
    42     * name - {String}  
    43     * options - {Object} Hashtable of extra options to tag onto 
    44     *                    the layer. Must include "location" property. 
    45     */ 
     62    * Constructor: OpenLayers.Layer.Text 
     63    * Create a text layer. 
     64    *  
     65    * Parameters: 
     66    * name - {String}  
     67    * options - {Object} Object with properties to be set on the layer. 
     68    *     Must include <location> property. 
     69    */ 
    4670    initialize: function(name, options) { 
    4771        OpenLayers.Layer.Markers.prototype.initialize.apply(this, arguments); 
    …… 
    5983    }, 
    6084 
    61    /** 
     85    /** 
    6286     * APIMethod: destroy  
    6387     */ 
    …… 
    199223    CLASS_NAME: "OpenLayers.Layer.Text" 
    200224}); 
    201       
    202