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

Improve documentation to mention clear

This commit is contained in:
Philipp Möller 2016-01-08 14:48:28 +01:00
parent 7ec3c25aa9
commit 7cf791fa0f
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -695,7 +695,12 @@ clear_impl(FaceGraph& g)
/**
* \ingroup PkgBGLHelperFct
*
* removes all vertices, faces and halfedges from a graph.
* removes all vertices, faces and halfedges from a graph. Calls
* `remove_edge()`, `remove_vertex()`, and `remove_face()` for each
* edge, vertex or face.
*
* If the graph has a member function `clear`, it will be called
* instead.
*
* @tparam FaceGraph model of `MutableHalfedgeGraph` and `MutableFaceGraph`
*