Change all 'Parameter:' to 'Parameters:' in documentation. Non functional change
This commit is contained in:
@@ -330,7 +330,7 @@ OpenLayers.Control.Panel = OpenLayers.Class(OpenLayers.Control, {
|
|||||||
* APIMethod: getControlsBy
|
* APIMethod: getControlsBy
|
||||||
* Get a list of controls with properties matching the given criteria.
|
* Get a list of controls with properties matching the given criteria.
|
||||||
*
|
*
|
||||||
* Parameter:
|
* Parameters:
|
||||||
* property - {String} A control property to be matched.
|
* property - {String} A control property to be matched.
|
||||||
* match - {String | Object} A string to match. Can also be a regular
|
* match - {String | Object} A string to match. Can also be a regular
|
||||||
* expression literal or object. In addition, it can be any object
|
* expression literal or object. In addition, it can be any object
|
||||||
@@ -355,7 +355,7 @@ OpenLayers.Control.Panel = OpenLayers.Class(OpenLayers.Control, {
|
|||||||
* APIMethod: getControlsByName
|
* APIMethod: getControlsByName
|
||||||
* Get a list of contorls with names matching the given name.
|
* Get a list of contorls with names matching the given name.
|
||||||
*
|
*
|
||||||
* Parameter:
|
* Parameters:
|
||||||
* match - {String | Object} A control name. The name can also be a regular
|
* match - {String | Object} A control name. The name can also be a regular
|
||||||
* expression literal or object. In addition, it can be any object
|
* expression literal or object. In addition, it can be any object
|
||||||
* with a method named test. For reqular expressions or other, if
|
* with a method named test. For reqular expressions or other, if
|
||||||
@@ -375,7 +375,7 @@ OpenLayers.Control.Panel = OpenLayers.Class(OpenLayers.Control, {
|
|||||||
* APIMethod: getControlsByClass
|
* APIMethod: getControlsByClass
|
||||||
* Get a list of controls of a given type (CLASS_NAME).
|
* Get a list of controls of a given type (CLASS_NAME).
|
||||||
*
|
*
|
||||||
* Parameter:
|
* Parameters:
|
||||||
* match - {String | Object} A control class name. The type can also be a
|
* match - {String | Object} A control class name. The type can also be a
|
||||||
* regular expression literal or object. In addition, it can be any
|
* regular expression literal or object. In addition, it can be any
|
||||||
* object with a method named test. For reqular expressions or other,
|
* object with a method named test. For reqular expressions or other,
|
||||||
|
|||||||
@@ -53,7 +53,7 @@ OpenLayers.Geometry.LinearRing = OpenLayers.Class(
|
|||||||
* be overridden by calling the method with a non-null index as the
|
* be overridden by calling the method with a non-null index as the
|
||||||
* second argument.
|
* second argument.
|
||||||
*
|
*
|
||||||
* Parameter:
|
* Parameters:
|
||||||
* point - {<OpenLayers.Geometry.Point>}
|
* point - {<OpenLayers.Geometry.Point>}
|
||||||
* index - {Integer} Index into the array to insert the component
|
* index - {Integer} Index into the array to insert the component
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -1124,7 +1124,7 @@ OpenLayers.Layer = OpenLayers.Class({
|
|||||||
/**
|
/**
|
||||||
* APIMethod: getResolutionForZoom
|
* APIMethod: getResolutionForZoom
|
||||||
*
|
*
|
||||||
* Parameter:
|
* Parameters:
|
||||||
* zoom - {Float}
|
* zoom - {Float}
|
||||||
*
|
*
|
||||||
* Returns:
|
* Returns:
|
||||||
@@ -1265,7 +1265,7 @@ OpenLayers.Layer = OpenLayers.Class({
|
|||||||
* APIMethod: setOpacity
|
* APIMethod: setOpacity
|
||||||
* Sets the opacity for the entire layer (all images)
|
* Sets the opacity for the entire layer (all images)
|
||||||
*
|
*
|
||||||
* Parameter:
|
* Parameters:
|
||||||
* opacity - {Float}
|
* opacity - {Float}
|
||||||
*/
|
*/
|
||||||
setOpacity: function(opacity) {
|
setOpacity: function(opacity) {
|
||||||
|
|||||||
@@ -205,7 +205,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(
|
|||||||
* APIMethod: setOpacity
|
* APIMethod: setOpacity
|
||||||
* Sets the opacity for the entire layer (all images)
|
* Sets the opacity for the entire layer (all images)
|
||||||
*
|
*
|
||||||
* Parameter:
|
* Parameters:
|
||||||
* opacity - {Float}
|
* opacity - {Float}
|
||||||
*/
|
*/
|
||||||
setOpacity: function(opacity) {
|
setOpacity: function(opacity) {
|
||||||
|
|||||||
@@ -114,7 +114,7 @@ OpenLayers.Layer.MapServer = OpenLayers.Class(OpenLayers.Layer.Grid, {
|
|||||||
* Method: getFullRequestString
|
* Method: getFullRequestString
|
||||||
* combine the layer's url with its params and these newParams.
|
* combine the layer's url with its params and these newParams.
|
||||||
*
|
*
|
||||||
* Parameter:
|
* Parameters:
|
||||||
* newParams - {Object} New parameters that should be added to the
|
* newParams - {Object} New parameters that should be added to the
|
||||||
* request string.
|
* request string.
|
||||||
* altUrl - {String} (optional) Replace the URL in the full request
|
* altUrl - {String} (optional) Replace the URL in the full request
|
||||||
|
|||||||
@@ -64,7 +64,7 @@ OpenLayers.Layer.Markers = OpenLayers.Class(OpenLayers.Layer, {
|
|||||||
* APIMethod: setOpacity
|
* APIMethod: setOpacity
|
||||||
* Sets the opacity for all the markers.
|
* Sets the opacity for all the markers.
|
||||||
*
|
*
|
||||||
* Parameter:
|
* Parameters:
|
||||||
* opacity - {Float}
|
* opacity - {Float}
|
||||||
*/
|
*/
|
||||||
setOpacity: function(opacity) {
|
setOpacity: function(opacity) {
|
||||||
|
|||||||
@@ -776,7 +776,7 @@ OpenLayers.Map = OpenLayers.Class({
|
|||||||
* APIMethod: getLayersBy
|
* APIMethod: getLayersBy
|
||||||
* Get a list of layers with properties matching the given criteria.
|
* Get a list of layers with properties matching the given criteria.
|
||||||
*
|
*
|
||||||
* Parameter:
|
* Parameters:
|
||||||
* property - {String} A layer property to be matched.
|
* property - {String} A layer property to be matched.
|
||||||
* match - {String | Object} A string to match. Can also be a regular
|
* match - {String | Object} A string to match. Can also be a regular
|
||||||
* expression literal or object. In addition, it can be any object
|
* expression literal or object. In addition, it can be any object
|
||||||
@@ -797,7 +797,7 @@ OpenLayers.Map = OpenLayers.Class({
|
|||||||
* APIMethod: getLayersByName
|
* APIMethod: getLayersByName
|
||||||
* Get a list of layers with names matching the given name.
|
* Get a list of layers with names matching the given name.
|
||||||
*
|
*
|
||||||
* Parameter:
|
* Parameters:
|
||||||
* match - {String | Object} A layer name. The name can also be a regular
|
* match - {String | Object} A layer name. The name can also be a regular
|
||||||
* expression literal or object. In addition, it can be any object
|
* expression literal or object. In addition, it can be any object
|
||||||
* with a method named test. For reqular expressions or other, if
|
* with a method named test. For reqular expressions or other, if
|
||||||
@@ -817,7 +817,7 @@ OpenLayers.Map = OpenLayers.Class({
|
|||||||
* APIMethod: getLayersByClass
|
* APIMethod: getLayersByClass
|
||||||
* Get a list of layers of a given class (CLASS_NAME).
|
* Get a list of layers of a given class (CLASS_NAME).
|
||||||
*
|
*
|
||||||
* Parameter:
|
* Parameters:
|
||||||
* match - {String | Object} A layer class name. The match can also be a
|
* match - {String | Object} A layer class name. The match can also be a
|
||||||
* regular expression literal or object. In addition, it can be any
|
* regular expression literal or object. In addition, it can be any
|
||||||
* object with a method named test. For reqular expressions or other,
|
* object with a method named test. For reqular expressions or other,
|
||||||
@@ -837,7 +837,7 @@ OpenLayers.Map = OpenLayers.Class({
|
|||||||
* APIMethod: getControlsBy
|
* APIMethod: getControlsBy
|
||||||
* Get a list of controls with properties matching the given criteria.
|
* Get a list of controls with properties matching the given criteria.
|
||||||
*
|
*
|
||||||
* Parameter:
|
* Parameters:
|
||||||
* property - {String} A control property to be matched.
|
* property - {String} A control property to be matched.
|
||||||
* match - {String | Object} A string to match. Can also be a regular
|
* match - {String | Object} A string to match. Can also be a regular
|
||||||
* expression literal or object. In addition, it can be any object
|
* expression literal or object. In addition, it can be any object
|
||||||
@@ -858,7 +858,7 @@ OpenLayers.Map = OpenLayers.Class({
|
|||||||
* APIMethod: getControlsByClass
|
* APIMethod: getControlsByClass
|
||||||
* Get a list of controls of a given class (CLASS_NAME).
|
* Get a list of controls of a given class (CLASS_NAME).
|
||||||
*
|
*
|
||||||
* Parameter:
|
* Parameters:
|
||||||
* match - {String | Object} A control class name. The match can also be a
|
* match - {String | Object} A control class name. The match can also be a
|
||||||
* regular expression literal or object. In addition, it can be any
|
* regular expression literal or object. In addition, it can be any
|
||||||
* object with a method named test. For reqular expressions or other,
|
* object with a method named test. For reqular expressions or other,
|
||||||
@@ -887,7 +887,7 @@ OpenLayers.Map = OpenLayers.Class({
|
|||||||
* APIMethod: getLayer
|
* APIMethod: getLayer
|
||||||
* Get a layer based on its id
|
* Get a layer based on its id
|
||||||
*
|
*
|
||||||
* Parameter:
|
* Parameters:
|
||||||
* id - {String} A layer id
|
* id - {String} A layer id
|
||||||
*
|
*
|
||||||
* Returns:
|
* Returns:
|
||||||
@@ -2159,7 +2159,7 @@ OpenLayers.Map = OpenLayers.Class({
|
|||||||
/**
|
/**
|
||||||
* APIMethod: getResolutionForZoom
|
* APIMethod: getResolutionForZoom
|
||||||
*
|
*
|
||||||
* Parameter:
|
* Parameters:
|
||||||
* zoom - {Float}
|
* zoom - {Float}
|
||||||
*
|
*
|
||||||
* Returns:
|
* Returns:
|
||||||
@@ -2177,7 +2177,7 @@ OpenLayers.Map = OpenLayers.Class({
|
|||||||
/**
|
/**
|
||||||
* APIMethod: getZoomForResolution
|
* APIMethod: getZoomForResolution
|
||||||
*
|
*
|
||||||
* Parameter:
|
* Parameters:
|
||||||
* resolution - {Float}
|
* resolution - {Float}
|
||||||
* closest - {Boolean} Find the zoom level that corresponds to the absolute
|
* closest - {Boolean} Find the zoom level that corresponds to the absolute
|
||||||
* closest resolution, which may result in a zoom whose corresponding
|
* closest resolution, which may result in a zoom whose corresponding
|
||||||
|
|||||||
@@ -452,7 +452,7 @@ OpenLayers.Renderer.SVG = OpenLayers.Class(OpenLayers.Renderer.Elements, {
|
|||||||
/**
|
/**
|
||||||
* Method: createRoot
|
* Method: createRoot
|
||||||
*
|
*
|
||||||
* Parameter:
|
* Parameters:
|
||||||
* suffix - {String} suffix to append to the id
|
* suffix - {String} suffix to append to the id
|
||||||
*
|
*
|
||||||
* Returns:
|
* Returns:
|
||||||
|
|||||||
@@ -387,7 +387,7 @@ OpenLayers.Renderer.SVG2 = OpenLayers.Class(OpenLayers.Renderer.NG, {
|
|||||||
/**
|
/**
|
||||||
* Method: createRoot
|
* Method: createRoot
|
||||||
*
|
*
|
||||||
* Parameter:
|
* Parameters:
|
||||||
* suffix - {String} suffix to append to the id
|
* suffix - {String} suffix to append to the id
|
||||||
*
|
*
|
||||||
* Returns:
|
* Returns:
|
||||||
|
|||||||
@@ -135,7 +135,7 @@ OpenLayers.Util.setOpacity = function(element, opacity) {
|
|||||||
* Safely stop the propagation of an event *without* preventing
|
* Safely stop the propagation of an event *without* preventing
|
||||||
* the default browser action from occurring.
|
* the default browser action from occurring.
|
||||||
*
|
*
|
||||||
* Parameter:
|
* Parameters:
|
||||||
* evt - {Event}
|
* evt - {Event}
|
||||||
*/
|
*/
|
||||||
OpenLayers.Util.safeStopPropagation = function(evt) {
|
OpenLayers.Util.safeStopPropagation = function(evt) {
|
||||||
@@ -2915,7 +2915,7 @@ OpenLayers.Layer.WFS = OpenLayers.Class(
|
|||||||
* Call the setOpacity method of the appropriate parent class to set the
|
* Call the setOpacity method of the appropriate parent class to set the
|
||||||
* opacity.
|
* opacity.
|
||||||
*
|
*
|
||||||
* Parameter:
|
* Parameters:
|
||||||
* opacity - {Float}
|
* opacity - {Float}
|
||||||
*/
|
*/
|
||||||
setOpacity: function (opacity) {
|
setOpacity: function (opacity) {
|
||||||
|
|||||||
Reference in New Issue
Block a user