Document pglwgeom_getbox2d_p. See http://trac.osgeo.org/postgis/ticket/1023

git-svn-id: http://svn.osgeo.org/postgis/trunk@7582 b70326c6-7e19-0410-871a-916f4a2858ee

diff --git a/postgis/lwgeom_pg.h b/postgis/lwgeom_pg.h
index 078006a2e6fecf7aab0b2f2f9b55a186b4906684..00c2b0381504430376e7fa14703b13d0abf4bcc4 100644 (file)
--- a/postgis/lwgeom_pg.h
+++ b/postgis/lwgeom_pg.h
@@ -104,6 +104,11 @@ extern bool pglwgeom_has_bbox(const PG_LWGEOM *lwgeom);
 extern bool pglwgeom_has_z(const PG_LWGEOM *lwgeom);
 extern bool pglwgeom_has_m(const PG_LWGEOM *lwgeom);
 extern int pglwgeom_is_empty(const PG_LWGEOM *geom);
+/*
+ * Get the 2d bounding box of the given geometry, in FLOAT4 format.
+ * Use a cached bbox if available, compute it otherwise.
+ * Return LW_FALSE if the geometry has no bounding box (ie: is empty).
+ */
 extern int pglwgeom_getbox2d_p(const PG_LWGEOM *geom, BOX2DFLOAT4 *box);
 extern BOX3D *pglwgeom_compute_serialized_box3d(const PG_LWGEOM *geom);
 extern int pglwgeom_compute_serialized_box3d_p(const PG_LWGEOM *geom, BOX3D *box3d);