OpenLayers OpenLayers

Changeset 3390

Show
Ignore:
Timestamp:
06/20/07 19:54:02 (1 year ago)
Author:
tschaub
Message:

updating half-finished WKT docs

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • sandbox/tschaub/naturaldocs/lib/OpenLayers/Format/WKT.js

    r3386 r3390  
    44 
    55/** 
    6  * Read and write WKT.  
    76 * @requires OpenLayers/Format.js 
     7 *  
     8 * Class: OpenLayers.Format.WKT 
     9 * Class for reading and writing Well-Known Text.  Create a new instance 
     10 * with the <OpenLayers.Format.WKT> constructor. 
     11 *  
    812 * Inherits from: 
    913 *  - <OpenLayers.Format> 
     
    1418     
    1519    /** 
    16      * 
     20     * Constructor: OpenLayers.Format.WKT 
     21     * Create a new parser for WKT 
     22     * 
     23     * Parameters: 
     24     * options - {Object} An optional object whose properties will be set on 
     25     *           this instance 
     26     * 
     27     * Return: 
     28     * {<OpenLayers.Format.WKT>} A new WKT parser. 
    1729     */ 
    1830    initialize: function(options) { 
     
    2840 
    2941    /** 
     42     * Method: read 
    3043     * Deserialize a WKT string and return an OpenLayers.Feature.Vector or an 
    3144     * array of OpenLayers.Feature.Vector.  Supports WKT for POINT, MULTIPOINT, 
    3245     * LINESTRING, MULTILINESTRING, POLYGON, MULTIPOLYGON, and 
    3346     * GEOMETRYCOLLECTION. 
    34      * @param {String} wkt A WKT string 
    35      * @returns {OpenLayers.Feature.Vector|Array} A feature or array of 
    36      *                                            features for 
    37      *                                            GEOMETRYCOLLECTION WKT. 
     47     * 
     48     * Parameters: 
     49     * wkt - {String} A WKT string 
     50     * 
     51     * Return: 
     52     * {<OpenLayers.Feature.Vector>|Array} A feature or array of features for 
     53     * GEOMETRYCOLLECTION WKT. 
    3854     */ 
    3955    read: function(wkt) { 
     
    5167 
    5268    /** 
     69     * Method: write 
    5370     * Serialize a feature or array of features into a WKT string. 
    54      * @param {OpenLayers.Feature.Vector|Array} features A feature or array of 
    55      *                                                   features 
    56      * @returns {String} The WKT string representation of the input geometries 
     71     * 
     72     * Parameters: 
     73     * features - {<OpenLayers.Feature.Vector>|Array} A feature or array of 
     74     *            features 
     75     * 
     76     * Return: 
     77     * {String} The WKT string representation of the input geometries 
    5778     */ 
    5879    write: function(features) {