From 4b188bb08cf5aaae3c68ab57bbcfa037eef1ac10 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Tue, 27 Oct 2020 21:32:09 +1100 Subject: Cleanup: use over-line for doxy comments Follow our code style for doxygen sections. --- source/blender/bmesh/intern/bmesh_core.c | 1 + source/blender/bmesh/intern/bmesh_delete.c | 4 +- source/blender/bmesh/intern/bmesh_interp.c | 1 + source/blender/bmesh/intern/bmesh_marking.c | 4 +- source/blender/bmesh/intern/bmesh_mesh_duplicate.c | 4 +- .../blender/bmesh/intern/bmesh_polygon_edgenet.c | 12 +++--- source/blender/bmesh/intern/bmesh_walkers_impl.c | 49 ++++++++++++---------- 7 files changed, 40 insertions(+), 35 deletions(-) (limited to 'source/blender/bmesh/intern') diff --git a/source/blender/bmesh/intern/bmesh_core.c b/source/blender/bmesh/intern/bmesh_core.c index df5e7aadc64..b913bdd12e4 100644 --- a/source/blender/bmesh/intern/bmesh_core.c +++ b/source/blender/bmesh/intern/bmesh_core.c @@ -2289,6 +2289,7 @@ bool BM_vert_splice(BMesh *bm, BMVert *v_dst, BMVert *v_src) return true; } +/* -------------------------------------------------------------------- */ /** \name BM_vert_separate, bmesh_kernel_vert_separate and friends * \{ */ diff --git a/source/blender/bmesh/intern/bmesh_delete.c b/source/blender/bmesh/intern/bmesh_delete.c index b5ff24f6d61..f470361e5fb 100644 --- a/source/blender/bmesh/intern/bmesh_delete.c +++ b/source/blender/bmesh/intern/bmesh_delete.c @@ -28,9 +28,9 @@ #include "bmesh.h" #include "intern/bmesh_private.h" -/* -------------------------------------------------------------------- */ /* BMO functions */ +/* -------------------------------------------------------------------- */ /** \name BMesh Operator Delete Functions * \{ */ @@ -203,7 +203,6 @@ void BMO_mesh_delete_oflag_context(BMesh *bm, const short oflag, const int type) /** \} */ -/* -------------------------------------------------------------------- */ /* BM functions * * note! this is just a duplicate of the code above (bad!) @@ -211,6 +210,7 @@ void BMO_mesh_delete_oflag_context(BMesh *bm, const short oflag, const int type) * each time we need to remove some geometry. */ +/* -------------------------------------------------------------------- */ /** \name BMesh Delete Functions (no oflags) * \{ */ diff --git a/source/blender/bmesh/intern/bmesh_interp.c b/source/blender/bmesh/intern/bmesh_interp.c index 0bbe86d2d2f..a15408d43be 100644 --- a/source/blender/bmesh/intern/bmesh_interp.c +++ b/source/blender/bmesh/intern/bmesh_interp.c @@ -1027,6 +1027,7 @@ void BM_elem_float_data_set(CustomData *cd, void *element, int type, const float } } +/* -------------------------------------------------------------------- */ /** \name Loop interpolation functions: BM_vert_loop_groups_data_layer_*** * * Handling loop custom-data such as UV's, while keeping contiguous fans is rather tedious. diff --git a/source/blender/bmesh/intern/bmesh_marking.c b/source/blender/bmesh/intern/bmesh_marking.c index a5d02cdc4e5..4fe6e6aee58 100644 --- a/source/blender/bmesh/intern/bmesh_marking.c +++ b/source/blender/bmesh/intern/bmesh_marking.c @@ -66,6 +66,7 @@ static void recount_totsels(BMesh *bm) } } +/* -------------------------------------------------------------------- */ /** \name BMesh helper functions for selection & hide flushing. * \{ */ @@ -540,7 +541,8 @@ void BM_face_select_set(BMesh *bm, BMFace *f, const bool select) } } -/** \name Non flushing versions element selection. +/* -------------------------------------------------------------------- */ +/** \name Non Flushing Versions Element Selection * \{ */ void BM_edge_select_set_noflush(BMesh *bm, BMEdge *e, const bool select) diff --git a/source/blender/bmesh/intern/bmesh_mesh_duplicate.c b/source/blender/bmesh/intern/bmesh_mesh_duplicate.c index 51f9d2eab1d..1d393abcd56 100644 --- a/source/blender/bmesh/intern/bmesh_mesh_duplicate.c +++ b/source/blender/bmesh/intern/bmesh_mesh_duplicate.c @@ -50,9 +50,7 @@ static BMEdge *bm_edge_copy_with_arrays(BMesh *bm_src, } static BMFace *bm_face_copy_with_arrays( - BMesh *bm_src, BMesh *bm_dst, BMFace *f_src, BMVert **verts_dst, BMEdge **edges_dst - -) + BMesh *bm_src, BMesh *bm_dst, BMFace *f_src, BMVert **verts_dst, BMEdge **edges_dst) { BMFace *f_dst; BMVert **vtar = BLI_array_alloca(vtar, f_src->len); diff --git a/source/blender/bmesh/intern/bmesh_polygon_edgenet.c b/source/blender/bmesh/intern/bmesh_polygon_edgenet.c index 09c0f48c2f6..1d000b3b232 100644 --- a/source/blender/bmesh/intern/bmesh_polygon_edgenet.c +++ b/source/blender/bmesh/intern/bmesh_polygon_edgenet.c @@ -39,9 +39,9 @@ #include "intern/bmesh_private.h" /* -------------------------------------------------------------------- */ -/* Face Split Edge-Net */ - -/** \name BM_face_split_edgenet and helper functions. +/** \name Face Split Edge-Net + * + * #BM_face_split_edgenet and helper functions. * * \note Don't use #BM_edge_is_wire or #BM_edge_is_boundary * since we need to take flagged faces into account. @@ -702,9 +702,9 @@ bool BM_face_split_edgenet(BMesh *bm, /** \} */ /* -------------------------------------------------------------------- */ -/* Face Split Edge-Net Connect Islands */ - -/** \name BM_face_split_edgenet_connect_islands and helper functions. +/** \name Face Split Edge-Net Connect Islands + * + * #BM_face_split_edgenet_connect_islands and helper functions. * * Connect isolated mesh 'islands' so they form legal regions from which we can create faces. * diff --git a/source/blender/bmesh/intern/bmesh_walkers_impl.c b/source/blender/bmesh/intern/bmesh_walkers_impl.c index dc9107a1616..8132230334b 100644 --- a/source/blender/bmesh/intern/bmesh_walkers_impl.c +++ b/source/blender/bmesh/intern/bmesh_walkers_impl.c @@ -37,6 +37,7 @@ } \ (void)0 +/* -------------------------------------------------------------------- */ /** \name Mask Flag Checks * \{ */ @@ -75,6 +76,7 @@ static bool bmw_mask_check_face(BMWalker *walker, BMFace *f) /** \} */ +/* -------------------------------------------------------------------- */ /** \name BMesh Queries (modified to check walker flags) * \{ */ @@ -94,8 +96,8 @@ static bool bmw_edge_is_wire(const BMWalker *walker, const BMEdge *e) } /** \} */ +/* -------------------------------------------------------------------- */ /** \name Shell Walker - * \{ * * Starts at a vertex on the mesh and walks over the 'shell' it belongs * to via visiting connected edges. @@ -104,7 +106,7 @@ static bool bmw_edge_is_wire(const BMWalker *walker, const BMEdge *e) * restrict flag acts on the edges as well. * * \todo Add restriction flag/callback for wire edges. - */ + * \{ */ static void bmw_VertShellWalker_visitEdge(BMWalker *walker, BMEdge *e) { BMwShellWalker *shellWalk = NULL; @@ -228,14 +230,14 @@ static void *bmw_VertShellWalker_step(BMWalker *walker) /** \} */ +/* -------------------------------------------------------------------- */ /** \name LoopShell Walker - * \{ * * Starts at any element on the mesh and walks over the 'shell' it belongs * to via visiting connected loops. * * \note this is mainly useful to loop over a shell delimited by edges. - */ + * \{ */ static void bmw_LoopShellWalker_visitLoop(BMWalker *walker, BMLoop *l) { BMwLoopShellWalker *shellWalk = NULL; @@ -352,10 +354,10 @@ static void *bmw_LoopShellWalker_step(BMWalker *walker) /** \} */ +/* -------------------------------------------------------------------- */ /** \name LoopShell & 'Wire' Walker - * \{ * - * Piggyback ontop of #BMwLoopShellWalker, but also walk over wire edges + * Piggyback on top of #BMwLoopShellWalker, but also walk over wire edges * This isn't elegant but users expect it when selecting linked, * so we can support delimiters _and_ walking over wire edges. * @@ -363,7 +365,7 @@ static void *bmw_LoopShellWalker_step(BMWalker *walker) * - can yield edges (as well as loops) * - only step over wire edges. * - verts and edges are stored in `visit_set_alt`. - */ + * \{ */ static void bmw_LoopShellWalker_visitEdgeWire(BMWalker *walker, BMEdge *e) { @@ -504,12 +506,12 @@ static void *bmw_LoopShellWireWalker_step(BMWalker *walker) /** \} */ +/* -------------------------------------------------------------------- */ /** \name FaceShell Walker - * \{ * * Starts at an edge on the mesh and walks over the 'shell' it belongs * to via visiting connected faces. - */ + * \{ */ static void bmw_FaceShellWalker_visitEdge(BMWalker *walker, BMEdge *e) { BMwShellWalker *shellWalk = NULL; @@ -567,13 +569,13 @@ static void *bmw_FaceShellWalker_step(BMWalker *walker) } /** \} */ +/* -------------------------------------------------------------------- */ /** \name Connected Vertex Walker - * \{ * * Similar to shell walker, but visits vertices instead of edges. * * Walk from a vertex to all connected vertices. - */ + * \{ */ static void bmw_ConnectedVertexWalker_visitVertex(BMWalker *walker, BMVert *v) { BMwConnectedVertexWalker *vwalk; @@ -629,8 +631,8 @@ static void *bmw_ConnectedVertexWalker_step(BMWalker *walker) /** \} */ +/* -------------------------------------------------------------------- */ /** \name Island Boundary Walker - * \{ * * Starts at a edge on the mesh and walks over the boundary of an island it belongs to. * @@ -640,7 +642,7 @@ static void *bmw_ConnectedVertexWalker_step(BMWalker *walker) * over the boundary. raises an error if it encounters non-manifold geometry. * * \todo Add restriction flag/callback for wire edges. - */ + * \{ */ static void bmw_IslandboundWalker_begin(BMWalker *walker, void *data) { BMLoop *l = data; @@ -723,13 +725,13 @@ static void *bmw_IslandboundWalker_step(BMWalker *walker) return owalk.curloop; } +/* -------------------------------------------------------------------- */ /** \name Island Walker - * \{ * * Starts at a tool flagged-face and walks over the face region * * \todo Add restriction flag/callback for wire edges. - */ + * \{ */ static void bmw_IslandWalker_begin(BMWalker *walker, void *data) { BMwIslandWalker *iwalk = NULL; @@ -828,11 +830,11 @@ static void *bmw_IslandManifoldWalker_step(BMWalker *walker) /** \} */ +/* -------------------------------------------------------------------- */ /** \name Edge Loop Walker - * \{ * * Starts at a tool-flagged edge and walks over the edge loop - */ + * \{ */ /* utility function to see if an edge is a part of an ngon boundary */ static bool bm_edge_is_single(BMEdge *e) @@ -1070,13 +1072,13 @@ static void *bmw_EdgeLoopWalker_step(BMWalker *walker) /** \} */ +/* -------------------------------------------------------------------- */ /** \name Face Loop Walker - * \{ * * Starts at a tool-flagged face and walks over the face loop * Conditions for starting and stepping the face loop have been * tuned in an attempt to match the face loops built by EditMesh - */ + * \{ */ /* Check whether the face loop should includes the face specified * by the given BMLoop */ @@ -1216,13 +1218,13 @@ static void *bmw_FaceLoopWalker_step(BMWalker *walker) // #define BMW_EDGERING_NGON +/* -------------------------------------------------------------------- */ /** \name Edge Ring Walker - * \{ * * Starts at a tool-flagged edge and walks over the edge ring * Conditions for starting and stepping the edge ring have been * tuned to match behavior users expect (dating back to v2.4x). - */ + * \{ */ static void bmw_EdgeringWalker_begin(BMWalker *walker, void *data) { BMwEdgeringWalker *lwalk, owalk, *owalk_pt; @@ -1349,6 +1351,7 @@ static void *bmw_EdgeringWalker_step(BMWalker *walker) /** \} */ +/* -------------------------------------------------------------------- */ /** \name Boundary Edge Walker * \{ */ @@ -1420,14 +1423,14 @@ static void *bmw_EdgeboundaryWalker_step(BMWalker *walker) /** \} */ +/* -------------------------------------------------------------------- */ /** \name UV Edge Walker * * walk over uv islands; takes a loop as input. restrict flag * restricts the walking to loops whose vert has restrict flag set as a * tool flag. * - * the flag parameter to BMW_init maps to a loop customdata layer index. - * + * The flag parameter to BMW_init maps to a loop customdata layer index. * \{ */ static void bmw_UVEdgeWalker_begin(BMWalker *walker, void *data) -- cgit v1.2.3