code cleanup: redundant includes and add minor comments.
[blender.git] / source / blender / bmesh / intern / bmesh_core.c
index 0b14cf22276e20479b8488a54a5cc7fdbb27bf08..8441a6ec75f1ae1ea61b9896e542b1e6e7f510e0 100644 (file)
@@ -2282,7 +2282,8 @@ BMVert *bmesh_urmv(BMesh *bm, BMFace *f_sep, BMVert *v_sep)
 
 /**
  * Avoid calling this where possible,
- * low level function for swapping faces.
+ * low level function so both face pointers remain intact but point to swapped data.
+ * \note must be from the same bmesh.
  */
 void bmesh_face_swap_data(BMesh *bm, BMFace *f_a, BMFace *f_b)
 {