OpenLayers OpenLayers

Changeset 3391

Show
Ignore:
Timestamp:
06/20/07 20:13:19 (2 years ago)
Author:
crschmidt
Message:

More docs, baby

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • sandbox/tschaub/naturaldocs/lib/OpenLayers/Feature.js

    r3373 r3391  
    55 
    66/** 
    7  * @class 
     7 * Class: OpenLayers.Feature 
     8 * Features are combinations of geography and attributes. The OpenLayers.Feature 
     9 * class specifically combines a marker and a lonlat. 
    810 *  
    911 * @requires OpenLayers/Util.js 
    …… 
    1315OpenLayers.Feature.prototype= { 
    1416 
    15     /** @type OpenLayers.Events */ 
    16     events:null, 
    17  
    18     /** @type OpenLayers.Layer */ 
    19     layer: null, 
    20  
    21     /** @type String */ 
    22     id: null, 
    23      
    24     /** @type OpenLayers.LonLat */ 
    25     lonlat:null, 
    26  
    27     /** @type Object */ 
    28     data:null, 
    29  
    30     /** @type OpenLayers.Marker */ 
    31     marker: null, 
    32  
    33     /** @type OpenLayers.Popup */ 
    34     popup: null, 
     17    /**  
     18     * Property: events  
     19     * {<OpenLayers.Events>}  
     20     */ 
     21    events: null, 
    3522 
    3623    /**  
    37      * @constructor 
     24     * Property: layer  
     25     * {<OpenLayers.Layer>}  
     26     */ 
     27    layer: null, 
     28 
     29    /**  
     30     * Property: id  
     31     * {String}  
     32     */ 
     33    id: null, 
     34     
     35    /**  
     36     * Property: lonlat  
     37     * {<OpenLayers.LonLat>}  
     38     */ 
     39    lonlat: null, 
     40 
     41    /**  
     42     * Property: data  
     43     * {Object}  
     44     */ 
     45    data: null, 
     46 
     47    /**  
     48     * Property: marker  
     49     * {<OpenLayers.Marker>}  
     50     */ 
     51    marker: null, 
     52 
     53    /**  
     54     * Property: popup  
     55     * {<OpenLayers.Popup>}  
     56     */ 
     57    popup: null, 
     58 
     59    /**  
     60     * Constructor: OpenLayers.Feature 
     61     * Constructor for features. 
     62     * 
     63     * Parameters: 
     64     * layer - {<OpenLayers.Layer>}  
     65     * lonlat - {<OpenLayers.LonLat>}  
     66     * data - {Object}  
    3867     *  
    39      * @param {OpenLayers.Layer} layer 
    40      * @param {OpenLayers.LonLat} lonlat 
    41      * @param {Object} data 
     68     * Return: 
     69     * {<OpenLayers.Feature>} 
    4270     */ 
    4371    initialize: function(layer, lonlat, data) { 

  • sandbox/tschaub/naturaldocs/lib/OpenLayers/Geometry/MultiPoint.js

    r2931 r3391  
    44 
    55/** 
    6  * @class 
    7  *  
     6 * @requires OpenLayers/Geometry/Collection.js 
     7 * 
     8 * Class: OpenLayers.Geometry.MultiPoint 
    89 * MultiPoint is a collection of Points. 
    9  *  
    10  * @requires OpenLayers/Geometry/Collection.js 
     10 * 
     11 * Inherits from: 
     12 *  - <OpenLayers.Geometry.Collection> 
     13 *  - <OpenLayers.Geometry> 
    1114 */ 
    1215OpenLayers.Geometry.MultiPoint = OpenLayers.Class.create(); 
    …… 
    2326 
    2427    /** 
    25      * @constructor 
     28     * Constructor: OpenLayers.Geometry.MultiPoint 
     29     * Create a new MultiPoint Geometry 
    2630     * 
    27      * @param {Array(OpenLayers.Geometry.Point)} components 
     31     * Parameters: 
     32     * components - Array({<OpenLayers.Geometry.Point>})  
     33     * 
     34     * Return: 
     35     * {<OpenLayers.Geometry.MultiPoint>} 
    2836     */ 
    2937    initialize: function(components) { 

  • sandbox/tschaub/naturaldocs/lib/OpenLayers/Geometry/Point.js

    r2945 r3391  
    44 
    55/** 
    6  * @class 
     6 * @requires OpenLayers/Geometry.js 
     7 * 
     8 * Class: OpenLayers.Geometry.Point 
     9 * Point geometry class.  
    710 *  
    8  * @requires OpenLayers/Geometry.js 
     11 * Inherits from: 
     12 *  - <OpenLayers.Geometry>  
    913 */ 
    1014OpenLayers.Geometry.Point = OpenLayers.Class.create(); 
    …… 
    1216    OpenLayers.Class.inherit(OpenLayers.Geometry, { 
    1317 
    14     /** @type float */ 
    15     x: null, 
     18    /**  
     19     * Property: x  
     20     * {float}  
     21     */ 
     22    x: null, 
    1623 
    17     /** @type float */ 
    18     y: null, 
     24    /**  
     25     * Property: y  
     26     * {float}  
     27     */ 
     28    y: null, 
    1929 
    2030    /** 
    21      * @constructor 
     31     * Constructor: OpenLayers.Geometry.Point 
     32     * Construct a point geometry. 
    2233     * 
    23      * @param {float} x 
    24      * @param {float} y 
     34     * Parameters: 
     35     * x - {float}  
     36     * y - {float} 
     37     *  
     38     * Return: 
     39     * {<OpenLayers.Geometry.Point>} 
    2540     */ 
    2641    initialize: function(x, y) { 
    …… 
    3247 
    3348    /** 
    34      * @returns An exact clone of this OpenLayers.Geometry.Point 
    35      * @type OpenLayers.Geometry.Point 
     49     * Method: clone 
     50     *  
     51     * Return: 
     52     * {<OpenLayers.Geometry.Point>} An exact clone of this OpenLayers.Geometry.Point 
    3653     */ 
    3754    clone: function(obj) { 
    …… 
    4663    }, 
    4764 
    48     /** Create a new Bounds based on the lon/lat 
    49      *  
     65    /**  
     66     * Method: calculateBounds 
     67     * Create a new Bounds based on the lon/lat 
    5068     */ 
    5169    calculateBounds: function () { 
    …… 
    5573 
    5674    /** 
    57      * @param {OpenLayers.Geometry.Point} point 
     75     * Method: distanceTo 
     76     *  
     77     * Parameters: 
     78     * point - {OpenLayers.Geometry.Point}  
    5879     */ 
    5980    distanceTo: function(point) { 
    …… 
    7091     
    7192    /**  
    72     * @param {OpenLayers.Geometry} xy 
    73     * @returns Boolean value indicating whether the passed-in  
    74     *          OpenLayers.Geometryobject has the same  components as this 
     93    * Method: equals 
     94    *  
     95    * Parameters: 
     96    * xy - {OpenLayers.Geometry}  
     97    * 
     98    * Return: 
     99    * {Boolean} Boolean value indicating whether the passed-in  
     100    *          {<OpenLayers.Geometry>} object has the same  components as this 
    75101    *          note that if ll passed in is null, returns false 
    76102    * 
    77     * @type bool 
    78103    */ 
    79104    equals:function(geom) { 
    …… 
    87112     
    88113    /** 
    89      * @return Shortened String representation of Point object.  
     114     * Method: toShortString 
     115     * 
     116     * Return: 
     117     * {String} Shortened String representation of Point object.  
    90118     *         (ex. <i>"5, 42"</i>) 
    91      * @type String 
    92119     */ 
    93120    toShortString: function() { 
    …… 
    96123     
    97124    /** 
     125     * Method: move 
    98126     * Moves a point in place 
    99      * @param {Float} x 
    100      * @param {Float} y 
     127     * 
     128     * Parameters: 
     129     * x - {Float}  
     130     * y - {Float}  
    101131     */ 
    102132    move: function(x, y) { 

  • sandbox/tschaub/naturaldocs/lib/OpenLayers/Geometry/Polygon.js

    r2931 r3391  
    44 
    55/** 
    6  * @class 
     6 * @requires OpenLayers/Geometry/Collection.js 
    77 *  
     8 * Class: OpenLayers.Geometry.Polygon  
    89 * Polygon is a collection of Geometry.LinearRings.  
    910 *  
    10  * The first ring (this.component[0])is the outer bounds of the polygon and  
    11  * all subsequent rings (this.component[1-n]) are internal holes. 
    12  * 
    13  * @requires OpenLayers/Geometry/Collection.js 
     11 * Inherits from: 
     12 *  - <OpenLayers.Geometry.Collection>  
     13 *  - <OpenLayers.Geometry>  
    1414 */ 
    1515OpenLayers.Geometry.Polygon = OpenLayers.Class.create(); 
    …… 
    2626 
    2727    /** 
    28      * @constructor 
     28     * Constructor: OpenLayers.Geometry.Polygon 
     29     * Constructor for a Polygon geometry.  
     30     * The first ring (this.component[0])is the outer bounds of the polygon and  
     31     * all subsequent rings (this.component[1-n]) are internal holes. 
    2932     * 
    30      * @param {Array(OpenLayers.Geometry.LinearRing)} 
     33     * 
     34     * Parameters: 
     35     * components - Array({<OpenLayers.Geometry.LinearRing>})  
     36     *  
     37     * Return: 
     38     * {<OpenLayers.Geometry.Polygon>}  
    3139     */ 
    3240    initialize: function(components) { 
    …… 
    3543    }, 
    3644     
    37     /** Calculated by subtracting the areas of the internal holes from the  
     45    /**  
     46     * Method: getArea 
     47     * Calculated by subtracting the areas of the internal holes from the  
    3848     *   area of the outer hole. 
    3949     *  
    40      * @returns The area of the geometry 
    41      * @type float  
     50     * Return: 
     51     * {float} The area of the geometry 
    4252     */ 
    4353    getArea: function() {