[geos-commits] r2496 - trunk/source/headers/geos/operation/distance

svn_geos at osgeo.org svn_geos at osgeo.org
Fri May 8 08:11:52 EDT 2009


Author: strk
Date: 2009-05-08 08:11:52 -0400 (Fri, 08 May 2009)
New Revision: 2496

Modified:
   trunk/source/headers/geos/operation/distance/DistanceOp.h
Log:
Document semantic of a null return from closestPoints

Modified: trunk/source/headers/geos/operation/distance/DistanceOp.h
===================================================================
--- trunk/source/headers/geos/operation/distance/DistanceOp.h	2009-05-08 12:09:23 UTC (rev 2495)
+++ trunk/source/headers/geos/operation/distance/DistanceOp.h	2009-05-08 12:11:52 UTC (rev 2496)
@@ -97,13 +97,18 @@
 
 	/**
 	 * Compute the the closest points of two geometries.
+	 *
 	 * The points are presented in the same order as the input Geometries.
 	 *
 	 * @param g0 a {@link Geometry}
 	 * @param g1 another {@link Geometry}
-	 * @return the closest points in the geometries, ownership to caller
+	 *
+	 * @return the closest points in the geometries, ownership to caller.
+	 *         A NULL return means one of the geometries is empty.
 	 */
-	static geom::CoordinateSequence* closestPoints(geom::Geometry *g0, geom::Geometry *g1);
+	static geom::CoordinateSequence* closestPoints(
+	                                        const geom::Geometry *g0,
+	                                        const geom::Geometry *g1);
 
 	/// @deprecated use the one taking references
 	DistanceOp(const geom::Geometry *g0, const geom::Geometry *g1);



More information about the geos-commits mailing list