wiki/NaturalDocs says we should be using 'Return:' and not 'Returns:' so this patch is fixing that. Of course, in the process, I came across not a few instances where other ND related whitespace or typos were at odds with a peaceful, uniform OL codebase. No functional changes here, just makin' things pretty.

git-svn-id: http://svn.openlayers.org/trunk/openlayers@4109 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
This commit is contained in:
euzuro
2007-08-29 18:08:32 +00:00
parent e5641c76e0
commit b5ef77096c
27 changed files with 192 additions and 196 deletions

View File

@@ -54,13 +54,13 @@ OpenLayers.Icon = OpenLayers.Class({
px: null,
/**
* Constructor: OpenLayers.Icon
* Creates an icon, which is an image tag in a div.
*
* url - {String}
* size - {<OpenLayers.Size>}
* calculateOffset - {Function}
*/
* Constructor: OpenLayers.Icon
* Creates an icon, which is an image tag in a div.
*
* url - {String}
* size - {<OpenLayers.Size>}
* calculateOffset - {Function}
*/
initialize: function(url, size, offset, calculateOffset) {
this.url = url;
this.size = (size) ? size : new OpenLayers.Size(20,20);
@@ -83,11 +83,11 @@ OpenLayers.Icon = OpenLayers.Class({
},
/**
* Method: clone
*
* Returns:
* {<OpenLayers.Icon>} A fresh copy of the icon.
*/
* Method: clone
*
* Return:
* {<OpenLayers.Icon>} A fresh copy of the icon.
*/
clone: function() {
return new OpenLayers.Icon(this.url,
this.size,
@@ -108,15 +108,15 @@ OpenLayers.Icon = OpenLayers.Class({
},
/**
* Method: draw
* Move the div to the given pixel.
*
* Parameters:
* px - {<OpenLayers.Pixel>}
*
* Returns:
* {DOMElement} A new DOM Image of this icon set at the location passed-in
*/
* Method: draw
* Move the div to the given pixel.
*
* Parameters:
* px - {<OpenLayers.Pixel>}
*
* Return:
* {DOMElement} A new DOM Image of this icon set at the location passed-in
*/
draw: function(px) {
OpenLayers.Util.modifyAlphaImageDiv(this.imageDiv,
null,
@@ -143,12 +143,12 @@ OpenLayers.Icon = OpenLayers.Class({
},
/**
* Method: moveTo
* move icon to passed in px.
*
* Parameters:
* px - {<OpenLayers.Pixel>}
*/
* Method: moveTo
* move icon to passed in px.
*
* Parameters:
* px - {<OpenLayers.Pixel>}
*/
moveTo: function (px) {
//if no px passed in, use stored location
if (px != null) {