From 61776befc3f88c373e47ccbdf8c75e2ca0f4e987 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Thu, 9 Dec 2021 00:55:11 +1100 Subject: Cleanup: move public doc-strings into headers for 'editors' Ref T92709 --- source/blender/editors/mesh/editmesh_utils.c | 53 ++-------------------------- 1 file changed, 2 insertions(+), 51 deletions(-) (limited to 'source/blender/editors/mesh/editmesh_utils.c') diff --git a/source/blender/editors/mesh/editmesh_utils.c b/source/blender/editors/mesh/editmesh_utils.c index 3ba8f601937..013d5e5a661 100644 --- a/source/blender/editors/mesh/editmesh_utils.c +++ b/source/blender/editors/mesh/editmesh_utils.c @@ -68,9 +68,6 @@ * just as the undo stack would. * So leaving this as an interface for further work */ -/** - * Save a copy of the #BMesh for restoring later. - */ BMBackup EDBM_redo_state_store(BMEditMesh *em) { BMBackup backup; @@ -93,9 +90,6 @@ void EDBM_redo_state_restore(BMBackup *backup, BMEditMesh *em, bool recalc_loopt } } -/** - * Delete the backup, flushing it to an edit-mesh. - */ void EDBM_redo_state_restore_and_free(BMBackup *backup, BMEditMesh *em, bool recalc_looptri) { BM_mesh_data_free(em->bm); @@ -139,11 +133,6 @@ bool EDBM_op_init(BMEditMesh *em, BMOperator *bmop, wmOperator *op, const char * return true; } -/** - * The return value: - * - False on error (the mesh must not be changed). - * - True on success, executes and finishes a #BMesh operator. - */ bool EDBM_op_finish(BMEditMesh *em, BMOperator *bmop, wmOperator *op, const bool do_report) { const char *errmsg; @@ -320,11 +309,6 @@ void EDBM_mesh_make(Object *ob, const int select_mode, const bool add_key_index) EDBM_selectmode_flush(me->edit_mesh); } -/** - * \warning This can invalidate the #Mesh runtime cache of other objects (for linked duplicates). - * Most callers should run #DEG_id_tag_update on `ob->data`, see: T46738, T46913. - * This ensures #BKE_object_free_derived_caches runs on all objects that use this mesh. - */ void EDBM_mesh_load_ex(Main *bmain, Object *ob, bool free_data) { Mesh *me = ob->data; @@ -363,9 +347,6 @@ void EDBM_mesh_load(Main *bmain, Object *ob) EDBM_mesh_load_ex(bmain, ob, true); } -/** - * Should only be called on the active edit-mesh, otherwise call #BKE_editmesh_free_data. - */ void EDBM_mesh_free_data(BMEditMesh *em) { /* These tables aren't used yet, so it's not strictly necessary @@ -486,9 +467,6 @@ void EDBM_flag_enable_all(BMEditMesh *em, const char hflag) /** \name UV Vertex Map API * \{ */ -/** - * Return a new #UvVertMap from the edit-mesh. - */ UvVertMap *BM_uv_vert_map_create(BMesh *bm, const bool use_select, const bool use_winding) { BMVert *ev; @@ -632,7 +610,6 @@ UvMapVert *BM_uv_vert_map_at_index(UvVertMap *vmap, uint v) return vmap->vert[v]; } -/* A specialized vert map used by stitch operator */ UvElementMap *BM_uv_element_map_create(BMesh *bm, const Scene *scene, const bool face_selected, @@ -953,10 +930,6 @@ UvElement *BM_uv_element_get(UvElementMap *map, BMFace *efa, BMLoop *l) /** \name Data Layer Checks * \{ */ -/** - * last_sel, use em->act_face otherwise get the last selected face in the editselections - * at the moment, last_sel is mainly useful for making sure the space image doesn't flicker. - */ BMFace *EDBM_uv_active_face_get(BMEditMesh *em, const bool sloppy, const bool selected) { BMFace *efa = NULL; @@ -974,7 +947,6 @@ BMFace *EDBM_uv_active_face_get(BMEditMesh *em, const bool sloppy, const bool se return NULL; } -/* Can we edit UV's for this mesh? */ bool EDBM_uv_check(BMEditMesh *em) { /* some of these checks could be a touch overkill */ @@ -1015,20 +987,10 @@ static BMVert *cache_mirr_intptr_as_bmvert(const intptr_t *index_lookup, int ind * \endcode */ -/* BM_SEARCH_MAXDIST is too big, copied from 2.6x MOC_THRESH, should become a - * preference */ +/* BM_SEARCH_MAXDIST is too big, copied from 2.6x MOC_THRESH, should become a preference. */ #define BM_SEARCH_MAXDIST_MIRR 0.00002f #define BM_CD_LAYER_ID "__mirror_index" -/** - * \param em: Editmesh. - * \param use_self: Allow a vertex to point to its self (middle verts). - * \param use_select: Restrict to selected verts. - * \param respecthide: Skip hidden vertices. - * \param use_topology: Use topology mirror. - * \param maxdist: Distance for close point test. - * \param r_index: Optional array to write into, as an alternative to a customdata layer - * (length of total verts). - */ + void EDBM_verts_mirror_cache_begin_ex(BMEditMesh *em, const int axis, const bool use_self, @@ -1255,7 +1217,6 @@ void EDBM_verts_mirror_apply(BMEditMesh *em, const int sel_from, const int sel_t /** \name Hide/Reveal API * \{ */ -/* swap is 0 or 1, if 1 it hides not selected */ bool EDBM_mesh_hide(BMEditMesh *em, bool swap) { BMIter iter; @@ -1410,9 +1371,6 @@ void EDBM_stats_update(BMEditMesh *em) } } -/** - * So many tools call these that we better make it a generic function. - */ void EDBM_update(Mesh *mesh, const struct EDBMUpdate_Params *params) { BMEditMesh *em = mesh->edit_mesh; @@ -1459,7 +1417,6 @@ void EDBM_update(Mesh *mesh, const struct EDBMUpdate_Params *params) #endif } -/* Bad level call from Python API. */ void EDBM_update_extern(struct Mesh *me, const bool do_tessellation, const bool is_destructive) { EDBM_update(me, @@ -1476,7 +1433,6 @@ void EDBM_update_extern(struct Mesh *me, const bool do_tessellation, const bool /** \name Operator Helpers * \{ */ -/* poll call for mesh operators requiring a view3d context */ bool EDBM_view3d_poll(bContext *C) { if (ED_operator_editmesh(C) && ED_operator_view3d_active(C)) { @@ -1509,11 +1465,6 @@ BMElem *EDBM_elem_from_selectmode(BMEditMesh *em, BMVert *eve, BMEdge *eed, BMFa return ele; } -/** - * Used when we want to store a single index for any vert/edge/face. - * - * Intended for use with operators. - */ int EDBM_elem_to_index_any(BMEditMesh *em, BMElem *ele) { BMesh *bm = em->bm; -- cgit v1.2.3