songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clarify that empty() does not clean garbage or remove property maps

This commit is contained in:
Mael Rouxel-Labbé 2023-05-15 12:42:42 +02:00
parent 34a9756836
commit 7a2e5412e9
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
BGL/include/CGAL/boost/graph/helpers.h
View File

@ -945,6 +945,9 @@ void swap_edges(const typename boost::graph_traits<FaceGraph>::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