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

@@ -135,7 +135,7 @@ OpenLayers.Control.DragFeature = OpenLayers.Class(OpenLayers.Control, {
* APIMethod: activate
* Activate the control and the feature handler.
*
* Returns:
* Return:
* {Boolean} Successfully activated the control and feature handler.
*/
activate: function() {
@@ -147,7 +147,7 @@ OpenLayers.Control.DragFeature = OpenLayers.Class(OpenLayers.Control, {
* APIMethod: deactivate
* Deactivate the control and all handlers.
*
* Returns:
* Return:
* {Boolean} Successfully deactivated the control.
*/
deactivate: function() {

View File

@@ -126,7 +126,7 @@ OpenLayers.Control.LayerSwitcher = OpenLayers.Class(OpenLayers.Control, {
/**
* Method: draw
*
* Returns:
* Return:
* {DOMElement} A reference to the DIV DOMElement containing the switcher
* tabs
*/
@@ -175,7 +175,7 @@ OpenLayers.Control.LayerSwitcher = OpenLayers.Class(OpenLayers.Control, {
* control to display that state. Groups base layers into a radio-button
* group and lists each data layer with a checkbox.
*
* Returns:
* Return:
* {DOMElement} A reference to the DIV DOMElement containing the control
*/
redraw: function() {

View File

@@ -98,7 +98,7 @@ OpenLayers.Control.MouseDefaults = OpenLayers.Class(OpenLayers.Control, {
* Parameters:
* evt - {Event}
*
* Returns:
* Return:
* {Boolean}
*/
defaultClick: function (evt) {
@@ -109,11 +109,11 @@ OpenLayers.Control.MouseDefaults = OpenLayers.Class(OpenLayers.Control, {
},
/**
* Method: defaultDblClick
*
* Parameters:
* evt - {Event}
*/
* Method: defaultDblClick
*
* Parameters:
* evt - {Event}
*/
defaultDblClick: function (evt) {
var newCenter = this.map.getLonLatFromViewPortPx( evt.xy );
this.map.setCenter(newCenter, this.map.zoom + 1);
@@ -122,11 +122,11 @@ OpenLayers.Control.MouseDefaults = OpenLayers.Class(OpenLayers.Control, {
},
/**
* Method: defaultMouseDown
*
* Parameters:
* evt - {Event}
*/
* Method: defaultMouseDown
*
* Parameters:
* evt - {Event}
*/
defaultMouseDown: function (evt) {
if (!OpenLayers.Event.isLeftClick(evt)) return;
this.mouseDragStart = evt.xy.clone();
@@ -151,11 +151,11 @@ OpenLayers.Control.MouseDefaults = OpenLayers.Class(OpenLayers.Control, {
},
/**
* Method: defaultMouseMove
*
* Parameters:
* evt - {Event}
*/
* Method: defaultMouseMove
*
* Parameters:
* evt - {Event}
*/
defaultMouseMove: function (evt) {
// record the mouse position, used in onWheelEvent
this.mousePosition = evt.xy.clone();
@@ -188,11 +188,11 @@ OpenLayers.Control.MouseDefaults = OpenLayers.Class(OpenLayers.Control, {
},
/**
* Method: defaultMouseUp
*
* Parameters:
* evt - {<OpenLayers.Event>}
*/
* Method: defaultMouseUp
*
* Parameters:
* evt - {<OpenLayers.Event>}
*/
defaultMouseUp: function (evt) {
if (!OpenLayers.Event.isLeftClick(evt)) return;
if (this.zoomBox) {
@@ -208,11 +208,11 @@ OpenLayers.Control.MouseDefaults = OpenLayers.Class(OpenLayers.Control, {
},
/**
* Method: defaultMouseOut
*
* Parameters:
* evt - {Event}
*/
* Method: defaultMouseOut
*
* Parameters:
* evt - {Event}
*/
defaultMouseOut: function (evt) {
if (this.mouseDragStart != null &&
OpenLayers.Util.mouseLeft(evt, this.map.div)) {
@@ -343,4 +343,3 @@ OpenLayers.Control.MouseDefaults = OpenLayers.Class(OpenLayers.Control, {
CLASS_NAME: "OpenLayers.Control.MouseDefaults"
});

View File

@@ -55,14 +55,14 @@ OpenLayers.Control.PanZoom = OpenLayers.Class(OpenLayers.Control, {
},
/**
* Method: draw
*
* Parameters:
* px - {<OpenLayers.Pixel>}
*
* Returns:
* {DOMElement} A reference to the container div for the PanZoom control
*/
* Method: draw
*
* Parameters:
* px - {<OpenLayers.Pixel>}
*
* Return:
* {DOMElement} A reference to the container div for the PanZoom control
*/
draw: function(px) {
// initialize our internal div
OpenLayers.Control.prototype.draw.apply(this, arguments);
@@ -98,7 +98,7 @@ OpenLayers.Control.PanZoom = OpenLayers.Class(OpenLayers.Control, {
* xy - {<OpenLayers.Pixel>}
* sz - {<OpenLayers.Size>}
*
* Returns:
* Return:
* {DOMElement} A Div (an alphaImageDiv, to be precise) that contains the
* image of the button, and has all the proper event handlers set.
*/
@@ -132,7 +132,7 @@ OpenLayers.Control.PanZoom = OpenLayers.Class(OpenLayers.Control, {
* Parameters:
* evt - {Event}
*
* Returns: {Boolean}
* Return: {Boolean}
*/
doubleClick: function (evt) {
OpenLayers.Event.stop(evt);

View File

@@ -82,7 +82,7 @@ OpenLayers.Control.Panel = OpenLayers.Class(OpenLayers.Control, {
/**
* Method: draw
*
* Returns: {DOMElement}
* Return: {DOMElement}
*/
draw: function() {
OpenLayers.Control.prototype.draw.apply(this, arguments);

View File

@@ -78,7 +78,7 @@ OpenLayers.Control.Permalink = OpenLayers.Class(OpenLayers.Control, {
/**
* Method: draw
*
* Returns: {DOMElement}
* Return: {DOMElement}
*/
draw: function() {
OpenLayers.Control.prototype.draw.apply(this, arguments);

View File

@@ -34,7 +34,7 @@ OpenLayers.Control.Scale = OpenLayers.Class(OpenLayers.Control, {
/**
* Method: draw
*
* Returns: {DOMElemen}t
* Return: {DOMElemen}
*/
draw: function() {
OpenLayers.Control.prototype.draw.apply(this, arguments);