[Bf-blender-cvs] [4b3ed76] temp-array-modifier: Cleanup: docstring

[Campbell Barton]

Commit: 4b3ed7644829bfb17f324c203dde357fee48dde9
Author: Campbell Barton
Date:   Tue Aug 12 12:35:38 2014 +1000
Branches: temp-array-modifier
https://developer.blender.org/rB4b3ed7644829bfb17f324c203dde357fee48dde9

Cleanup: docstring

===================================================================

M	source/blender/blenkernel/intern/cdderivedmesh.c

===================================================================

diff --git a/source/blender/blenkernel/intern/cdderivedmesh.c b/source/blender/blenkernel/intern/cdderivedmesh.c
index 9ad9916..8094ae5 100644
--- a/source/blender/blenkernel/intern/cdderivedmesh.c
+++ b/source/blender/blenkernel/intern/cdderivedmesh.c
@@ -2737,32 +2737,32 @@ static int poly_ghash_compare_fn(const void *k1, const void *k2)
 	}
 }
 
-
 /**
  * Merge Verts
  *
+ * This frees dm, and returns a new one.
+ *
  * \param vtargetmap  The table that maps vertices to target vertices.  a value of -1
  * indicates a vertex is a target, and is to be kept.
  * This array is aligned with 'dm->numVertData'
  *
- * \param tot_vtargetmap  The number of non '-1' values in vtargetmap.
- * (not the size )
- *
- * this frees dm, and returns a new one.
+ * \param tot_vtargetmap  The number of non '-1' values in vtargetmap. (not the size )
  *
- * note, CDDM_recalc_tessellation has to run on the returned DM if you want to access tessfaces.
+ * \param merge_mode enum with two modes.
+ * - #CDDM_MERGE_VERTS_DUMP_IF_MAPPED
+ * When called by the Mirror Modifier,
+ * In this mode it skips any faces that have all vertices merged (to avoid creating pairs
+ * of faces sharing the same set of vertices)
+ * - #CDDM_MERGE_VERTS_DUMP_IF_EQUAL
+ * When called by the Array Modifier,
+ * In this mode, faces where all vertices are merged are double-checked, to see whether
+ * all target vertices actually make up a poly already.   Indeed it could be that all of a poly's
+ * vertices are merged, but merged to vertices that do not make up a single poly, in which case
+ * the original poly should not be dumped.
+ * Actually this later behaviour could apply to the Mirror Modifier as well, but the additionnal checks are
+ * costly and not necessary in the case of mirror, because each vertex is only merged to its own mirror.
  *
- * Note: This function has two modes. 
- *       When called by the Mirror Modifier, it uses merge_mode= ..._DUMP_IF_MAPPED (=1).
- *       In this mode it skips any faces that have all vertices merged (to avoid creating pairs
- *       of faces sharing the same set of vertices)
- *       When called by the Array Modifier, it uses merge_mode= ..._DUMP_IF_EQUAL (=2).
- *       In this mode, faces where all vertices are merged are double-checked, to see whether
- *       all target vertices actually make up a poly already.   Indeed it could be that all of a poly's
- *       vertices are merged, but merged to vertices that do not make up a single poly, in which case
- *       the original poly should not be dumped.
- *       Actually this later behaviour could apply to the Mirror Modifier as well, but the additionnal checks are
- *       costly and not necessary in the case of mirror, because each vertex is only merged to its own mirror.
+ * \note #CDDM_recalc_tessellation has to run on the returned DM if you want to access tessfaces.
  */
 DerivedMesh *CDDM_merge_verts(DerivedMesh *dm, const int *vtargetmap, const int tot_vtargetmap, const int merge_mode)
 {