Changeset 1188

Show
Ignore:
Timestamp:
10/10/08 16:48:16 (3 months ago)
Author:
alex
Message:

improved some natural doc

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • sandbox/camptocamp/MapFishAeai/client/mfbase/mapfish/widgets/recenter/Base.js

    r1187 r1188  
    8181    /** 
    8282     * Method: initComponent 
    83      * 
    8483     * Overrides super-class initComponent method. Builds the recentering form. 
    8584     */ 
    …… 
    9291    /** 
    9392     * Method: fillComponent 
    94      * 
    9593     * Called by initComponent to create the component's sub-elements. To be 
    9694     * implemented by child classes. 
    …… 
    111109    /** 
    112110     * Method: addScaleCombo 
    113      * 
    114111     * Adds a scale combobox in the form 
    115112     */ 
    …… 
    145142    /** 
    146143     * Method: recenter 
    147      * 
    148144     * Recentering action. implemented by child classes. 
    149145     */ 
    …… 
    152148    /** 
    153149     * Method: recenterOnCoords 
    154      * 
    155150     * Recenters on given coordinates and zoom level 
     151     * 
     152     * Parameters: 
     153     * {Float} - easting coordinate 
     154     * {Float} - northing coordinate 
     155     * {Integer} - zoom level (optional) 
    156156     */ 
    157157    recenterOnCoords: function(x, y, zoom) { 
    …… 
    184184    /** 
    185185     * Method: prepareVectorLayer 
    186      * 
    187186     * Adds a layer for displaying the center symbol. If it is already set, removes 
    188187     * existing features. 
    …… 
    215214     * Method: getZoomByName 
    216215     * 
     216     * Parameters: 
     217     * {String} - scale label 
     218     * 
    217219     * Returns: 
    218220     * {Integer} - zoom level matching the given scale label 
    …… 
    230232    /** 
    231233     * Method: showError 
    232      * 
    233234     * Displays an error message 
     235     * 
     236     * Parameters: 
     237     * {String} - message 
     238     * {String} - box title 
    234239     */ 
    235240    showError: function(msg, title) { 
    …… 
    240245    /** 
    241246     * Method: formateScale 
    242      * 
    243247     * Builds scale label according to the given value 
     248     * 
     249     * Parameters: 
     250     * {Integer} - scale 
     251     * 
     252     * Returns: 
     253     * {String} - scale label 
    244254     */ 
    245255    formateScale: function(scale) { 

  • sandbox/camptocamp/MapFishAeai/client/mfbase/mapfish/widgets/recenter/Coords.js

    r1187 r1188  
    6565    /** 
    6666     * Method: fillComponent 
    67      * 
    6867     * Called by initComponent to create the component's sub-elements. 
    6968     */ 
    …… 
    9190    /** 
    9291     * Method: recenter 
    93      * 
    9492     * Recenters map using user-provided coordinates and scale. 
    9593     */ 
    …… 
    114112    /**  
    115113     * Method: checkCoords 
     114     * Checks that submitted coordinates are well-formatted and within the map bounds. 
    116115     * 
    117      * Checks that submitted coordinates are well-formatted and within the map bounds. 
     116     * Parameters: 
     117     * {Float} - easting coordinate 
     118     * {Float} - northing coordinate 
     119     * 
    118120     * Returns:  
    119121     * {Boolean}