add a warning

2022-06-15 10:03:51 +02:00 · 2022-06-15 10:03:51 +02:00 · 1f8cf134da
parent e806a25861
commit 1f8cf134da
1 changed files with 2 additions and 0 deletions
--- a/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/orientation.h
+++ b/Polygon_mesh_processing/include/CGAL/Polygon_mesh_processing/orientation.h
@ -1240,6 +1240,8 @@ volume_connected_components(const TriangleMesh& tm,
 *
 * @pre `CGAL::is_closed(tm)`
 *
+ * @attention if `tm` is self-intersecting the behavior of this function is undefined.
+ *
 * \cgalNamedParamsBegin
 *   \cgalParamNBegin{vertex_point_map}
 *     \cgalParamDescription{a property map associating points to the vertices of `tm`}