diff options
author | Campbell Barton <ideasman42@gmail.com> | 2018-09-02 11:28:27 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2018-09-02 11:28:27 +0300 |
commit | ae573836483d6acc56761918336cb8d2b0486d08 (patch) | |
tree | a9bb8a66c543824ae876c18f299fd176a952619e /source/blender/bmesh | |
parent | 6abb37babc6aad9d7f262b1516b7a0e2972cb8e1 (diff) |
Cleanup: comment blocks
Diffstat (limited to 'source/blender/bmesh')
-rw-r--r-- | source/blender/bmesh/intern/bmesh_interp.c | 50 | ||||
-rw-r--r-- | source/blender/bmesh/intern/bmesh_mesh.c | 22 | ||||
-rw-r--r-- | source/blender/bmesh/intern/bmesh_opdefines.c | 2 | ||||
-rw-r--r-- | source/blender/bmesh/intern/bmesh_polygon.c | 12 | ||||
-rw-r--r-- | source/blender/bmesh/intern/bmesh_private.h | 6 | ||||
-rw-r--r-- | source/blender/bmesh/intern/bmesh_query.c | 16 | ||||
-rw-r--r-- | source/blender/bmesh/operators/bmo_smooth_laplacian.c | 6 | ||||
-rw-r--r-- | source/blender/bmesh/tools/bmesh_bevel.c | 6 |
8 files changed, 63 insertions, 57 deletions
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: + * <pre> + * v4/next + * | + * | v1/cent-----mid2 ---> x + * | | | + * | | | + * v2/prev---mid1-----v3/cur + * | + * V + * y + * </pre> */ 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: + * <pre> + * v4/next + * | + * | v1/cent-----mid2 ---> x + * | | | + * | | | + * v2/prev---mid1-----v3/cur + * | + * V + * y + * </pre> */ if (l->radial_next == l) diff --git a/source/blender/bmesh/intern/bmesh_mesh.c b/source/blender/bmesh/intern/bmesh_mesh.c index 0dcbc05b201..8833564e486 100644 --- a/source/blender/bmesh/intern/bmesh_mesh.c +++ b/source/blender/bmesh/intern/bmesh_mesh.c @@ -1096,24 +1096,24 @@ void BM_lnorspace_invalidate(BMesh *bm, const bool do_invalidate_all) BMLoop *l; BMIter viter, liter; /* Note: we could use temp tag of BMItem for that, but probably better not use it in such a low-level func? - * --mont29 */ + * --mont29 */ BLI_bitmap *done_verts = BLI_BITMAP_NEW(bm->totvert, __func__); BM_mesh_elem_index_ensure(bm, BM_VERT); /* When we affect a given vertex, we may affect following smooth fans: - * - all smooth fans of said vertex; - * - all smooth fans of all immediate loop-neighbors vertices; - * This can be simplified as 'all loops of selected vertices and their immediate neighbors' - * need to be tagged for update. - */ + * - all smooth fans of said vertex; + * - all smooth fans of all immediate loop-neighbors vertices; + * This can be simplified as 'all loops of selected vertices and their immediate neighbors' + * need to be tagged for update. + */ BM_ITER_MESH(v, &viter, bm, BM_VERTS_OF_MESH) { if (BM_elem_flag_test(v, BM_ELEM_SELECT)) { BM_ITER_ELEM(l, &liter, v, BM_LOOPS_OF_VERT) { BM_ELEM_API_FLAG_ENABLE(l, BM_LNORSPACE_UPDATE); /* Note that we only handle unselected neighbor vertices here, main loop will take care of - * selected ones. */ + * selected ones. */ if ((!BM_elem_flag_test(l->prev->v, BM_ELEM_SELECT)) && !BLI_BITMAP_TEST(done_verts, BM_elem_index_get(l->prev->v))) { @@ -1265,10 +1265,10 @@ void BM_normals_loops_edges_tag(BMesh *bm, const bool do_edges) } /** -* Auxillary function only used by rebuild to detect if any spaces were not marked as invalid. -* Reports error if any of the lnor spaces change after rebuilding, meaning that all the possible -* lnor spaces to be rebuilt were not correctly marked. -*/ + * Auxillary function only used by rebuild to detect if any spaces were not marked as invalid. + * Reports error if any of the lnor spaces change after rebuilding, meaning that all the possible + * lnor spaces to be rebuilt were not correctly marked. + */ #ifndef NDEBUG void BM_lnorspace_err(BMesh *bm) { diff --git a/source/blender/bmesh/intern/bmesh_opdefines.c b/source/blender/bmesh/intern/bmesh_opdefines.c index c054089480f..427ef239abc 100644 --- a/source/blender/bmesh/intern/bmesh_opdefines.c +++ b/source/blender/bmesh/intern/bmesh_opdefines.c @@ -1529,7 +1529,7 @@ static BMO_FlagSet bmo_enum_similar_edges_types[] = { /* * 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 421b2adc3a7..8c96c938cef 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 */ diff --git a/source/blender/bmesh/operators/bmo_smooth_laplacian.c b/source/blender/bmesh/operators/bmo_smooth_laplacian.c index 317045b303c..9f394aacc1c 100644 --- a/source/blender/bmesh/operators/bmo_smooth_laplacian.c +++ b/source/blender/bmesh/operators/bmo_smooth_laplacian.c @@ -153,9 +153,12 @@ static LaplacianSystem *init_laplacian_system(int a_numEdges, int a_numFaces, in return sys; } -/* Compute weight between vertice v_i and all your neighbors +/** + * Compute weight between vertice v_i and all your neighbors * weight between v_i and v_neighbor + * <pre> * Wij = cot(alpha) + cot(beta) / (4.0 * total area of all faces * sum all weight) + * * v_i * * / | \ * / | \ @@ -163,6 +166,7 @@ static LaplacianSystem *init_laplacian_system(int a_numEdges, int a_numFaces, in * \ | / * \ | / * * v_neighbor + * </pre> */ static void init_laplacian_matrix(LaplacianSystem *sys) diff --git a/source/blender/bmesh/tools/bmesh_bevel.c b/source/blender/bmesh/tools/bmesh_bevel.c index 90e4033d572..ed32a9bbc2c 100644 --- a/source/blender/bmesh/tools/bmesh_bevel.c +++ b/source/blender/bmesh/tools/bmesh_bevel.c @@ -1596,8 +1596,8 @@ static void bevel_extend_edge_data(BevVert *bv) start = bcur; /* set start to first boundvert with seam_len > 0 */ /* Now for all the mesh_verts starting at current index and ending at idxlen - * We go through outermost ring and through all its segments and add seams - * for those edges */ + * We go through outermost ring and through all its segments and add seams + * for those edges */ int idxlen = bcur->index + bcur->seam_len; for (int i = bcur->index; i < idxlen; i++) { BMVert *v1 = mesh_vert(vm, i % vm->count, 0, 0)->v, *v2; @@ -2345,7 +2345,7 @@ static void adjust_the_cycle_or_chain(BoundVert *vstart, bool iscycle) /* residue np + 2*i (if cycle) else np - 1 + 2*i: * right offset for parm i matches its spec; weighted */ - row = iscycle ? np + 2 * i : np - 1 + 2 * i; + row = iscycle ? np + 2 * i : np - 1 + 2 * i; EIG_linear_solver_matrix_add(solver, row, i, weight); EIG_linear_solver_right_hand_side_add(solver, 0, row, weight * eright->offset_r); #ifdef DEBUG_ADJUST |