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:
Tim Schaub
2007-08-29 18:44:10 +00:00
parent b5ef77096c
commit c2148651ed
78 changed files with 397 additions and 388 deletions

View File

@@ -67,7 +67,7 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, {
* APIMethod: clone
* Clone this geometry.
*
* Return:
* Returns:
* {<OpenLayers.Geometry.Collection>} An exact clone of this collection
*/
clone: function() {
@@ -86,7 +86,7 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, {
* Method: getComponentsString
* Get a string representing the components for this collection
*
* Return:
* Returns:
* {String} A string representation of the components of this geometry
*/
getComponentsString: function(){
@@ -139,7 +139,7 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, {
* component - {<OpenLayers.Geometry>} A geometry to add
* index - {int} Optional index into the array to insert the component
*
* Return:
* Returns:
* {Boolean} The component geometry was successfully added
*/
addComponent: function(component, index) {
@@ -202,7 +202,7 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, {
* APIMethod: getLength
* Calculate the length of this geometry
*
* Return:
* Returns:
* {Float} The length of the geometry
*/
getLength: function() {
@@ -218,7 +218,7 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, {
* Calculate the area of this geometry. Note how this function is overridden
* in <OpenLayers.Geometry.Polygon>.
*
* Return:
* Returns:
* {Float} The area of the collection by summing its parts
*/
getArea: function() {
@@ -283,7 +283,7 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, {
* Parameters:
* geometry - {<OpenLayers.Geometry>}
*
* Return:
* Returns:
* {Boolean} The coordinates are equivalent
*/
equals: function(geometry) {

View File

@@ -37,7 +37,7 @@ OpenLayers.Geometry.Curve = OpenLayers.Class(OpenLayers.Geometry.MultiPoint, {
/**
* APIMethod: getLength
*
* Return:
* Returns:
* {Float} The length of the curve
*/
getLength: function() {

View File

@@ -58,7 +58,7 @@ OpenLayers.Geometry.LinearRing = OpenLayers.Class(
* point - {<OpenLayers.Geometry.Point>}
* index - {Integer} Index into the array to insert the component
*
* Return:
* Returns:
* {Boolean} Was the Point successfully added?
*/
addComponent: function(point, index) {
@@ -157,7 +157,7 @@ OpenLayers.Geometry.LinearRing = OpenLayers.Class(
* Note - The area is positive if the ring is oriented CW, otherwise
* it will be negative.
*
* Return:
* Returns:
* {Float} The signed area for a ring.
*/
getArea: function() {

View File

@@ -31,7 +31,7 @@ OpenLayers.Geometry.MultiPoint = OpenLayers.Class(
* Parameters:
* components - Array({<OpenLayers.Geometry.Point>})
*
* Return:
* Returns:
* {<OpenLayers.Geometry.MultiPoint>}
*/
initialize: function(components) {

View File

@@ -44,7 +44,7 @@ OpenLayers.Geometry.Point = OpenLayers.Class(OpenLayers.Geometry, {
/**
* APIMethod: clone
*
* Return:
* Returns:
* {<OpenLayers.Geometry.Point>} An exact clone of this OpenLayers.Geometry.Point
*/
clone: function(obj) {
@@ -91,7 +91,7 @@ OpenLayers.Geometry.Point = OpenLayers.Class(OpenLayers.Geometry, {
* Parameters:
* xy - {<OpenLayers.Geometry>}
*
* Return:
* Returns:
* {Boolean} Boolean value indicating whether the passed-in
* {<OpenLayers.Geometry>} object has the same components as this
* note that if ll passed in is null, returns false
@@ -109,7 +109,7 @@ OpenLayers.Geometry.Point = OpenLayers.Class(OpenLayers.Geometry, {
/**
* Method: toShortString
*
* Return:
* Returns:
* {String} Shortened String representation of Point object.
* (ex. <i>"5, 42"</i>)
*/

View File

@@ -43,7 +43,7 @@ OpenLayers.Geometry.Polygon = OpenLayers.Class(
* Calculated by subtracting the areas of the internal holes from the
* area of the outer hole.
*
* Return:
* Returns:
* {float} The area of the geometry
*/
getArea: function() {

View File

@@ -70,7 +70,7 @@ OpenLayers.Geometry.Rectangle = OpenLayers.Class(OpenLayers.Geometry, {
/**
* APIMethod: getLength
*
* Return:
* Returns:
* {Float} The length of the geometry
*/
getLength: function() {
@@ -81,7 +81,7 @@ OpenLayers.Geometry.Rectangle = OpenLayers.Class(OpenLayers.Geometry, {
/**
* APIMethod: getArea
*
* Return:
* Returns:
* {Float} The area of the geometry
*/
getArea: function() {