[OpenLayers-Commits] r11576 - in trunk/openlayers/lib/OpenLayers: .
BaseTypes Control Format Geometry Layer Protocol/WFS Renderer
commits-20090109 at openlayers.org
commits-20090109 at openlayers.org
Mon Feb 28 03:19:19 EST 2011
Author: fredj
Date: 2011-02-28 00:19:18 -0800 (Mon, 28 Feb 2011)
New Revision: 11576
Modified:
trunk/openlayers/lib/OpenLayers/BaseTypes.js
trunk/openlayers/lib/OpenLayers/BaseTypes/Bounds.js
trunk/openlayers/lib/OpenLayers/Console.js
trunk/openlayers/lib/OpenLayers/Control/SelectFeature.js
trunk/openlayers/lib/OpenLayers/Control/Snapping.js
trunk/openlayers/lib/OpenLayers/Control/Split.js
trunk/openlayers/lib/OpenLayers/Events.js
trunk/openlayers/lib/OpenLayers/Format/GML.js
trunk/openlayers/lib/OpenLayers/Format/GPX.js
trunk/openlayers/lib/OpenLayers/Format/GeoRSS.js
trunk/openlayers/lib/OpenLayers/Format/KML.js
trunk/openlayers/lib/OpenLayers/Geometry/Rectangle.js
trunk/openlayers/lib/OpenLayers/Layer.js
trunk/openlayers/lib/OpenLayers/Layer/Grid.js
trunk/openlayers/lib/OpenLayers/Map.js
trunk/openlayers/lib/OpenLayers/Projection.js
trunk/openlayers/lib/OpenLayers/Protocol/WFS/v1.js
trunk/openlayers/lib/OpenLayers/Renderer/SVG.js
trunk/openlayers/lib/OpenLayers/Util.js
Log:
fix Natural Docs comments, no functional change. p=jorix, r=me (closes #2989)
Modified: trunk/openlayers/lib/OpenLayers/BaseTypes/Bounds.js
===================================================================
--- trunk/openlayers/lib/OpenLayers/BaseTypes/Bounds.js 2011-02-28 08:12:05 UTC (rev 11575)
+++ trunk/openlayers/lib/OpenLayers/BaseTypes/Bounds.js 2011-02-28 08:19:18 UTC (rev 11576)
@@ -260,7 +260,7 @@
* Default is center.
*
* Returns:
- * {<OpenLayers.Bound>} A new bounds that is scaled by ratio
+ * {<OpenLayers.Bounds>} A new bounds that is scaled by ratio
* from origin.
*/
@@ -560,6 +560,8 @@
* Parameters:
* maxExtent - {<OpenLayers.Bounds>}
* options - {Object} Some possible options are:
+ *
+ * Allowed Options:
* leftTolerance - {float} Allow for a margin of error
* with the 'left' value of this
* bound.
Modified: trunk/openlayers/lib/OpenLayers/BaseTypes.js
===================================================================
--- trunk/openlayers/lib/OpenLayers/BaseTypes.js 2011-02-28 08:12:05 UTC (rev 11575)
+++ trunk/openlayers/lib/OpenLayers/BaseTypes.js 2011-02-28 08:19:18 UTC (rev 11576)
@@ -25,7 +25,7 @@
*
* Parameters:
* str - {String} The string to test.
- * sub - {Sring} The substring to look for.
+ * sub - {String} The substring to look for.
*
* Returns:
* {Boolean} The first string starts with the second.
@@ -204,7 +204,7 @@
* *Deprecated*. Whether or not a string starts with another string.
*
* Parameters:
- * sStart - {Sring} The string we're testing for.
+ * sStart - {String} The string we're testing for.
*
* Returns:
* {Boolean} Whether or not this string starts with the string passed in.
Modified: trunk/openlayers/lib/OpenLayers/Console.js
===================================================================
--- trunk/openlayers/lib/OpenLayers/Console.js 2011-02-28 08:12:05 UTC (rev 11575)
+++ trunk/openlayers/lib/OpenLayers/Console.js 2011-02-28 08:19:18 UTC (rev 11576)
@@ -101,7 +101,7 @@
* Expects a single error message
*
* Parameters:
- * object - {Object}
+ * error - {Object}
*/
userError: function(error) {
alert(error);
Modified: trunk/openlayers/lib/OpenLayers/Control/SelectFeature.js
===================================================================
--- trunk/openlayers/lib/OpenLayers/Control/SelectFeature.js 2011-02-28 08:12:05 UTC (rev 11575)
+++ trunk/openlayers/lib/OpenLayers/Control/SelectFeature.js 2011-02-28 08:19:18 UTC (rev 11576)
@@ -132,7 +132,7 @@
/**
* Property: layers
- * {Array(<OpenLayers.Layer.Vector>} The layers this control will work on,
+ * {Array(<OpenLayers.Layer.Vector>)} The layers this control will work on,
* or null if the control was configured with a single layer
*/
layers: null,
Modified: trunk/openlayers/lib/OpenLayers/Control/Snapping.js
===================================================================
--- trunk/openlayers/lib/OpenLayers/Control/Snapping.js 2011-02-28 08:12:05 UTC (rev 11575)
+++ trunk/openlayers/lib/OpenLayers/Control/Snapping.js 2011-02-28 08:19:18 UTC (rev 11576)
@@ -372,7 +372,7 @@
* Method: considerSnapping
*
* Parameters:
- * point - {<OpenLayers.Geometry.Point}} The vertex to be snapped (or
+ * point - {<OpenLayers.Geometry.Point>} The vertex to be snapped (or
* unsnapped).
* loc - {<OpenLayers.Geometry.Point>} The location of the mouse in map
* coords.
Modified: trunk/openlayers/lib/OpenLayers/Control/Split.js
===================================================================
--- trunk/openlayers/lib/OpenLayers/Control/Split.js 2011-02-28 08:12:05 UTC (rev 11575)
+++ trunk/openlayers/lib/OpenLayers/Control/Split.js 2011-02-28 08:19:18 UTC (rev 11576)
@@ -297,7 +297,7 @@
* Remove a feature from a list based on the given geometry.
*
* Parameters:
- * features - {Array(<OpenLayers.Feature.Vector>} A list of features.
+ * features - {Array(<OpenLayers.Feature.Vector>)} A list of features.
* geometry - {<OpenLayers.Geometry>} A geometry.
*/
removeByGeometry: function(features, geometry) {
@@ -340,7 +340,7 @@
* will be split if eligible.
*
* Parameters:
- * feature - {<OpenLayers.Feature.Vector}} The newly created or modified
+ * feature - {<OpenLayers.Feature.Vector>} The newly created or modified
* feature.
*
* Returns:
Modified: trunk/openlayers/lib/OpenLayers/Events.js
===================================================================
--- trunk/openlayers/lib/OpenLayers/Events.js 2011-02-28 08:12:05 UTC (rev 11575)
+++ trunk/openlayers/lib/OpenLayers/Events.js 2011-02-28 08:19:18 UTC (rev 11576)
@@ -604,6 +604,9 @@
* events.register("loadstart", object, loadStartListener);
* events.register("loadstart", object, loadEndListener);
* (end)
+ *
+ * Parameters:
+ * object - {Object}
*/
on: function(object) {
for(var type in object) {
Modified: trunk/openlayers/lib/OpenLayers/Format/GML.js
===================================================================
--- trunk/openlayers/lib/OpenLayers/Format/GML.js 2011-02-28 08:12:05 UTC (rev 11575)
+++ trunk/openlayers/lib/OpenLayers/Format/GML.js 2011-02-28 08:19:18 UTC (rev 11576)
@@ -582,7 +582,7 @@
* Method: parseAttributes
*
* Parameters:
- * node - {<DOMElement>}
+ * node - {DOMElement}
*
* Returns:
* {Object} An attributes object.
Modified: trunk/openlayers/lib/OpenLayers/Format/GPX.js
===================================================================
--- trunk/openlayers/lib/OpenLayers/Format/GPX.js 2011-02-28 08:12:05 UTC (rev 11575)
+++ trunk/openlayers/lib/OpenLayers/Format/GPX.js 2011-02-28 08:19:18 UTC (rev 11576)
@@ -134,7 +134,7 @@
* Method: extractSegment
*
* Parameters:
- * segment - {<DOMElement>} a trkseg or rte node to parse
+ * segment - {DOMElement} a trkseg or rte node to parse
* segmentType - {String} nodeName of waypoints that form the line
*
* Returns:
Modified: trunk/openlayers/lib/OpenLayers/Format/GeoRSS.js
===================================================================
--- trunk/openlayers/lib/OpenLayers/Format/GeoRSS.js 2011-02-28 08:12:05 UTC (rev 11575)
+++ trunk/openlayers/lib/OpenLayers/Format/GeoRSS.js 2011-02-28 08:19:18 UTC (rev 11576)
@@ -263,12 +263,12 @@
/**
* APIMethod: read
* Return a list of features from a GeoRSS doc
-
+ *
* Parameters:
- * data - {Element}
+ * doc - {Element}
*
* Returns:
- * An Array of <OpenLayers.Feature.Vector>s
+ * {Array(<OpenLayers.Feature.Vector>)}
*/
read: function(doc) {
if (typeof doc == "string") {
Modified: trunk/openlayers/lib/OpenLayers/Format/KML.js
===================================================================
--- trunk/openlayers/lib/OpenLayers/Format/KML.js 2011-02-28 08:12:05 UTC (rev 11575)
+++ trunk/openlayers/lib/OpenLayers/Format/KML.js 2011-02-28 08:19:18 UTC (rev 11576)
@@ -1125,7 +1125,7 @@
* Accept Feature Collection, and return a string.
*
* Parameters:
- * features - {Array(<OpenLayers.Feature.Vector>} An array of features.
+ * features - {Array(<OpenLayers.Feature.Vector>)} An array of features.
*
* Returns:
* {String} A KML string.
Modified: trunk/openlayers/lib/OpenLayers/Geometry/Rectangle.js
===================================================================
--- trunk/openlayers/lib/OpenLayers/Geometry/Rectangle.js 2011-02-28 08:12:05 UTC (rev 11575)
+++ trunk/openlayers/lib/OpenLayers/Geometry/Rectangle.js 2011-02-28 08:19:18 UTC (rev 11576)
@@ -50,7 +50,7 @@
* Constructor: OpenLayers.Geometry.Rectangle
*
* Parameters:
- * points - {Array(<OpenLayers.Geometry.Point>}
+ * points - {Array(<OpenLayers.Geometry.Point>)}
*/
initialize: function(x, y, width, height) {
OpenLayers.Geometry.prototype.initialize.apply(this, arguments);
Modified: trunk/openlayers/lib/OpenLayers/Layer/Grid.js
===================================================================
--- trunk/openlayers/lib/OpenLayers/Layer/Grid.js 2011-02-28 08:12:05 UTC (rev 11575)
+++ trunk/openlayers/lib/OpenLayers/Layer/Grid.js 2011-02-28 08:19:18 UTC (rev 11576)
@@ -798,7 +798,7 @@
*
* Parameters:
* rows - {Integer} Maximum number of rows we want our grid to have.
- * colums - {Integer} Maximum number of columns we want our grid to have.
+ * columns - {Integer} Maximum number of columns we want our grid to have.
*/
removeExcessTiles: function(rows, columns) {
Modified: trunk/openlayers/lib/OpenLayers/Layer.js
===================================================================
--- trunk/openlayers/lib/OpenLayers/Layer.js 2011-02-28 08:12:05 UTC (rev 11575)
+++ trunk/openlayers/lib/OpenLayers/Layer.js 2011-02-28 08:19:18 UTC (rev 11576)
@@ -556,7 +556,7 @@
* Method: moveTo
*
* Parameters:
- * bound - {<OpenLayers.Bounds>}
+ * bounds - {<OpenLayers.Bounds>}
* zoomChanged - {Boolean} Tells when zoom has changed, as layers have to
* do some init work in that case.
* dragging - {Boolean}
@@ -715,7 +715,7 @@
* subverted.
*
* Parameters:
- * visible - {Boolean} Whether or not to display the layer (if in range)
+ * visibility - {Boolean} Whether or not to display the layer (if in range)
*/
setVisibility: function(visibility) {
if (visibility != this.visibility) {
@@ -1079,7 +1079,7 @@
* APIMethod: getZoomForExtent
*
* Parameters:
- * bounds - {<OpenLayers.Bounds>}
+ * extent - {<OpenLayers.Bounds>}
* closest - {Boolean} Find the zoom level that most closely fits the
* specified bounds. Note that this may result in a zoom that does
* not exactly contain the entire extent.
Modified: trunk/openlayers/lib/OpenLayers/Map.js
===================================================================
--- trunk/openlayers/lib/OpenLayers/Map.js 2011-02-28 08:12:05 UTC (rev 11575)
+++ trunk/openlayers/lib/OpenLayers/Map.js 2011-02-28 08:19:18 UTC (rev 11576)
@@ -1591,7 +1591,7 @@
* If the new lonlat is in the current extent the map will slide smoothly
*
* Parameters:
- * lonlat - {<OpenLayers.Lonlat>}
+ * lonlat - {<OpenLayers.LonLat>}
*/
panTo: function(lonlat) {
if (this.panMethod && this.getExtent().scale(this.panRatio).containsLonLat(lonlat)) {
@@ -2250,8 +2250,6 @@
/**
* APIMethod: zoomIn
*
- * Parameters:
- * zoom - {int}
*/
zoomIn: function() {
this.zoomTo(this.getZoom() + 1);
@@ -2260,8 +2258,6 @@
/**
* APIMethod: zoomOut
*
- * Parameters:
- * zoom - {int}
*/
zoomOut: function() {
this.zoomTo(this.getZoom() - 1);
Modified: trunk/openlayers/lib/OpenLayers/Projection.js
===================================================================
--- trunk/openlayers/lib/OpenLayers/Projection.js 2011-02-28 08:12:05 UTC (rev 11575)
+++ trunk/openlayers/lib/OpenLayers/Projection.js 2011-02-28 08:19:18 UTC (rev 11576)
@@ -30,7 +30,7 @@
/**
* Property: titleRegEx
- * {RegEx} regular expression to strip the title from a proj4js definition
+ * {RegExp} regular expression to strip the title from a proj4js definition
*/
titleRegEx: /\+title=[^\+]*/,
@@ -174,10 +174,10 @@
* the input point is transformed in place.
*
* Parameters:
- * point - {{OpenLayers.Geometry.Point> | Object} An object with x and y
+ * point - {<OpenLayers.Geometry.Point> | Object} An object with x and y
* properties representing coordinates in those dimensions.
- * sourceProj - {OpenLayers.Projection} Source map coordinate system
- * destProj - {OpenLayers.Projection} Destination map coordinate system
+ * source - {OpenLayers.Projection} Source map coordinate system
+ * dest - {OpenLayers.Projection} Destination map coordinate system
*
* Returns:
* point - {object} A transformed coordinate. The original point is modified.
Modified: trunk/openlayers/lib/OpenLayers/Protocol/WFS/v1.js
===================================================================
--- trunk/openlayers/lib/OpenLayers/Protocol/WFS/v1.js 2011-02-28 08:12:05 UTC (rev 11575)
+++ trunk/openlayers/lib/OpenLayers/Protocol/WFS/v1.js 2011-02-28 08:19:18 UTC (rev 11576)
@@ -250,7 +250,7 @@
* is used.
*
* Parameters:
- * features - {Array(<OpenLayers.Feature.Vector>}
+ * features - {Array(<OpenLayers.Feature.Vector>)}
*
* Returns:
* {<OpenLayers.Protocol.Response>} A response object with a features
Modified: trunk/openlayers/lib/OpenLayers/Renderer/SVG.js
===================================================================
--- trunk/openlayers/lib/OpenLayers/Renderer/SVG.js 2011-02-28 08:12:05 UTC (rev 11575)
+++ trunk/openlayers/lib/OpenLayers/Renderer/SVG.js 2011-02-28 08:19:18 UTC (rev 11576)
@@ -799,9 +799,9 @@
* inside the valid range.
*
* Parameters:
- * badComponent - {<OpenLayers.Geometry.Point>)} original geometry of the
+ * badComponent - {<OpenLayers.Geometry.Point>} original geometry of the
* invalid point
- * goodComponent - {<OpenLayers.Geometry.Point>)} original geometry of the
+ * goodComponent - {<OpenLayers.Geometry.Point>} original geometry of the
* valid point
* Returns
* {String} the SVG coordinate pair of the clipped point (like
Modified: trunk/openlayers/lib/OpenLayers/Util.js
===================================================================
--- trunk/openlayers/lib/OpenLayers/Util.js 2011-02-28 08:12:05 UTC (rev 11575)
+++ trunk/openlayers/lib/OpenLayers/Util.js 2011-02-28 08:19:18 UTC (rev 11576)
@@ -22,6 +22,11 @@
/**
* Function: getElement
* This is the old $() from prototype
+ *
+ * Parameters:
+ * e - {String or DOMElement or Window}
+ * Return:
+ * {Array(DOMElement)}
*/
OpenLayers.Util.getElement = function() {
var elements = [];
@@ -105,7 +110,7 @@
*
* Parameters:
* array - {Array}
- * obj - {Object}
+ * obj - {*}
*
* Returns:
* {Integer} The index at, which the first object was found in the array.
@@ -134,6 +139,7 @@
* null to an individual parameter will avoid setting the attribute.
*
* Parameters:
+ * element - {DOMElement} DOM element to modify.
* id - {String} The element id attribute to set.
* px - {<OpenLayers.Pixel>} The left and top style position.
* sz - {<OpenLayers.Size>} The width and height style attributes.
@@ -404,6 +410,7 @@
/**
* Function: modifyAlphaImageDiv
*
+ * Parameters:
* div - {DOMElement} Div containing Alpha-adjusted Image
* id - {String}
* px - {<OpenLayers.Pixel>}
@@ -411,7 +418,7 @@
* imgURL - {String}
* position - {String}
* border - {String}
- * sizing {String} 'crop', 'scale', or 'image'. Default is "scale"
+ * sizing - {String} 'crop', 'scale', or 'image'. Default is "scale"
* opacity - {Float} Fractional value (0.0 - 1.0)
*/
OpenLayers.Util.modifyAlphaImageDiv = function(div, id, px, sz, imgURL,
@@ -452,6 +459,7 @@
/**
* Function: createAlphaImageDiv
*
+ * Parameters:
* id - {String}
* px - {<OpenLayers.Pixel>}
* sz - {<OpenLayers.Size>}
@@ -938,7 +946,7 @@
* lonlat - {<OpenLayers.LonLat>} (or any object with both .lat, .lon
* properties) The start point.
* brng - {Float} The bearing (degrees).
- * distance - {Float} The ground distance (meters).
+ * dist - {Float} The ground distance (meters).
*
* Returns:
* {<OpenLayers.LonLat>} The destination point.
@@ -1663,6 +1671,8 @@
* useful in the case where we have a limit in one dimension and must
* therefore meaure the flow in the other dimension.
* options - {Object}
+ *
+ * Allowed Options:
* displayClass - {String} Optional parameter. A CSS class name(s) string
* to provide the CSS context of the rendered content.
* containerElement - {DOMElement} Optional parameter. Insert the HTML to
More information about the Commits
mailing list