fix Natural Docs comments, no functional change. p=jorix, r=me (closes #2989)

git-svn-id: http://svn.openlayers.org/trunk/openlayers@11576 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
2011-02-28 08:19:18 +00:00
parent 1887969a3c
commit 82a64751af
19 changed files with 45 additions and 34 deletions
--- a/lib/OpenLayers/BaseTypes.js
+++ b/lib/OpenLayers/BaseTypes.js
@@ -25,7 +25,7 @@ OpenLayers.String = {
     * 
     * 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 @@ if (!String.prototype.startsWith) {
     * *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.
--- a/lib/OpenLayers/BaseTypes/Bounds.js
+++ b/lib/OpenLayers/BaseTypes/Bounds.js
@@ -260,7 +260,7 @@ OpenLayers.Bounds = OpenLayers.Class({
     *          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 @@ OpenLayers.Bounds = OpenLayers.Class({
     * 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.
--- a/lib/OpenLayers/Console.js
+++ b/lib/OpenLayers/Console.js
@@ -101,7 +101,7 @@ OpenLayers.Console = {
     * Expects a single error message
     * 
     * Parameters:
-     * object - {Object}
+     * error - {Object}
     */
    userError: function(error) {
        alert(error);
--- a/lib/OpenLayers/Control/SelectFeature.js
+++ b/lib/OpenLayers/Control/SelectFeature.js
@@ -132,7 +132,7 @@ OpenLayers.Control.SelectFeature = OpenLayers.Class(OpenLayers.Control, {
    
    /**
     * 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,
--- a/lib/OpenLayers/Control/Snapping.js
+++ b/lib/OpenLayers/Control/Snapping.js
@@ -372,7 +372,7 @@ OpenLayers.Control.Snapping = OpenLayers.Class(OpenLayers.Control, {
     * 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.
--- a/lib/OpenLayers/Control/Split.js
+++ b/lib/OpenLayers/Control/Split.js
@@ -297,7 +297,7 @@ OpenLayers.Control.Split = OpenLayers.Class(OpenLayers.Control, {
     * 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 @@ OpenLayers.Control.Split = OpenLayers.Class(OpenLayers.Control, {
     *     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:
--- a/lib/OpenLayers/Events.js
+++ b/lib/OpenLayers/Events.js
@@ -604,6 +604,9 @@ OpenLayers.Events = OpenLayers.Class({
     * events.register("loadstart", object, loadStartListener);
     * events.register("loadstart", object, loadEndListener);
     * (end)
+     *
+     * Parameters:
+     *  object - {Object}     
     */
    on: function(object) {
        for(var type in object) {
--- a/lib/OpenLayers/Format/GML.js
+++ b/lib/OpenLayers/Format/GML.js
@@ -582,7 +582,7 @@ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format.XML, {
     * Method: parseAttributes
     *
     * Parameters:
-     * node - {<DOMElement>}
+     * node - {DOMElement}
     *
     * Returns:
     * {Object} An attributes object.
--- a/lib/OpenLayers/Format/GPX.js
+++ b/lib/OpenLayers/Format/GPX.js
@@ -134,7 +134,7 @@ OpenLayers.Format.GPX = OpenLayers.Class(OpenLayers.Format.XML, {
    * 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:
--- a/lib/OpenLayers/Format/GeoRSS.js
+++ b/lib/OpenLayers/Format/GeoRSS.js
@@ -263,12 +263,12 @@ OpenLayers.Format.GeoRSS = OpenLayers.Class(OpenLayers.Format.XML, {
    /**
     * 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") { 
--- a/lib/OpenLayers/Format/KML.js
+++ b/lib/OpenLayers/Format/KML.js
@@ -1125,7 +1125,7 @@ OpenLayers.Format.KML = OpenLayers.Class(OpenLayers.Format.XML, {
     * 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.
--- a/lib/OpenLayers/Geometry/Rectangle.js
+++ b/lib/OpenLayers/Geometry/Rectangle.js
@@ -50,7 +50,7 @@ OpenLayers.Geometry.Rectangle = OpenLayers.Class(OpenLayers.Geometry, {
     * 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);
--- a/lib/OpenLayers/Layer.js
+++ b/lib/OpenLayers/Layer.js
@@ -556,7 +556,7 @@ OpenLayers.Layer = OpenLayers.Class({
     * 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 @@ OpenLayers.Layer = OpenLayers.Class({
     *     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 @@ OpenLayers.Layer = OpenLayers.Class({
     * 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.
--- a/lib/OpenLayers/Layer/Grid.js
+++ b/lib/OpenLayers/Layer/Grid.js
@@ -798,7 +798,7 @@ OpenLayers.Layer.Grid = OpenLayers.Class(OpenLayers.Layer.HTTPRequest, {
     * 
     * 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) {
        
--- a/lib/OpenLayers/Map.js
+++ b/lib/OpenLayers/Map.js
@@ -1591,7 +1591,7 @@ OpenLayers.Map = OpenLayers.Class({
     * 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 @@ OpenLayers.Map = OpenLayers.Class({
    /**
     * APIMethod: zoomIn
     * 
-     * Parameters:
-     * zoom - {int}
     */
    zoomIn: function() {
        this.zoomTo(this.getZoom() + 1);
@@ -2260,8 +2258,6 @@ OpenLayers.Map = OpenLayers.Class({
    /**
     * APIMethod: zoomOut
     * 
-     * Parameters:
-     * zoom - {int}
     */
    zoomOut: function() {
        this.zoomTo(this.getZoom() - 1);
--- a/lib/OpenLayers/Projection.js
+++ b/lib/OpenLayers/Projection.js
@@ -30,7 +30,7 @@ OpenLayers.Projection = OpenLayers.Class({
    
    /**
     * 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 @@ OpenLayers.Projection.addTransform = function(from, to, method) {
 *     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.
--- a/lib/OpenLayers/Protocol/WFS/v1.js
+++ b/lib/OpenLayers/Protocol/WFS/v1.js
@@ -250,7 +250,7 @@ OpenLayers.Protocol.WFS.v1 = OpenLayers.Class(OpenLayers.Protocol, {
     *     is used.
     *
     * Parameters:
-     * features - {Array(<OpenLayers.Feature.Vector>}
+     * features - {Array(<OpenLayers.Feature.Vector>)}
     *
     * Returns:
     * {<OpenLayers.Protocol.Response>} A response object with a features
--- a/lib/OpenLayers/Renderer/SVG.js
+++ b/lib/OpenLayers/Renderer/SVG.js
@@ -799,9 +799,9 @@ OpenLayers.Renderer.SVG = OpenLayers.Class(OpenLayers.Renderer.Elements, {
     * 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
--- a/lib/OpenLayers/Util.js
+++ b/lib/OpenLayers/Util.js
@@ -22,6 +22,11 @@ OpenLayers.Util = OpenLayers.Util || {};
 /** 
 * 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 @@ OpenLayers.Util.clearArray = function(array) {
 * 
 * Parameters:
 * array - {Array}
- * obj - {Object}
+ * obj - {*}
 * 
 * Returns:
 * {Integer} The index at, which the first object was found in the array.
@@ -134,6 +139,7 @@ OpenLayers.Util.indexOf = function(array, obj) {
 * 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 @@ OpenLayers.Util.alphaHack = function() {
 /** 
 * Function: modifyAlphaImageDiv
 * 
+ * Parameters:
 * div - {DOMElement} Div containing Alpha-adjusted Image
 * id - {String}
 * px - {<OpenLayers.Pixel>}
@@ -411,7 +418,7 @@ OpenLayers.Util.alphaHack = function() {
 * 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 @@ OpenLayers.Util.modifyAlphaImageDiv = function(div, id, px, sz, imgURL,
 /** 
 * Function: createAlphaImageDiv
 * 
+ * Parameters:
 * id - {String}
 * px - {<OpenLayers.Pixel>}
 * sz - {<OpenLayers.Size>}
@@ -938,7 +946,7 @@ OpenLayers.Util.distVincenty = function(p1, p2) {
 * 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 @@ OpenLayers.Util.getBrowserName = function() {
 *     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