[geos-commits] r3176 - trunk/include/geos/geom/util

[svn_geos at osgeo.org]

Author: strk
Date: 2011-02-03 11:58:41 -0800 (Thu, 03 Feb 2011)
New Revision: 3176

Modified:
   trunk/include/geos/geom/util/GeometryCombiner.h
Log:
Document ownerhips of GeometryCombiner inputs

Modified: trunk/include/geos/geom/util/GeometryCombiner.h
===================================================================
--- trunk/include/geos/geom/util/GeometryCombiner.h	2011-02-03 08:15:08 UTC (rev 3175)
+++ trunk/include/geos/geom/util/GeometryCombiner.h	2011-02-03 19:58:41 UTC (rev 3176)
@@ -51,7 +51,7 @@
     /**
      * Combines a collection of geometries.
      * 
-     * @param geoms the geometries to combine
+     * @param geoms the geometries to combine (ownership left to caller)
      * @return the combined geometry
      */
     static Geometry* combine(std::vector<Geometry*> const& geoms);
@@ -59,8 +59,8 @@
     /**
      * Combines two geometries.
      * 
-     * @param g0 a geometry to combine
-     * @param g1 a geometry to combine
+     * @param g0 a geometry to combine (ownership left to caller)
+     * @param g1 a geometry to combine (ownership left to caller)
      * @return the combined geometry
      */
     static Geometry* combine(Geometry* g0, Geometry* g1);
@@ -68,9 +68,9 @@
     /**
      * Combines three geometries.
      * 
-     * @param g0 a geometry to combine
-     * @param g1 a geometry to combine
-     * @param g2 a geometry to combine
+     * @param g0 a geometry to combine (ownership left to caller)
+     * @param g1 a geometry to combine (ownership left to caller)
+     * @param g2 a geometry to combine (ownership left to caller)
      * @return the combined geometry
      */
     static Geometry* combine(Geometry* g0, Geometry* g1, Geometry* g2);