Filling our log with cruft, adding meaningless conflicts for merges, and changing a comment style that ndocs could care less about, this commit changes Return to Returns (closes #945).
git-svn-id: http://svn.openlayers.org/trunk/openlayers@4110 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
This commit is contained in:
@@ -193,7 +193,7 @@ OpenLayers.Util.modifyDOMElement = function(element, id, px, sz, position,
|
||||
* overflow - {String} The style.overflow value. Eg. hidden
|
||||
* opacity - {Float} Fractional value (0.0 - 1.0)
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {DOMElement} A DOM Div created with the specified attributes.
|
||||
*/
|
||||
OpenLayers.Util.createDiv = function(id, px, sz, imgURL, position,
|
||||
@@ -234,7 +234,7 @@ OpenLayers.Util.createDiv = function(id, px, sz, imgURL, position,
|
||||
* loaded.
|
||||
* opacity - {Float} Fractional value (0.0 - 1.0)
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {DOMElement} A DOM Image created with the specified attributes.
|
||||
*/
|
||||
OpenLayers.Util.createImage = function(id, px, sz, imgURL, position, border,
|
||||
@@ -353,7 +353,7 @@ OpenLayers.Util.onImageLoadError = function() {
|
||||
* hack which allows alpha transparency for png images under Internet
|
||||
* Explorer.
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Boolean} true if alpha has is necessary and possible, false otherwise.
|
||||
*/
|
||||
OpenLayers.Util.alphaHack = function() {
|
||||
@@ -437,7 +437,7 @@ OpenLayers.Util.modifyAlphaImageDiv = function(div, id, px, sz, imgURL,
|
||||
* sizing {String} 'crop', 'scale', or 'image'. Default is "scale"
|
||||
* delayDisplay{Boolean}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {DOMElement} A DOM Div created with a DOM Image inside it. If the hack is
|
||||
* needed for transparency in IE, it is added.
|
||||
*/
|
||||
@@ -509,7 +509,7 @@ OpenLayers.Util.applyDefaults = function (to, from) {
|
||||
* Parameters:
|
||||
* params - {Object}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {String} A concatenation of the properties of an object in
|
||||
* http parameter notation.
|
||||
* (ex. <i>"key1=value1&key2=value2&key3=value3"</i>)
|
||||
@@ -552,7 +552,7 @@ OpenLayers.ImgPath = '';
|
||||
/**
|
||||
* Function: getImagesLocation
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {String} The fully formatted image location string
|
||||
*/
|
||||
OpenLayers.Util.getImagesLocation = function() {
|
||||
@@ -572,7 +572,7 @@ OpenLayers.Util.getImagesLocation = function() {
|
||||
* successfully executes.
|
||||
* If none executes successfully, returns null.
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {*} The value returned by the first successfully executed function.
|
||||
*/
|
||||
OpenLayers.Util.Try = function() {
|
||||
@@ -599,7 +599,7 @@ OpenLayers.Util.Try = function() {
|
||||
* p - {}
|
||||
* tagName - {String}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Array}
|
||||
*/
|
||||
OpenLayers.Util.getNodes=function(p, tagName) {
|
||||
@@ -622,7 +622,7 @@ OpenLayers.Util.getNodes=function(p, tagName) {
|
||||
* nodes - {Array}
|
||||
* tagName - {String}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Array}
|
||||
*/
|
||||
OpenLayers.Util._getNodes=function(nodes, tagName) {
|
||||
@@ -646,7 +646,7 @@ OpenLayers.Util._getNodes=function(nodes, tagName) {
|
||||
* item - {String}
|
||||
* index - {Integer}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {String}
|
||||
*/
|
||||
OpenLayers.Util.getTagText = function (parent, item, index) {
|
||||
@@ -673,7 +673,7 @@ OpenLayers.Util.getTagText = function (parent, item, index) {
|
||||
* Parameters:
|
||||
* node - {XMLNode}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {String} The text value of the given node, without breaking in firefox or IE
|
||||
*/
|
||||
OpenLayers.Util.getXmlNodeValue = function(node) {
|
||||
@@ -699,7 +699,7 @@ OpenLayers.Util.getXmlNodeValue = function(node) {
|
||||
* evt - {Event}
|
||||
* div - {HTMLDivElement}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Boolean}
|
||||
*/
|
||||
OpenLayers.Util.mouseLeft = function (evt, div) {
|
||||
@@ -719,7 +719,7 @@ OpenLayers.Util.mouseLeft = function (evt, div) {
|
||||
* Parameters:
|
||||
* x - {Float}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Float}
|
||||
*/
|
||||
OpenLayers.Util.rad = function(x) {return x*Math.PI/180;};
|
||||
@@ -731,7 +731,7 @@ OpenLayers.Util.rad = function(x) {return x*Math.PI/180;};
|
||||
* p1 - {Float}
|
||||
* p2 - {Float}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Float}
|
||||
*/
|
||||
OpenLayers.Util.distVincenty=function(p1, p2) {
|
||||
@@ -779,7 +779,7 @@ OpenLayers.Util.distVincenty=function(p1, p2) {
|
||||
* url - {String} Optional url used to extract the query string.
|
||||
* If null, query string is taken from page location.
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} An object of key/value pairs from the query string.
|
||||
*/
|
||||
OpenLayers.Util.getParameters = function(url) {
|
||||
@@ -831,7 +831,7 @@ OpenLayers.Util.getParameters = function(url) {
|
||||
* url - {String} Optional url used to extract the query string.
|
||||
* If null, query string is taken from page location.
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} An object of key/value pairs from the query string.
|
||||
*/
|
||||
OpenLayers.Util.getArgs = function(url) {
|
||||
@@ -856,7 +856,7 @@ OpenLayers.Util.lastSeqID = 0;
|
||||
* prefix {String} String to prefix unique id.
|
||||
* If null, default is "id_"
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {String} A unique id string, built on the passed in prefix
|
||||
*/
|
||||
OpenLayers.Util.createUniqueID = function(prefix) {
|
||||
@@ -894,7 +894,7 @@ OpenLayers.DOTS_PER_INCH = 72;
|
||||
* Parameters:
|
||||
* scale - {float}
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Float} A normalized scale value, in 1 / X format.
|
||||
* This means that if a value less than one ( already 1/x) is passed
|
||||
* in, it just returns scale directly. Otherwise, it returns
|
||||
@@ -914,7 +914,7 @@ OpenLayers.Util.normalizeScale = function (scale) {
|
||||
* units - {String} Index into OpenLayers.INCHES_PER_UNIT hashtable.
|
||||
* Default is degrees
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Float} The corresponding resolution given passed-in scale and unit
|
||||
* parameters.
|
||||
*/
|
||||
@@ -939,7 +939,7 @@ OpenLayers.Util.getResolutionFromScale = function (scale, units) {
|
||||
* units - {String} Index into OpenLayers.INCHES_PER_UNIT hashtable.
|
||||
* Default is degrees
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Float} The corresponding scale given passed-in resolution and unit
|
||||
* parameters.
|
||||
*/
|
||||
@@ -979,7 +979,7 @@ OpenLayers.Util.safeStopPropagation = function(evt) {
|
||||
* Parameters:
|
||||
* forElement - {DOMElement}
|
||||
*
|
||||
* Return:<3A>
|
||||
* Returns:<3A>
|
||||
* {Array} two item array, L value then T value.
|
||||
*/
|
||||
OpenLayers.Util.pagePosition = function(forElement) {
|
||||
@@ -1044,7 +1044,7 @@ OpenLayers.Util.pagePosition = function(forElement) {
|
||||
* 'ignorePort80' - Default is True
|
||||
* 'ignoreHash' - Default is True
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Boolean} Whether or not the two URLs are equivalent
|
||||
*/
|
||||
OpenLayers.Util.isEquivalentUrl = function(url1, url2, options) {
|
||||
@@ -1116,7 +1116,7 @@ OpenLayers.Util.isEquivalentUrl = function(url1, url2, options) {
|
||||
* ignorePort80: don't include explicit port if port is 80,
|
||||
* ignoreHash: Don't include part of url after the hash (#).
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {Object} An object with separate url, a, port, host, and args parsed out
|
||||
* and ready for comparison
|
||||
*/
|
||||
@@ -1227,7 +1227,7 @@ OpenLayers.Util.createUrlObject = function(url, options) {
|
||||
* Parameters:
|
||||
* url - {String} The url to process
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {String} The string with all queryString and Hash removed
|
||||
*/
|
||||
OpenLayers.Util.removeTail = function(url) {
|
||||
@@ -1249,7 +1249,7 @@ OpenLayers.Util.removeTail = function(url) {
|
||||
/**
|
||||
* Function: getBrowserName
|
||||
*
|
||||
* Return:
|
||||
* Returns:
|
||||
* {String} A string which specifies which is the current
|
||||
* browser in which we are running.
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user