Cleanup: use colon separator after parameter

Helps separate variable names from descriptive text.
Was already used in some parts of the code,
double space and dashes were used elsewhere.

7 files changed, 61 insertions, 61 deletions

diff --git a/source/blender/bmesh/intern/bmesh_construct.c b/source/blender/bmesh/intern/bmesh_construct.c
index 8f124afc55b..68f08025e5a 100644
--- a/source/blender/bmesh/intern/bmesh_construct.c
+++ b/source/blender/bmesh/intern/bmesh_construct.c
@@ -127,7 +127,7 @@ BMFace *BM_face_create_quad_tri(
 /**
  * \brief copies face loop data from shared adjacent faces.
  *
- * \param filter_fn  A function that filters the source loops before copying (don't always want to copy all)
+ * \param filter_fn: A function that filters the source loops before copying (don't always want to copy all)
  *
  * \note when a matching edge is found, both loops of that edge are copied
  * this is done since the face may not be completely surrounded by faces,
diff --git a/source/blender/bmesh/intern/bmesh_core.c b/source/blender/bmesh/intern/bmesh_core.c
index 97f1bad08b7..c384497e0d1 100644
--- a/source/blender/bmesh/intern/bmesh_core.c
+++ b/source/blender/bmesh/intern/bmesh_core.c
@@ -420,11 +420,11 @@ BLI_INLINE BMFace *bm_face_create__internal(BMesh *bm)
 /**
  * Main face creation function
  *
- * \param bm  The mesh
- * \param verts  A sorted array of verts size of len
- * \param edges  A sorted array of edges size of len
- * \param len  Length of the face
- * \param create_flag  Options for creating the face
+ * \param bm: The mesh
+ * \param verts: A sorted array of verts size of len
+ * \param edges: A sorted array of edges size of len
+ * \param len: Length of the face
+ * \param create_flag: Options for creating the face
  */
 BMFace *BM_face_create(
         BMesh *bm, BMVert **verts, BMEdge **edges, const int len,
@@ -2395,7 +2395,7 @@ void bmesh_kernel_vert_separate(
  *
  * Any edges which failed to split off in #bmesh_kernel_vert_separate will be merged back into the original edge.
  *
- * \param edges_separate
+ * \param edges_separate:
  * A list-of-lists, each list is from a single original edge (the first edge is the original),
  * Check for duplicates (not just with the first) but between all.
  * This is O(n2) but radial edges are very rarely >2 and almost never >~10.
diff --git a/source/blender/bmesh/intern/bmesh_mesh_conv.c b/source/blender/bmesh/intern/bmesh_mesh_conv.c
index 2259a7dfe09..fdd4ad084d1 100644
--- a/source/blender/bmesh/intern/bmesh_mesh_conv.c
+++ b/source/blender/bmesh/intern/bmesh_mesh_conv.c
@@ -592,7 +592,7 @@ BLI_INLINE void bmesh_quick_edgedraw_flag(MEdge *med, BMEdge *e)
 
 /**
  *
- * \param bmain May be NULL in case \a calc_object_remap parameter option is not set.
+ * \param bmain: May be NULL in case \a calc_object_remap parameter option is not set.
  */
 void BM_mesh_bm_to_me(
         Main *bmain, BMesh *bm, Mesh *me,
diff --git a/source/blender/bmesh/intern/bmesh_mods.c b/source/blender/bmesh/intern/bmesh_mods.c
index dfa3486227f..e95d5239caf 100644
--- a/source/blender/bmesh/intern/bmesh_mods.c
+++ b/source/blender/bmesh/intern/bmesh_mods.c
@@ -247,12 +247,12 @@ BMFace *BM_faces_join_pair(BMesh *bm, BMLoop *l_a, BMLoop *l_b, const bool do_de
  * Split a face along two vertices. returns the newly made face, and sets
  * the \a r_l member to a loop in the newly created edge.
  *
- * \param bm The bmesh
- * \param f the original face
- * \param l_a, l_b  Loops of this face, their vertices define
+ * \param bm: The bmesh
+ * \param f: the original face
+ * \param l_a, l_b: Loops of this face, their vertices define
  * the split edge to be created (must be differ and not can't be adjacent in the face).
- * \param r_l pointer which will receive the BMLoop for the split edge in the new face
- * \param example Edge used for attributes of splitting edge, if non-NULL
+ * \param r_l: pointer which will receive the BMLoop for the split edge in the new face
+ * \param example: Edge used for attributes of splitting edge, if non-NULL
  * \param no_double: Use an existing edge if found
  *
  * \return Pointer to the newly created face representing one side of the split
@@ -327,13 +327,13 @@ BMFace *BM_face_split(
  *
  * Like BM_face_split, but with an edge split by \a n intermediate points with given coordinates.
  *
- * \param bm The bmesh
- * \param f the original face
- * \param l_a, l_b vertices which define the split edge, must be different
- * \param cos Array of coordinates for intermediate points
- * \param n Length of \a cos (must be > 0)
- * \param r_l pointer which will receive the BMLoop for the first split edge (from \a l_a) in the new face
- * \param example Edge used for attributes of splitting edge, if non-NULL
+ * \param bm: The bmesh
+ * \param f: the original face
+ * \param l_a, l_b: Vertices which define the split edge, must be different.
+ * \param cos: Array of coordinates for intermediate points
+ * \param n: Length of \a cos (must be > 0)
+ * \param r_l: pointer which will receive the BMLoop for the first split edge (from \a l_a) in the new face
+ * \param example: Edge used for attributes of splitting edge, if non-NULL
  *
  * \return Pointer to the newly created face representing one side of the split
  * if the split is successful (and the original original face will be the
@@ -422,13 +422,13 @@ BMFace *BM_face_split_n(
  * both collapse a vertex and return a new edge.
  * Except this takes a factor and merges custom data.
  *
- * \param bm The bmesh
- * \param e_kill The edge to collapse
- * \param v_kill The vertex  to collapse into the edge
- * \param fac The factor along the edge
- * \param join_faces When true the faces around the vertex will be joined
+ * \param bm: The bmesh
+ * \param e_kill: The edge to collapse
+ * \param v_kill: The vertex  to collapse into the edge
+ * \param fac: The factor along the edge
+ * \param join_faces: When true the faces around the vertex will be joined
  * otherwise collapse the vertex by merging the 2 edges this vert touches into one.
- * \param kill_degenerate_faces Removes faces with less than 3 verts after collapsing.
+ * \param kill_degenerate_faces: Removes faces with less than 3 verts after collapsing.
  *
  * \returns The New Edge
  */
@@ -580,10 +580,10 @@ BMVert *BM_edge_collapse(
  *                 r_e                e
  * </pre>
  *
- * \param e  The edge to split.
- * \param v  One of the vertices in \a e and defines the "from" end of the splitting operation,
+ * \param e: The edge to split.
+ * \param v: One of the vertices in \a e and defines the "from" end of the splitting operation,
  * the new vertex will be \a fac of the way from \a v to the other end.
- * \param r_e  The newly created edge.
+ * \param r_e: The newly created edge.
  * \return  The new vertex.
  */
 BMVert *BM_edge_split(BMesh *bm, BMEdge *e, BMVert *v, BMEdge **r_e, float fac)
@@ -703,7 +703,7 @@ BMVert *BM_edge_split(BMesh *bm, BMEdge *e, BMVert *v, BMEdge **r_e, float fac)
 /**
  * \brief Split an edge multiple times evenly
  *
- * \param r_varr  Optional array, verts in between (v1 -> v2)
+ * \param r_varr: Optional array, verts in between (v1 -> v2)
  */
 BMVert  *BM_edge_split_n(BMesh *bm, BMEdge *e, int numcuts, BMVert **r_varr)
 {
@@ -857,8 +857,8 @@ bool BM_edge_rotate_check(BMEdge *e)
  * 1) does the newly forms edge form a flipped face (compare with previous cross product)
  * 2) does the newly formed edge cause a zero area corner (or close enough to be almost zero)
  *
- * \param e The edge to test rotation.
- * \param l1,l2 are the loops of the proposed verts to rotate too and should
+ * \param e: The edge to test rotation.
+ * \param l1, l2: are the loops of the proposed verts to rotate too and should
  * be the result of calling #BM_edge_calc_rotate
  */
 bool BM_edge_rotate_check_degenerate(BMEdge *e, BMLoop *l1, BMLoop *l2)
diff --git a/source/blender/bmesh/intern/bmesh_operators.c b/source/blender/bmesh/intern/bmesh_operators.c
index 62d892712fd..546bd9fb461 100644
--- a/source/blender/bmesh/intern/bmesh_operators.c
+++ b/source/blender/bmesh/intern/bmesh_operators.c
@@ -1375,7 +1375,7 @@ void *BMO_slot_buffer_get_first(BMOpSlot slot_args[BMO_OP_MAX_SLOTS], const char
 /**
  * \brief New Iterator
  *
- * \param restrictmask restricts the iteration to certain element types
+ * \param restrictmask: restricts the iteration to certain element types
  * (e.g. combination of BM_VERT, BM_EDGE, BM_FACE), if iterating
  * over an element buffer (not a mapping). */
 void *BMO_iter_new(
diff --git a/source/blender/bmesh/intern/bmesh_polygon.c b/source/blender/bmesh/intern/bmesh_polygon.c
index 5e3f5958a32..9751c2d8aef 100644
--- a/source/blender/bmesh/intern/bmesh_polygon.c
+++ b/source/blender/bmesh/intern/bmesh_polygon.c
@@ -950,7 +950,7 @@ bool BM_face_point_inside_test(const BMFace *f, const float co[3])
  * It uses polyfill for the ngons splitting, and
  * the beautify operator when use_beauty is true.
  *
- * \param r_faces_new if non-null, must be an array of BMFace pointers,
+ * \param r_faces_new: if non-null, must be an array of BMFace pointers,
  * with a length equal to (f->len - 3). It will be filled with the new
  * triangles (not including the original triangle).
  *
@@ -1393,7 +1393,7 @@ void BM_face_as_array_loop_quad(BMFace *f, BMLoop *r_loops[4])
 
 /**
  * \brief BM_mesh_calc_tessellation get the looptris and its number from a certain bmesh
- * \param looptris
+ * \param looptris:
  *
  * \note \a looptris Must be pre-allocated to at least the size of given by: poly_to_tri_count
  */
diff --git a/source/blender/bmesh/intern/bmesh_query.c b/source/blender/bmesh/intern/bmesh_query.c
index 13e2029381e..78fb28bda2f 100644
--- a/source/blender/bmesh/intern/bmesh_query.c
+++ b/source/blender/bmesh/intern/bmesh_query.c
@@ -1573,8 +1573,8 @@ float BM_loop_calc_face_normal_safe(const BMLoop *l, float r_normal[3])
  *
  * Calculate the normal at this loop corner or fallback to the face normal on straight lines.
  *
- * \param l The loop to calculate the normal at
- * \param r_normal Resulting normal
+ * \param l: The loop to calculate the normal at
+ * \param r_normal: Resulting normal
  * \return The length of the cross product (double the area).
  */
 float BM_loop_calc_face_normal(const BMLoop *l, float r_normal[3])
@@ -1596,8 +1596,8 @@ float BM_loop_calc_face_normal(const BMLoop *l, float r_normal[3])
  *
  * Calculate the direction a loop is pointing.
  *
- * \param l The loop to calculate the direction at
- * \param r_dir Resulting direction
+ * \param l: The loop to calculate the direction at
+ * \param r_dir: Resulting direction
  */
 void BM_loop_calc_face_direction(const BMLoop *l, float r_dir[3])
 {
@@ -1620,8 +1620,8 @@ void BM_loop_calc_face_direction(const BMLoop *l, float r_dir[3])
  * Calculate the tangent at this loop corner or fallback to the face normal on straight lines.
  * This vector always points inward into the face.
  *
- * \param l The loop to calculate the tangent at
- * \param r_tangent Resulting tangent
+ * \param l: The loop to calculate the tangent at
+ * \param r_tangent: Resulting tangent
  */
 void BM_loop_calc_face_tangent(const BMLoop *l, float r_tangent[3])
 {
@@ -1743,10 +1743,10 @@ float BM_edge_calc_face_angle_signed(const BMEdge *e)
  * This vector always points inward into the face.
  *
  * \brief BM_edge_calc_face_tangent
- * \param e
- * \param e_loop The loop to calculate the tangent at,
+ * \param e:
+ * \param e_loop: The loop to calculate the tangent at,
  * used to get the face and winding direction.
- * \param r_tangent The loop corner tangent to set
+ * \param r_tangent: The loop corner tangent to set
  */
 
 void BM_edge_calc_face_tangent(const BMEdge *e, const BMLoop *e_loop, float r_tangent[3])
@@ -2246,8 +2246,8 @@ bool BM_face_exists_multi_edge(BMEdge **earr, int len)
  * \note Its possible there are more than one overlapping faces,
  * in this case the first one found will be returned.
  *
- * \param varr  Array of unordered verts.
- * \param len  \a varr array length.
+ * \param varr: Array of unordered verts.
+ * \param len: \a varr array length.
  * \return The face or NULL.
  */
 
@@ -2294,8 +2294,8 @@ BMFace *BM_face_exists_overlap(BMVert **varr, const int len)
  * there is a face that uses vertices only from this list
  * (that the face is a subset or made from the vertices given).
  *
- * \param varr  Array of unordered verts.
- * \param len  varr array length.
+ * \param varr: Array of unordered verts.
+ * \param len: varr array length.
  */
 bool BM_face_exists_overlap_subset(BMVert **varr, const int len)
 {
@@ -2504,16 +2504,16 @@ float BM_mesh_calc_volume(BMesh *bm, bool is_signed)
 /**
  * Calculate isolated groups of faces with optional filtering.
  *
- * \param bm  the BMesh.
- * \param r_groups_array  Array of ints to fill in, length of bm->totface
+ * \param bm: the BMesh.
+ * \param r_groups_array: Array of ints to fill in, length of bm->totface
  *        (or when hflag_test is set, the number of flagged faces).
- * \param r_group_index  index, length pairs into \a r_groups_array, size of return value
+ * \param r_group_index: index, length pairs into \a r_groups_array, size of return value
  *        int pairs: (array_start, array_length).
- * \param filter_fn  Filter the edge-loops or vert-loops we step over (depends on \a htype_step).
- * \param user_data  Optional user data for \a filter_fn, can be NULL.
- * \param hflag_test  Optional flag to test faces,
+ * \param filter_fn: Filter the edge-loops or vert-loops we step over (depends on \a htype_step).
+ * \param user_data: Optional user data for \a filter_fn, can be NULL.
+ * \param hflag_test: Optional flag to test faces,
  *        use to exclude faces from the calculation, 0 for all faces.
- * \param htype_step  BM_VERT to walk over face-verts, BM_EDGE to walk over faces edges
+ * \param htype_step: BM_VERT to walk over face-verts, BM_EDGE to walk over faces edges
  *        (having both set is supported too).
  * \return The number of groups found.
  */
@@ -2660,15 +2660,15 @@ int BM_mesh_calc_face_groups(
 /**
  * Calculate isolated groups of edges with optional filtering.
  *
- * \param bm  the BMesh.
- * \param r_groups_array  Array of ints to fill in, length of bm->totedge
+ * \param bm: the BMesh.
+ * \param r_groups_array: Array of ints to fill in, length of bm->totedge
  *        (or when hflag_test is set, the number of flagged edges).
- * \param r_group_index  index, length pairs into \a r_groups_array, size of return value
+ * \param r_group_index: index, length pairs into \a r_groups_array, size of return value
  *        int pairs: (array_start, array_length).
- * \param filter_fn  Filter the edges or verts we step over (depends on \a htype_step)
+ * \param filter_fn: Filter the edges or verts we step over (depends on \a htype_step)
  *        as to which types we deal with.
- * \param user_data  Optional user data for \a filter_fn, can be NULL.
- * \param hflag_test  Optional flag to test edges,
+ * \param user_data: Optional user data for \a filter_fn, can be NULL.
+ * \param hflag_test: Optional flag to test edges,
  *        use to exclude edges from the calculation, 0 for all edges.
  * \return The number of groups found.
  *