From 7a2e5412e942a0acfd11d2bc0c81c380ba9867bb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mael=20Rouxel-Labb=C3=A9?= Date: Mon, 15 May 2023 12:42:42 +0200 Subject: [PATCH] Clarify that empty() does not clean garbage or remove property maps --- BGL/include/CGAL/boost/graph/helpers.h | 3 +++ 1 file changed, 3 insertions(+) diff --git a/BGL/include/CGAL/boost/graph/helpers.h b/BGL/include/CGAL/boost/graph/helpers.h index 27677cdfe7d..185a00239a3 100644 --- a/BGL/include/CGAL/boost/graph/helpers.h +++ b/BGL/include/CGAL/boost/graph/helpers.h @@ -945,6 +945,9 @@ void swap_edges(const typename boost::graph_traits::halfedge_descript * \link MutableHalfedgeGraph `remove_edge()`\endlink, and * \link MutableFaceGraph `remove_face()`\endlink, for each vertex, edge, and face. * + * @warning This function does not perform anything more than what is advertised above. It is + * up to the user to e.g. clean garbage or remove internal property maps (if relevant, and desired). + * * @tparam FaceGraph model of `MutableHalfedgeGraph` and `MutableFaceGraph` * * @param g the graph to empty