Additional ndocs for geometry.equals.

git-svn-id: http://svn.openlayers.org/trunk/openlayers@9074 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
2009-03-17 18:31:46 +00:00
parent b505822fd1
commit 5497e3a272
2 changed files with 17 additions and 17 deletions
@@ -331,15 +331,16 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, {
        return best;
    },

-    /**
+    /** 
     * APIMethod: equals
-     * Tests for equivalent geometries
-     *
+     * Determine whether another geometry is equivalent to this one.  Geometries
+     *     are considered equivalent if all components have the same coordinates.
+     * 
     * Parameters:
-     * geometry - {<OpenLayers.Geometry>}
+     * geom - {<OpenLayers.Geometry>} The geometry to test. 
     *
     * Returns:
-     * {Boolean} The coordinates are equivalent
+     * {Boolean} The supplied geometry is equivalent to this geometry.
     */
    equals: function(geometry) {
        var equivalent = true;