From d2bf82c8e580c19f2dd3d742f721e6e7474cbf7e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Loriot?= Date: Wed, 19 Jun 2013 19:28:19 +0200 Subject: [PATCH] document FaceGraph triangle primitive to be only for Polyhedron --- .../CGAL/AABB_FaceGraph_triangle_primitive.h | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/AABB_tree/include/CGAL/AABB_FaceGraph_triangle_primitive.h b/AABB_tree/include/CGAL/AABB_FaceGraph_triangle_primitive.h index c0895df5f23..471ceaed91b 100644 --- a/AABB_tree/include/CGAL/AABB_FaceGraph_triangle_primitive.h +++ b/AABB_tree/include/CGAL/AABB_FaceGraph_triangle_primitive.h @@ -31,19 +31,16 @@ namespace CGAL { /*! * \ingroup PkgAABB_tree * Primitive type for a facet of a polyhedral surface. - * It wraps a `face_descriptor` of a class model of `FaceGraph` to a 3D triangle. - * The class model of `FaceGraph` from which the primitive is built should not be deleted + * It wraps a handle to a facet of a polyhedron to a 3D triangle. + * The polyhedron from which the primitive is built should not be deleted * while the AABB tree holding the primitive is in use. * * \cgalModels `AABBPrimitive` if `OneFaceGraphPerTree` is `CGAL::Tag_false`, * and `AABBPrimitiveWithSharedData` if `OneFaceGraphPerTree` is `CGAL::Tag_true`. * - *\tparam FaceGraph is a model of the face graph concept. - *\tparam OneFaceGraphPerTree is either `CGAL::Tag_true` or `CGAL::Tag_false`. In the former case, - * we guarantee that all the primitives will be from a common `FaceGraph` and some data - * will be factorized so that the size of the primitive is reduced. In the latter case, - * the primitives can be from different graphs and extra storage is required in the primitives. - * The default is `CGAL::Tag_true`. + *\tparam FaceGraph is a \cgal Polyhedron. + *\tparam OneFaceGraphPerTree must be set to `CGAL::Tag_true`. + * This parameter is useless for the moment and will be useful in an upcoming release of \cgal. *\tparam cache_datum is either `CGAL::Tag_true` or `CGAL::Tag_false`. In the former case, the datum is stored * in the primitive, while in the latter it is constructed on the fly to reduce the memory footprint. * The default is `CGAL::Tag_false` (datum is not stored).