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
This commit is contained in:
Frédéric Junod
2011-02-28 08:19:18 +00:00
parent 1887969a3c
commit 82a64751af
19 changed files with 45 additions and 34 deletions

View File

@@ -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