Updated docu for garbage collection

git-svn-id: http://www.openmesh.org/svnrepo/OpenMesh/trunk@615 fdac6126-5c0c-442c-9429-916003d36597
2012-07-06 12:14:19 +00:00
parent d649542f3b
commit 1cc1ad05a2
1 changed files with 3 additions and 0 deletions
--- a/Doc/Concepts/MeshKernel.hh
+++ b/Doc/Concepts/MeshKernel.hh
@@ -178,6 +178,9 @@ public:
  void clear();
  /** Remove all items that are marked as deleted from the
      corresponding containers.
+      \note All handles (and indices) to any entity (face, vertex,
+            edge, halfedge) created before garbage collection  
+            will be out of sync with the mesh, do not use them anymore!
      \note Needs the Attributes::Status attribute
      \note This function may not be implemented for all kernels.
  */