diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-12-03 11:29:35 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-03 12:10:57 +0300 |
commit | c4e041da23b9c45273fcd4874308c536b6a315d1 (patch) | |
tree | 9afdea81b57e801d3a1930988ebf3a2145a408bb /source/blender/bmesh/intern/bmesh_structure.c | |
parent | 7c4fc5b58d2e7982aefbba093cb8f1dc36b64884 (diff) |
Cleanup: move public doc-strings into headers for 'bmesh'
Some minor improvements to doc-strings too.
Ref T92709
Diffstat (limited to 'source/blender/bmesh/intern/bmesh_structure.c')
-rw-r--r-- | source/blender/bmesh/intern/bmesh_structure.c | 60 |
1 files changed, 0 insertions, 60 deletions
diff --git a/source/blender/bmesh/intern/bmesh_structure.c b/source/blender/bmesh/intern/bmesh_structure.c index 1f1ad0bae5b..08b0920c115 100644 --- a/source/blender/bmesh/intern/bmesh_structure.c +++ b/source/blender/bmesh/intern/bmesh_structure.c @@ -47,11 +47,6 @@ void bmesh_disk_vert_swap(BMEdge *e, BMVert *v_dst, BMVert *v_src) } } -/** - * Handles all connected data, use with care. - * - * Assumes caller has setup correct state before the swap is done. - */ void bmesh_edge_vert_swap(BMEdge *e, BMVert *v_dst, BMVert *v_src) { /* swap out loops */ @@ -268,14 +263,6 @@ bool bmesh_disk_validate(int len, BMEdge *e, BMVert *v) return true; } -/** - * \brief DISK COUNT FACE VERT - * - * Counts the number of loop users - * for this vertex. Note that this is - * equivalent to counting the number of - * faces incident upon this vertex - */ int bmesh_disk_facevert_count(const BMVert *v) { /* is there an edge on this vert at all */ @@ -315,14 +302,6 @@ int bmesh_disk_facevert_count_at_most(const BMVert *v, const int count_max) return count; } -/** - * \brief FIND FIRST FACE EDGE - * - * Finds the first edge in a vertices - * Disk cycle that has one of this - * vert's loops attached - * to it. - */ BMEdge *bmesh_disk_faceedge_find_first(const BMEdge *e, const BMVert *v) { const BMEdge *e_iter = e; @@ -334,11 +313,6 @@ BMEdge *bmesh_disk_faceedge_find_first(const BMEdge *e, const BMVert *v) return NULL; } -/** - * Special case for BM_LOOPS_OF_VERT & BM_FACES_OF_VERT, avoids 2x calls. - * - * The returned BMLoop.e matches the result of #bmesh_disk_faceedge_find_first - */ BMLoop *bmesh_disk_faceloop_find_first(const BMEdge *e, const BMVert *v) { const BMEdge *e_iter = e; @@ -350,9 +324,6 @@ BMLoop *bmesh_disk_faceloop_find_first(const BMEdge *e, const BMVert *v) return NULL; } -/** - * A version of #bmesh_disk_faceloop_find_first that ignores hidden faces. - */ BMLoop *bmesh_disk_faceloop_find_first_visible(const BMEdge *e, const BMVert *v) { const BMEdge *e_iter = e; @@ -384,7 +355,6 @@ BMEdge *bmesh_disk_faceedge_find_next(const BMEdge *e, const BMVert *v) return (BMEdge *)e; } -/*****radial cycle functions, e.g. loops surrounding edges**** */ bool bmesh_radial_validate(int radlen, BMLoop *l) { BMLoop *l_iter = l; @@ -442,14 +412,6 @@ void bmesh_radial_loop_append(BMEdge *e, BMLoop *l) l->e = e; } -/** - * \brief BMESH RADIAL REMOVE LOOP - * - * Removes a loop from an radial cycle. If edge e is non-NULL - * it should contain the radial cycle, and it will also get - * updated (in the case that the edge's link into the radial - * cycle was the loop which is being removed from the cycle). - */ void bmesh_radial_loop_remove(BMEdge *e, BMLoop *l) { /* if e is non-NULL, l must be in the radial cycle of e */ @@ -480,10 +442,6 @@ void bmesh_radial_loop_remove(BMEdge *e, BMLoop *l) l->e = NULL; } -/** - * A version of #bmesh_radial_loop_remove which only performs the radial unlink, - * leaving the edge untouched. - */ void bmesh_radial_loop_unlink(BMLoop *l) { if (l->radial_next != l) { @@ -497,12 +455,6 @@ void bmesh_radial_loop_unlink(BMLoop *l) l->e = NULL; } -/** - * \brief BME RADIAL FIND FIRST FACE VERT - * - * Finds the first loop of v around radial - * cycle - */ BMLoop *bmesh_radial_faceloop_find_first(const BMLoop *l, const BMVert *v) { const BMLoop *l_iter; @@ -553,12 +505,6 @@ int bmesh_radial_length(const BMLoop *l) return i; } -/** - * \brief RADIAL COUNT FACE VERT - * - * Returns the number of times a vertex appears - * in a radial cycle - */ int bmesh_radial_facevert_count(const BMLoop *l, const BMVert *v) { const BMLoop *l_iter; @@ -590,11 +536,6 @@ int bmesh_radial_facevert_count_at_most(const BMLoop *l, const BMVert *v, const return count; } -/** - * \brief RADIAL CHECK FACE VERT - * - * Quicker check for `bmesh_radial_facevert_count(...) != 0`. - */ bool bmesh_radial_facevert_check(const BMLoop *l, const BMVert *v) { const BMLoop *l_iter; @@ -608,7 +549,6 @@ bool bmesh_radial_facevert_check(const BMLoop *l, const BMVert *v) return false; } -/*****loop cycle functions, e.g. loops surrounding a face**** */ bool bmesh_loop_validate(BMFace *f) { int i; |