From 0ddf3e110ef0f1f69ef785db867e581f813ee9a7 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Sun, 2 Sep 2018 18:51:31 +1000 Subject: Cleanup: comment blocks --- source/blender/bmesh/intern/bmesh_interp.c | 50 ++++++++++++++------------- source/blender/bmesh/intern/bmesh_opdefines.c | 2 +- source/blender/bmesh/intern/bmesh_polygon.c | 12 +++---- source/blender/bmesh/intern/bmesh_private.h | 6 ++-- source/blender/bmesh/intern/bmesh_query.c | 16 ++++----- 5 files changed, 44 insertions(+), 42 deletions(-) (limited to 'source/blender/bmesh/intern') diff --git a/source/blender/bmesh/intern/bmesh_interp.c b/source/blender/bmesh/intern/bmesh_interp.c index e3b779ddbcd..e9c92e0d5e4 100644 --- a/source/blender/bmesh/intern/bmesh_interp.c +++ b/source/blender/bmesh/intern/bmesh_interp.c @@ -583,18 +583,19 @@ void BM_face_multires_bounds_smooth(BMesh *bm, BMFace *f) int sides; int y; - /* - * mdisps is a grid of displacements, ordered thus: - * - * v4/next - * | - * | v1/cent-----mid2 ---> x - * | | | - * | | | - * v2/prev---mid1-----v3/cur - * | - * V - * y + /** + * mdisps is a grid of displacements, ordered thus: + * 
+		 *                    v4/next
+		 *                      |
+		 *  |      v1/cent-----mid2 ---> x
+		 *  |         |         |
+		 *  |         |         |
+		 * v2/prev---mid1-----v3/cur
+		 *            |
+		 *            V
+		 *            y
+		 *
*/ sides = (int)sqrt(mdp->totdisp); @@ -613,18 +614,19 @@ void BM_face_multires_bounds_smooth(BMesh *bm, BMFace *f) int sides; int y; - /* - * mdisps is a grid of displacements, ordered thus: - * - * v4/next - * | - * | v1/cent-----mid2 ---> x - * | | | - * | | | - * v2/prev---mid1-----v3/cur - * | - * V - * y + /** + * mdisps is a grid of displacements, ordered thus: + * 
+		 *                    v4/next
+		 *                      |
+		 *  |      v1/cent-----mid2 ---> x
+		 *  |         |         |
+		 *  |         |         |
+		 * v2/prev---mid1-----v3/cur
+		 *            |
+		 *            V
+		 *            y
+		 *
*/ if (l->radial_next == l) diff --git a/source/blender/bmesh/intern/bmesh_opdefines.c b/source/blender/bmesh/intern/bmesh_opdefines.c index b5e6fe168e5..450d49211ec 100644 --- a/source/blender/bmesh/intern/bmesh_opdefines.c +++ b/source/blender/bmesh/intern/bmesh_opdefines.c @@ -1424,7 +1424,7 @@ static BMOpDefine bmo_similar_faces_def = { /* * Similar Edges Search. * - * Find similar edges (length, direction, edge, seam, ...). + * Find similar edges (length, direction, edge, seam, ...). */ static BMOpDefine bmo_similar_edges_def = { "similar_edges", diff --git a/source/blender/bmesh/intern/bmesh_polygon.c b/source/blender/bmesh/intern/bmesh_polygon.c index 7cbc6461667..3137725d6e7 100644 --- a/source/blender/bmesh/intern/bmesh_polygon.c +++ b/source/blender/bmesh/intern/bmesh_polygon.c @@ -869,7 +869,7 @@ void BM_face_normal_flip(BMesh *bm, BMFace *f) } /** - * BM POINT IN FACE + * BM POINT IN FACE * * Projects co onto face f, and returns true if it is inside * the face bounds. @@ -1284,7 +1284,7 @@ void BM_face_splits_check_optimal(BMFace *f, BMLoop *(*loops)[2], int len) * Small utility functions for fast access * * faster alternative to: - * BM_iter_as_array(bm, BM_VERTS_OF_FACE, f, (void **)v, 3); + * BM_iter_as_array(bm, BM_VERTS_OF_FACE, f, (void **)v, 3); */ void BM_face_as_array_vert_tri(BMFace *f, BMVert *r_verts[3]) { @@ -1299,7 +1299,7 @@ void BM_face_as_array_vert_tri(BMFace *f, BMVert *r_verts[3]) /** * faster alternative to: - * BM_iter_as_array(bm, BM_VERTS_OF_FACE, f, (void **)v, 4); + * BM_iter_as_array(bm, BM_VERTS_OF_FACE, f, (void **)v, 4); */ void BM_face_as_array_vert_quad(BMFace *f, BMVert *r_verts[4]) { @@ -1318,7 +1318,7 @@ void BM_face_as_array_vert_quad(BMFace *f, BMVert *r_verts[4]) * Small utility functions for fast access * * faster alternative to: - * BM_iter_as_array(bm, BM_LOOPS_OF_FACE, f, (void **)l, 3); + * BM_iter_as_array(bm, BM_LOOPS_OF_FACE, f, (void **)l, 3); */ void BM_face_as_array_loop_tri(BMFace *f, BMLoop *r_loops[3]) { @@ -1333,7 +1333,7 @@ void BM_face_as_array_loop_tri(BMFace *f, BMLoop *r_loops[3]) /** * faster alternative to: - * BM_iter_as_array(bm, BM_LOOPS_OF_FACE, f, (void **)l, 4); + * BM_iter_as_array(bm, BM_LOOPS_OF_FACE, f, (void **)l, 4); */ void BM_face_as_array_loop_quad(BMFace *f, BMLoop *r_loops[4]) { @@ -1352,7 +1352,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 * - * \note \a looptris Must be pre-allocated to at least the size of given by: poly_to_tri_count + * \note \a looptris Must be pre-allocated to at least the size of given by: poly_to_tri_count */ void BM_mesh_calc_tessellation(BMesh *bm, BMLoop *(*looptris)[3], int *r_looptris_tot) { diff --git a/source/blender/bmesh/intern/bmesh_private.h b/source/blender/bmesh/intern/bmesh_private.h index daee22ffe76..61e47a6cbd4 100644 --- a/source/blender/bmesh/intern/bmesh_private.h +++ b/source/blender/bmesh/intern/bmesh_private.h @@ -31,9 +31,9 @@ /** \file blender/bmesh/intern/bmesh_private.h * \ingroup bmesh * - * Private function prototypes for bmesh public API. - * This file is a grab-bag of functions from various - * parts of the bmesh internals. + * Private function prototypes for bmesh public API. + * This file is a grab-bag of functions from various + * parts of the bmesh internals. */ /* returns positive nonzero on error */ diff --git a/source/blender/bmesh/intern/bmesh_query.c b/source/blender/bmesh/intern/bmesh_query.c index 33ad7836893..540888ac0b9 100644 --- a/source/blender/bmesh/intern/bmesh_query.c +++ b/source/blender/bmesh/intern/bmesh_query.c @@ -1206,7 +1206,7 @@ bool BM_face_share_face_check(BMFace *f1, BMFace *f2) } /** - * Counts the number of edges two faces share (if any) + * Counts the number of edges two faces share (if any) */ int BM_face_share_edge_count(BMFace *f_a, BMFace *f_b) { @@ -1225,7 +1225,7 @@ int BM_face_share_edge_count(BMFace *f_a, BMFace *f_b) } /** - * Returns true if the faces share an edge + * Returns true if the faces share an edge */ bool BM_face_share_edge_check(BMFace *f1, BMFace *f2) { @@ -1243,7 +1243,7 @@ bool BM_face_share_edge_check(BMFace *f1, BMFace *f2) } /** - * Counts the number of verts two faces share (if any). + * Counts the number of verts two faces share (if any). */ int BM_face_share_vert_count(BMFace *f_a, BMFace *f_b) { @@ -1262,7 +1262,7 @@ int BM_face_share_vert_count(BMFace *f_a, BMFace *f_b) } /** - * Returns true if the faces share a vert. + * Returns true if the faces share a vert. */ bool BM_face_share_vert_check(BMFace *f_a, BMFace *f_b) { @@ -1656,8 +1656,8 @@ void BM_loop_calc_face_tangent(const BMLoop *l, float r_tangent[3]) /** * \brief BMESH EDGE/FACE ANGLE * - * Calculates the angle between two faces. - * Assumes the face normals are correct. + * Calculates the angle between two faces. + * Assumes the face normals are correct. * * \return angle in radians */ @@ -1680,8 +1680,8 @@ float BM_edge_calc_face_angle(const BMEdge *e) /** * \brief BMESH EDGE/FACE ANGLE * - * Calculates the angle between two faces. - * Assumes the face normals are correct. + * Calculates the angle between two faces. + * Assumes the face normals are correct. * * \return angle in radians */ -- cgit v1.2.3